启动流程
消费者在启动之后,会通过ReferenceConfig#get()
来生成远程调用代理类。在get
方法中,会启动一系列调用函数,我们来一个个解析。
配置同样包含2种:
- XML
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dubbo="http://dubbo.apache.org/schema/dubbo"
xmlns="http://www.springframework.org/schema/beans"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd">
<dubbo:application name="first-consumer-xml"/>
<dubbo:registry address="zookeeper://127.0.0.1:2181/"/>
<dubbo:reference proxy="javassist" scope="remote"
id="demoService"
generic="false"
check="false"
async="false"
group="dubbo-sxzhongf-group"
version="1.0.0"
interface="com.sxzhongf.deep.in.dubbo.api.service.IGreetingService">
<dubbo:method name="sayHello" retries="3" timeout="5000" mock="false" />
<dubbo:method name="testGeneric" retries="3" timeout="5000" mock="false" />
</dubbo:reference>
</beans>
- Java API
public class ApiConsumerApplication {
public static void main(String[] args) {
// 1. 创建服务引用对象实例
ReferenceConfig<IGreetingService> referenceConfig = new ReferenceConfig<IGreetingService>();
// 2. 设置应用程序信息
referenceConfig.setApplication(new ApplicationConfig("deep-in-dubbo-first-consumer"));
// 3. 设置注册中心
referenceConfig.setRegistry(new RegistryConfig("zookeeper://127.0.0.1:2181/"));
// 4. 设置服务接口和超时时间
referenceConfig.setInterface(IGreetingService.class);
// 默认重试3次
referenceConfig.setTimeout(5000);
// 5 设置服务分组和版本
referenceConfig.setGroup("dubbo-sxzhongf-group");
referenceConfig.setVersion("1.0.0");
// 6. 引用服务
IGreetingService greetingService = referenceConfig.get();
// 7. 设置隐式参数
RpcContext.getContext().setAttachment("company", "sxzhongf");
// 获取provider端传递的隐式参数(FIXME: 需要后续追踪)
// System.out.println("年龄是:" RpcContext.getContext().getAttachment("age"));
//8. 调用服务
System.out.println(greetingService.sayHello("pan"));
}
}
1. new ReferenceConfig
在此阶段,会初始化org.apache.dubbo.config.AbstractConfig
& org.apache.dubbo.config.ReferenceConfig
的静态变量以及静态代码块。
2. ReferenceConfig#get
ReferenceConfig#init
- 通过
DubboBootstrap
启动dubbo。 - 继而初始化服务的元数据信息,
URL.buildKey(interfaceName, group, version)
这段用来生成唯一服务的key,所以我们之前说dubbo的唯一标识是通过全路径
和group以及version来决定的。 - 接下来通过
org.apache.dubbo.config.utils.ConfigValidationUtils#checkMock
来检查我们mock是否设置正确。 - 设置一系列要用的参数(系统运行参数、是否为consumer、是否为泛型调用等等),检查
dubbo
的注册地址,默认为当前主机IP
- 通过
ReferenceConfig#createProxy
创建调用代理开始
ReferenceConfig#shouldJvmRefer
首先判断是否为Injvm
调用- 如果不为
injvm
,判断是否为peer to peer
端对端设置,如果为p2p,那么就直连url - 检查注册中心是否存在(注册中心有可能有多个)
- 循环检查注册中心是否有效
- 配置转换
URL
json registry://127.0.0.1:2181/org.apache.dubbo.registry.RegistryService?application=deep-in-dubbo-first-consumer&dubbo=2.0.2&pid=9780&refer=application=deep-in-dubbo-first-consumer&dubbo=2.0.2&group=dubbo-sxzhongf-group&interface=com.sxzhongf.deep.in.dubbo.api.service.IGreetingService&methods=sayHello,testGeneric&pid=9780®ister.ip=192.168.14.99&release=2.7.5&revision=1.0.0&side=consumer&sticky=false&timeout=5000×tamp=1582959441066&version=1.0.0®istry=zookeeper&release=2.7.5×tamp=1582961922459
- 如果只有一个注册中心,执行
REF_PROTOCOL.refer(interfaceClass, urls.get(0));
来将URL
转为Invoker
对象,因为private static final Protocol REF_PROTOCOL = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();
是扩展是Adaptive
,因此在这里会执行Protocol$Adaptive#refer
方法,又由于protocol
参数值为registry
,因此会只是RegistryProtocol#refer
,又由于被Wrapper
类装配,因此会先执行三个Wrapper类,最后才能执行到RegistryProtocol#refer -> RegistryProtocol#doRefer
,在doRefer
方法中会订阅服务提供者地址,最后返回Invoker
对象。!
那么究竟是如何生成的Invoker
对象呢?我们来看下具体代码:
java private <T> Invoker<T> doRefer(Cluster cluster, Registry registry, Class<T> type, URL url) { // 1.可以查寻RegistryDirectory & StaticDirectory 区别 RegistryDirectory<T> directory = new RegistryDirectory<T>(type, url); directory.setRegistry(registry); directory.setProtocol(protocol); // all attributes of REFER_KEY Map<String, String> parameters = new HashMap<String, String>(directory.getUrl().getParameters()); //2. 封装订阅所用URL URL subscribeUrl = new URL(CONSUMER_PROTOCOL, parameters.remove(REGISTER_IP_KEY), 0, type.getName(), parameters); if (!ANY_VALUE.equals(url.getServiceInterface()) && url.getParameter(REGISTER_KEY, true)) { directory.setRegisteredConsumerUrl(getRegisteredConsumerUrl(subscribeUrl, url)); registry.register(directory.getRegisteredConsumerUrl()); } //3.build路由规则链 directory.buildRouterChain(subscribeUrl); //4.订阅服务提供者地址 directory.subscribe(subscribeUrl.addParameter(CATEGORY_KEY, PROVIDERS_CATEGORY "," CONFIGURATORS_CATEGORY "," ROUTERS_CATEGORY)); //5.封装集群策略到虚拟invoker Invoker invoker = cluster.join(directory); return invoker; }
上述代码中,步骤1根据URL生成了一个RegistryDirectory
(关于Directory接口的作用,可以自行查询一些,直白一些就是将一堆Invoker对象封装成一个List,只有2种实现RegistryDirectory & StaticDirectory
,从命名可看出一个是动态可变,一个不可变),代码2 封装了订阅所要使用的参数信息,代码3则是封装绑定路由规则链,代码4订阅。代码5调用 Cluster$Adaptive#join
方法生成Invoker
对象。
在代码2种从zk获取服务提供者信息:
一旦zk返回服务提供者列表之后,就会调用RegistryDirectory#notify
,如下:
在org.apache.dubbo.common.utils.UrlUtils#isMatch
中对provider和consumer的api进行匹配校验。继续跟踪:RegistryDirectory#notify -> RegistryDirectory#refreshOverrideAndInvoker -> RegistryDirectory#refreshInvoker -> RegistryDirectory#toInvokers
在toInvokers
正式将URL转换为Invoker
,通过invoker = new InvokerDelegate<>(protocol.refer(serviceType, url), url, providerUrl);
在这里protocol#refer
同样执行顺序如:
(dubbo 2.7.5) protocol#refer -> protocol$Adaptive#refer -> QosProtocolWrapper#refer -> ProtocolListenerWrapper#refer -> ProtocolFilterWrapper#refer ->AbstractProtocol#refer->DubboProtocol#protocolBindingRefer
,调用代码如下:
```java
@Override
public <T> Invoker<T> protocolBindingRefer(Class<T> serviceType, URL url) throws RpcException {
optimizeSerialization(url);
// create rpc invoker.
DubboInvoker<T> invoker = new DubboInvoker<T>(serviceType, url, getClients(url), invokers);
invokers.add(invoker);
return invoker;
}
```
关注getClients
,其中执行了DubboProtocol#getSharedClient -> DubboProtocol#initClient
创建netty client进行连接。
因为这里使用的是明确的DubboInvoker
,在回调的时候,Wrapper会对该Invoker进行包装,执行效果如下:
因此,会执行到ProtocolFilterWrapper#buildInvokerChain
,该函数会对服务进行调用链跟踪:
```java
private static <T> Invoker<T> buildInvokerChain(final Invoker<T> invoker, String key, String group) {
Invoker<T> last = invoker;
// 获取所有在MATA-INF文件中配置的激活的责任链接口
List<Filter> filters = ExtensionLoader.getExtensionLoader(Filter.class).getActivateExtension(invoker.getUrl(), key, group);
if (!filters.isEmpty()) {
for (int i = filters.size() - 1; i >= 0; i--) {
final Filter filter = filters.get(i);
final Invoker<T> next = last;
last = new Invoker<T>() {
@Override
public Class<T> getInterface() {
return invoker.getInterface();
}
@Override
public URL getUrl() {
return invoker.getUrl();
}
@Override
public boolean isAvailable() {
return invoker.isAvailable();
}
@Override
public Result invoke(Invocation invocation) throws RpcException {
Result asyncResult;
try {
asyncResult = filter.invoke(next, invocation);
} catch (Exception e) {
if (filter instanceof ListenableFilter) {// Deprecated!
Filter.Listener listener = ((ListenableFilter) filter).listener();
if (listener != null) {
listener.onError(e, invoker, invocation);
}
} else if (filter instanceof Filter.Listener) {
Filter.Listener listener = (Filter.Listener) filter;
listener.onError(e, invoker, invocation);
}
throw e;
} finally {
}
return asyncResult.whenCompleteWithContext((r, t) -> {
if (filter instanceof ListenableFilter) {// Deprecated!
Filter.Listener listener = ((ListenableFilter) filter).listener();
if (listener != null) {
if (t == null) {
listener.onMessage(r, invoker, invocation);
} else {
listener.onError(t, invoker, invocation);
}
}
} else if (filter instanceof Filter.Listener) {
Filter.Listener listener = (Filter.Listener) filter;
if (t == null) {
listener.onMessage(r, invoker, invocation);
} else {
listener.onError(t, invoker, invocation);
}
} else {// Deprecated!
filter.onResponse(r, invoker, invocation);
}
});
}
@Override
public void destroy() {
invoker.destroy();
}
@Override
public String toString() {
return invoker.toString();
}
};
}
}
return last;
}
```
所有的负载均衡、容错策略等都是在这里绑定的。
7.如果有多个注册中心,将会循环执行步骤6,将URL转换为Invoker
对象,然后添加到一个List,分别进行注册之后,然后判断最后一个注册中心url
是否有效,针对多订阅的场景,URL中添加cluster
参数,默认使用org.apache.dubbo.rpc.cluster.support.registry.ZoneAwareCluster
策略,使用org.apache.dubbo.rpc.cluster.Cluster#join
将多个Invoker
对象封装一个虚拟的Invoker
中,否则如果最后一个注册中心是无效的,直接封装Invoker
对象。
8.创建服务代理ProxyFactory#getProxy(org.apache.dubbo.rpc.Invoker<T>)
,因为ProxyFactory
是一个适配类。那么同样这里会调用ProxyFactory$Adaptive#getProxy
,这里最终就是返回一个代理服务的Invoker对象。
至此,我们的消费端的绑定远程zk的服务就已经结束了。 那么,我们在调用服务器方法的时候服务器端和客户端都是如何处理的呢?下节我们将继续分析。