Dubbo原理剖析之 @DubboReference.version設(shè)置為*

作者：Howinfun 2021-05-09 23:01:41

開(kāi)發(fā) 前端

Dubbo在消費(fèi)端提供了一個(gè)功能，即將消費(fèi)者的版本號(hào)指定為*，那么不管服務(wù)端的接口版本是啥，都可以調(diào)用成功。

[[398274]]

本文轉(zhuǎn)載自微信公眾號(hào)「不送花的程序猿」，作者Howinfun。轉(zhuǎn)載本文請(qǐng)聯(lián)系不送花的程序猿公眾號(hào)。

1 背景

Dubbo在消費(fèi)端提供了一個(gè)功能，即將消費(fèi)者的版本號(hào)指定為*，那么不管服務(wù)端的接口版本是啥，都可以調(diào)用成功。

2 初步猜測(cè)

dubbo接口定位邏輯：接口(全路徑)+服務(wù)分組(group字段)+版本號(hào)(version字段)。

Zookeeper 是用樹(shù)狀來(lái)保存數(shù)據(jù)的，在 Zookeeper 中，可以利用Dubbo接口(全路徑)作為父節(jié)點(diǎn)，再根據(jù)group和version信息寫(xiě)入子節(jié)點(diǎn)。

而 Nacos，在 Nacos 的控制臺(tái)中，我們看到可以根據(jù)服務(wù)名或服務(wù)分組來(lái)模糊查詢(xún)服務(wù)列表，那么在消費(fèi)者訂閱的時(shí)候，就根據(jù)這兩個(gè)模糊查詢(xún)就可以了，查出來(lái)的健康提供者都是符合的。

下面就深入一下源碼，看看實(shí)際的邏輯是不是類(lèi)似我們的猜想。

3 源碼剖析

3.1 Zookeeper 作為注冊(cè)中心

3.1.1 準(zhǔn)備

弄一個(gè)服務(wù)提供者、一個(gè)服務(wù)消費(fèi)者。服務(wù)提供者對(duì)外提供一個(gè)dubbo接口，版本有1.0.0和2.0.0;服務(wù)消費(fèi)者引入服務(wù)提供者提供的dubbo接口，version設(shè)置為*。

啟動(dòng)服務(wù)提供者、接著啟動(dòng)消費(fèi)者，觀察后臺(tái)日志打印：

我們可以看到，當(dāng)我們將@DubboReference的version設(shè)置為*的時(shí)候，他就根據(jù)注冊(cè)u(píng)rl(帶*)去找有哪些服務(wù)提供者，然后返回的urls會(huì)有多個(gè)，其中包含版本號(hào)為1.0.0和2.0.0的url。

2021-05-01 10:24:08.561 [main] [INFO ] [o.a.d.r.z.ZookeeperRegistry] [] [] -  [DUBBO] Subscribe: consumer://127.0.0.1/com.winfun.service.DubboServiceOne?application=dubbo-service&category=providers,configurators,routers&dubbo=2.0.2&init=false&interface=com.winfun.service.DubboServiceOne&methods=sayHello&pid=14021&qos.enable=false&reference.filter=default,dubboLogFilter,sentinel.dubbo.consumer.filter&release=2.7.7&revision=*&side=consumer&sticky=false&timestamp=1619835848549&version=*, dubbo version: 2.7.7, current host: 127.0.0.1 
2021-05-01 10:24:08.572 [main] [INFO ] [o.a.d.r.z.ZookeeperRegistry] [] [] -  [DUBBO] Notify urls for subscribe url consumer://127.0.0.1/com.winfun.service.DubboServiceOne?application=dubbo-service&category=providers,configurators,routers&dubbo=2.0.2&init=false&interface=com.winfun.service.DubboServiceOne&methods=sayHello&pid=14021&qos.enable=false&reference.filter=default,dubboLogFilter,sentinel.dubbo.consumer.filter&release=2.7.7&revision=*&side=consumer&sticky=false&timestamp=1619835848549&version=*, urls: [dubbo://192.168.2.10:20880/com.winfun.service.DubboServiceOne?anyhost=true&application=dubbo-provider-one&deprecated=false&dubbo=2.0.2&dynamic=true&generic=false&interface=com.winfun.service.DubboServiceOne&metadata-type=remote&methods=sayHello&pid=13996&release=2.7.8&revision=1.0.0&service.filter=default,dubboLogFilter&side=provider&timestamp=1619835820516&version=1.0.0, dubbo://192.168.2.10:20880/com.winfun.service.DubboServiceOne?anyhost=true&application=dubbo-provider-one&deprecated=false&dubbo=2.0.2&dynamic=true&generic=false&interface=com.winfun.service.DubboServiceOne&metadata-type=remote&methods=sayHello&pid=13996&release=2.7.8&revision=2.0.0&service.filter=default,dubboLogFilter&side=provider&timestamp=1619835820187&version=2.0.0, empty://127.0.0.1/com.winfun.service.DubboServiceOne?application=dubbo-service&category=configurators&dubbo=2.0.2&init=false&interface=com.winfun.service.DubboServiceOne&methods=sayHello&pid=14021&qos.enable=false&reference.filter=default,dubboLogFilter,sentinel.dubbo.consumer.filter&release=2.7.7&revision=*&side=consumer&sticky=false&timestamp=1619835848549&version=*, empty://127.0.0.1/com.winfun.service.DubboServiceOne?application=dubbo-service&category=routers&dubbo=2.0.2&init=false&interface=com.winfun.service.DubboServiceOne&methods=sayHello&pid=14021&qos.enable=false&reference.filter=default,dubboLogFilter,sentinel.dubbo.consumer.filter&release=2.7.7&revision=*&side=consumer&sticky=false&timestamp=1619835848549&version=*], dubbo version: 2.7.7, current host: 127.0.0.1

