SpringBoot 整合 Dubbo 3 案例

发表于 2024-11-03 更新于 2025-02-27 阅读次数：评论数：本文字数： 2.1k 阅读时长 ≈ 2 分钟

大纲

前言

Dubbo 是阿里巴巴开源的产品，采用二进制通信，相比 OpenFeign 的 HTTP 通信，具有性能优势，而且可以轻松集成到 SpringBoot 和 Spring Cloud 中使用，对于性能要求比较高的场景，使用比较广泛。

学习资源

版本对应关系

SpringBoot 与 Dubbo 的版本必须互相匹配，否则不同版本之间可能会存在兼容性问题，最终导致服务无法正常运行。两者的版本对应关系如下：

Dubbo 分支	最新版本	JDK	SpringBoot	详细说明
3.3.x	3.3.2	8, 17, 21	2.x、3.x	生产可用（推荐，长期维护）！最新 Triple 协议升级，内置 Metrics、Tracing、GraalVM 支持等
3.2.x	3.2.10	8, 17	2.x、3.x	生产可用（长期维护）！
3.1.x	3.1.11	8, 17	2.x、3.x	仅修复安全漏洞！
3.0.x	3.0.15	8	2.x	停止维护！
2.7.x	2.7.23	8	2.x	停止维护！
2.6.x	2.6.20	6, 7	-	停止维护！
2.5.x	2.5.10	6, 7	-	停止维护！

如果仍然使用版本低于 2.7.0 的旧版 Dubbo，请使用以下 Spring Boot 启动器：

Dubbo Spring Boot Starter	Dubbo	Spring Boot
0.2.1.RELEASE	2.6.5+	2.x
0.1.2.RELEASE	2.6.5+	1.x

官方文档

Dubbo 整合案例

本节目将整合 SpringBoot 与 Dubbo，并使用 Nacos 作为 Dubbo 的注册中心。值得一提的是，本教程的内容也适用于 Spring Cloud 项目。

版本说明

组件	版本	说明
SpringBoot	`3.4.2`
Dubbo Spring Boot Starter	`3.3.2`	依赖 Dubbo `3.3.2`
Nacos Server	`2.5.0`	Nacos 服务器，作为服务注册中心
JDK	`17`	支持 JDK `17` 及以上版本

模块说明

api：抽取出来的公共模块，存放公用的实体类和接口
provider：服务提供者，实现 api 模块中的接口
customer：服务消费者，调用服务提供者中的接口

案例代码

API 模块

为了简化代码，API 模块只简单定义一个接口

public interface DemoService {

    String sayHello(String name);

}

Provider 模块

引入依赖

<properties>
    <spring-boot.version>3.4.2</spring-boot.version>
    <dubbo-springboot.version>3.3.2</dubbo-springboot.version>
    <dubbo-nacos.version>3.3.2</dubbo-nacos.version>
</properties>

