Spring Boot 整合 Apache Dubbo的示例代码

时间：2021-07-04

阅读：

Apache Dubbo是一款高性能、轻量级的开源 Java RPC 框架，它提供了三大核心能力：面向接口的远程方法调用，智能容错和负载均衡，以及服务自动注册和发现。

注意，是 Apache Dubbo，不再是 Alibaba Dubbo。简单来说就是 Alibaba 将 Dubbo 移交给 Apache 开源社区进行维护。参见 dubbo-spring-boot-project

Spring Boot 系列：整合 Alibaba Dubbo

一、本文示例说明

1.1 框架版本Dubbo 版本

<dependency>
    <groupId>org.apache.dubbo</groupId>
    <artifactId>dubbo-spring-boot-starter</artifactId>
    <version>2.7.5</version>
</dependency>

Spring Boot 版本

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.1.RELEASE</version>
    <relativePath/>
</parent>

1.2 模块关系

根工程 order：管理工程信息；子工程 order-api：定义RPC服务的接口、参数以及响应结果的结果集；子工程 order-provider：RPC服务的提供端；子工程 order-consumer：RPC服务的消费端，实际开发过程中实际情况是其它服务的调用该订单RPC服务

二、根工程

2.1 创建项目 order

我这里为了和之前老版本的alibaba的dubbo项目区分，文件名取为apache-dubbo-demo，maven 项目名称为order。

该项目主要作用是定义工程信息、管理整个项目依赖版本等等，所以src目录不需要。

2.2 pom.xml

根工程中使用了<dependencyManagement>和<dependencies>进行依赖管理。

<dependencyManagement>：声明全局依赖，当子项目指定引用才会继承依赖；<dependencies>：声明全局依赖，子项目直接自动继承依赖。

<?xml version="1.0" encoding="UTF-8"?>
<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://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <!-- 父级引用 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.1.RELEASE</version>
        <relativePath/>
    </parent>

    <!-- 基本信息 -->
    <groupId>cn.van.order</groupId>
    <artifactId>order</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <name>${project.artifactId}</name>
    <description>Apache Dubbo 根项目</description>

    <!--配置-->
    <properties>
        <java.version>1.8</java.version>
        <dubbo.version>2.7.5</dubbo.version>
        <zookeeper.version>3.4.14</zookeeper.version>
    </properties>

    <!-- 子项目 -->
    <modules>
        <module>order-api</module>
        <module>order-provider</module>
        <module>order-consumer</module>
    </modules>

    <!--声明全局依赖（子项目需要显示的引用才会继承依赖）-->
    <dependencyManagement>
        <dependencies>
            <!-- dubbo-start依赖 -->
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo-spring-boot-starter</artifactId>
                <version>${dubbo.version}</version>
            </dependency>
            <!--zookeeper 注册中心客户端引入 使用的是curator客户端 -->
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo-dependencies-zookeeper</artifactId>
                <version>${dubbo.version}</version>
                <type>pom</type>
                <exclusions>
                    <exclusion>
                        <artifactId>slf4j-log4j12</artifactId>
                        <groupId>org.slf4j</groupId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <!--声明全局依赖（子项目不需要显示的引用，自动继承依赖）-->
    <dependencies>
        <!-- spring boot 依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <!-- 打包插件 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

三、order-api

3.1 项目依赖

无需更多依赖，所以很简单。

<?xml version="1.0" encoding="UTF-8"?>
<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://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>cn.van.order</groupId>
        <artifactId>order</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <groupId>cn.van.order</groupId>
    <artifactId>order-api</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <name>${project.artifactId}</name>
    <description>dubbo公共项目</description>


    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

3.2 封装 RPC 结果集先封装一个返回码枚举类ResultCodeEnum.java

public enum ResultCodeEnum {
    /*** 通用部分 100 - 599***/
    // 成功请求
    SUCCESS(200, "successful"),
    
    /*** 这里可以根据不同模块用不同的区级分开错误码，例如:  ***/

    // 1000～1999 区间表示用户模块错误
    // 2000～2999 区间表示订单模块错误
    // 3000～3999 区间表示商品模块错误
    // 。。。

    ORDER_NOT_FOUND(2000, "order not found"),
    ;
    /**
     * 响应状态码
     */
    private Integer code;
    /**
     * 响应信息
     */
    private String message;

    ResultCodeEnum(Integer code, String msg) {
        this.code = code;
        this.message = msg;
    }

    public Integer getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

先封装一个RPC 响应结果集RpcResult.java

public class RpcResult <T> implements Serializable {

    /**
     * 是否响应成功
     */
    private Boolean success;
    /**
     * 响应状态码
     */
    private Integer code;
    /**
     * 响应数据
     */
    private T data;
    /**
     * 错误信息
     */
    private String message;