3.1.2 源碼分析

上面我們看到，version=*可以成功訂閱，并且服務(wù)提供者有兩個(gè)，分別是version=1.0.0和version=2.0.0。

結(jié)果是看得出來(lái)了，但是我們還是需要看看Zookeeper是怎么的判斷邏輯。

3.1.2.1 服務(wù)消費(fèi)者訂閱過(guò)程

我們都知道，正常發(fā)布Dubbo的消費(fèi)者，需要配置ReferenceConfig，然后調(diào)用export方法;當(dāng)然了，我們這里就不過(guò)于深入了，直接從日志的入口來(lái)開(kāi)始：org.apache.dubbo.registry.zookeeper.ZookeeperRegistry#doSubscribe

我們服務(wù)消費(fèi)者的訂閱url：

consumer://127.0.0.1/com.winfun.service.DubboServiceOne?application=dubbo-service&category=providers,configurators,routers&dubbo=2.0.2&init=false&interface=com.winfun.service.DubboServiceOne&methods=sayHello&pid=16215&qos.enable=false&reference.filter=default,dubboLogFilter,sentinel.dubbo.consumer.filter&release=2.7.7&revision=*&side=consumer&sticky=false&timestamp=1619842106726&version=*

第一步：獲取dubbo接口全路徑

url.getServiceInterface() -> com.winfun.service.DubboServiceOne

接著判斷是否等于“*”，明顯不是，跳到else分支

第二步：根據(jù)url獲取path

獲取根節(jié)點(diǎn):

toCategoriesPath(url) -> /dubbo/com.winfun.service.DubboServiceOne/providers、/dubbo/com.winfun.service.DubboServiceOne/configurators、/dubbo/com.winfun.service.DubboServiceOne/consumers

第三步：遍歷第二步的path、創(chuàng)建父節(jié)點(diǎn)

重點(diǎn)在path=/dubbo/com.winfun.service.DubboServiceOne/providers，其他忽略即可

根據(jù)path創(chuàng)建節(jié)點(diǎn)(非持久化)：zkClient.create(root, false);

給path添加子節(jié)點(diǎn)監(jiān)聽(tīng)器：zkClient.addChildListener(path, zkListener) 并返回子節(jié)點(diǎn)列表

dubbo://192.168.2.10:20880/com.winfun.service.DubboServiceOne?anyhost=true&application=dubbo-provider-one&deprecated=false&dubbo=2.0.2&dynamic=true&generic=false&interface=com.winfun.service.DubboServiceOne&metadata-type=remote&methods=sayHello&pid=13996&release=2.7.8&revision=1.0.0&service.filter=default,dubboLogFilter&side=provider×tamp=1619835820516&version=1.0.0
dubbo://192.168.2.10:20880/com.winfun.service.DubboServiceOne?anyhost=true&application=dubbo-provider-one&deprecated=false&dubbo=2.0.2&dynamic=true&generic=false&interface=com.winfun.service.DubboServiceOne&metadata-type=remote&methods=sayHello&pid=13996&release=2.7.8&revision=2.0.0&service.filter=default,dubboLogFilter&side=provider×tamp=1619835820187&version=2.0.0

