使用 Apache Dubbo 实现远程通信(微服务架构)

前言

参考资料：
《spring microservices in action》
《spring cloud alibaba 微服务原理与实战》
《b站尚硅谷 springcloud 框架开发教程周阳》

apache dubbo 是一个分布式服务框架，主要实现多个系统之间的高性能、透明化调用；
dubbo 相关内容笔者之前写过一篇入门笔记：dubbo快速上手笔记 – 环境与配置。入门笔记强调的是 dubbo 的一些基本特性，以与 zookeeper 的整合。因此这里将重点放在 dubbo 与 spring cloud 的联系、区别以及整合；

1. dubbo 基础知识

1.1 dubbo 是什么

apache dubbo 是一个分布式服务框架，主要实现多个系统之间的高性能、透明化调用；
简单来说它就是一个 rpc 框架，但是和普通的 rpc 框架不同的是，它提供了服务治理功能，比如服务注册、监控、路由、容错等；

1.2 dubbo 的架构图

1.3 spring cloud 与 dubbo 的区别

参考：https://segmentfault.com/a/1190000038320266

比较项	dubbo	spring cloud
通信协议	基于 tcp 协议传输，使用 netty 配合以hession序列化完成rpc通信	基于 http 协议 + rest 接口调用远程过程的通信
服务调用方式	rpc	rest api
定位	soa 时代的产物	微服务架构时代
关注点	服务的重用性及解决信息孤岛问题；服务治理	解耦，降低业务之间的耦合度；微服务治理整套方案
模块	服务注册中心、服务提供者、服务消费者、管控中心	分布式一站式框架

http 请求会有更大的报文，占的带宽也会更多。但是 rest 相比 rpc 更为灵活，服务提供方和调用方的依赖只依靠一纸契约，不存在代码级别的强依赖，这在强调快速演化的微服务环境下，显得更为合适；
模块组件的具体比较如下：

组件	dubbo	spring cloud (netflix)
注册中心	以前是 zookeeper，现在推广 nacos	spring cloud eureka
服务监控	dubbo-monitor	spring boot admin
熔断器	6种容错模式	spring cloud hystrix
负载均衡	4 种负载均衡策略	spring cloud ribbon
服务降级	mock 机制	hystrix 的 @hystrixcommand 注解
网关	无	spring cloud zuul
配置	无	spring cloud config
服务跟踪	无	spring cloud sleuth
数据流	无	spring cloud stream
批量任务	无	spring cloud task
消息总线	无	spring cloud bus

1.4 dubbo 的特点

支持多种协议的服务发布，默认是 dubbo://，还可以支持 rest://、webservice://、thrift:// 等；
支持多种不同的注册中心，如：nacos、zookeeper、redis，未来还将会支持 consul、eureka、etcd 等；
支持多种序列化技术，如：avro、fst、fastjson、hessian2、kryo 等；
在服务治理方面的功能非常完善，如：集群容错、服务路由、负载均衡、服务降级、服务限流、服务监控、安全验证等；
中文文档；

1.5 dubbo 的 6 种容错模式容错模式

容错模式	模式名称	说明	适用场景
failover cluster	【默认】失败自动切换	当服务调用失败后，会切换到集群中的其他机器进行重试，默认重试次数为2，通过属性 retries=2 可以修改次数	通常用于读操作（查），因为事务型操作会带来数据重复问题
failfast cluster	快速失败	当服务调用失败后，立即报错，也就是只发起一次调用	通常用于一些幂等的写操作（增删改），比如新增数据；以避免在结果不确定的情况下导致数据重复插入的问题
failsafe cluster	失败安全	出现异常时，直接忽略异常	使用 failover cluster(retries=”0″)，应对（增删改）操作
failback cluster	失败后自动回复	服务调用出现异常时，在后台记录这条失败的请求定时重发	适合用于消息通知操作，保证这个请求一定发送成功
forking cluster	并行提交	并行调用集群中的多个服务，只要其中一个成功就返回。可以通过forks=2来设置最大并行数
broadcast cluster	广播通知	广播调用所有的服务提供者，任意一个服务报错则表示服务调用失败	通常用于通知所有的服务提供者更新缓存或者本地资源信息

可以自行扩展容错模式；
配置也很简单，在 @service 接口里添加一个 cluster 参数即可；