<dependencyManagement>
    <dependencies>
        <!-- SpringBoot -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${spring-boot.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>com.clay.dubbo</groupId>
        <artifactId>dubbo-lesson-01-api</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.apache.dubbo</groupId>
        <artifactId>dubbo-spring-boot-starter</artifactId>
        <version>${dubbo-springboot.version}</version>
    </dependency>
    <dependency>
        <groupId>org.apache.dubbo</groupId>
        <artifactId>dubbo-registry-nacos</artifactId>
        <version>${dubbo-nacos.version}</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

接口实现类，@DubboService 注解主要用于暴露服务，使其能够被 Dubbo 框架识别并注册到服务注册中心

import org.apache.dubbo.config.annotation.DubboService;

@DubboService
public class DemoServiceImpl implements DemoService {

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

}

主启动类

@SpringBootApplication
public class ProviderApplication {

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

}

配置文件（application.yml）

server:
  port: 9090

spring:
  application:
    name: dubbo-provider-application

dubbo:
  # 服务信息
  application:
    name: ${spring.application.name}
  # 注册中心地址
  registry:
    address: nacos://127.0.0.1:8848
  # 服务提供者的协议
  protocol:
    name: dubbo
    port: 20880
  # 扫描 Dubbo 相关的注解
  scan:
    base-packages: com.clay.dubbo.provider

提示

若不希望在 YML 配置文件中指定 dubbo.scan.base-packages 参数，那么可以在主启动类上标注 @EnableDubbo(scanBasePackages = "xxx") 注解或者 @DubboComponentScan(basePackages = "xxx") 注解来替代。

Consumer 模块

引入依赖

<properties>
    <spring-boot.version>3.4.2</spring-boot.version>
    <dubbo-springboot.version>3.3.2</dubbo-springboot.version>
    <dubbo-nacos.version>3.3.2</dubbo-nacos.version>
</properties>

<dependencyManagement>
    <dependencies>
        <!-- SpringBoot -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${spring-boot.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>com.clay.dubbo</groupId>
        <artifactId>dubbo-lesson-01-api</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.apache.dubbo</groupId>
        <artifactId>dubbo-spring-boot-starter</artifactId>
        <version>${dubbo-springboot.version}</version>
    </dependency>
    <dependency>
        <groupId>org.apache.dubbo</groupId>
        <artifactId>dubbo-registry-nacos</artifactId>
        <version>${dubbo-nacos.version}</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

业务测试类，@DubboReference 注解主要用于在服务消费者端引用远程服务提供者的服务

import org.apache.dubbo.config.annotation.DubboReference;

@Slf4j
@RestController
public class DemoController {

    /**
     * 引用 Dubbo 服务
     * <p> 可以指定版本、负载均衡算法、重试次数、超时毫秒等。
     * <p> 负载均衡默认为 random，还可以配置为：roundrobin 、leastactive 、consistenthash
     * <p> 超时毫秒数 timeout 可以统一在 application.yml 进行配置，也可以在具体服务上做个性化配置
     * <p> 重试次数 retries 可以统一在 application.yml 进行配置，也可以在具体服务上做个性化配置，但是对于增删改等非幂等操作，建议不要重试
     */
    @DubboReference(loadbalance = "random")
    private DemoService demoService;

    @GetMapping("/sayHello/{name}")
    public String sayHello(@PathVariable("name") String name) {
        String result = demoService.sayHello(name);
        log.info("===> " + result);
        return result;
    }

}

主启动类

@SpringBootApplication
public class ConsumerApplication {

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

}

配置文件（application.yml）

server:
  port: 9095

spring:
  application:
    name: dubbo-consumer-application

dubbo:
  # 服务信息
  application:
    name: ${spring.application.name}
  # 注册中心地址
  registry:
    address: nacos://127.0.0.1:8848
  # 扫描 Dubbo 相关的注解
  scan:
    base-packages: com.clay.dubbo.consumer
  # 消费行为配置
  consumer:
    # 关闭了启动检查，这样消费者启动时，不会到注册中心里面检查服务提供者是否存在
    check: false
    # 建议统一配置为不重试请求，对于查询等幂等操作来说可以在代码中单独配置重试次数
    retries: 0
    # 默认情况下限制请求必须在 1000 毫秒内完成，对于具体服务可以在代码中单独配置
    timeout: 1000

提示

测试代码

(1) 在 IDEA 开发工具内，分别启动 Provider 和 Consumer 模块。
(2) 使用 Postman 等工具访问 http://localhost:9095/sayHello/dubbo 接口，若接口可以返回 Hello dubbo 结果，则说明 SpringBoot 整合 Dubbo 成功。

下载代码

完整的案例代码可以直接从 GitHub 下载对应章节 dubbo-lesson-01。

使用 ZooKeeper 注册中心

若希望在 SpringBoot 整合 Dubbo 时，使用 ZooKeeper 作为注册中心，那么在上述案例的基础上，按照以下步骤进行更改即可。

(1) 在 Provider 和 Consumer 模块中，移除 Nacos 的依赖，并添加 ZooKeeper 与 Curator 的依赖，其中 Curator 用于连接 ZooKeeper 注册中心（版本为 3.9.3）

<properties>
    <spring-boot.version>3.4.2</spring-boot.version>
    <dubbo-springboot.version>3.3.2</dubbo-springboot.version>
    <curator.version>5.7.1</curator.version>
</properties>

<dependencyManagement>
    <dependencies>
        <!-- SpringBoot -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${spring-boot.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.apache.dubbo</groupId>
        <artifactId>dubbo-spring-boot-starter</artifactId>
        <version>${dubbo-springboot.version}</version>
    </dependency>
    <dependency>
        <groupId>org.apache.curator</groupId>
        <artifactId>curator-recipes</artifactId>
        <version>${curator.version}</version>
    </dependency>
    <dependency>
        <groupId>org.apache.curator</groupId>
        <artifactId>curator-x-discovery-server</artifactId>
        <version>${curator.version}</version>
    </dependency>
</dependencies>

(2) 在 Provider 和 Consumer 模块中，指定 ZooKeeper 注册中心的地址

dubbo:
  # 注册中心地址
  registry:
    address: zookeeper://127.0.0.1:2181

特别注意

如果使用 ZooKeeper 作为注册中心，那么在 Maven 的配置文件中，Curator 的版本必须与 ZooKeeper 服务器的版本相匹配，否则会导致兼容问题的出现。

参考资料

SpringBoot 集成和使用 Dubbo，基于 Nacos 注册中心