configurators 和 consumers 不存在子節(jié)點(diǎn)，所以子節(jié)點(diǎn)是根據(jù)規(guī)則生成的url，前綴為empty

第四步：對(duì)上面獲取到的urls進(jìn)行監(jiān)聽(tīng)

調(diào)用org.apache.dubbo.registry.support.FailbackRegistry#notify方法。

最后會(huì)去到 org.apache.dubbo.registry.support.AbstractRegistry#notify(org.apache.dubbo.common.URL, org.apache.dubbo.registry.NotifyListener, java.util.List)

重點(diǎn)：在監(jiān)聽(tīng)前，會(huì)先匹配根據(jù)path查詢(xún)的所有子節(jié)點(diǎn)中，匹配符合當(dāng)前消費(fèi)者的子節(jié)點(diǎn)(根據(jù)group和version判斷)，利用org.apache.dubbo.common.utils.UrlUtils#isMatch判斷。

判斷中最重要的邏輯：

String ANY_VALUE = "*"; 
 
String consumerGroup = consumerUrl.getParameter(GROUP_KEY); 
String consumerVersion = consumerUrl.getParameter(VERSION_KEY); 
String consumerClassifier = consumerUrl.getParameter(CLASSIFIER_KEY, ANY_VALUE); 
 
String providerGroup = providerUrl.getParameter(GROUP_KEY); 
String providerVersion = providerUrl.getParameter(VERSION_KEY); 
String providerClassifier = providerUrl.getParameter(CLASSIFIER_KEY, ANY_VALUE); 
return (ANY_VALUE.equals(consumerGroup) || StringUtils.isEquals(consumerGroup, providerGroup) || StringUtils.isContains(consumerGroup, providerGroup)) 
        && (ANY_VALUE.equals(consumerVersion) || StringUtils.isEquals(consumerVersion, providerVersion)) 
        && (consumerClassifier == null || ANY_VALUE.equals(consumerClassifier) || StringUtils.isEquals(consumerClassifier, providerClassifier));

上面完全可以體現(xiàn)出：當(dāng)版本號(hào)等于*號(hào)，dubbo接口根節(jié)點(diǎn)下的服務(wù)都會(huì)作為當(dāng)前消費(fèi)者的服務(wù)提供者。

好了，到這里，我們可以知道Zookeeper是怎么為version=*的消費(fèi)者訂閱服務(wù)的，直接根據(jù)接口全路徑名到Zookeeper里獲取所有子節(jié)點(diǎn)，并都可以作為服務(wù)提供者。

其實(shí)這里會(huì)有一個(gè)擴(kuò)展點(diǎn)：多個(gè)服務(wù)提供者，調(diào)用的時(shí)候是怎么負(fù)載的，其實(shí)在@DubboReference中的loadbance屬性中看得出，默認(rèn)的負(fù)載策略是隨機(jī)。

/** 
 * Load balance strategy, legal values include: random, roundrobin, leastactive 
 * <p> 
 * see Constants#DEFAULT_LOADBALANCE 
 */ 
String loadbalance() default ""; 
 
org.apache.dubbo.common.constants.CommonConstants#DEFAULT_LOADBALANCE="random";

3.1.2.2 服務(wù)消費(fèi)者執(zhí)行過(guò)程

proxy執(zhí)行入口：

我們可以通過(guò)debug模式，進(jìn)入到Dubbo方法執(zhí)行的入口：org.apache.dubbo.rpc.proxy.InvokerInvocationHandler#invoke

第一步：初步判斷

如果是 Object類(lèi) 或者 toString、destory、hashCode等方法，直接執(zhí)行

第二步：創(chuàng)建RpcInvocation

根據(jù)執(zhí)行方法、參數(shù)等信息創(chuàng)建RpcInvocation

獲取serviceKey：-> serviceKey = dubbo-api-path/group:version

RpcInvocation設(shè)置TargetServiceUniqueName

第三步：調(diào)用invoker的invoke方法

來(lái)到org.apache.dubbo.rpc.cluster.support.wrapper.MockClusterInvoker#invoke

判斷是否設(shè)置了 mock 或 force

如果是調(diào)用org.apache.dubbo.rpc.cluster.support.wrapper.MockClusterInvoker#doMockInvoke方法
否則來(lái)到org.apache.dubbo.rpc.cluster.support.wrapper.AbstractCluster.InterceptorInvokerNode#invoke