@service(cluster = "failfast") //更改容错方式为快速失败
public class testserviceimpl implements testservice {
	@override
	public string test() {
	    ...
	}
}

1.6 dubbo 的 4 种负载均衡策略

负载均衡策略	策略名称	说明
random loadbalance	随机算法	可以针对性能较好的服务器设置较大的权重值，权重值越大，随机的概率也会越大
roundrobin loadbalance	轮询	按照公约后的权重设置轮询比例
leastactive loadbalance	最少活跃调用	处理较慢的节点将会收到更少的请求
consistenthash loadbalance	一致性hash	相同参数的请求总是发送到同一个服务提供者

可以基于 dubbo 中的 spi 机制来扩展负载均衡策略；
配置也很简单，在 @service 接口里添加一个 loadbalance 参数即可；

@service(loadbalance = "roundrobin") //更改负载均衡策略为轮询
public class testserviceimpl implements testservice {
	@override
	public string test() {
	    ...
	}
}

1.7 主机绑定规则

主机绑定表示的是 dubbo 服务对外发布的 ip 地址，默认情况下 dubbo 会按照以下顺序来查找并绑定主机 ip 地址：
- 查找环境变量中 dubbo_ip_to_bind 属性配置的 ip 地址；
- 查找 dubbo.protocol.host 属性配置的 ip 地址，默认是空，如果没有配置或者ip地址不合法，则继续往下查找；
- 通过 localhost.gethostaddress 获取本机 ip 地址，如果获取失败，则继续往下查找；
- 如果配置了注册中心的地址，则使用 socket 通信连接到注册中心的地址后，使用 for 循环通过 socket.getlocaladdress().gethostaddress() 扫描各个网卡获取网卡 ip 地址；
获取的 ip 地址并不是写入注册中心的地址。默认情况下，写入注册中心的 ip 地址优先选择环境变量中 dubbo_ip_to_registry 属性配置的 ip 地址。在这个属性没有配置的情况下，才会选取前面获得的 ip 地址并写入注册中心；
问题：使用默认的主机绑定规则，可能会存在获取的 p 地址不正确的情况；
- 原因：dubbo 检测本地 ip 地址的策略是先调用 localhost.gethostaddress，这个方法的原理是通过获取本机的 hostname 映射 ip 地址，如果它指向的是一个错误的 ip 地址，那么这个错误的地址将会作为服务发布的地址注册到 zookeeper 节点上；
- 解决方案：
  - 在 /etc/hosts 中配置机器名对应正确的 ip 地址映射；
  - 在环境变量中添加 dubbo_ip_to_bind 或者 dubbo_ip_to_registry 属性，value 值为绑定的主机地址；
  - 通过 dubbo.protocolhost 设置主机地址；

2. 构建 dubbo 服务提供方

同样，这里使用 zookeeper，就需要先下载 zookeeper 服务器：详情请见笔者的另一篇文章：；

2.1 构建服务接口模块

dubbo 官方推荐把服务接口打成 jar 包发布到仓库上；
这样服务消费者可以依赖该 jar 包，通过接口调用方式完成远程通信。对于服务提供者来说，也需要依赖该 jar 包完成接口的实现；
做法如下：
新建 spring-cloud-dubbo-sample-api 模块，添加 pom.xml 依赖文件；

<!-- dubbo -->
<dependency>
    <groupid>org.apache.dubbo</groupid>
    <artifactid>dubbo</artifactid>
    <version>${dubbo.version}</version>
</dependency>

在 service 包下新建接口：

public interface testservice {
	string test(string message);
}

执行 mvn install 命令将接口 jar 包安装到本地仓库；

2.2 添加 pom.xml 依赖文件

<!-- spring cloud 核心包-->
<dependency>
    <groupid>org.springframework.cloud</groupid>
    <artifactid>spring-cloud-starter</artifactid>
</dependency>

<!-- dubbo spring cloud starter -->
    <groupid>com.alibaba.cloud</groupid>
    <artifactid>spring-cloud-starter-dubbo</artifactid>
<!-- sample api 接口声明-->
    <artifactid>spring-cloud-dubbo-sample-api</artifactid>
<!-- spring cloud nacos service discovery -->
    <artifactid>spring-cloud-starter-zookeeper-discovery</artifactid>

2.3 修改 application.yml 配置文件

