SpringBoot集成Dubbo实现RPC远程过程调用
Dubbo介绍
Apache Dubbo是一款高性能、轻量级的开源Java RPC框架,它提供了三大核心能力:面向接口的远程方法调用、智能容错和负载均衡,以及服务自动注册和发现。
官方文档:https://dubbo.apache.org/zh/index.html
dubbo特性
dubbo运行原理图
1)服务提供者(Provider)
暴露服务的服务提供方,服务提供者在启动时,向注册中心注册自己提供的服务。
2)服务消费者(Consumer)
调用远程服务的服务消费方,服务消费者在启动时,向注册中心订阅自己所需的服务,服务消费者从提供者地址列表中,基于软负载均衡算法,选一台提供者进行调用,如果调用失败,再选另一台调用。
3)注册中心(Registry)
注册中心返回服务提供者地址列表给消费者,如果有变更,注册中心将基于长连接推送变更数据给消费者。
4)监控中心(Monitor)
服务消费者和提供者,在内存中累计调用次数和调用时间,定时每分钟发送一次统计数据到监控中心。
调用关系说明:
dubbo架构特点
Dubbo 架构具有以下几个特点,分别是连通性、健壮性、伸缩性、以及向未来架构的升级性。
1)连通性
- 注册中心负责服务地址的注册与查找,相当于目录服务,服务提供者和消费者只在启动时与注册中心交互,注册中心不转发请求,压力较小。
- 注册中心,服务提供者,服务消费者三者之间均为长连接,监控中心除外。
- 注册中心通过长连接感知服务提供者的存在,服务提供者宕机,注册中心将立即推送事件通知消费者。
- 注册中心和监控中心全部宕机,不影响已运行的提供者和消费者,消费者在本地缓存了提供者列表。
- 注册中心和监控中心都是可选的,服务消费者可以直连服务提供者。
2)健壮性
- 监控中心宕掉不影响使用,只是丢失部分采样数据。
- 数据库宕掉后,注册中心仍能通过缓存提供服务列表查询,但不能注册新服务。
- 注册中心对等集群,任意一台宕掉后,将自动切换到另一台。
- 注册中心全部宕掉后,服务提供者和服务消费者仍能通过本地缓存通讯。
- 服务提供者无状态,任意一台宕掉后,不影响使用。
- 服务提供者全部宕掉后,服务消费者应用将无法使用,并无限次重连等待服务提供者恢复。
3)伸缩性
- 注册中心为对等集群,可动态增加机器部署实例,所有客户端将自动发现新的注册中心。
- 服务提供者无状态,可动态增加机器部署实例,注册中心将推送新的服务提供者信息给消费者。
SpringBoot集成Dubbo
基础用法
创建接口工程
UserInfo.java
public class UserInfo implements Serializable {
private Integer id;
private String name;
private Integer age;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
@Override
public String toString() {
return "UserInfo{" +
"id=" + id +
", name='" + name + '\'' +
", age=" + age +
'}';
}
}
UserDubboService.java
public interface UserDubboService {
boolean addUser(UserInfo userInfo);
List<UserInfo> findAll();
List<UserInfo> findByName(String name);
UserInfo getById(Integer id);
boolean deleteById(Integer id);
void update(UserInfo userInfo);
}
创建提供者(Provider)web工程
1)引入相关依赖
<!--dubbo集成springboot依赖-->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>2.7.15</version>
</dependency>
<!--注册中心依赖-->
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-framework</artifactId>
<version>2.13.0</version>
</dependency>
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-recipes</artifactId>
<version>2.13.0</version>
</dependency>
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-x-discovery</artifactId>
<version>2.13.0</version>
</dependency>
<!--接口工程依赖-->
<dependency>
<groupId>com.harvey</groupId>
<artifactId>DubboInterfaceDemo</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<!-- JDBC -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!-- MySQL 驱动包-->
<!--MySQL Server 版本为 8.x时,mysql-connector-java使用5.1.35时会报错-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.11</version>
</dependency>
2)application.yml配置
server:
port: 9999
spring:
datasource:
#通用配置
driver-class-name: com.mysql.jdbc.Driver
password: root
username: root
url: jdbc:mysql://localhost:3306/test?serverTimezone=Asia/Shanghai&useUnicode=true&charcterEncoding=UTF-8&useSSL=false
#数据源连接池配置
hikari:
minimum-idle: 10
maximum-pool-size: 20
idle-timeout: 500000
max-lifetime: 540000
connection-timeout: 60000
connection-test-query: select 1
# dubbo配置
dubbo:
application:
name: dubbo-user-provider
registry:
address: 192.168.198.155:2182,192.168.198.155:2183,192.168.198.155:2184 # zookeeper 地址
protocol: zookeeper
protocol:
port: -1 # 随机端口
provider:
timeout: 5000
retries: 3
consumer:
timeout: 5000
check: true
scan:
base-packages: com.harvey.demo.dubbo # 包路径
3)UserDubboService接口的实现类
// org.apache.dubbo.config.annotation.DubboService直接
@DubboService
public class UserDubboServiceImpl implements UserDubboService {
@Autowired
private JdbcTemplate jdbcTemplate;
@Override
public boolean addUser(UserInfo userInfo) {
return jdbcTemplate.update("insert into tb_user(name, age) values(?, ?)", userInfo.getName(), userInfo.getAge()) > 0;
}
@Override
public List<UserInfo> findAll() {
//错误代码 IncorrectResultSetColumnCountException: Incorrect column count: expected 1, actual 9
//List<UserInfo> userInfoList = jdbcTemplate.queryForList("select * from tb_user",UserInfo.class);
//返回结果不符合预期 maps
//List<Map<String, Object>> maps = jdbcTemplate.queryForList("select * from tb_user", new BeanPropertyRowMapper<UserInfo>());
List<UserInfo> userInfoList = jdbcTemplate.query("select * from tb_user", new BeanPropertyRowMapper(UserInfo.class));
return userInfoList;
}
@Override
public List<UserInfo> findByName(String name) {
List<UserInfo> userInfoList = jdbcTemplate.query("select * from tb_user where name like '%?%'", new BeanPropertyRowMapper(UserInfo.class), name);
return userInfoList;
}
@Override
public UserInfo getById(Integer id) {
UserInfo userInfo = jdbcTemplate.queryForObject("select * from tb_user where id = ?", UserInfo.class, id);
return userInfo;
}
@Override
public boolean deleteById(Integer id) {
return jdbcTemplate.update("delete from tb_user where id = ?", id) > 0;
}
@Override
public void update(UserInfo userInfo) {
jdbcTemplate.update("update tb_user set name = ?, age = ? where id = ?", userInfo.getName(), userInfo.getAge(), userInfo.getId());
}
}
启动SpringBoot项目即可。
创建消费者(Consumer)工程
1)引入相关依赖
<!--dubbo集成springboot依赖-->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>2.7.15</version>
</dependency>
<!--注册中心依赖-->
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-framework</artifactId>
<version>2.13.0</version>
</dependency>
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-recipes</artifactId>
<version>2.13.0</version>
</dependency>
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-x-discovery</artifactId>
<version>2.13.0</version>
</dependency>
<!--接口工程依赖-->
<dependency>
<groupId>com.harvey</groupId>
<artifactId>DubboInterfaceDemo</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
2)application.yml配置
server:
port: 9999
# dubbo配置
dubbo:
application:
name: dubbo-user-consumer
registry:
address: 192.168.198.155:2182,192.168.198.155:2183,192.168.198.155:2184 # zookeeper 地址
protocol: zookeeper
protocol:
port: -1 # 随机端口
provider:
timeout: 5000
retries: 3
consumer:
timeout: 5000
check: true
scan:
base-packages: com.harvey.demo.service
3)服务接口和实现类
调用Dubbo接口实现相关业务逻辑。
public interface OperatorService {
boolean saveUser(UserInfo userInfo);
List<UserInfo> findAll();
}
@Service
public class OperatorServiceImpl implements OperatorService{
@DubboReference
private UserDubboService userDubboService;
@Override
public boolean saveUser(UserInfo userInfo) {
return userDubboService.addUser(userInfo);
}
@Override
public List<UserInfo> findAll() {
return userDubboService.findAll();
}
}
4)测试验证
@RunWith(SpringRunner.class)
@SpringBootTest(classes = DubboConsumerApp.class)
public class DubboConsumerTest {
@Autowired
private OperatorService operatorService;
@Test
public void testSaveUser() {
Random random = new Random();
UserInfo userInfo = new UserInfo();
userInfo.setName("测试" + random.nextInt(10000));
userInfo.setAge(random.nextInt(100));
boolean flag = operatorService.saveUser(userInfo);
System.out.println("保存用户:" + flag);
}
@Test
public void testFindAllUser() {
List<UserInfo> userInfoList = operatorService.findAll();
System.out.println(userInfoList);
}
}
dubbo常用配置
服务发布者的一般配置:
#dubbo服务名
dubbo.application.name=xxx
#注册中中心
dubbo.registry.address=zookeeper://127.0.0.1:2181
#dubbo的RPC协议
dubbo.protocol.name=dubbo
#dubbo的RPC端口
dubbo.protocol.port=20880
#远程服务超时时间
dubbo.provider.timeout=5000
#发布服务扫描的路径
dubbo.base-package=xxx
服务调用者的一般配置:
#dubbo应用名
dubbo.application.name=xxx
#连接的注册中心地址
dubbo.registry.address=zookeeper://127.0.0.1:2181
#远程服务调用超时
dubbo.consumer.timeout=5000
#启动时检查提供者是否存在,true报错,false忽略
dubbo.consumer.check=false
#引用服务扫描的路径
dubbo.base-package=xxx
以下是dubbo可配置项:
1)应用配置参数(必须配置)
dubbo:
application:
# 必填 服务治理 当前应用名称,用于注册中心计算应用间依赖关系,
# 注意:消费者和提供者应用名不要一样,此参数不是匹配条件,你当前项目叫什么名字就填什么,和提供者消费者角色无关.
name: demo-provider
# 可选 服务治理 应用负责人,用于服务治理,请填写负责人公司邮箱前缀 2.0.5以上版本
owner: linhongwei
# 可选 服务治理 用于服务分层对应的架构。如,intl、china。不同的架构使用不同的分层。 2.0.7以上版本
architecture:
# 可选 性能优化 Java字节码编译器,用于动态类的生成,可选:jdk或javassist 2.1.0以上版本
compiler: javassist
# 可选 服务治理 应用环境,如:develop/test/product,不同环境使用不同的缺省值,以及作为只用于开发测试功能的限制条件 2.0.0以上版本
environment:
# 可选 性能优化 日志输出方式,可选:slf4j,jcl,log4j,jdk 2.2.0以上版本
logger: slf4j
# 可选 服务治理 组织名称(BU或部门),用于注册中心区分服务来源,此配置项建议不要使用autoconfig,直接写死在配置中
# 比如china,intl,itu,crm,asc,dw,aliexpress等 2.0.0以上版本
organization:
# 可选 服务治理 当前应用的版本 2.2.0以上版本
version:
2)服务扫描的包
dubbo:
scan:
# 提供者service和消费者所在的java包,多个包用逗号分割
base-package:
3)注册中心支持的配置参数 (必须配置)
dubbo:
registry:
# 必填 服务发现 注册中心支持的协议 包括 dubbo,multicast,zookeeper,nacos, redis 默认是zookeeper
protocol: zookeeper
# 必填 服务发现 注册中心服务器地址,如果地址没有端口缺省为9090,同一集群内的多个地址用逗号分隔,如:ip:port,ip:port
address: 127.0.0.1
# 可选 服务发现 注册中心支持的客户端, zookeeper 支持客户端包括 curator和zkclient,如果不配置,默认使用zkclient
client: zkclient
# 可选 性能调优 注册中心会话超时时间(毫秒),用于检测提供者非正常断线后的脏数据
# 比如用心跳检测的实现,此时间就是心跳间隔,不同注册中心实现不一样。 2.1.0以上版本
session: 60000
# 可选 服务治理 是否向此注册中心注册服务,如果设为false,将只订阅,不注册 2.0.5以上版本
register: true
# 可选 服务治理 注册中心不存在时,是否报错,默认是true
check: false
# # 可选 服务治理 服务是否动态注册,如果设为false,注册后将显示后disable状态,
# 需人工启用,并且服务提供者停止时,也不会自动取消册,需人工禁用。 2.0.5以上版本
dynamic: true
# 可选 服务治理 登录注册中心用户名,如果注册中心不需要验证可不填 2.0.0以上版本
username:
# 可选 服务治理 登录注册中心密码,如果注册中心不需要验证可不填 2.0.0以上版本
password:
# 可选 服务治理 是否向此注册中心订阅服务,如果设为false,将只注册,不订阅 2.0.5以上版本
subscribe:
# 可选 性能调优 注册中心请求超时时间(毫秒) 2.0.0以上版本
timeout:
4)服务协议支持的类型
dubbo:
protocol:
# 必填 性能调优 协议名称 2.0.5以上版本
name: dubbo
#可选 性能调优 协议序列化方式,当协议支持多种序列化方式时使用,
#比如:dubbo协议的dubbo,hessian2,java,compactedjava,以及http协议的json等 2.0.5以上版本
serialization: hessian2
# 可选 性能调优 服务提供方最大可接受连接数 2.0.5以上版本
accepts: 0
# 可选 服务治理 设为true,将向logger中输出访问日志,也可填写访问日志文件路径,直接把访问日志输出到指定文件 2.0.5以上版本
accesslog: false
# 可选 性能调优 网络读写缓冲区大小 2.0.5以上版本
buffer: 8192
# 可选 性能调优 序列化编码 2.0.5以上版本
charset: UTF-8
# 可选 性能调优 协议的客户端实现类型,比如:dubbo协议的mina,netty等 2.0.5以上版本
client: netty
# 可选 性能调优 协议编码方式 2.0.5以上版本
codec: dubbo
# 可选 服务治理 2.0.6以上版本
contextpath:
# 可选 性能调优 协议的消息派发方式,用于指定线程模型,比如:dubbo协议的all, direct, message, execution, connection等 2.1.0以上版本
dispatcher: all
# 可选 性能调优 心跳间隔,对于长连接,当物理层断开时,比如拔网线,TCP的FIN消息来不及发送,
# 对方收不到断开事件,此时需要心跳来帮助检查连接是否已断开 2.0.10以上版本
heartbeat: 0
# 可选 性能调优 io线程池大小(固定大小) 2.0.5以上版本
iothreads:
# 可选 性能调优 请求及响应数据包大小限制,单位:字节 2.0.5以上版本
payload: 88388608
# 可选 服务发现 -1表示随机端口
port: -1
# 可选 性能调优 线程池队列大小,当线程池满时,排队等待执行的队列大小,建议不要设置,当线程程池时应立即失败,重试其它服务提供机器,而不是排队,除非有特殊需求。 2.0.5以上版本
queues: 0
# 可选 服务治理 该协议的服务是否注册到注册中心 2.0.8以上版本
register: true
# 可选 性能调优 协议的服务器端实现类型,比如:dubbo协议的mina,netty等,http协议的jetty,servlet等 2.0.5以上版本
server:
# 可选 服务治理 所支持的telnet命令,多个命令用逗号分隔 2.0.5以上版本
telnet:
# 可选 性能调优 线程池类型,可选:fixed/cached 2.0.5以上版本
threadpool: fixed
# 可选 性能调优 服务线程池大小(固定大小) 2.0.5以上版本
threads: 100
# 可选 性能调优 协议的服务端和客户端实现类型,比如:dubbo协议的mina,netty等,可以分拆为server和client配置 2.0.5以上版本
transporter: netty
5)提供者默认的配置参数
dubbo:
provider: # 公用的生产者配置
# 可选 性能调优 远程服务调用重试次数,不包括第一次调用,不需要重试请设为0 2.0.5以上版本
retries: -1
# 可选 服务治理 设为true,将向logger中输出访问日志,也可填写访问日志文件路径,直接把访问日志输出到指定文件 2.0.5以上版本
accesslog: false
# 可选 性能调优 延迟注册服务时间(毫秒)- ,设为-1时,表示延迟到Spring容器初始化完成时暴露服务 2.0.5以上版本
delay: 0
# 可选 服务治理 服务是否过时,如果设为true,消费方引用时将打印服务过时警告error日志 2.0.5以上版本
deprecated: false
# 可选 服务治理 服务是否动态注册,如果设为false,注册后将显示后disable状态,需人工启用,并且服务提供者停止时,也不会自动取消册,需人工禁用。 2.0.5以上版本
dynamic: true
# 可选 性能调优 服务提供者每服务每方法最大可并行执行请求数 2.0.5以上版本
executes: 0
# 可选 服务发现 服务分组,当一个接口有多个实现,可以用分组区分 2.0.5以上版本
group:
# 可选 服务治理 服务提供者所在的分层。如:biz、dao、intl:web、china:acton。 2.0.7以上版本
layer:
# 可选 性能调优 服务提供方导出服务监听器名称,多个名称用逗号分隔 2.0.5以上版本
listener:
# 可选 服务治理 设为true,表示使用缺省Mock类名,即:接口名 + Mock后缀。 2.0.5以上版本
mock: false
# 可选 服务治理 服务负责人,用于服务治理,请填写负责人公司邮箱前缀 2.0.5以上版本
owner:
# 可选 性能调优 协议名称 1.0.16以上版本
protocol: dubbo
# 可选 性能调优 生成动态代理方式,可选:jdk/javassist 2.0.5以上版本
proxy: javassist
# 可选 服务治理 设为true,表示使用缺省代理类名,即:接口名 + Local后缀。 2.0.5以上版本
stub: false
# 可选 服务治理 令牌验证,为空表示不开启,如果为true,表示随机生成动态令牌 2.0.5以上版本
token: false
# 可选 服务发现 服务版本,建议使用两位数字版本,如:1.0,通常在接口不兼容时版本号才需要升级 2.0.5以上版本
version: 0.0.0
# 可选 性能调优 服务权重 2.0.5以上版本
weight: 0
# 可选 性能调优 服务提供者最大可接受连接数 2.0.5以上版本
accepts: 0
# 可选 性能调优 每服务消费者每服务每方法最大并发调用数 2.0.5以上版本
actives: 0
# 可选 性能调优 是否缺省异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程 2.0.5以上版本
async: false
# 可选 性能调优 网络读写缓冲区大小 2.0.5以上版本
buffer: 8192
# 可选 性能调优 序列化编码 2.0.5以上版本
charset: UTF-8
# 可选 性能调优 协议的客户端实现类型,比如:dubbo协议的mina,netty等 2.0.0以上版本
client: netty
# 可选 性能调优 集群方式,可选:failover/failfast/failsafe/failback/forking 2.0.5以上版本
cluster: failover
# 可选 性能调优 协议编码方式 2.0.0以上版本
codec: dubbo
# 可选 性能调优 对每个提供者的最大连接数,rmi、http、hessian等短连接协议表示限制连接数,dubbo等长连接协表示建立的长连接个数 2.0.5以上版本
connections: 0
# 可选 配置关联 是否为缺省协议,用于多协议 1.0.16以上版本
default: false
# 可选 性能调优 负载均衡策略,可选值:random,roundrobin,leastactive,分别表示:随机,轮循,最少活跃调用 2.0.5以上版本
loadbalance: random
# 可选 性能调优 请求及响应数据包大小限制,单位:字节 2.0.0以上版本
payload: 88388608
# 可选 性能调优 协议序列化方式,当协议支持多种序列化方式时使用,比如:dubbo协议的dubbo,hessian2,java,compactedjava,以及http协议的json,xml等 2.0.5以上版本
serialization: hessian2
# 可选 性能调优 协议的服务器端实现类型,比如:dubbo协议的mina,netty等,http协议的jetty,servlet等 2.0.0以上版本
server: netty
# 可选 服务治理 所支持的telnet命令,多个命令用逗号分隔 2.0.5以上版本
telnet:
# 可选 性能调优 线程池类型,可选:fixed/cached 2.0.5以上版本
threadpool: fixed
# 可选 性能调优 线程池类型,可选:fixed/cached 2.0.5以上版本
threads: 100
# 可选 性能调优 远程服务调用超时时间(毫秒) 2.0.5以上版本
timeout: 1000
# 可选 性能调优 服务提供方远程调用过程拦截器名称,多个名称用逗号分隔 2.0.5以上版本
filter:
6)调用者默认的配置
dubbo:
consumer: # 公用的消费者配置
lazy: true
# 可选 性能调优 远程服务调用超时时间(毫秒) 1.0.16以上版本
timeout: 1000
# 可选 服务治理 启动时检查提供者是否存在,true报错,false忽略 1.0.16以上版本
check: true
# 可选 性能调优 服务消费方远程调用过程拦截器名称,多个名称用逗号分隔 2.0.5以上版本
filter:
# 可选 性能调优 每服务消费者每服务每方法最大并发调用数 2.0.5以上版本
actives: 0
# 可选 性能调优 是否缺省异步执行,不可靠异步,只是忽略返回值,不阻塞执行线程 2.0.0以上版本
async: false
# 可选 服务治理 以调用参数为key,缓存返回结果,可选:lru, threadlocal, jcache等 Dubbo2.1.0及其以上版本支持
cache:
# 可选 性能调优 集群方式,可选:failover/failfast/failsafe/failback/forking 2.0.5以上版本
cluster: failover
# 可选 性能调优 每个服务对每个提供者的最大连接数,rmi、http、hessian等短连接协议支持此配置,dubbo协议长连接不支持此配置 1.0.16以上版本
connections: 100
# 可选 服务治理 是否缺省泛化接口,如果为泛化接口,将返回GenericService 2.0.0以上版本
generic: false
# 可选 性能调优 是否在afterPropertiesSet()时饥饿初始化引用,否则等到有人注入或引用该实例时再初始化。 2.0.10以上版本
init: false
# 可选 服务治理 服务调用者所在的分层。如:biz、dao、intl:web、china:acton。 2.0.7以上版本
layer:
# 可选 性能调优 服务消费方引用服务监听器名称,多个名称用逗号分隔 2.0.5以上版本
listener:
# 可选 性能调优 负载均衡策略,可选值:random,roundrobin,leastactive,分别表示:随机,轮循,最少活跃调用 1.0.16以上版本
loadbalance: random
# 可选 服务治理 调用服务负责人,用于服务治理,请填写负责人公司邮箱前缀 2.0.5以上版本
owner:
# 可选 性能调优 生成动态代理方式,可选:jdk/javassist 2.0.5以上版本
proxy: javassist
# 可选 性能调优 远程服务调用重试次数,不包括第一次调用,不需要重试请设为0 1.0.16以上版本
retries: 2
validation:
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 全程不用写代码,我用AI程序员写了一个飞机大战
· MongoDB 8.0这个新功能碉堡了,比商业数据库还牛
· 记一次.NET内存居高不下排查解决与启示
· DeepSeek 开源周回顾「GitHub 热点速览」
· 白话解读 Dapr 1.15:你的「微服务管家」又秀新绝活了