    // 构造器开始
    /**
     * 无参构造器(构造器私有，外部不可以直接创建)
     */
    private RpcResult() {
        this.code = 200;
        this.success = true;
    }
    /**
     * 有参构造器
     * @param obj
     */
    private RpcResult(T obj) {
        this.code = 200;
        this.data = obj;
        this.success = true;
    }

    /**
     * 有参构造器
     * @param resultCode
     */
    private RpcResult(ResultCodeEnum resultCode) {
        this.success = false;
        this.code = resultCode.getCode();
        this.message = resultCode.getMessage();
    }
    // 构造器结束

    /**
     * 通用返回成功（没有返回结果）
     * @param <T>
     * @return
     */
    public static<T> RpcResult<T> success(){
        return new RpcResult();
    }

    /**
     * 返回成功（有返回结果）
     * @param data
     * @param <T>
     * @return
     */
    public static<T> RpcResult<T> success(T data){
        return new RpcResult<T>(data);
    }

    /**
     * 通用返回失败
     * @param resultCode
     * @param <T>
     * @return
     */
    public static<T> RpcResult<T> failure(ResultCodeEnum resultCode){
        return  new RpcResult<T>(resultCode);
    }

    public Boolean getSuccess() {
        return success;
    }

    public void setSuccess(Boolean success) {
        this.success = success;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    @Override
    public String toString() {
        return "RpcResult{" +
                "success=" + success +
                ", code=" + code +
                ", data=" + data +
                ", message='" + message + '\'' +
                '}';
    }
}

3.3 编写一个 RPC 接口

public interface OrderDubboService {
    RpcResult<OrderDomain> getOrder();
}

实体OrderDomain.java挺简单的，详见 Github 仓库。

四、order-provider

此子项目是一个服务类项目，也就是将接口服务注册到zookeeper注册中心供消费端调取使用。

4.1 项目依赖

<?xml version="1.0" encoding="UTF-8"?>
<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://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>cn.van.order</groupId>
        <artifactId>order</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <groupId>cn.van.order</groupId>
    <artifactId>order-provider</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>${project.artifactId}</name>
    <description>Dubbo 服务提供者</description>

    <dependencies>
        <dependency>
            <groupId>cn.van.order</groupId>
            <artifactId>order-api</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
        </dependency>
        <!-- zookeeper依赖 -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-dependencies-zookeeper</artifactId>
            <version>${dubbo.version}</version>
            <type>pom</type>
            <exclusions>
                <exclusion>
                    <artifactId>slf4j-log4j12</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

4.2 服务实现接口

@Service
public class OrderDubboServiceImpl implements OrderDubboService {
    
    @Override
    public RpcResult<OrderDomain> getOrder() {
        return RpcResult.success(new OrderDomain(1, 10086, LocalDateTime.now()));
    }
}

注意：
@Service 是 dubbo 包下面的注解不是 Spring 里面的注解。

4.3 项目配置

dubbo 的配置直接用 dubbo，不再以 Spring 开头; base-packages：指定接口实现所在路径。

server:
  # 服务端口
  port: 7777
spring:
  application:
    name: order-provider
# dubbo 相关配置(dubbo 的配置不再以 Spring 开头)
dubbo:
  application:
    # 应用名称
    name: order-provider
  scan:
    # 接口实现者（服务实现）包
    base-packages: cn.van.order.service.impl
  # 注册中心信息
  registry:
    address: zookeeper://127.0.0.1:2181
  protocol:
    # 协议名称
    name: dubbo
    # 协议端口
    port: 20880

五、order-consumer

此子项目就是一个消费项目，比如商品模块、财务模块等等。

5.1 项目依赖

<?xml version="1.0" encoding="UTF-8"?>
<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://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>cn.van.order</groupId>
        <artifactId>order</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <groupId>cn.van.order</groupId>
    <artifactId>order-consumer</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>${project.artifactId}</name>
    <description>Dubbo 消费者</description>


    <dependencies>
        <dependency>
            <groupId>cn.van.order</groupId>
            <artifactId>order-api</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>

        <!-- web项目依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- dubbo依赖 -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
        </dependency>

        <!-- dubbo的zookeeper依赖 -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-dependencies-zookeeper</artifactId>
            <version>${dubbo.version}</version>
            <type>pom</type>
            <exclusions>
                <exclusion>
                    <artifactId>slf4j-log4j12</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

5.2 测试接口

模拟一个接口获取订单详情。

@RestController
@RequestMapping("/order")
public class OrderConsumerController {
    @Reference
    OrderDubboService orderDubboService;