spring:
  application:
    name: spring-cloud-dubbo-provider
  cloud:
    zookeeper:
      discovery:
        register: true  #表示该服务要注册进注册中心
      connect-string: localhost:2181  #zookeeper 服务器位置
dubbo:     
  protocol:
    name: dubbo
    port: 20880

2.4 在主程序类上添加注解

@dubbocomponentscan：扫描主程序类所在包及其子包下的所有注解，将 @servicr 注解下类注册进容器里；

2.5 实现 2.1 定义的接口

@service
public class testserviceimpl implements testservice {
    @value("${dubbo.application.name}")
    private string servicename;
    
	@override
	public string test(string message) {
		return servicename;
	}
}

可以在 @service 注解里添加两个属性配置 cluster 和 loadbalance，分别用来配置容错模式和负载均衡策略；
详情请见本篇《1.5 dubbo 的 6 种容错模式》和《1.6 dubbo 的 4 种负载均衡策略》

3. 构建 dubbo 服务消费方

3.1 添加 pom.xml 依赖文件同服务提供方；

<!-- spring cloud 核心包-->
<dependency>
    <groupid>org.springframework.cloud</groupid>
    <artifactid>spring-cloud-starter</artifactid>
</dependency>

<!-- dubbo spring cloud starter -->
    <groupid>com.alibaba.cloud</groupid>
    <artifactid>spring-cloud-starter-dubbo</artifactid>
<!-- sample api 接口声明-->
    <artifactid>spring-cloud-dubbo-sample-api</artifactid>
<!-- spring cloud nacos service discovery -->
    <artifactid>spring-cloud-starter-zookeeper-discovery</artifactid>

3.2 修改 application.yml 配置文件

spring:
  application:
    name: spring-cloud-dubbo-consumer
  cloud:
    zookeeper:
      discovery:
        register: false #表示该服务不要注册进注册中心
      connect-string: localhost:2181  
dubbo:     
  cloud:
    subscribed-services: spring-cloud-dubbo-provider  #表示服务调用者订阅的服务提供方的应用名称列表。默认值为“*”，不推荐使用默认值

3.3 修改业务类

在服务类中使用 @reference 注解注入 testservice 即可；

@restcontroller
public class testcontroller{
    @reference 
    private testservice testservice;
    
    @getmapping("/message")
    public string testcontroller(){
        return testservice.test("message");
}

4. 在消费者端使用 mock 配置实现服务降级

在本示例中将对 2.1 中定义的 testservice 接口配置服务降级策略；
降级策略的配置都是在基于服务消费者之上的；

4.1 为接口实现一种服务降级方法

public class mocktestservice implements testservice {
	@override
	public string test(string message) {
		return "当前无法访问";
	}
}

4.2 给 @reference 注解增加 mock 参数

@restcontroller
public class testcontroller{
    @reference(mock = "com.dlhjw.springcloud.mock.mocktestservice", cluster="failfast")
    private testservice testservice;
    
