Spring Boot 中使用 Dubbo 详解
一开始只是想实现一下Dubbo的功能,也满满的实现了Dubbo的demo例子,但是出于求知欲又引出了一堆问题!一下是主要的几个
- 如何使用IDEA构建一个多模块的项目
- Java项目中如何指定配置路径
- SpringBoot 多模块项目(module)Service自动注入(
@Autowired
)是怎么实现的。
话不多说,直接上项目! 这是我的Dubbo的实战项目
Spring Boot 注解下使用Dubbo(使用IDEA构建一个多模块的项目)
创建父类工程
首先使用 Spring Initializr 来快速创建好一个Maven工程。然后删除无关的文件,只需保留pom.xml 文件。
对的!你没看错,就只需要一个pom.xml
文件。
在 pom.xml 里面声明该父工程包含的子模块。(其它信息就不逐一讲述了,诸如继承SpringBoot官方父工程以及统一依赖管理 请查看下面的注释说明)
1.0.0
test-dubbo-boot
Demo project for Spring Boot
pom
com.nezha
test-dubbo-boot
0.0.1-SNAPSHOT
jar
org.springframework.boot
spring-boot-starter-parent
2.0.6.RELEASE
test-dubbo-boot-api
test-dubbo-boot-provider
test-dubbo-boot-consumer
UTF-8
UTF-8
1.8
org.springframework.boot
spring-boot-starter
org.springframework.boot
spring-boot-starter-test
test
com.alibaba.boot
dubbo-spring-boot-starter
0.2.0
org.apache.zookeeper
zookeeper
3.4.6
org.slf4j
slf4j-log4j12
log4j
log4j
org.springframework.boot
spring-boot-maven-plugin
创建子类工程
注:这里是使用IDEA来创建子模块,使用Eclipse的小伙伴可通过
Spring Initializr
构建,然后复制去进去父工程根目录即可。
这里我主要就是按照分层思想创建了三个模块:test-dubbo-boot-api
,test-dubbo-boot-provider
和test-dubbo-boot-consumer
,如下图所示
test-dubbo-boot-api
api
中主要定义了服务调用的接口,这里的API是会对外暴露出来的。
test-dubbo-boot-provider
provider
是服务的提供者,这里实现了api
的接口,它会注册为服务。
test-dubbo-boot-consumer
consumer
是服务的调用者。
创建的子项目需要注意的是:一定要继承本项目的父工程
例如test-dubbo-boot-consumer
的pom.xml
文件
4.0.0
com.nezha
test-dubbo-boot-provider
0.0.1-SNAPSHOT
jar
test-dubbo-boot-provider
Demo project for Spring Boot
com.nezha
test-dubbo-boot
0.0.1-SNAPSHOT
../pom.xml
UTF-8
UTF-8
1.8
com.nezha
test-dubbo-boot-api
0.0.1-SNAPSHOT
org.springframework.boot
spring-boot-starter
org.springframework.boot
spring-boot-starter-actuator
org.springframework.boot
spring-boot-starter-test
test
org.springframework.boot
spring-boot-maven-plugin
这里在
provider
和consumer
的dependency
中一定要记住加上test-dubbo-boot-api
的依赖,因为服务提供者和消费者都依赖于接口实现的。在现实的项目中这个api
的模块就可以单独的打成JAR包给别人使用了。
Spring Boot 的 Actuator 提供了很多生产级的特性,比如监控和度量Spring Boot 应用程序。Actuator 的这些特性可以通过众多 REST 接口、远程 shell 和 JMX 获得。
具体可以参考:
Spring Boot Actuator 使用: https://www.jianshu.com/p/af9738634a21
Spring Boot Actuator:健康检查、审计、统计和监控: https://www.jianshu.com/p/d5943e303a1f
如果需要监控dubbo的服务可以引入dubbo的Actuator依赖
com.alibaba.boot
dubbo-spring-boot-actuator
0.2.0
编写子模块代码
1.test-dubbo-boot-api
这个模块中其实就只有一个接口类
package com.nezha.test.dubbo;
public interface DemoService {
String sayHello(String name);
}
2.test-dubbo-boot-provider
provider
主要有三个文件:接口实现类、配置文件和启动类
1.接口实现类:DemoServiceImpl.java
package com.nezha.test.dubbo.provider;
import com.alibaba.dubbo.config.annotation.Service;
import com.nezha.test.dubbo.DemoService;
import java.net.InetAddress;
import java.text.SimpleDateFormat;
import java.util.Date;
@Service
public class DemoServiceImpl implements DemoService {
@Override
public String sayHello(String name) {
try {
System.out.println("[" + new SimpleDateFormat("HH:mm:ss").format(new Date()) + "] Hello " + name + ", request from consumer: " + InetAddress.getLocalHost());
return "Hello " + name + ", response from provider: " + InetAddress.getLocalHost();
}catch (Exception e){
return "net error";
}
}
}
注意这里的
Service
是alibaba
包下的。
2.配置文件:application.properties
# Spring boot application
spring.application.name = dubbo-provider-demo
dubbo.application.name = dubbo-provider-demo
#注册中心地址
dubbo.registry.address=zookeeper://127.0.0.1:2181
#协议名称
dubbo.protocol.name=dubbo
#协议端口
dubbo.protocol.port=20880
# DemoService service version
demo.service.version = 1.0.0
# Base packages to scan Dubbo Components (e.g @Service , @Reference)
dubbo.scan.basePackages = com.nezha.test.dubbo.provider
!!!重要!!!这里有一个非常坑的地方是0.2版本的
dubbo-spring-boot-starter
中配置 dubbo的时候,ide自动生成的扫描包路径为:dubbo.scan.base-packages
,实际上通过properties注入的名字应该为dubbo.scan.basePackages,导致无法扫描到basePackages,故而没有暴露出服务。将base-packages 修改为 basePackages后 发现成功暴露出服务。
3.启动类:TestDubboBootProviderApplication
package com.nezha.test.dubbo.provider;
import org.springframework.boot.WebApplicationType;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
@SpringBootApplication
public class TestDubboBootProviderApplication {
public static void main(String[] args) {
new SpringApplicationBuilder(TestDubboBootProviderApplication.class)
.web(WebApplicationType.NONE)
.run(args);
}
}
3.test-dubbo-boot-consumer
消费者也是主要三个文件。
1.服务调用类:DemoConsumerController
package com.nezha.test.dubbo.consumer;
import com.alibaba.dubbo.config.annotation.Reference;
import com.nezha.test.dubbo.DemoService;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class DemoConsumerController {
@Reference
private DemoService demoService;
@RequestMapping("/sayHello")
public String sayHello(@RequestParam String name) {
return demoService.sayHello(name);
}
}
2.配置文件:application.properties
# Spring boot application
spring.application.name = dubbo-consumer-demo
# Dubbo 服务消费者配置
dubbo.application.name=consumer
dubbo.registry.address=zookeeper://127.0.0.1:2181
# Service Version
demo.service.version = 1.0.0
3.启动类:TestDubboBootConsumerApplication
package com.nezha.test.dubbo.consumer;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication()
public class TestDubboBootConsumerApplication {
public static void main(String[] args) {
SpringApplication.run(TestDubboBootConsumerApplication.class, args);
}
}
Dubbo 简介
这部分的资料来自:来自掘金关于Spring Boot Dubbo的实战
Dubbo是阿里巴巴SOA服务化治理方案的核心框架,每天为2,000+个服务提供3,000,000,000+次访问量支持,并被广泛应用于阿里巴巴集团的各成员站点。Dubbo是一个分布式服务框架,致力于提供高性能和透明化的RPC远程服务调用方案,以及SOA服务治理方案。
Dubbo 是什么?
Dubbo是一个分布式服务框架,致力于提供高性能和透明化的RPC远程服务调用方案,以及SOA服务治理方案。简单的说,dubbo就是个服务框架,如果没有分布式的需求,其实是不需要用的,只有在分布式的时候,才有dubbo这样的分布式服务框架的需求,并且本质上是个服务调用的东东,说白了就是个远程服务调用的分布式框架
其核心部分包含:
1.远程通讯: 提供对多种基于长连接的NIO框架抽象封装,包括多种线程模型,序列化,以及“请求-响应”模式的信息交换方式。
2.集群容错: 提供基于接口方法的透明远程过程调用,包括多协议支持,以及软负载均衡,失败容错,地址路由,动态配置等集群支持。
3.自动发现: 基于注册中心目录服务,使服务消费方能动态的查找服务提供方,使地址透明,使服务提供方可以平滑增加或减少机器。
Dubbo 能做什么?
1.透明化的远程方法调用,就像调用本地方法一样调用远程方法,只需简单配置,没有任何API侵入。
2.软负载均衡及容错机制,可在内网替代F5等硬件负载均衡器,降低成本,减少单点。
3.服务自动注册与发现,不再需要写死服务提供方地址,注册中心基于接口名查询服务提供者的IP地址,并且能够平滑添加或删除服务提供者。
Dubbo 的架构
节点角色说明
节点 | 角色说明 |
---|---|
Provider | 暴露服务的服务提供方 |
Consumer | 调用远程服务的服务消费方 |
Registry | 服务注册与发现的注册中心 |
Monitor | 统计服务的调用次调和调用时间的监控中心 |
Container | 服务运行容器 |
Dubbo提供三个关键功能,包括基于接口的远程呼叫,容错和负载平衡以及自动服务注册和发现
调用关系说明
1.服务容器负责启动,加载,运行服务提供者。
2.服务提供者在启动时,向注册中心注册自己提供的服务。
3.服务消费者在启动时,向注册中心订阅自己所需的服务。
4.注册中心返回服务提供者地址列表给消费者,如果有变更,注册中心将基于长连接推送变更数据给消费者。
5.服务消费者,从提供者地址列表中,基于软负载均衡算法,选一台提供者进行调用,如果调用失败,再选另一台调用。
6.服务消费者和提供者,在内存中累计调用次数和调用时间,定时每分钟发送一次统计数据到监控中心。
Dubbo 特点
Dubbo 架构具有以下几个特点,分别是连通性、健壮性、伸缩性、以及向未来架构的升级性
连通性
- 注册中心负责服务地址的注册与查找,相当于目录服务,服务提供者和消费者只在启动时与注册中心交互,注册中心不转发请求,压力较小
- 监控中心负责统计各服务调用次数,调用时间等,统计先在内存汇总后每分钟一次发送到监控中心服务器,并以报表展示
- 服务提供者向注册中心注册其提供的服务,并汇报调用时间到监控中心,此时间不包含网络开销
- 服务消费者向注册中心获取服务提供者地址列表,并根据负载算法直接调用提供者,同时汇报调用时间到监控中心,此时间包含网络开销
- 注册中心,服务提供者,服务消费者三者之间均为长连接,监控中心除外
- 注册中心通过长连接感知服务提供者的存在,服务提供者宕机,注册中心将立即推送事件通知消费者
- 注册中心和监控中心全部宕机,不影响已运行的提供者和消费者,消费者在本地缓存了提供者列表
- 注册中心和监控中心都是可选的,服务消费者可以直连服务提供者
健状性
- 监控中心宕掉不影响使用,只是丢失部分采样数据
- 数据库宕掉后,注册中心仍能通过缓存提供服务列表查询,但不能注册新服务
- 注册中心对等集群,任意一台宕掉后,将自动切换到另一台
- 注册中心全部宕掉后,服务提供者和服务消费者仍能通过本地缓存通讯
- 服务提供者无状态,任意一台宕掉后,不影响使用
- 服务提供者全部宕掉后,服务消费者应用将无法使用,并无限次重连等待服务提供者恢复
伸缩性
- 注册中心为对等集群,可动态增加机器部署实例,所有客户端将自动发现新的注册中心
- 服务提供者无状态,可动态增加机器部署实例,注册中心将推送新的服务提供者信息给消费者
升级性
当服务集群规模进一步扩大,带动IT治理结构进一步升级,需要实现动态部署,进行流动计算,现有分布式服务架构不会带来阻力。下图是未来可能的一种架构:
节点角色说明
节点 | 角色说明 |
---|---|
Deployer | 自动部署服务的本地代理 |
Repository | 仓库用于存储服务应用发布包 |
Scheduler | 调度中心基于访问压力自动增减服务提供者 |
Admin | 统一管理控制台 |
Registry | 服务注册与发现的注册中心 |
Monitor | 统计服务的调用次调和调用时间的监控中心 |
参考文献
好消息:Dubbo & Spring Boot要来了
Spring Boot集成的新特性可参考官方文档: https://github.com/apache/incubator-dubbo-spring-boot-project
听听八年阿里架构师怎样讲述Dubbo和Spring Cloud微服务架构:
Spring Boot Dubbo applications.properties 配置清单
肥朝的Dubbo源码学习https://www.jianshu.com/u/f7daa458b874
Spring Boot 中使用 Dubbo 详解:https://juejin.im/post/59f43c025188253d6816d7fe,这篇文章在掘金中找到的,很不错
dubbo-spring-boot-starter 的官方地址:https://github.com/apache/incubator-dubbo-spring-boot-project,一开始问题一直不知道怎么解决,看了
github
上的Issues
终于解决了!