41 加餐:一键通关服务发布全流程 在前面的课时中,我们已经将整个 Dubbo 的核心实现进行了分析。接下来的两个课时,我们将串联 Dubbo 中的这些核心实现,分析 Dubbo服务发布和服务引用的全流程,帮助你将之前课时介绍的独立知识点联系起来,形成一个完整整体。
本课时我们就先来重点关注 Provider 节点发布服务的过程,在这个过程中会使用到之前介绍的很多 Dubbo 核心组件。我们从 DubboBootstrap 这个入口类开始介绍,分析 Provider URL 的组装以及服务发布流程,其中会详细介绍本地发布和远程发布的核心流程。
DubboBootstrap 入口
在[第 01 课时]dubbo-demo-api-provider 示例的 Provider 实现中我们可以看到,整个 Provider 节点的启动入口是 DubboBootstrap.start() 方法,在该方法中会执行一些初始化操作,以及一些状态控制字段的更新,具体实现如下: public DubboBootstrap start() { if (started.compareAndSet(false, true)) { // CAS操作,保证启动一次 ready.set(false); // 用于判断当前节点是否已经启动完毕,在后面的Dubbo QoS中会使用到该字段 // 初始化一些基础组件,例如,配置中心相关组件、事件监听、元数据相关组件,这些组件在后面将会进行介绍 initialize(); // 重点:发布服务 exportServices(); if (!isOnlyRegisterProvider() || hasExportedServices()) { // 用于暴露本地元数据服务,后面介绍元数据的时候会深入介绍该部分的内容 exportMetadataService(); // 用于将服务实例注册到专用于服务发现的注册中心 registerServiceInstance(); } // 处理Consumer的ReferenceConfig referServices(); if (asyncExportingFutures.size() > 0) { // 异步发布服务,会启动一个线程监听发布是否完成,完成之后会将ready设置为true new Thread(() -> { this.awaitFinish(); ready.set(true); }).start(); } else { // 同步发布服务成功之后,会将ready设置为true ready.set(true); } } return this; }
不仅是直接通过 API 启动 Provider 的方式会使用到 DubboBootstrap,在 Spring 与 Dubbo 集成的时候也是使用 DubboBootstrap 作为服务发布入口的,具体逻辑在 DubboBootstrapApplicationListener 这个 Spring Context 监听器中,如下所示:
public class DubboBootstrapApplicationListener extends OneTimeExecutionApplicationContextEventListener implements Ordered { private final DubboBootstrap dubboBootstrap; public DubboBootstrapApplicationListener() { // 初始化DubboBootstrap对象 this.dubboBootstrap = DubboBootstrap.getInstance(); } @Override public void onApplicationContextEvent(ApplicationContextEvent event) { // 监听ContextRefreshedEvent事件和ContextClosedEvent事件 if (event instanceof ContextRefreshedEvent) { onContextRefreshedEvent((ContextRefreshedEvent) event); } else if (event instanceof ContextClosedEvent) { onContextClosedEvent((ContextClosedEvent) event); } } private void onContextRefreshedEvent(ContextRefreshedEvent event) { dubboBootstrap.start(); // 启动DubboBootstrap } private void onContextClosedEvent(ContextClosedEvent event) { dubboBootstrap.stop(); } @Override public int getOrder() { return LOWEST_PRECEDENCE; } }
这里我们重点关注的是exportServices() 方法,它是服务发布核心逻辑的入口,其中每一个服务接口都会转换为对应的 ServiceConfig 实例,然后通过代理的方式转换成 Invoker,最终转换成 Exporter 进行发布。服务发布流程中涉及的核心对象转换,如下图所示:
服务发布核心流程图
exportServices() 方法的具体实现如下: private void exportServices() { // 从配置管理器中获取到所有的要暴露的服务配置,一个接口类对应一个ServiceConfigBase实例 configManager.getServices().forEach(sc -> { ServiceConfig serviceConfig = (ServiceConfig) sc; serviceConfig.setBootstrap(this); if (exportAsync) { // 异步模式,获取一个线程池来异步执行服务发布逻辑 ExecutorService executor = executorRepository.getServiceExporterExecutor(); Future<?> future = executor.submit(() -> { sc.export(); exportedServices.add(sc); }); // 记录异步发布的Future asyncExportingFutures.add(future); } else {// 同步发布 sc.export(); exportedServices.add(sc); } }); }
ServiceConfig
在 ServiceConfig.export() 方法中,服务发布的第一步是检查参数,第二步会根据当前配置决定是延迟发布还是立即调用 doExport() 方法进行发布,第三步会通过 exported() 方法回调相关监听器,具体实现如下: public synchronized void export() { if (!shouldExport()) { return; } if (bootstrap == null) { bootstrap = DubboBootstrap.getInstance(); bootstrap.init(); } // 检查并更新各项配置 checkAndUpdateSubConfigs(); … // 初始化元数据相关服务 if (shouldDelay()) { // 延迟发布 DELAY_EXPORT_EXECUTOR.schedule(this::doExport, getDelay(), TimeUnit.MILLISECONDS); } else { // 立即发布 doExport(); } exported(); // 回调监听器 }
在 checkAndUpdateSubConfigs() 方法中,会去检查各项配置是否合理,并补齐一些缺省的配置信息,这个方法非常冗长,这里就不再展示,你若感兴趣的话可以参考源码进行学习。
完成配置的检查之后,再来看 doExport() 方法,其中首先调用 loadRegistries() 方法加载注册中心信息,即将 RegistryConfig 配置解析成 registryUrl。无论是使用 XML、Annotation,还是 API 配置方式,都可以配置多个注册中心地址,一个服务接口可以同时注册在多个不同的注册中心。
RegistryConfig 是 Dubbo 的多个配置对象之一,可以通过解析 XML、Annotation 中注册中心相关的配置得到,对应的配置如下(当然,也可以直接通过 API 创建得到):
RegistryUrl 的格式大致如下(为了方便查看,这里将每个 URL 参数单独放在一行中展示):
// path是Zookeeper的地址 registry://127.0.0.1:2181/org.apache.dubbo.registry.RegistryService? application=dubbo-demo-api-provider &dubbo=2.0.2 &pid=9405 ®istry=zookeeper // 使用的注册中心是Zookeeper ×tamp=1600307343086
加载注册中心信息得到 RegistryUrl 之后,会遍历所有的 ProtocolConfig,依次调用 doExportUrlsFor1Protocol(protocolConfig, registryURLs) 在每个注册中心发布服务。一个服务接口可以以多种协议进行发布,每种协议都对应一个 ProtocolConfig,例如我们在 Demo 示例中,只使用了 dubbo 协议,对应的配置是:
。
组装服务 URL
doExportUrlsFor1Protocol() 方法的代码非常长,这里我们分成两个部分进行介绍:一部分是组装服务的 URL,另一部分就是后面紧接着介绍的服务发布。
组装服务的 URL核心步骤有如下 7 步。
- 获取此次发布使用的协议,默认使用 dubbo 协议。
- 设置服务 URL 中的参数,这里会从 MetricsConfig、ApplicationConfig、ModuleConfig、ProviderConfig、ProtocolConfig 中获取配置信息,并作为参数添加到 URL 中。这里调用的 appendParameters() 方法会将 AbstractConfig 中的配置信息存储到 Map 集合中,后续在构造 URL 的时候,会将该集合中的 KV 作为 URL 的参数。
- 解析指定方法的 MethodConfig 配置以及方法参数的 ArgumentConfig 配置,得到的配置信息也是记录到 Map 集合中,后续作为 URL 参数。
- 根据此次调用是泛化调用还是普通调用,向 Map 集合中添加不同的键值对。
- 获取 token 配置,并添加到 Map 集合中,默认随机生成 UUID。
- 获取 host、port 值,并开始组装服务的 URL。
- 根据 Configurator 覆盖或新增 URL 参数。
下面是 doExportUrlsFor1Protocol() 方法组装 URL 的核心实现:
private void doExportUrlsFor1Protocol(ProtocolConfig protocolConfig, List
经过上述准备操作之后,得到的服务 URL 如下所示(为了方便查看,这里将每个 URL 参数单独放在一行中展示):
dubbo://172.17.108.185:20880/org.apache.dubbo.demo.DemoService? anyhost=true &application=dubbo-demo-api-provider &bind.ip=172.17.108.185 &bind.port=20880 &default=true &deprecated=false &dubbo=2.0.2 &dynamic=true &generic=false &interface=org.apache.dubbo.demo.DemoService &methods=sayHello,sayHelloAsync &pid=3918 &release= &side=provider ×tamp=1600437404483
服务发布入口
完成了服务 URL 的组装之后,doExportUrlsFor1Protocol() 方法开始执行服务发布。服务发布可以分为远程发布和本地发布,具体发布方式与服务 URL 中的 scope 参数有关。
scope 参数有三个可选值,分别是 none、remote 和 local,分别代表不发布、发布到本地和发布到远端注册中心,从下面介绍的 doExportUrlsFor1Protocol() 方法代码中可以看到:
- 发布到本地的条件是 scope != remote;
- 发布到注册中心的条件是 scope != local。
scope 参数的默认值为 null,也就是说,默认会同时在本地和注册中心发布该服务。下面来看 doExportUrlsFor1Protocol() 方法中发布服务的具体实现:
private void doExportUrlsFor1Protocol(ProtocolConfig protocolConfig, List
本地发布
了解了本地发布、远程发布的入口逻辑之后,下面我们开始深入本地发布的逻辑。
在 exportLocal() 方法中,会将 Protocol 替换成 injvm 协议,将 host 设置成 127.0.0.1,将 port 设置为 0,得到新的 LocalURL,大致如下: injvm://127.0.0.1/org.apache.dubbo.demo.DemoService?anyhost=true &application=dubbo-demo-api-provider &bind.ip=172.17.108.185 &bind.port=20880 &default=true &deprecated=false &dubbo=2.0.2 &dynamic=true &generic=false &interface=org.apache.dubbo.demo.DemoService &methods=sayHello,sayHelloAsync &pid=4249 &release= &side=provider ×tamp=1600440074214
之后,会通过 ProxyFactory 接口适配器找到对应的 ProxyFactory 实现(默认使用 JavassistProxyFactory),并调用 getInvoker() 方法创建 Invoker 对象;最后,通过 Protocol 接口的适配器查找到 InjvmProtocol 实现,并调用 export() 方法进行发布。 exportLocal() 方法的具体实现如下:
private void exportLocal(URL url) { URL local = URLBuilder.from(url) // 创建新URL .setProtocol(LOCAL_PROTOCOL) .setHost(LOCALHOST_VALUE) .setPort(0) .build(); // 本地发布 Exporter<?> exporter = PROTOCOL.export( PROXY_FACTORY.getInvoker(ref, (Class) interfaceClass, local)); exporters.add(exporter); }
InjvmProtocol 的相关实现比较简单,这里就不再展示,你若感兴趣的话可以参考源码进行学习。
远程发布
介绍完本地发布之后,我们再来看远程发布的核心逻辑,远程服务发布的流程相较本地发布流程,要复杂得多。
在 doExportUrlsFor1Protocol() 方法中,远程发布服务时,会遍历全部 RegistryURL,并根据 RegistryURL 选择对应的 Protocol 扩展实现进行发布。我们知道 RegistryURL 是 “registry://” 协议,所以这里使用的是 RegistryProtocol 实现。
下面来看 RegistryProtocol.export() 方法的核心流程:
public
我们可以看到,远程发布流程大致可分为下面 5 个步骤。
- 准备 URL,比如 ProviderURL、RegistryURL 和 OverrideSubscribeUrl。
- 发布 Dubbo 服务。在 doLocalExport() 方法中调用 DubboProtocol.export() 方法启动 Provider 端底层 Server。
- 注册 Dubbo 服务。在 register() 方法中,调用 ZookeeperRegistry.register() 方法向 Zookeeper 注册服务。
- 订阅 Provider 端的 Override 配置。调用 ZookeeperRegistry.subscribe() 方法订阅注册中心 configurators 节点下的配置变更。
- 触发 RegistryProtocolListener 监听器。
远程发布的详细流程如下图所示:
服务发布详细流程图
总结
本课时我们重点介绍了 Dubbo 服务发布的核心流程。
首先我们介绍了 DubboBootstrap 这个入口门面类中与服务发布相关的方法,重点是 start() 和 exportServices() 两个方法;然后详细介绍了 ServiceConfig 类的三个核心步骤:检查参数、立即(或延迟)执行 doExport() 方法进行发布、回调服务发布的相关监听器。
接下来,我们分析了doExportUrlsFor1Protocol() 方法,它是发布一个服务的入口,也是规定服务发布流程的地方,其中涉及 Provider URL 的组装、本地服务发布流程以及远程服务发布流程,对于这些步骤,我们都进行了详细的分析。
参考资料
https://learn.lianglianglee.com/%e4%b8%93%e6%a0%8f/Dubbo%e6%ba%90%e7%a0%81%e8%a7%a3%e8%af%bb%e4%b8%8e%e5%ae%9e%e6%88%98-%e5%ae%8c/41%20%20%e5%8a%a0%e9%a4%90%ef%bc%9a%e4%b8%80%e9%94%ae%e9%80%9a%e5%85%b3%e6%9c%8d%e5%8a%a1%e5%8f%91%e5%b8%83%e5%85%a8%e6%b5%81%e7%a8%8b.md
更多学习
更多实时资讯,前沿技术,生活趣事。尽在【老马啸西风】
交流社群:[交流群信息](https://mp.weixin.qq.com/s/rkSvXxiiLGjl3S-ZOZCr0Q)