小伙伴的诉求
最近,不少小伙们私信我说:冰哥,我在你星球正在学习手写RPC框架,学习这个手写RPC框架时,我也想对比研究下Dubbo的源码,但是我自己看Dubbo的源码很费劲,看了半天也看不明白,你可以再出一个专栏带着大家研究下Dubbo的源码吗?我想将你手写的RPC和Dubbo的源码进行对比学习。
看到小伙伴们这么高的学习热情,我当然不能拒绝啊。记得刚写RPC框架时,我就说过,这个手写RPC框架是冰河将Dubbo 2.x和Dubbo 3.x的源码研究透彻后写的,这次既然小伙伴们想跟冰河一起彻底吃透Dubbo,冰河当然要安排啦!
开干了
既然是要写深度解析Dubbo源码的系列专题,我们首先要做的就是搭建一套Dubbo的源码环境,正所谓“工欲善其事,必先利其器”。但是,为了更好的理解Dubbo,我将这篇文章重点分成三个部分:Dubbo中的核心角色、搭建Dubbo源码环境、Dubbo核心模块说明、运行Dubbo的示例程序 四个部分。说干就干,上重点。
Dubbo中的核心角色
为了更好的说明Dubbo中的核心角色,这里,我就直接引用一张Dubbo的依赖关系图。
图片
注:图片来自Dubbo官网。
从Dubbo的依赖关系图中,我们可以看出,Dubbo主要由四部分构成:Registry、Provider、Consumer和Monitor 。接下来,我们就分别对这四部分进行简单的介绍。
- Registry,注册中心。在Dubbo中,注册中心负责服务的注册与发现,主要就是针对服务地址的注册与查找。值得一提的是,在Dubbo中,Provider和Consumer只有在服务启动的时候与注册中心进行交互。之后,注册中心通过长连接的形式来感知Provider的存在,如果Provider宕机或不可用,注册中心就会立即推送相关的事件来告知Consumer。
- Provider,服务的提供者。Provider在启动的时候,会向注册中心注册自己的相关服务,主要是通过将自身的服务地址和相关的配置信息封装成URL添加到Zookeeper等服务中。
- Consumer,服务的消费者。Consumer在启动的时候,会向注册中心订阅其关注的服务。主要是向Zookeeper等服务中获取Provider注册的URL,并且在Zookeeper等服务中添加相应的监听器。获取到Provider注册的URL之后,Consumer就会通过负载均衡算法从获取的多个Provider中选择一个,并与其建立连接,发起RPC调用。如果Zookeeper等服务中注册的Provider发生了变更,Consumer就会通过在注册中心中添加的监听器来获取最新的Provider信息。而且Consumer会缓存Provider的信息,如果Consumer与Provider一旦建立起连接,即使注册中心宕机或不可用,也不会影响Consumer和Provider之间的交互。
- Monitor:监控中心。主要用来统计Dubbo服务的调用次数和调用的时间。在Dubbo的核心架构中,监控中心不是必需的,监控中心宕机或不可用不会影响Dubbo的整体服务。
好了,对于Dubbo的核心角色我们就介绍到这儿,更多的信息,小伙伴们可以参见Dubbo的官方文档。
搭建Dubbo源码环境
我们可以使用如下命令将github的源码下载的本地。
git clone https://github.com/apache/dubbo.git
接下来,将Dubbo的源码切换到2.7.8
git checkout -b dubbo-2.7.8 dubbo-2.7.8
使用Maven进行编译
mvn clean install -Dmaven.test.skip=true
转换成IDEA项目,这里我使用的是IDEA分析Dubbo源码。
mvn idea:idea
接下来,我们就可以将Dubbo源码导入到IDEA了。
说了这么多,其中还有一种方式就是通过浏览器直接下载Dubbo 2.7.8的源码到本地。
在浏览器中打开链接:https://github.com/apache/dubbo/releases/tag/dubbo-2.7.8 下载Dubbo源码。
图片
这里下载zip压缩包和tar.gz压缩包均可,下载到本地后解压,将其导入到IDEA中即可。
导入完成后,我们看到的项目结构如下所示。
图片
接下来,我们就对Dubbo源码中的核心模块进行简单的介绍。
Dubbo核心模块说明
dubbo-common模块
Dubbo的公共模块,提供了Dubbo SPI的实现、时间轮的实现、动态编译等通用的功能。
图片
dubbo-remoting模块
Dubbo的远程通信模块,其中,dubbo-remoting-api是对整个模块的核心抽象,其他子模块基于其他开源框架对dubbo-remoting-api进行实现。
图片
dubbo-rpc模块
Dubbo的RPC模块,依赖dubbo-remoting模块。其中,dubbo-remoting-api是整个dubbo-rpc模块的核心抽象,其他模块是对dubbo-remoting-api的实现。
图片
dubbo-registry模块
Dubbo中与注册中心交互的模块。其中dubbo-registry-api是整个dubbo-registry的核心抽象,其他模块是对dubbo-registry-api的具体实现。
图片
dubbo-config模块
Dubbo中解析对外暴露的配置的模块。其中,dubbo-config-api 子模块负责处理以API 方式使用Dubbo时的相关配置,dubbo-config-spring 子模块负责处理与 Spring 集成使用时的相关配置方式。
图片
dubbo-metadata模块
Dubbo中的元数据模块。其中,dubbo-metadata-api是对整个dubbo-metadata的抽象,其他模块是对dubbo-metadata-api的实现。
图片
dubbo-configcenter模块
Dubbo的配置中心模块,其中,提供了多种服务发现的方式并接入了多种服务发现组件。
图片
dubbo-monitor模块
Dubbo 的监控模块,主要用于统计服务调用次数、调用时间以及实现调用链跟踪的服务。
图片
dubbo-cluster模块
Dubbo的集群管理模块,主要提供负载均衡、容错、路由等功能。
图片
运行Dubbo示例程序
在Dubbo源码中,有一个示例程序模块dubbo-demo,在运行dubbo-demo模块中的示例前,我们先在本地启动一个Zookeeper作为注册中心。
注:小伙伴们可以自行到Apache官网下载Zookeeper。
Dubbo示例程序结构
Dubbo提供的示例程序的总体结构如下所示。
图片
我们来看看dubbo-demo下有哪些模块。
- dubbo-demo-interface:Dubbo示例定义的业务接口。
- dubbo-demo-xml:提供了基于Spring XML的使用示例。
- dubbo-demo-annotation:提供了基于Spring注解方式的使用示例。
- dubbo-demo-api:提供了以API方式使用Dubbo的示例。
其中,dubbo-demo-xml、dubbo-demo-annotation和dubbo-demo-api模块都是依赖dubbo-demo-interface模块的。
接下来,我们就对dubbo-demo-interface模块和dubbo-demo-annotation模块的核心代码进行简单的介绍,并运行相关的示例程序。小伙伴们可自行分析和运行dubbo-demo-xml和dubbo-demo-api中的示例程序并运行相关的代码。
(1)dubbo-demo-interface:定义了业务接口。
图片
其中,DemoService接口的核心代码如下所示。
package org.apache.dubbo.demo;
import java.util.concurrent.CompletableFuture;
public interface DemoService {
//同步调用
String sayHello(String name);
//异步调用
default CompletableFuture<String> sayHelloAsync(String name) {
return CompletableFuture.completedFuture(sayHello(name));
}
}
(2)dubbo-demo-annotation:提供了基于Spring注解的示例程序。
Provider代码
我们先来看dubbo-demo-annotation-provider模块,也就是服务的提供者。其DemoServiceImpl的代码如下所示。
@DubboService
public class DemoServiceImpl implements DemoService {
private static final Logger logger = LoggerFactory.getLogger(DemoServiceImpl.class);
@Override
public String sayHello(String name) {
logger.info("Hello " + name + ", request from consumer: " + RpcContext.getContext().getRemoteAddress());
return "Hello " + name + ", response from provider: " + RpcContext.getContext().getLocalAddress();
}
@Override
public CompletableFuture<String> sayHelloAsync(String name) {
return null;
}
}
Application类的代码如下所示。
public class Application {
public static void main(String[] args) throws Exception {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ProviderConfiguration.class);
context.start();
System.in.read();
}
@Configuration
@EnableDubbo(scanBasePackages = "org.apache.dubbo.demo.provider")
@PropertySource("classpath:/spring/dubbo-provider.properties")
static class ProviderConfiguration {
@Bean
public RegistryConfig registryConfig() {
RegistryConfig registryConfig = new RegistryConfig();
registryConfig.setAddress("zookeeper://127.0.0.1:2181");
return registryConfig;
}
}
}
Consumer代码
接下来,我们来看看dubbo-demo-annotation-consumer模块的代码,也就是服务消费者的示例代码。其中,DemoServiceComponent类的代码如下所示。
@Component("demoServiceComponent")
public class DemoServiceComponent implements DemoService {
@DubboReference
private DemoService demoService;
@Override
public String sayHello(String name) {
return demoService.sayHello(name);
}
@Override
public CompletableFuture<String> sayHelloAsync(String name) {
return null;
}
}
Application类的代码如下所示。
public class Application {
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConsumerConfiguration.class);
context.start();
DemoService service = context.getBean("demoServiceComponent", DemoServiceComponent.class);
String hello = service.sayHello("world");
System.out.println("result :" + hello);
}
@Configuration
@EnableDubbo(scanBasePackages = "org.apache.dubbo.demo.consumer.comp")
@PropertySource("classpath:/spring/dubbo-consumer.properties")
@ComponentScan(value = {"org.apache.dubbo.demo.consumer.comp"})
static class ConsumerConfiguration {
}
}
运行Dubbo示例程序
我们先在本地启动Zookeeper,然后分别运行dubbo-demo-annotation-provider模块的Application类和dubbo-demo-annotation-consumer模块的Application类。
此时在IDEA的控制台会输出如下信息。
result :Hello world, response from provider: 192.168.0.5:20880
图片
Dubbo总结
到这里,我们介绍了Dubbo中的核心角色,如何搭建Dubbo源码环境,对Dubbo源码中的核心模块进行了简单的说明,并简单的分析了Dubbo的示例程序并运行了示例程序。
其中,在介绍和运行示例程序时,我们重点介绍了dubbo-demo-annotation示例模块,小伙伴们可自行分析和运行其他示例模块。在后续的文章中分析源码时,我们也主要是通过debug Dubbo的示例程序的方式进行。