Dubbo（90）如何设计一个支持多协议的Dubbo服务？

于 2025-05-02 11:54:02 发布
阅读量960 收藏 17
点赞数 24
分类专栏： 微服务 文章标签： dubbo
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43012298/article/details/139385021
版权

设计一个支持多协议的Dubbo服务需要考虑以下几个方面：

  1. 服务接口设计：确保服务接口的定义可以被不同协议实现。
  2. 多协议配置：配置不同的协议，例如 Dubbo、HTTP、gRPC 等。
  3. 服务注册与发现：确保服务能够在多个协议下注册和发现。
  4. 客户端和服务端实现：在不同协议下实现客户端和服务端。
  5. 配置管理：确保配置文件和环境变量支持多协议。

以下是一个详细的设计步骤和代码示例，展示如何构建一个支持多协议的Dubbo服务。

1. 服务接口设计

使用 Java 接口定义服务接口。

1.1 创建服务接口模块（dubbo-api）

服务接口模块 dubbo-api 定义了服务接口。

1.1.1 创建 pom.xml

在 dubbo-api 模块中创建 pom.xml 文件：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://www.w3.org/2001/04/xmldsig-more#">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>dubbo-api</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo</artifactId>
            <version>2.7.8</version>
        </dependency>
    </dependencies>
</project>
1.1.2 创建服务接口

在 dubbo-api/src/main/java/com/example/dubbo/api 目录下创建 UserService 接口：

package com.example.dubbo.api;

public interface UserService {
    String getUser(String userId);
}

2. 创建服务提供者模块（dubbo-provider）

服务提供者模块 dubbo-provider 实现了服务接口并提供服务。

2.1 创建 pom.xml

在 dubbo-provider 模块中创建 pom.xml 文件：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.w3.org/2001/04/xmldsig-more#">

    <parent>
        <groupId>com.example</groupId>
        <artifactId>dubbo-demo</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <artifactId>dubbo-provider</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>dubbo-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
            <version>2.7.8</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
    </dependencies>
</project>
2.2 创建服务实现

在 dubbo-provider/src/main/java/com/example/dubbo/provider/service 目录下创建 UserServiceImpl 类：

package com.example.dubbo.provider.service;

import com.example.dubbo.api.UserService;
import org.apache.dubbo.config.annotation.DubboService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@DubboService(protocol = {"dubbo", "rest"})
@RestController
public class UserServiceImpl implements UserService {

    @Override
    @GetMapping("/getUser")
    public String getUser(@RequestParam String userId) {
        return "User: " + userId;
    }
}
2.3 创建多协议配置

在 dubbo-provider/src/main/java/com/example/dubbo/provider/config 目录下创建 DubboProviderConfig 类。

package com.example.dubbo.provider.config;

import org.apache.dubbo.config.ProtocolConfig;
import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableDubbo(scanBasePackages = "com.example.dubbo.provider.service")
public class DubboProviderConfig {

    @Bean
    public ProtocolConfig dubboProtocolConfig() {
        ProtocolConfig protocolConfig = new ProtocolConfig();
        protocolConfig.setName("dubbo");
        protocolConfig.setPort(20880);
        return protocolConfig;
    }

    @Bean
    public ProtocolConfig restProtocolConfig() {
        ProtocolConfig protocolConfig = new ProtocolConfig();
        protocolConfig.setName("rest");
        protocolConfig.setPort(8080);
        return protocolConfig;
    }
}
2.4 创建启动类

在 dubbo-provider/src/main/java/com/example/dubbo/provider 目录下创建 DubboProviderApplication 类：

package com.example.dubbo.provider;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DubboProviderApplication {
    public static void main(String[] args) {
        SpringApplication.run(DubboProviderApplication.class, args);
    }
}
2.5 配置文件

在 dubbo-provider/src/main/resources 目录下创建 application.yml 配置文件：

spring:
  application:
    name: dubbo-provider
  main:
    web-application-type: none

dubbo:
  application:
    name: dubbo-provider
  registry:
    address: zookeeper://localhost:2181
  protocol:
    dubbo:
      name: dubbo
      port: 20880
    rest:
      name: rest
      port: 8080
  scan:
    base-packages: com.example.dubbo.provider.service