第四步：AbstractClusterInvoker#invoke

調(diào)用AbstractClusterInvoker#list獲取invoker列表，可以看到拿到的就是1.0.0版本和2.0.0版本的服務(wù)提供者

接著調(diào)用 initLoadBalance 方法來(lái)初始化負(fù)載均衡策略，從訂閱url里面獲取loadbalance的值，如果沒(méi)有設(shè)置，返回默認(rèn)值“random”

/** 
 * Init LoadBalance. 
 * <p> 
 * if invokers is not empty, init from the first invoke's url and invocation 
 * if invokes is empty, init a default LoadBalance(RandomLoadBalance) 
 * </p> 
 * 
 * @param invokers   invokers 
 * @param invocation invocation 
 * @return LoadBalance instance. if not need init, return null. 
 */ 
protected LoadBalance initLoadBalance(List<Invoker<T>> invokers, Invocation invocation) { 
    if (CollectionUtils.isNotEmpty(invokers)) { 
        return ExtensionLoader.getExtensionLoader(LoadBalance.class).getExtension(invokers.get(0).getUrl() 
                .getMethodParameter(RpcUtils.getMethodName(invocation), LOADBALANCE_KEY, DEFAULT_LOADBALANCE)); 
    } else { 
        return ExtensionLoader.getExtensionLoader(LoadBalance.class).getExtension(DEFAULT_LOADBALANCE); 
    } 
}

第五步：根據(jù)集群策略執(zhí)行方法

由于Dubbo默認(rèn)的集群策略是 failover，所以會(huì)來(lái)到來(lái)到：org.apache.dubbo.rpc.cluster.support.FailoverClusterInvoker#doInvoker

首先會(huì)從注冊(cè)u(píng)rl里面的retries字段獲取重試次數(shù)(如果為空，默認(rèn)重試次數(shù)為2)，此次取的是默認(rèn)值，所以最后最大調(diào)用次數(shù)為3.

循環(huán)retries+1次

來(lái)到：org.apache.dubbo.rpc.cluster.support.AbstractClusterInvoker#select 選擇Invoker

在RandomLoadBalance#doSelect 中，首先會(huì)根據(jù)服務(wù)提供者的權(quán)重判斷，如果權(quán)重沒(méi)賦值，最后會(huì)利用ThreadLocalRandom.current().nextInt(invokers.size())隨機(jī)選擇一個(gè)invoker。

下一步：org.apache.dubbo.rpc.cluster.support.AbstractClusterInvoker#doSelect
下一步：org.apache.dubbo.rpc.cluster.loadbalance.AbstractLoadBalance#select由于默認(rèn)是random的負(fù)載均衡策略，所以最后來(lái)到：org.apache.dubbo.rpc.cluster.loadbalance.RandomLoadBalance#doSelect
執(zhí)行invoke方法，返回結(jié)果
如果有錯(cuò)誤，記錄著，下次循環(huán)打印warn日志
如果超過(guò)retries+1次調(diào)用失敗，往外拋出RpcException異常

到這里，我們已經(jīng)非常清楚Zookeeper 是如何支持消費(fèi)者將 version設(shè)置為*，并且方法調(diào)用時(shí)是如何選擇服務(wù)提供者。

3.2 Nacos 作為注冊(cè)中心

3.2.1 準(zhǔn)備

弄一個(gè)服務(wù)提供者、一個(gè)服務(wù)消費(fèi)者，這次不再是Zookeeper作為注冊(cè)中心，而是Nacos作為注冊(cè)中心。服務(wù)提供者對(duì)外提供一個(gè)dubbo接口，版本有1.0.0和2.0.0;服務(wù)消費(fèi)者引入服務(wù)提供者提供的dubbo接口，version設(shè)置為*。

啟動(dòng)服務(wù)提供者、接著啟動(dòng)消費(fèi)者，觀察后臺(tái)日志打印：

3.2.2 源碼分析

3.2.2.1 服務(wù)消費(fèi)者訂閱過(guò)程

Nacos 源碼分析也是直接從 NacosRegistry#doSubscribe 入口開(kāi)始：

org.apache.dubbo.registry.nacos.NacosRegistry#doSubscribe(org.apache.dubbo.common.URL, org.apache.dubbo.registry.NotifyListener)

消費(fèi)者的注冊(cè)u(píng)rl：

