spring-cloud-starter-dubbo

Spring Cloud Alibaba 下额外支持的 RPC 方案：Dubbo。

构建服务接口

创建一个简单的 Java 项目，并在下面定义一个抽象接口，比如：

public interface HelloService {

    String hello(String name);

}

构建服务接口提供方

第一步：创建一个 Spring Boot 项目，在pom.xml中引入第一步中构建的 API 包以及 Spring Cloud Alibaba 对 Nacos 和 Dubbo 的依赖，比如：

<dependencies>
    <!-- 第一步中构建的API包 -->
    <dependency>
        <groupId>com.didispace</groupId>
        <artifactId>alibaba-dubbo-api</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <!--<groupId>com.alibaba.cloud</groupId>-->
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-dubbo</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
</dependencies>

这里需要注意两点：

1. 必须包含spring-boot-starter-actuator包，不然启动会报错。

2. spring-cloud-starter-dubbo 包需要注意 groupId 根据具体使用的 spring cloud alibaba 版本依赖来确定。

   • 项目孵化期间，使用的groupId为：org.springframework.cloud；
   • 项目孵化之后，使用的groupId修改为了com.alibaba.cloud，所以用户需要注意是否使用正确。避免加载不到对应 JAR 包的问题。

第二步：实现 Dubbo 接口

@Service
public class HelloServiceImpl implements HelloService {

    @Override
    public String hello(String name) {
        return "hello " + name;
    }

}

注意：这里的@Service注解不是 Spring 的，而是org.apache.dubbo.config.annotation.Service注解。

第三步：配置 Dubbo 服务相关的信息，比如：

spring.application.name=alibaba-dubbo-server
server.port=8001

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

# 指定 Dubbo 服务实现类的扫描基准包
dubbo.scan.base-packages=com.didispace.alibaba.dubbo.server
dubbo.protocol.name=dubbo
dubbo.protocol.port=-1
dubbo.registry.address=spring-cloud://localhost

配置说明如下：

• dubbo.scan.base-packages: 指定 Dubbo 服务实现类的扫描基准包
• dubbo.protocol: Dubbo 服务暴露的协议配置，其中子属性 name 为协议名称，port 为协议端口（ -1 表示自增端口，从 20880 开始）
• dubbo.registry: Dubbo 服务注册中心配置，其中子属性 address 的值 “spring-cloud://localhost”，说明挂载到 Spring Cloud 注册中心

注意：如果使用 Spring Boot 2.1 及更高版本时候，需要增加配置spring.main.allow-bean-definition-overriding=true

第四步：创建应用主类，比如：

@EnableDiscoveryClient
@SpringBootApplication
public class DubboServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(DubboServerApplication.class, args);
    }

}

构建服务接口消费方

第一步：创建一个 Spring Boot 项目，在pom.xml中引入第一步中构建的 API 包以及 Spring Cloud Alibaba 对 Nacos 和 Dubbo 的依赖，具体内容与服务提供方一致：

<dependencies>
    <!-- 第一步中构建的API包 -->
    <dependency>
        <groupId>com.didispace</groupId>
        <artifactId>alibaba-dubbo-api</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <!--<groupId>com.alibaba.cloud</groupId>-->
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-dubbo</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>

    //...
</dependencies>

第二步：配置 Dubbo 服务相关的信息，比如：

spring.application.name=alibaba-dubbo-client
server.port=8002

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

dubbo.protocol.name=dubbo
dubbo.protocol.port=-1
dubbo.registry.address=spring-cloud://localhost
dubbo.cloud.subscribed-services=alibaba-dubbo-server

注意：

1. 这里多增加了dubbo.cloud.subscribed-services参数，表示要订阅服务的服务名，这里配置的alibaba-dubbo-server对应的就是上一节服务提供方的spring.application.name的值，也就是服务提供方的应用名。
2. 如果使用 Spring Boot 2.1 及更高版本时候，需要增加配置spring.main.allow-bean-definition-overriding=true。

第三步：创建应用主类，并实现一个接口，在这个接口中调用 Dubbo 服务，比如：

@EnableDiscoveryClient
@SpringBootApplication
public class DubboClientApplication {

    public static void main(String[] args) {
        SpringApplication.run(DubboClientApplication.class, args);
    }

    @Slf4j
    @RestController
    static class TestController {

        @Reference
        HelloService helloService;

        @GetMapping("/test")
        public String test() {
            return helloService.hello("didispace.com");
        }
    }

}

注意：这里的@Reference注解是org.apache.dubbo.config.annotation.Reference

测试验证

完成了上面的所有开发之后，我们可以将 Nacos、服务提供者、服务消费者依次启动起来。在完成启动之后，我们可以在 Nacos 控制台的服务列表中看到上面定义的两个服务，比如：

接下来，我们就可以通过调用服务消费者中定义的/test接口来触发 dubbo 服务的消费了。如果一切顺畅，应该可以得到如下结果：

$ curl localhost:8002/test
hello didispace.com

小结

通过上面的例子，如果你曾经同时玩过 Spring Cloud 和 Dubbo，一定会深有感触。你不用再同时顾虑 Eureka 和 Zookeeper 的配置，也不同同时关注这两个中间件的健康，只需要关注和维护好 Nacos 一个即可。而对于 Dubbo 的配置和使用来说，配置还是相当简单的，而代码编写上与以往的 Dubbo 没什么大的不同。在 Spring Cloud Alibaba 的整合之下，Dubbo 用户既可以享受到原本 RPC 带来性能优势，又可以更好的享受 Spring Cloud 的各种福利；而对于 Spring Cloud 用户来说，在服务治理层面，又对了一个不错的可选项。可以说这块的整合是真正的让这两大用户群体得到了很好的融合，起到了互相成就的作用。

参考资料：官方文档 (opens new window)

代码示例

本文介绍内容的客户端代码，示例读者可以通过查看下面仓库中的alibaba-dubbo-api、alibaba-dubbo-server、alibaba-dubbo-client项目：

• Github：https://github.com/dyc87112/SpringCloud-Learning/ (opens new window)
• Gitee：https://gitee.com/didispace/SpringCloud-Learning/ (opens new window)