logging:
  level:
    com.example.dubbo: INFO
  file:
    name: logs/dubbo-provider.log

3. 创建服务消费者模块（dubbo-consumer）

服务消费者模块 dubbo-consumer 调用服务提供者提供的服务。

3.1 创建 pom.xml

在 dubbo-consumer 模块中创建 pom.xml 文件：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.w3.org/POM/4.0.0 http://www.w3.org/2001/04/xmldsig-more#">

    <parent>
        <groupId>com.example</groupId>
        <artifactId>dubbo-demo</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <artifactId>dubbo-consumer</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>dubbo-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
            <version>2.7.8</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
    </dependencies>
</project>
3.2 创建控制器

在 dubbo-consumer/src/main/java/com/example/dubbo/consumer/controller 目录下创建 UserController 类：

package com.example.dubbo.consumer.controller;

import com.example.dubbo.api.UserService;
import org.apache.dubbo.config.annotation.DubboReference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {
    private static final Logger logger = LoggerFactory.getLogger(UserController.class);

    @DubboReference(protocol = "dubbo")
    private UserService userService;

    @GetMapping("/getUser")
    public String getUser(@RequestParam String userId) {
        logger.info("Fetching user with ID: {}", userId);
        return userService.getUser(userId);
    }
}
3.3 创建多协议配置

在 dubbo-consumer/src/main/java/com/example/dubbo/consumer/config 目录下创建 DubboConsumerConfig 类。

package com.example.dubbo.consumer.config;

import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableDubbo(scanBasePackages = "com.example.dubbo.consumer.controller")
public class DubboConsumerConfig {
}
3.4 创建启动类

在 dubbo-consumer/src/main/java/com/example/dubbo/consumer 目录下创建 DubboConsumerApplication 类：

package com.example.dubbo.consumer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DubboConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(DubboConsumerApplication.class, args);
    }
}
3.5 配置文件

在 dubbo-consumer/src/main/resources 目录下创建 application.yml 配置文件：

spring:
  application:
    name: dubbo-consumer

dubbo:
  application:
    name: dubbo-consumer
  registry:
    address: zookeeper://localhost:2181
  protocol:
    name: dubbo
  scan:
    base-packages: com.example.dubbo.consumer.controller

logging:
  level:
    com.example.dubbo: INFO
  file:
    name: logs/dubbo-consumer.log

4. 根项目的 pom.xml

在根项目 dubbo-demo 中创建 pom.xml 文件，定义模块和依赖管理：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.w3.org/2001/04/xmldsig-more#">

    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>dubbo-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>dubbo-api</module>
        <module>dubbo-provider</module>
        <module>dubbo-consumer</module>
    </modules>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo</artifactId>
                <version>2.7.8</version>
            </dependency>
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo-spring-boot-starter</artifactId>
                <version>2.7.8</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.1</version>
                    <configuration>
                        <source>1.8</source>
                        <target>1.8</target>
                    </configuration>
                </plugin>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>2.3.4.RELEASE</version>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

5. 启动Zookeeper

确保Zookeeper在本地运行，默认端口为 2181。可以通过下载Zookeeper并运行以下命令启动Zookeeper：

bin/zkServer.sh start

6. 启动服务提供者和消费者

  1. 启动服务提供者：运行 DubboProviderApplication 类。
  2. 启动服务消费者：运行 DubboConsumerApplication 类。

7. 测试多协议服务

7.1 测试Dubbo协议

使用Dubbo协议调用服务：

curl http://localhost:8080/getUser?userId=12345
7.2 测试HTTP协议

使用HTTP协议调用服务：

curl http://localhost:8080/getUser?userId=12345

8. 总结

通过以上步骤，我们设计并实现了一个支持多协议的Dubbo服务，包含服务接口设计、协议配置、服务注册与发现、客户端和服务端实现、配置管理等功能。这样可以确保服务能够被不同协议的客户端调用，并在不同协议下实现服务端。

评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

辞暮尔尔-烟火年年

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值