    @getmapping("/message")
    public string testcontroller(){
        return testservice.test("message");
}

在 testcontroller 类中修改 @reference 注解增加 mock 参数；
其中设置了属性 cluster="failfast"，因为默认的容错策略会发起两次重试，等待的时间较长；

5. dubbo 使用 zookeeper 作为注册中心（spring boot）

这里仅使用到了 spring boot 的自动配置；
有两种配置方式，一种是使用 .xml，另一种是使用 .yml；
.xml 的配置详情请见笔者的另一篇文章：dubbo | dubbo快速上手笔记 – 环境与配置；

5.1 下载 zookeeper 服务器

zookeeper 服务器的下载详情请见笔者的另一篇文章：

5.2 引入 pom.xml 依赖文件服务提供者与服务消费者需要引入的依赖相同；

<!-- zookeeper 相关依赖 -->
<dependency>
    <groupid>org.apache.zookeeper</groupid>
    <artifactid>zookeeper</artifactid>
    <version>3.5.3-beta</version>
</dependency>
<dependency>
    <groupid>org.apache.curator</groupid>
    <artifactid>curator-framework</artifactid>
    <version>4.0.1</version>
</dependency>
<dependency>
    <groupid>org.apache.curator</groupid>
    <artifactid>curator-recipes</artifactid>
    <version>4.0.1</version>
</dependency>

<!-- dubbo 相关依赖 -->
<dependency>
    <groupid>org.apache.dubbo</groupid>
    <artifactid>dubbo-spring-boot-starter</artifactid>
    <version>2.7.5</version>
</dependency>

<!-- spring boot 依赖 -->
<dependency>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-starter</artifactid>
</dependency>

5.3 服务提供者

5.3.1 修改 application.yml 配置文件

spring:
  application:
    name: springboot-dubbo-demo 
dubbo:
  #服务提供方的信息
  application:
    name: springboot-provider      
  protocol:
    name: dubbo
    port: 20880
  registry:
    address: zookeeper://localhost:2181  #zookeeper地址
  #scan:
    #base-packages: com.dlhjw.dubbo.service.impl  #指定 dubbo 服务实现类的扫描基准包，作用等同于 主程序类上的 @dubbocomponentscan

5.3.2 在主程序类上添加注解

@dubbocomponentscan：作用同 spring boot 的 @componentscan，不过这里要扫描 dubbo 提供的 @service 注解；
@dubbocomponentscan(basepackages = “com.dlhjw.dubbo.service.impl”)
如果上面 application 中已经做了配置，这里可以不用添加；

5.3.3 编写业务类

创建接口及其实现类：

public interface testservice {
    void testdubbo();
}

@service(version = "1.0.0",timeout = 3000)
public class testserviceimpl implements testservice{
    @override
    public void testdubbo() {
    }
}

注意：@service 注解是 com.alibaba.dubbo.config.annotation.service 包下的；

5.4 服务消费者

5.4.1 修改 application.yml 配置文件

dubbo:
  #服务消费方的信息
  application:
    name: springboot-consumer 
  registry:
    #zookeeper地址
    address: zookeeper://localhost:2181

5.4.2 在主程序类上添加注解

5.4.3 编写业务类

这里直接在 controller 接口里直接调用服务提供者提供的 testservice 即可；

@reference(version = "1.0.0",timeout = 300)
private testservice testservice;

@reference 注解可以获得一个远程代理对象；

6. dubbo 使用 nacos 作为注册中心（spring boot）

这里仅使用到了 spring boot 的自动配置；
这里仅提供服务提供者的示例，服务消费者类似；

6.1 下载 nacos 服务器

nacos 服务器的下载详情请见笔者的另一篇文章：

6.2 工程结构

新建一个父工程 spring-cloud-nacos-sample，包含两个模块：nacos-sample-api 和 nacos-sample-provider；
在 nacos-sample-api 中声明接口；

public interface ihelloservice{
    string sayhello(string name);
}

6.3 引入 pom.xml 依赖文件

在 nacos-sample-provider 中添加依赖文件：

<!-- 接口定义类 -->
<dependency>
  <groupid>com.gupaoedu.book.nacos</groupid>
  <version>1.0-snapshot</version>
  <artifactid>nacos-sample-api</artifactid>
</dependency>
<!-- nacos 的 starter 组件 -->
<dependency>
  <groupid>com.alibaba.boot</groupid>
  <artifactid>nacos-discovery-spring-boot-starter</artifactid>
  <version>0.2.4</version>
  <exclusions>
    <exclusion>
      <groupid>com.alibaba.spring</groupid>
      <artifactid>spring-context-support</artifactid>
    </exclusion>
  </exclusions>
</dependency>
<!-- dubbo 的 starter 组件 -->
<dependency>
  <groupid>org.apache.dubbo</groupid>
  <artifactid>dubbo-spring-boot-starter</artifactid>
  <version>2.7.5</version>
</dependency>

6.4 修改 application.yml 配置文件

dubbo:
  application:
    name: spring-boot-dubbo-nacos-sample 
  registry:
    address: nacos://127.0.0.1:8848  #基于 nacos 协议
  protocol: 
    name: dubbo
    port: 20880

6.5 在主程序类上添加注解

@dubbocomponentscan：dubbo 的包扫描注解；

6.6 编写业务类实现

6.2 中定义的接口；

@service 
public class helloserviceimpl implements ihelloservice{
    @override 
    public string sayhello(string name){
        return "he1lo world:"+name;
    }

6.7 启动测试

启动服务，访问 nacos 控制台，进入“服务管理” -> “服务列表”，可以看到所有注册在 nacos 上的服务；

7. dubbo 使用 nacos 作为注册中心（spring cloud）

这里仅提供服务提供者的示例，服务消费者类似；

7.1 下载 nacos 服务器