    @GetMapping("getOrder")
    public RpcResult getOrder() {
        return orderDubboService.getOrder();
    }
}

注意：@Reference引入的是 Dubbo 接口，所以是 Dubbo 的注解。

5.3 配置文件

server:
  port: 7000
spring:
  application:
    name: order-consumer
# dubbo 相关配置
dubbo:
  application:
    name: order-consumer
  registry:
    address: zookeeper://127.0.0.1:2181

六、测试

一切就绪，如果在order-consumer 的测试接口能成功请求到数据，则证明 Dubbo 服务搭建成功。

6.1 启动 zookeeper

我们选用zookeeper作为注册中心，因此启动项目之前需要先启动它。

6.2 dubbo-admin

dubbo-admin 便于观察 order-provider 是否成功将接口注册，具体安装步骤详见apache/dubbo-admin

默认端口：8080。

6.3 启动 dubbo-provider

成功启动后可以在dubbo-admin：已经成功将接口 OrderService 注册到 zookeeper 上如下：

成功将借口注册到注册中心，说明dubbo-provider 注册成功。

6.4 启动 order-cosumer

启动消费者项目，在浏览器请求消费接口：http://localhost:7000/order/getOrder，成功返回数据如下：

{
    "success":true,
    "code":200,
    "data":{
        "id":1,
        "orderNum":10086,
        "gmtCreate":"2020-05-06T11:59:45.535"
    },
    "message":null
}

成功请求到 order-provider 提供的数据，说明 Dubbo 搭建成功！

七、总结

以上的完整代码我已上传到 Github，需要的可以自取测试，欢迎star！

目录 mybatis resultType自带数据类型别名定义了一些常见类的别名整理成表格总结 mybatis resultType自带数据类型别名为了简化开发，mybatis 默认在 org.apache.ibat

2024-10-20 21:52:35

目录 1. 引言 2. 核心代码解析 2.1 POM依赖 2.2 SpringBoot启动类注解 2.3 核心代码总结 3. Spring 注解说明 3.1 @Retryable注解 3.2 @Backoff注解 4. 如何使用

2024-10-20 21:52:26

目录 Spring Boot API 中的速率限制步骤 1 - 定义速率限制配置步骤 2 - 创建速率限制方面步骤 3 — 定义 RateLimited 注释步骤 4 - 实施速率限制器步骤 5

2024-10-20 21:52:18

目录引言 1. 使用 Spring Boot 默认的 Logback 日志框架步骤： 2. 使用 Log4j2 日志框架步骤： 3. 在代码中使用日志 4.使用lombok.extern.slf4j.Slf4j 1.基本使用

2024-10-20 21:52:11

目录前言 1.方法一：反射获取线程池中的线程列表 2.方法二：使用Thread.getAllStackTraces() 3.方法三：使用ThreadPoolExecutor的getCompletedTaskCount()和getActiveCount()等

2024-10-20 21:52:03

目录一、使用 @Scheduled 注解二、使用 SchedulingConfigurer 接口三、使用 TaskScheduler 四、使用 Quartz 实现定时任务一、使用 @Scheduled 注解@Scheduled 是 Spring

2024-10-20 21:51:49

目录引言一、问题描述： 1.1 报错示例： 1.2 报错分析： 1.3 解决思路：二、解决方法： 2.1 方法一： 2.2 方法二： 2.3 方法三： 2.4 方法四：三、其他解决方法：四、总结：

2024-10-20 21:51:41

目录 SpringBoot项目启动报错：命令行太长解决 1. 第一种方法 1. 第二种方法 1-1 旧版本Idea 1-2 新版本Idea SpringBoot项目启动报错：命令行太长解决报错信息：1. 第

2024-10-20 21:51:32

目录前言一、Spring Boot 日志框架概述 1.1 Spring Boot 支持的日志框架 1.2 Spring Boot 默认日志配置二、日志框架冲突问题 2.1 问题描述 2.2 解决方案 2.3 检

2024-10-20 21:51:18

目录前言一、Maven 简介二、为什么需要手动添加 JAR 文件？三、Maven 本地仓库位置如何确认本地仓库位置？四、创建必要的目录结构创建目录结构的步骤：五、创建 PO

2024-10-20 21:51:10

目录什么是职责链模式？职责链模式在电商订单流程中的应用 POM 文件配置具体处理器实现控制器接口优化前端界面及 jQuery 调用 JSON 接口总结在电商系统中，订单的处理流

2024-10-18 23:26:01

目录 1.生成war包 1.1 更改pom包 1.2 编写类 1.3 将war包使用 tomcat 解压为文件夹 1.生成war包1.1 更改pom包打开一个springboot 项目，右击项目名从项目管理器打开在po

2024-10-18 23:25:45

数据库表中的字段创建时间 (createTime) 更新时间 (updateTime)每次增删改查的时候，需要通过对Entity的字段（createTime，updateTime）进行set设置，但是，每次增删改都要set设置比

2024-10-18 23:25:25

目录主键策略 1、AUTO(自动增长策略) 2、INPUT(插入前自行设置主键值) 3、ASSING_ID(雪花算法) 4、ASSING_UUID(不含中划线的UUID) 5、NONE(无状态) 雪花算法算

2024-10-18 23:25:12

目录第一个Hystrix程序步骤1：创建父工程hystrix-1 步骤2：改造服务提供者步骤3：改造服务消费者为Hystrix客户端（1）添加Hystrix依赖（2）添加@EnableHystrix注解（3）创

2024-10-18 23:24:58

目录 Config与Bus整合自动刷新步骤1：安装RabbitMQ并启动 RabbitMQ的安装步骤2：创建项目创建Eureka Server 创建config-server 步骤3：添加依赖修改配置文件步骤4：Co

2024-10-18 23:24:27

目录 1. 前言 2. 注册 2.1. 手机验证码注册流程 2.2. 代码实现（仅核心） 3. 登录 3.1. 手机验证码登录流程 3.2. 涉及到的Spring Security组件 3.3. 代码实现（仅核心）

2024-10-18 23:23:50

目录 Java中重写和重载的区别方法重载的规则方法重写的规则总结 Java中重写和重载的区别其实java中的重写和重载没有任何关系，只是因为都有个重字，有些小白就会对这两

2024-10-18 23:23:37

目录 1. 什么是 Spring Web MVC 1.1 MVC 定义 1.2 什么是 Spring MVC 2. 学习 Spring MVC 2.1 项目准备 2.2 建立连接 1. 什么是 Spring Web MVCSpring Web MVC 是基

2024-10-18 23:23:29

目录 springBoot跨域注解@CrossOrigin用法在controller控制类上方加注解 spring注解@CrossOrigin不起作用的原因总结 springBoot跨域注解@CrossOrigin用法Spring Fra

2024-10-18 23:23:14

目录 1. 找到自动生成的pom.xml文件 2.添加servlet依赖 3.别眨眼，你已经搞定了！ 4.就可以右键新建Servlet 总结 IDEA版本2021右键新建没有servlet?在pom.xml文件中需要导入ser

2024-10-14 19:56:52

目录问题解决步骤：找到File->Project Structure... 设置SDK 设置SDKs 问题刚刚在使用IDEA专业版创建好SpringBoot项目后，发现上方导航栏的运行按钮是灰色的，而且左侧导

2024-10-14 19:56:37

实现flex的分页查询需要去维护一个对应的获取数据库总数的方法，下面会对有无该方法进行一个比较实现文件主要以下几个类，注意UserMapper.xml的位置，默认是扫描resources下的map

2024-10-14 19:56:23

目录在编译项目的时候出现报错：解决办法： 1、无效的源发行版 2、IDEA 报错，java无效的目标发行版：22 无效的目标发行版总结在编译项目的时候出现报错：解决办法：1、无效

2024-10-14 19:56:09

目录 1、目的 2、实现 2-1、导入MyBatis-Flex和ShardingSphere-JDBC的相关依赖 2-2、配置初始化的数据库连接用来加载配置，当然用配置中心来保存初始化数据的配置 2-3、

2024-10-14 19:55:50

前端发送请求后，会请求DeptController的方法list()。package com.intelligent_learning_aid_system.controller;import com.intelligent_learning_aid_system.pojo.Dept;impo

2024-10-14 19:55:31

Java 函数式编程中 try-catch 块的替代方案在 Java 函数式编程中，传统意义上的 try-catch 块并不是必不可少的。函数式编程强调代码的不可变性和纯净性，这意味着我们不希望函

2024-09-17 21:25:34

Java 函数参数可以定义多个类型吗？在 Java 中，函数的参数可以定义多个类型，这称为方法重载。通过方法重载，可以创建具有相同名称但接受不同参数类型的多个函数版本。语法<return

2024-09-17 21:23:26

如何在 Java 中使用 lambda 表达式实现接口方法Java 8 引入了 lambda 表达式，它提供了简洁且方便的方法来实现接口方法。lambda 表达式是一种匿名函数，它可以用来替换实现接口

2024-09-17 21:22:43

在 java 中，函数的返回值类型指定函数返回的值的类型，位于函数签名中函数名之前。例如，getgreeting 函数返回一个字符串 string getgreeting() { return "hello!"; }。返回值类

2024-09-10 22:37:27

2021-02-06

2020-09-18

2020-12-12

2020-05-05

2020-11-20

2021-01-09

2020-09-25

2021-02-06

2021-03-07

2020-09-27

Spring Boot 整合 Apache Dubbo的示例代码

一、本文示例说明

二、根工程

三、order-api

四、order-provider

五、order-consumer

六、测试

七、总结

热点内容

免费资源网

在线工具

扫一扫随时看

本站下载频道