consumer://192.168.3.3/com.winfun.service.DubboServiceOne?application=dubbo-consumer-nacos&category=providers,configurators,routers&dubbo=2.0.2&init=false&interface=com.winfun.service.DubboServiceOne&metadata-type=remote&methods=sayHello&pid=39203&qos.enable=false&reference.filter=default,dubboLogFilter&release=2.7.8&revision=*&side=consumer&sticky=false&timestamp=1620177626113&version=*

第一步、根據(jù)url獲取serviceName集合：

org.apache.dubbo.registry.nacos.NacosRegistry#getServiceNames0

1、創(chuàng)建 NacosServiceName：

providers:com.winfun.service.DubboServiceOne:*:

2、接著到：org.apache.dubbo.registry.nacos.NacosRegistry#filterServiceNames(org.apache.dubbo.registry.nacos.NacosServiceName)

根據(jù)上面的servicename過(guò)濾出所有的serviceName

2.1、先利用NamingProxy查詢(xún)：

com.alibaba.nacos.client.naming.net.NamingProxy#getServiceList(int, int, java.lang.String, com.alibaba.nacos.api.selector.AbstractSelector)

利用接口全路徑名+group查詢(xún)，沒(méi)有帶版本號(hào)

2.2、最后到：

com.alibaba.nacos.common.http.client.NacosRestTemplate#exchangeForm

http 請(qǐng)求：

url：

http://127.0.0.1:8848/nacos/v1/ns/service/list 
params：{app=unknown, pageSize=2147483647, groupName=DEFAULT_GROUP, namespaceId=public, pageNo=1}

返回結(jié)果：

RestResult{code=200, message='null', data={"doms":["providers:com.winfun.service.DubboServiceOne:1.0.0:","providers:com.winfun.service.DubboServiceOne:2.0.0:"],"count":2}}

明顯包含兩個(gè)版本的service

第二步、根據(jù)條件過(guò)濾合適的 service

public boolean isCompatible(NacosServiceName concreteServiceName) { 
 
    if (!concreteServiceName.isConcrete()) { // The argument must be the concrete NacosServiceName 
        return false; 
    } 
 
    // Not match comparison 
    if (!StringUtils.isEquals(this.category, concreteServiceName.category) 
            && !matchRange(this.category, concreteServiceName.category)) { 
        return false; 
    } 
 
    if (!StringUtils.isEquals(this.serviceInterface, concreteServiceName.serviceInterface)) { 
        return false; 
    } 
 
    // wildcard condition 
    // 重點(diǎn)在這里 
    if (isWildcard(this.version)) { 
        return true; 
    } 
 
    if (isWildcard(this.group)) { 
        return true; 
    } 
 
    // range condition 
    if (!StringUtils.isEquals(this.version, concreteServiceName.version) 
            && !matchRange(this.version, concreteServiceName.version)) { 
        return false; 
    } 
 
    if (!StringUtils.isEquals(this.group, concreteServiceName.group) && 
            !matchRange(this.group, concreteServiceName.group)) { 
        return false; 
    } 
 
    return true; 
} 
 
private boolean isWildcard(String value) { 
    return WILDCARD.equals(value); 
} 
 
public static final String WILDCARD = "*";

過(guò)濾后的 service 有兩個(gè)，分別是1.0.0和2.0.0

那么繼續(xù)深一步的訂閱流程：org.apache.dubbo.registry.nacos.NacosRegistry#doSubscribe(org.apache.dubbo.common.URL, org.apache.dubbo.registry.NotifyListener, java.util.Set)

第三步、遍歷serviceNames，根據(jù)serviceName+group查詢(xún)所有實(shí)例列表并且進(jìn)行實(shí)例監(jiān)聽(tīng)

List<Instance> instances = new LinkedList<>(); 
for (String serviceName : serviceNames) { 
    instances.addAll(namingService.getAllInstances(serviceName 
            , getUrl().getParameter(GROUP_KEY, Constants.DEFAULT_GROUP))); 
    notifySubscriber(url, listener, instances); 
    subscribeEventListener(serviceName, url, listener); 
}

到這里，整個(gè)訂閱流程已經(jīng)結(jié)束，主要是看version=*如何判斷哪些服務(wù)實(shí)例可提供服務(wù)，再深入的就沒(méi)有了。

Nacos 作為注冊(cè)中心，查詢(xún)服務(wù)實(shí)例主要是根據(jù) serviceName(接口全路徑名)和group(分組)，這是因?yàn)镹acos的數(shù)據(jù)結(jié)構(gòu)本身主要的就是服務(wù)名+分組名。