Dubbo 服務(wù)引用詳解

上一篇我們介紹了暴露服務(wù),這一篇我們來(lái)說(shuō)引用服務(wù)。首先我們看下應(yīng)用層引用服務(wù)所做的

    @Bean
    public ReferenceBean<LogService> logService(){
        ReferenceBean<LogService> referenceBean=new ReferenceBean<>();
        referenceBean.setInterface(LogService.class);
        return referenceBean;
    }

在使用的地方,聲明了一個(gè)ReferenceBean,然后指明了要引用的類型,就可以了,他內(nèi)部其實(shí)封裝了大量的內(nèi)容,我們開(kāi)始吧。ReferenceBean也是一個(gè)InitializingBean,所以看他的聲明周期方法是afterPropertiesSet,基本上和ServiceBean是一致的,同時(shí)他也是FactoryBean類的實(shí)例,所以他的getObject方法也是在生命周期過(guò)程中被主動(dòng)調(diào)用到的,他里面引用的是get()方法,他的實(shí)現(xiàn)也比較簡(jiǎn)單

  public synchronized T get() {
        if (destroyed){
            throw new IllegalStateException("Already destroyed!");
        }
        if (ref == null) {
            init();
        }
        return ref;
    }

那么看來(lái)最核心的是init(),他里面做的就是裝配Dubbo所依賴的屬性,最后我們著眼于

ref = createProxy(map);

基于上面提供的屬性放到map中,根據(jù)這個(gè)map創(chuàng)建一個(gè)代理對(duì)象作為ref。

private T createProxy(Map<String, String> map) {
        URL tmpUrl = new URL("temp", "localhost", 0, map);
        final boolean isJvmRefer;
        if (isInjvm() == null) {
            if (url != null && url.length() > 0) { //指定URL的情況下,不做本地引用
                isJvmRefer = false;
            } else if (InjvmProtocol.getInjvmProtocol().isInjvmRefer(tmpUrl)) {
                //默認(rèn)情況下如果本地有服務(wù)暴露,則引用本地服務(wù).
                isJvmRefer = true;
            } else {
                isJvmRefer = false;
            }
        } else {
            isJvmRefer = isInjvm().booleanValue();
        }
        
        if (isJvmRefer) {
            URL url = new URL(Constants.LOCAL_PROTOCOL, NetUtils.LOCALHOST, 0, interfaceClass.getName()).addParameters(map);
            invoker = refprotocol.refer(interfaceClass, url);
            if (logger.isInfoEnabled()) {
                logger.info("Using injvm service " + interfaceClass.getName());
            }
        } else {
            if (url != null && url.length() > 0) { // 用戶指定URL,指定的URL可能是對(duì)點(diǎn)對(duì)直連地址,也可能是注冊(cè)中心URL
                String[] us = Constants.SEMICOLON_SPLIT_PATTERN.split(url);
                if (us != null && us.length > 0) {
                    for (String u : us) {
                        URL url = URL.valueOf(u);
                        if (url.getPath() == null || url.getPath().length() == 0) {
                            url = url.setPath(interfaceName);
                        }
                        if (Constants.REGISTRY_PROTOCOL.equals(url.getProtocol())) {
                            urls.add(url.addParameterAndEncoded(Constants.REFER_KEY, StringUtils.toQueryString(map)));
                        } else {
                            urls.add(ClusterUtils.mergeUrl(url, map));
                        }
                    }
                }
            } else { // 通過(guò)注冊(cè)中心配置拼裝URL
                List<URL> us = loadRegistries(false);
                if (us != null && us.size() > 0) {
                    for (URL u : us) {
                        URL monitorUrl = loadMonitor(u);
                        if (monitorUrl != null) {
                            map.put(Constants.MONITOR_KEY, URL.encode(monitorUrl.toFullString()));
                        }
                        urls.add(u.addParameterAndEncoded(Constants.REFER_KEY, StringUtils.toQueryString(map)));
                    }
                }
                if (urls == null || urls.size() == 0) {
                    throw new IllegalStateException("No such any registry to reference " + interfaceName  + " on the consumer " + NetUtils.getLocalHost() + " use dubbo version " + Version.getVersion() + ", please config <dubbo:registry address=\"...\" /> to your spring config.");
                }
            }

            if (urls.size() == 1) {
                invoker = refprotocol.refer(interfaceClass, urls.get(0));
            } else {
                List<Invoker<?>> invokers = new ArrayList<Invoker<?>>();
                URL registryURL = null;
                for (URL url : urls) {
                    invokers.add(refprotocol.refer(interfaceClass, url));
                    if (Constants.REGISTRY_PROTOCOL.equals(url.getProtocol())) {
                        registryURL = url; // 用了最后一個(gè)registry url
                    }
                }
                if (registryURL != null) { // 有 注冊(cè)中心協(xié)議的URL
                    // 對(duì)有注冊(cè)中心的Cluster 只用 AvailableCluster
                    URL u = registryURL.addParameter(Constants.CLUSTER_KEY, AvailableCluster.NAME); 
                    invoker = cluster.join(new StaticDirectory(u, invokers));
                }  else { // 不是 注冊(cè)中心的URL
                    invoker = cluster.join(new StaticDirectory(invokers));
                }
            }
        }

        Boolean c = check;
        if (c == null && consumer != null) {
            c = consumer.isCheck();
        }
        if (c == null) {
            c = true; // default true
        }
        if (c && ! invoker.isAvailable()) {
            throw new IllegalStateException("Failed to check the status of the service " + interfaceName + ". No provider available for the service " + (group == null ? "" : group + "/") + interfaceName + (version == null ? "" : ":" + version) + " from the url " + invoker.getUrl() + " to the consumer " + NetUtils.getLocalHost() + " use dubbo version " + Version.getVersion());
        }
        if (logger.isInfoEnabled()) {
            logger.info("Refer dubbo service " + interfaceClass.getName() + " from url " + invoker.getUrl());
        }
        // 創(chuàng)建服務(wù)代理
        return (T) proxyFactory.getProxy(invoker);
    }

我們從List<URL> us = loadRegistries(false)開(kāi)始說(shuō)起,從注冊(cè)中心獲取注冊(cè)的URL,例如registry://127.0.0.1:2181/com.alibaba.dubbo.registry.RegistryService?application=user&dubbo=2.5.3&pid=2836&registry=zookeeper&timestamp=1525835334588。這是原始的鏈接,隨后增加REFER_KEY,他的內(nèi)容就是傳入的數(shù)據(jù)組成的map。拼接之后是encode后的內(nèi)容,為了方便觀察,我們?cè)谖闹辛谐龅氖莇ecode后的內(nèi)容registry://127.0.0.1:2181/com.alibaba.dubbo.registry.RegistryService?application=user&dubbo=2.5.3&pid=2836&refer=application=user&default.check=false&default.retries=0&default.timeout=30000&default.version=LATEST&dubbo=2.5.3&interface=com.linyang.test.service.LogService&methods=modify,create&pid=2836&revision=1.0-SNAPSHOT&side=consumer&timestamp=1525835306361&registry=zookeeper&timestamp=1525835306402.URL拼裝完成后,我們就進(jìn)入到我們的主角refprotocol.refer(interfaceClass, url),開(kāi)始自己的引用邏輯。如果大家還有印象,就知道我們r(jià)efprotocol的處理是經(jīng)過(guò)了ProtocolFilterWrapper,ProtocolListenerWrapper,這兩個(gè)類里的處理,和export是相同的,見(jiàn)到registry直接忽略,最后進(jìn)入了RegistryProtocol中,為啥是這個(gè)協(xié)議,不是其他的協(xié)議,可以看下我們之前的文章,里面會(huì)有答案。RegistryProtocol中的refer方法

public <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException {
        url = url.setProtocol(url.getParameter(Constants.REGISTRY_KEY, Constants.DEFAULT_REGISTRY)).removeParameter(Constants.REGISTRY_KEY);
        Registry registry = registryFactory.getRegistry(url);
        if (RegistryService.class.equals(type)) {
            return proxyFactory.getInvoker((T) registry, type, url);
        }

        // group="a,b" or group="*"
        Map<String, String> qs = StringUtils.parseQueryString(url.getParameterAndDecoded(Constants.REFER_KEY));
        String group = qs.get(Constants.GROUP_KEY);
        if (group != null && group.length() > 0 ) {
            if ( ( Constants.COMMA_SPLIT_PATTERN.split( group ) ).length > 1
                    || "*".equals( group ) ) {
                return doRefer( getMergeableCluster(), registry, type, url );
            }
        }
        return doRefer(cluster, registry, type, url);
    }

url.setProtocol(url.getParameter(Constants.REGISTRY_KEY, Constants.DEFAULT_REGISTRY)).removeParameter(Constants.REGISTRY_KEY)
第一件事就是替換協(xié)議,過(guò)來(lái)的時(shí)候的協(xié)議是registry協(xié)議,我們重新設(shè)置協(xié)議,變成注冊(cè)中心的協(xié)議,例如我們例子中使用的zookeeper.替換協(xié)議后,刪除了key為registry的內(nèi)容。替換協(xié)議的目的是為了下一步,從registryFactory挑選合適的注冊(cè)器,我們使用的是zk的協(xié)議,那么注冊(cè)器就是zk的注冊(cè)器。我們需要的數(shù)據(jù)都有了,我們就可以進(jìn)行真正的引用邏輯了doRefer了

private <T> Invoker<T> doRefer(Cluster cluster, Registry registry, Class<T> type, URL url) {
        RegistryDirectory<T> directory = new RegistryDirectory<T>(type, url);
        directory.setRegistry(registry);
        directory.setProtocol(protocol);
        URL subscribeUrl = new URL(Constants.CONSUMER_PROTOCOL, NetUtils.getLocalHost(), 0, type.getName(), directory.getUrl().getParameters());
        if (! Constants.ANY_VALUE.equals(url.getServiceInterface())
                && url.getParameter(Constants.REGISTER_KEY, true)) {
            registry.register(subscribeUrl.addParameters(Constants.CATEGORY_KEY, Constants.CONSUMERS_CATEGORY,
                    Constants.CHECK_KEY, String.valueOf(false)));
        }
        directory.subscribe(subscribeUrl.addParameter(Constants.CATEGORY_KEY, 
                Constants.PROVIDERS_CATEGORY 
                + "," + Constants.CONFIGURATORS_CATEGORY 
                + "," + Constants.ROUTERS_CATEGORY));
        return cluster.join(directory);
    }

首先我們想一個(gè)問(wèn)題,這個(gè)cluster是怎么來(lái)的?答案在我的上一篇文章依賴注入里面。隨后我們看下subscribeUrl長(zhǎng)啥樣。consumer://172.16.197.200/com.linyang.test.service.LogService?application=user&category=providers,configurators,routers&default.check=false&default.retries=0&default.timeout=30000&default.version=LATEST&dubbo=2.5.3&interface=com.linyang.test.service.LogService&methods=modify,create&pid=2836&revision=1.0-SNAPSHOT&side=consumer&timestamp=1525835306361。隨后進(jìn)行了訂閱registry.subscribe(url, this);首先這個(gè)URL的內(nèi)容就是上面那個(gè),這是this就是指RegistryDirectory的實(shí)例,也就是說(shuō)他也是NotifyListener的實(shí)例。我們知道這里的registry是ZookeeperRegistry,所以他的subscribe方法

  @Override
    public void subscribe(URL url, NotifyListener listener) {
        super.subscribe(url, listener);
        removeFailedSubscribed(url, listener);
        try {
            // 向服務(wù)器端發(fā)送訂閱請(qǐng)求
            doSubscribe(url, listener);
        } catch (Exception e) {
            Throwable t = e;

            List<URL> urls = getCacheUrls(url);
            if (urls != null && urls.size() > 0) {
                notify(url, listener, urls);
                logger.error("Failed to subscribe " + url + ", Using cached list: " + urls + " from cache file: " + getUrl().getParameter(Constants.FILE_KEY, System.getProperty("user.home") + "/dubbo-registry-" + url.getHost() + ".cache") + ", cause: " + t.getMessage(), t);
            } else {
                // 如果開(kāi)啟了啟動(dòng)時(shí)檢測(cè),則直接拋出異常
                boolean check = getUrl().getParameter(Constants.CHECK_KEY, true)
                        && url.getParameter(Constants.CHECK_KEY, true);
                boolean skipFailback = t instanceof SkipFailbackWrapperException;
                if (check || skipFailback) {
                    if(skipFailback) {
                        t = t.getCause();
                    }
                    throw new IllegalStateException("Failed to subscribe " + url + ", cause: " + t.getMessage(), t);
                } else {
                    logger.error("Failed to subscribe " + url + ", waiting for retry, cause: " + t.getMessage(), t);
                }
            }

            // 將失敗的訂閱請(qǐng)求記錄到失敗列表,定時(shí)重試
            addFailedSubscribed(url, listener);
        }
    }

super.subscribe(url, listener);往本地存儲(chǔ)映射關(guān)系,key是url,value是一個(gè)Set<Listener>。最關(guān)鍵的無(wú)疑是doSubscribe(url, listener);,下面是ZookeeperRegistry的doSubscribe的部分實(shí)現(xiàn)

                List<URL> urls = new ArrayList<URL>();
                for (String path : toCategoriesPath(url)) {
                    ConcurrentMap<NotifyListener, ChildListener> listeners = zkListeners.get(url);
                    if (listeners == null) {
                        zkListeners.putIfAbsent(url, new ConcurrentHashMap<NotifyListener, ChildListener>());
                        listeners = zkListeners.get(url);
                    }
                    ChildListener zkListener = listeners.get(listener);
                    if (zkListener == null) {
                        listeners.putIfAbsent(listener, new ChildListener() {
                            public void childChanged(String parentPath, List<String> currentChilds) {
                                ZookeeperRegistry.this.notify(url, listener, toUrlsWithEmpty(url, parentPath, currentChilds));
                            }
                        });
                        zkListener = listeners.get(listener);
                    }
                    zkClient.create(path, false);
                    List<String> children = zkClient.addChildListener(path, zkListener);
                    if (children != null) {
                        urls.addAll(toUrlsWithEmpty(url, path, children));
                    }
                }
                notify(url, listener, urls);

ChildListener是對(duì)關(guān)注的路徑的有他下一級(jí)的節(jié)點(diǎn)的增減,就會(huì)觸發(fā)的監(jiān)聽(tīng)器。所以我們看到listeners.putIfAbsent里放置的是一個(gè)匿名類,他里面的實(shí)現(xiàn)就是notify。也就是說(shuō)當(dāng)關(guān)注的路徑的下增減節(jié)點(diǎn),就會(huì)觸發(fā)回調(diào),然后通過(guò)notify方法,進(jìn)行業(yè)務(wù)數(shù)據(jù)的變更邏輯。當(dāng)我們,都注冊(cè)好了之后,自己觸發(fā)了notify,他的具體的邏輯在doNotify里面。

protected void notify(URL url, NotifyListener listener, List<URL> urls) {
        if (url == null) {
            throw new IllegalArgumentException("notify url == null");
        }
        if (listener == null) {
            throw new IllegalArgumentException("notify listener == null");
        }
        if ((urls == null || urls.size() == 0) 
                && ! Constants.ANY_VALUE.equals(url.getServiceInterface())) {
            logger.warn("Ignore empty notify urls for subscribe url " + url);
            return;
        }
        if (logger.isInfoEnabled()) {
            logger.info("Notify urls for subscribe url " + url + ", urls: " + urls);
        }
        Map<String, List<URL>> result = new HashMap<String, List<URL>>();
        for (URL u : urls) {
            if (UrlUtils.isMatch(url, u)) {
                String category = u.getParameter(Constants.CATEGORY_KEY, Constants.DEFAULT_CATEGORY);
                List<URL> categoryList = result.get(category);
                if (categoryList == null) {
                    categoryList = new ArrayList<URL>();
                    result.put(category, categoryList);
                }
                categoryList.add(u);
            }
        }
        if (result.size() == 0) {
            return;
        }
        Map<String, List<URL>> categoryNotified = notified.get(url);
        if (categoryNotified == null) {
            notified.putIfAbsent(url, new ConcurrentHashMap<String, List<URL>>());
            categoryNotified = notified.get(url);
        }
        for (Map.Entry<String, List<URL>> entry : result.entrySet()) {
            String category = entry.getKey();
            List<URL> categoryList = entry.getValue();
            categoryNotified.put(category, categoryList);
            saveProperties(url);
            listener.notify(categoryList);
        }
    }

忽略里面的所有的細(xì)節(jié),我們看下主干就是listener.notify。這里的listener就是我們之前在接口中傳入的RegistryDirectory的實(shí)例對(duì)象,所以調(diào)用的就是他的notify方法。

public synchronized void notify(List<URL> urls) {
        List<URL> invokerUrls = new ArrayList<URL>();
        List<URL> routerUrls = new ArrayList<URL>();
        List<URL> configuratorUrls = new ArrayList<URL>();
        for (URL url : urls) {
            String protocol = url.getProtocol();
            String category = url.getParameter(Constants.CATEGORY_KEY, Constants.DEFAULT_CATEGORY);
            if (Constants.ROUTERS_CATEGORY.equals(category) 
                    || Constants.ROUTE_PROTOCOL.equals(protocol)) {
                routerUrls.add(url);
            } else if (Constants.CONFIGURATORS_CATEGORY.equals(category) 
                    || Constants.OVERRIDE_PROTOCOL.equals(protocol)) {
                configuratorUrls.add(url);
            } else if (Constants.PROVIDERS_CATEGORY.equals(category)) {
                invokerUrls.add(url);
            } else {
                logger.warn("Unsupported category " + category + " in notified url: " + url + " from registry " + getUrl().getAddress() + " to consumer " + NetUtils.getLocalHost());
            }
        }
        // configurators 
        if (configuratorUrls != null && configuratorUrls.size() >0 ){
            this.configurators = toConfigurators(configuratorUrls);
        }
        // routers
        if (routerUrls != null && routerUrls.size() >0 ){
            List<Router> routers = toRouters(routerUrls);
            if(routers != null){ // null - do nothing
                setRouters(routers);
            }
        }
        List<Configurator> localConfigurators = this.configurators; // local reference
        // 合并override參數(shù)
        this.overrideDirectoryUrl = directoryUrl;
        if (localConfigurators != null && localConfigurators.size() > 0) {
            for (Configurator configurator : localConfigurators) {
                this.overrideDirectoryUrl = configurator.configure(overrideDirectoryUrl);
            }
        }
        // providers
        refreshInvoker(invokerUrls);
    }

這里面的操作就是根據(jù)傳入的url就行創(chuàng)建或者更新invoker.重點(diǎn)放在 refreshInvoker(invokerUrls),我們看一下傳入的urldubbo://172.16.197.200:20880/com.linyang.test.service.LogService?anyhost=true&application=log&default.proxy=javassist&default.retries=0&default.timeout=30000&default.version=LATEST&dubbo=2.5.3&interface=com.linyang.test.service.LogService&methods=modify,create&pid=2747&side=provider&threads=100&timestamp=1525835283678這個(gè)就是provider的信息,后面會(huì)根據(jù)這個(gè)provider的url創(chuàng)建出來(lái)一個(gè)代理,給consumer端的項(xiàng)目使用。下面我們看看refreshInvoker。

 private void refreshInvoker(List<URL> invokerUrls){
        if (invokerUrls != null && invokerUrls.size() == 1 && invokerUrls.get(0) != null
                && Constants.EMPTY_PROTOCOL.equals(invokerUrls.get(0).getProtocol())) {
            this.forbidden = true; // 禁止訪問(wèn)
            this.methodInvokerMap = null; // 置空列表
            destroyAllInvokers(); // 關(guān)閉所有Invoker
        } else {
            this.forbidden = false; // 允許訪問(wèn)
            Map<String, Invoker<T>> oldUrlInvokerMap = this.urlInvokerMap; // local reference
            if (invokerUrls.size() == 0 && this.cachedInvokerUrls != null){
                invokerUrls.addAll(this.cachedInvokerUrls);
            } else {
                this.cachedInvokerUrls = new HashSet<URL>();
                this.cachedInvokerUrls.addAll(invokerUrls);//緩存invokerUrls列表,便于交叉對(duì)比
            }
            if (invokerUrls.size() ==0 ){
                return;
            }
            Map<String, Invoker<T>> newUrlInvokerMap = toInvokers(invokerUrls) ;// 將URL列表轉(zhuǎn)成Invoker列表
            Map<String, List<Invoker<T>>> newMethodInvokerMap = toMethodInvokers(newUrlInvokerMap); // 換方法名映射Invoker列表
            // state change
            //如果計(jì)算錯(cuò)誤,則不進(jìn)行處理.
            if (newUrlInvokerMap == null || newUrlInvokerMap.size() == 0 ){
                logger.error(new IllegalStateException("urls to invokers error .invokerUrls.size :"+invokerUrls.size() + ", invoker.size :0. urls :"+invokerUrls.toString()));
                return ;
            }
            this.methodInvokerMap = multiGroup ? toMergeMethodInvokerMap(newMethodInvokerMap) : newMethodInvokerMap;
            this.urlInvokerMap = newUrlInvokerMap;
            try{
                destroyUnusedInvokers(oldUrlInvokerMap,newUrlInvokerMap); // 關(guān)閉未使用的Invoker
            }catch (Exception e) {
                logger.warn("destroyUnusedInvokers error. ", e);
            }
        }
    }

其中有一個(gè)toInvokers的方法,就是講傳入的invokerUrls轉(zhuǎn)成具體的invoker,也就是providerurl轉(zhuǎn)成invoker的過(guò)程。

 private Map<String, Invoker<T>> toInvokers(List<URL> urls) {
        Map<String, Invoker<T>> newUrlInvokerMap = new HashMap<String, Invoker<T>>();
        if(urls == null || urls.size() == 0){
            return newUrlInvokerMap;
        }
        Set<String> keys = new HashSet<String>();
        String queryProtocols = this.queryMap.get(Constants.PROTOCOL_KEY);
        for (URL providerUrl : urls) {
            //如果reference端配置了protocol,則只選擇匹配的protocol
            if (queryProtocols != null && queryProtocols.length() >0) {
                boolean accept = false;
                String[] acceptProtocols = queryProtocols.split(",");
                for (String acceptProtocol : acceptProtocols) {
                    if (providerUrl.getProtocol().equals(acceptProtocol)) {
                        accept = true;
                        break;
                    }
                }
                if (!accept) {
                    continue;
                }
            }
            if (Constants.EMPTY_PROTOCOL.equals(providerUrl.getProtocol())) {
                continue;
            }
            if (! ExtensionLoader.getExtensionLoader(Protocol.class).hasExtension(providerUrl.getProtocol())) {
                logger.error(new IllegalStateException("Unsupported protocol " + providerUrl.getProtocol() + " in notified url: " + providerUrl + " from registry " + getUrl().getAddress() + " to consumer " + NetUtils.getLocalHost() 
                        + ", supported protocol: "+ExtensionLoader.getExtensionLoader(Protocol.class).getSupportedExtensions()));
                continue;
            }
            URL url = mergeUrl(providerUrl);
            
            String key = url.toFullString(); // URL參數(shù)是排序的
            if (keys.contains(key)) { // 重復(fù)URL
                continue;
            }
            keys.add(key);
            // 緩存key為沒(méi)有合并消費(fèi)端參數(shù)的URL,不管消費(fèi)端如何合并參數(shù),如果服務(wù)端URL發(fā)生變化,則重新refer
            Map<String, Invoker<T>> localUrlInvokerMap = this.urlInvokerMap; // local reference
            Invoker<T> invoker = localUrlInvokerMap == null ? null : localUrlInvokerMap.get(key);
            if (invoker == null) { // 緩存中沒(méi)有,重新refer
                try {
                    boolean enabled = true;
                    if (url.hasParameter(Constants.DISABLED_KEY)) {
                        enabled = ! url.getParameter(Constants.DISABLED_KEY, false);
                    } else {
                        enabled = url.getParameter(Constants.ENABLED_KEY, true);
                    }
                    if (enabled) {
                        invoker = new InvokerDelegete<T>(protocol.refer(serviceType, url), url, providerUrl);
                    }
                } catch (Throwable t) {
                    logger.error("Failed to refer invoker for interface:"+serviceType+",url:("+url+")" + t.getMessage(), t);
                }
                if (invoker != null) { // 將新的引用放入緩存
                    newUrlInvokerMap.put(key, invoker);
                }
            }else {
                newUrlInvokerMap.put(key, invoker);
            }
        }
        keys.clear();
        return newUrlInvokerMap;
    }

劃重點(diǎn)!protocol.refer(serviceType, url)因?yàn)槲覀儌鬟^(guò)來(lái)的協(xié)議是dubbo,所以使用的最后處理的就是DubboProtocol,當(dāng)然少不了的是warpper類的包裹,這個(gè)和export是一致的,可以自己進(jìn)行回顧。下面是DubboProtocl的refer

public <T> Invoker<T> refer(Class<T> serviceType, URL url) throws RpcException {
        // create rpc invoker.
        DubboInvoker<T> invoker = new DubboInvoker<T>(serviceType, url, getClients(url), invokers);
        invokers.add(invoker);
        return invoker;
    }

會(huì)根據(jù)url來(lái)獲得一個(gè)clients

 private ExchangeClient[] getClients(URL url){
        //是否共享連接
        boolean service_share_connect = false;
        int connections = url.getParameter(Constants.CONNECTIONS_KEY, 0);
        //如果connections不配置,則共享連接,否則每服務(wù)每連接
        if (connections == 0){
            service_share_connect = true;
            connections = 1;
        }
        
        ExchangeClient[] clients = new ExchangeClient[connections];
        for (int i = 0; i < clients.length; i++) {
            if (service_share_connect){
                clients[i] = getSharedClient(url);
            } else {
                clients[i] = initClient(url);
            }
        }
        return clients;
    }

不管是getSharedClient(url)還是initClient(url)最終都會(huì)調(diào)用initClient(url),所以我們看看他是怎么初始化的。

private ExchangeClient initClient(URL url) {
        
        // client type setting.
        String str = url.getParameter(Constants.CLIENT_KEY, url.getParameter(Constants.SERVER_KEY, Constants.DEFAULT_REMOTING_CLIENT));

        String version = url.getParameter(Constants.DUBBO_VERSION_KEY);
        boolean compatible = (version != null && version.startsWith("1.0."));
        url = url.addParameter(Constants.CODEC_KEY, Version.isCompatibleVersion() && compatible ? COMPATIBLE_CODEC_NAME : DubboCodec.NAME);
        //默認(rèn)開(kāi)啟heartbeat
        url = url.addParameterIfAbsent(Constants.HEARTBEAT_KEY, String.valueOf(Constants.DEFAULT_HEARTBEAT));
        
        // BIO存在嚴(yán)重性能問(wèn)題,暫時(shí)不允許使用
        if (str != null && str.length() > 0 && ! ExtensionLoader.getExtensionLoader(Transporter.class).hasExtension(str)) {
            throw new RpcException("Unsupported client type: " + str + "," +
                    " supported client type is " + StringUtils.join(ExtensionLoader.getExtensionLoader(Transporter.class).getSupportedExtensions(), " "));
        }
        
        ExchangeClient client ;
        try {
            //設(shè)置連接應(yīng)該是lazy的 
            if (url.getParameter(Constants.LAZY_CONNECT_KEY, false)){
                client = new LazyConnectExchangeClient(url ,requestHandler);
            } else {
                client = Exchangers.connect(url ,requestHandler);
            }
        } catch (RemotingException e) {
            throw new RpcException("Fail to create remoting client for service(" + url
                    + "): " + e.getMessage(), e);
        }
        return client;
    }

出現(xiàn)了我們的Exchanges層client = Exchangers.connect(url ,requestHandler)也就是說(shuō)對(duì)于網(wǎng)絡(luò)的封裝都是通過(guò)Exchangers作為入口,剩下的代碼基本就和export端的代碼相同了,只不過(guò),consumer端的操作一直就是連接上服務(wù)端的ip,端口,發(fā)送消息罷了。后面就是getExchanger(url).connect(url, handler)getExchanger(url)獲得的是HeaderExchanger,調(diào)用他的connect方法,他的內(nèi)部是通過(guò)Transporters來(lái)連接的

 public ExchangeClient connect(URL url, ExchangeHandler handler) throws RemotingException {
        return new HeaderExchangeClient(Transporters.connect(url, new DecodeHandler(new HeaderExchangeHandler(handler))));
    }

那么他的操作也和exchange是相同的getTransporter().connect(url, handler);
getTransporter默認(rèn)使用的是NettyTransporter,所以調(diào)用的NettyTransporter的connect方法進(jìn)行的具體的鏈接,他的內(nèi)部創(chuàng)建了一個(gè)NettyClient

public Client connect(URL url, ChannelHandler listener) throws RemotingException {
        return new NettyClient(url, listener);
    }

返回DubboProtocol的refer方法,將創(chuàng)建的NettyClient封裝成DubboInvoker返回。

toInvokers要說(shuō)的就結(jié)束了,我們看下他的下一個(gè)方法。toInvokers是將URL列表轉(zhuǎn)成url和對(duì)應(yīng)的invoker的映射關(guān)系,就是一個(gè)map。toMethodInvokers是將toInvokers的返回值作為入?yún)?返回方法名稱作為key,value是可以被執(zhí)行的invoker的列表,這里說(shuō)的可以被執(zhí)行,不是指全部,而是只經(jīng)過(guò)route過(guò)濾后的。我們看下toMethodInvokers

private Map<String, List<Invoker<T>>> toMethodInvokers(Map<String, Invoker<T>> invokersMap) {
        Map<String, List<Invoker<T>>> newMethodInvokerMap = new HashMap<String, List<Invoker<T>>>();
        // 按提供者URL所聲明的methods分類,兼容注冊(cè)中心執(zhí)行路由過(guò)濾掉的methods
        List<Invoker<T>> invokersList = new ArrayList<Invoker<T>>();
        if (invokersMap != null && invokersMap.size() > 0) {
            for (Invoker<T> invoker : invokersMap.values()) {
                String parameter = invoker.getUrl().getParameter(Constants.METHODS_KEY);
                if (parameter != null && parameter.length() > 0) {
                    String[] methods = Constants.COMMA_SPLIT_PATTERN.split(parameter);
                    if (methods != null && methods.length > 0) {
                        for (String method : methods) {
                            if (method != null && method.length() > 0 
                                    && ! Constants.ANY_VALUE.equals(method)) {
                                List<Invoker<T>> methodInvokers = newMethodInvokerMap.get(method);
                                if (methodInvokers == null) {
                                    methodInvokers = new ArrayList<Invoker<T>>();
                                    newMethodInvokerMap.put(method, methodInvokers);
                                }
                                methodInvokers.add(invoker);
                            }
                        }
                    }
                }
                invokersList.add(invoker);
            }
        }
        newMethodInvokerMap.put(Constants.ANY_VALUE, invokersList);
        if (serviceMethods != null && serviceMethods.length > 0) {
            for (String method : serviceMethods) {
                List<Invoker<T>> methodInvokers = newMethodInvokerMap.get(method);
                if (methodInvokers == null || methodInvokers.size() == 0) {
                    methodInvokers = invokersList;
                }
                newMethodInvokerMap.put(method, route(methodInvokers, method));
            }
        }
        // sort and unmodifiable
        for (String method : new HashSet<String>(newMethodInvokerMap.keySet())) {
            List<Invoker<T>> methodInvokers = newMethodInvokerMap.get(method);
            Collections.sort(methodInvokers, InvokerComparator.getComparator());
            newMethodInvokerMap.put(method, Collections.unmodifiableList(methodInvokers));
        }
        return Collections.unmodifiableMap(newMethodInvokerMap);
    }

從invoker中的url獲取到provider提供的方法,根據(jù)方法名稱作為key,可以為此方法提供遠(yuǎn)程調(diào)用的invoker的列表作為value,將上面的映射放入到methodInvokers,然后有一個(gè)invokersList是一個(gè)調(diào)用者的列表,可以看做是傳入的invokersMap中的values,他也是newMethodInvokerMap中的value,key呢就是*.填充完整個(gè)map后。目前為止是全量的數(shù)據(jù),我們前面說(shuō)的過(guò)濾呢,請(qǐng)看這一行newMethodInvokerMap.put(method, route(methodInvokers, method));
里面的這個(gè)route方法就是所謂的過(guò)濾。我們?cè)敿?xì)的看下

 private List<Invoker<T>> route(List<Invoker<T>> invokers, String method) {
        Invocation invocation = new RpcInvocation(method, new Class<?>[0], new Object[0]);
        List<Router> routers = getRouters(); 
        if (routers != null) {
            for (Router router : routers) {
                if (router.getUrl() != null && ! router.getUrl().getParameter(Constants.RUNTIME_KEY, true)) {
                    invokers = router.route(invokers, getConsumerUrl(), invocation);
                }
            }
        }
        return invokers;
    }

getRouters可以看做尋找所有的invoker的過(guò)濾器,隨后遍歷這些過(guò)濾器,將傳入的所有的invokers進(jìn)行過(guò)濾router.route,過(guò)濾完了在返回過(guò)濾后的invokers.Router分為兩種,一種是條件ConditionRouter,表示滿足某種條件才是我們需要的Router,另外一種是ScriptRouter,通過(guò)具體的表達(dá)式判斷,應(yīng)用不廣泛。

到目前為止Registry.doRefer中的directory.subscribe已經(jīng)執(zhí)行完了,后面就是cluster.join(directory)返回一個(gè)invoker.我們?cè)倩氐阶畛醯牡胤絉eferenceConfig中的createProxy中refprotocol.refer(interfaceClass, url)創(chuàng)建的invokers,可以暴露成一個(gè)invoker給上層調(diào)用,憑借的就是invoker = cluster.join(new StaticDirectory(invokers)),隨后將這個(gè)集成的這個(gè)invoker進(jìn)行代理,生產(chǎn)代理對(duì)象proxyFactory.getProxy(invoker),這個(gè)代理對(duì)象就是ref,也就是我們需要使用的接口的代理對(duì)象。

到目前為止,服務(wù)引用,基本上就說(shuō)完了。我們?cè)倩ㄉ倭康臅r(shí)間,說(shuō)一下具體使用這個(gè)代理對(duì)象,發(fā)起遠(yuǎn)程調(diào)用的過(guò)程。現(xiàn)在我們有了一個(gè)動(dòng)態(tài)代理產(chǎn)生的對(duì)象。

JDK的動(dòng)態(tài)代理,創(chuàng)建代理的時(shí)候

 public <T> T getProxy(Invoker<T> invoker, Class<?>[] interfaces) {
        return (T) Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(), interfaces, new InvokerInvocationHandler(invoker));
    }

Handler是InvokerInvocationHandler的實(shí)例,并且他的構(gòu)造函數(shù)需要傳入invoker。所以當(dāng)應(yīng)用被代理的類的接口的時(shí)候,實(shí)際上回走到InvokerInvocationHandler.invoke,這個(gè)invoker是MockClusterInvoker的實(shí)例,他里面做了真正的invoker和directory的封裝,從directory中獲取到url,從里面搜索要調(diào)用的方法是否是mock的類型,如果不是,就直接發(fā)起調(diào)用,如果是的話,就進(jìn)行mock,這個(gè)設(shè)計(jì)主要是為了熔斷。當(dāng)被調(diào)用的服務(wù)已經(jīng)不堪重負(fù)了,在調(diào)用也處理不過(guò)來(lái),就不調(diào)用了,使用策略進(jìn)行mock。當(dāng)然,這不是我們關(guān)注的重點(diǎn)。真正的invoker是FailoverClusterInvoker的實(shí)例,所以看下他的invoke方法。

    public Result invoke(final Invocation invocation) throws RpcException {

        checkWheatherDestoried();

        LoadBalance loadbalance;
        
        List<Invoker<T>> invokers = list(invocation);
        if (invokers != null && invokers.size() > 0) {
            loadbalance = ExtensionLoader.getExtensionLoader(LoadBalance.class).getExtension(invokers.get(0).getUrl()
                    .getMethodParameter(invocation.getMethodName(),Constants.LOADBALANCE_KEY, Constants.DEFAULT_LOADBALANCE));
        } else {
            loadbalance = ExtensionLoader.getExtensionLoader(LoadBalance.class).getExtension(Constants.DEFAULT_LOADBALANCE);
        }
        RpcUtils.attachInvocationIdIfAsync(getUrl(), invocation);
        return doInvoke(invocation, invokers, loadbalance);
    }

首先我們看下list(invocation)做了什么

protected  List<Invoker<T>> list(Invocation invocation) throws RpcException {
        List<Invoker<T>> invokers = directory.list(invocation);
        return invokers;
    }

將這個(gè)地址簿中所有可以提供調(diào)用的invoker都列出來(lái)了。不管我們有多少個(gè)invoker,最后我們使用的肯定只有一個(gè),我們通過(guò)負(fù)載均衡LoadBalance選出。如果是多個(gè),我們通過(guò)URL中的信息得到具體的負(fù)載均衡器,否則使用默認(rèn)的,默認(rèn)的是random,也就是隨機(jī)。我們所有的組件都有了,我們看下下一個(gè)方法doInvoke(invocation, invokers, loadbalance)

public Result doInvoke(Invocation invocation, final List<Invoker<T>> invokers, LoadBalance loadbalance) throws RpcException {
        List<Invoker<T>> copyinvokers = invokers;
        checkInvokers(copyinvokers, invocation);
        int len = getUrl().getMethodParameter(invocation.getMethodName(), Constants.RETRIES_KEY, Constants.DEFAULT_RETRIES) + 1;
        if (len <= 0) {
            len = 1;
        }
        // retry loop.
        RpcException le = null; // last exception.
        List<Invoker<T>> invoked = new ArrayList<Invoker<T>>(copyinvokers.size()); // invoked invokers.
        Set<String> providers = new HashSet<String>(len);
        for (int i = 0; i < len; i++) {
            //重試時(shí),進(jìn)行重新選擇,避免重試時(shí)invoker列表已發(fā)生變化.
            //注意:如果列表發(fā)生了變化,那么invoked判斷會(huì)失效,因?yàn)閕nvoker示例已經(jīng)改變
            if (i > 0) {
                checkWheatherDestoried();
                copyinvokers = list(invocation);
                //重新檢查一下
                checkInvokers(copyinvokers, invocation);
            }
            Invoker<T> invoker = select(loadbalance, invocation, copyinvokers, invoked);
            invoked.add(invoker);
            RpcContext.getContext().setInvokers((List)invoked);
            try {
                Result result = invoker.invoke(invocation);
                if (le != null && logger.isWarnEnabled()) {
                    logger.warn("Although retry the method " + invocation.getMethodName()
                            + " in the service " + getInterface().getName()
                            + " was successful by the provider " + invoker.getUrl().getAddress()
                            + ", but there have been failed providers " + providers 
                            + " (" + providers.size() + "/" + copyinvokers.size()
                            + ") from the registry " + directory.getUrl().getAddress()
                            + " on the consumer " + NetUtils.getLocalHost()
                            + " using the dubbo version " + Version.getVersion() + ". Last error is: "
                            + le.getMessage(), le);
                }
                return result;
            } catch (RpcException e) {
                if (e.isBiz()) { // biz exception.
                    throw e;
                }
                le = e;
            } catch (Throwable e) {
                le = new RpcException(e.getMessage(), e);
            } finally {
                providers.add(invoker.getUrl().getAddress());
            }
        }
        throw new RpcException(le != null ? le.getCode() : 0, "Failed to invoke the method "
                + invocation.getMethodName() + " in the service " + getInterface().getName() 
                + ". Tried " + len + " times of the providers " + providers 
                + " (" + providers.size() + "/" + copyinvokers.size() 
                + ") from the registry " + directory.getUrl().getAddress()
                + " on the consumer " + NetUtils.getLocalHost() + " using the dubbo version "
                + Version.getVersion() + ". Last error is: "
                + (le != null ? le.getMessage() : ""), le != null && le.getCause() != null ? le.getCause() : le);
    }

我們最為關(guān)注的就是Invoker<T> invoker = select(loadbalance, invocation, copyinvokers, invoked);看看選擇出一個(gè)具體的invoker來(lái)進(jìn)行后面的流程的。

/**
     * 使用loadbalance選擇invoker.</br>
     * a)先lb選擇,如果在selected列表中 或者 不可用且做檢驗(yàn)時(shí),進(jìn)入下一步(重選),否則直接返回</br>
     * b)重選驗(yàn)證規(guī)則:selected > available .保證重選出的結(jié)果盡量不在select中,并且是可用的 
     * 
     * @param availablecheck 如果設(shè)置true,在選擇的時(shí)候先選invoker.available == true
     * @param selected 已選過(guò)的invoker.注意:輸入保證不重復(fù)
     * 
     */
    protected Invoker<T> select(LoadBalance loadbalance, Invocation invocation, List<Invoker<T>> invokers, List<Invoker<T>> selected) throws RpcException {
        if (invokers == null || invokers.size() == 0)
            return null;
        String methodName = invocation == null ? "" : invocation.getMethodName();
        
        boolean sticky = invokers.get(0).getUrl().getMethodParameter(methodName,Constants.CLUSTER_STICKY_KEY, Constants.DEFAULT_CLUSTER_STICKY) ;
        {
            //ignore overloaded method
            if ( stickyInvoker != null && !invokers.contains(stickyInvoker) ){
                stickyInvoker = null;
            }
            //ignore cucurrent problem
            if (sticky && stickyInvoker != null && (selected == null || !selected.contains(stickyInvoker))){
                if (availablecheck && stickyInvoker.isAvailable()){
                    return stickyInvoker;
                }
            }
        }
        Invoker<T> invoker = doselect(loadbalance, invocation, invokers, selected);
        
        if (sticky){
            stickyInvoker = invoker;
        }
        return invoker;
    }

這個(gè)方法的主體就是Invoker<T> invoker = doselect(loadbalance, invocation, invokers, selected);

private Invoker<T> doselect(LoadBalance loadbalance, Invocation invocation, List<Invoker<T>> invokers, List<Invoker<T>> selected) throws RpcException {
        if (invokers == null || invokers.size() == 0)
            return null;
        if (invokers.size() == 1)
            return invokers.get(0);
        // 如果只有兩個(gè)invoker,退化成輪循
        if (invokers.size() == 2 && selected != null && selected.size() > 0) {
            return selected.get(0) == invokers.get(0) ? invokers.get(1) : invokers.get(0);
        }
        Invoker<T> invoker = loadbalance.select(invokers, getUrl(), invocation);
        
        //如果 selected中包含(優(yōu)先判斷) 或者 不可用&&availablecheck=true 則重試.
        if( (selected != null && selected.contains(invoker))
                ||(!invoker.isAvailable() && getUrl()!=null && availablecheck)){
            try{
                Invoker<T> rinvoker = reselect(loadbalance, invocation, invokers, selected, availablecheck);
                if(rinvoker != null){
                    invoker =  rinvoker;
                }else{
                    //看下第一次選的位置,如果不是最后,選+1位置.
                    int index = invokers.indexOf(invoker);
                    try{
                        //最后在避免碰撞
                        invoker = index <invokers.size()-1?invokers.get(index+1) :invoker;
                    }catch (Exception e) {
                        logger.warn(e.getMessage()+" may because invokers list dynamic change, ignore.",e);
                    }
                }
            }catch (Throwable t){
                logger.error("clustor relselect fail reason is :"+t.getMessage() +" if can not slove ,you can set cluster.availablecheck=false in url",t);
            }
        }
        return invoker;
    } 

這個(gè)方法中的關(guān)鍵點(diǎn)是Invoker<T> invoker = loadbalance.select(invokers, getUrl(), invocation);通過(guò)具體的負(fù)載均衡的算法得到一個(gè)invoker,最后調(diào)用invoker.invoke(invocation)發(fā)起遠(yuǎn)程請(qǐng)求。

測(cè)試源碼

測(cè)試代碼源碼點(diǎn)擊獲取

END

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容

  • 學(xué)習(xí)了博贊學(xué)習(xí)技巧第二章高效學(xué)習(xí)的障礙,我才發(fā)現(xiàn)我就是一個(gè)勉強(qiáng)的學(xué)習(xí)者,總是為推遲學(xué)習(xí)找借口。我做了這一章節(jié)思維導(dǎo)...
    談?wù)?/span>閱讀 188評(píng)論 0 1
  • 一直遇到好人,讓我覺(jué)得自己活著非常幸運(yùn)。無(wú)論是養(yǎng)育我的父母,還是我成長(zhǎng)路上遇見(jiàn)的朋友。 “沒(méi)有人會(huì)害你,這樣好好地...
    冷咲閱讀 410評(píng)論 0 0
  • 今日陰歷臘月初三,天氣晴。 2016年的最后一天,明天就是元旦了,下班路上等紅綠燈的時(shí)候,街邊小店...
    Echo的樹(shù)洞閱讀 78評(píng)論 0 0
  • 在這個(gè)萬(wàn)物復(fù)蘇的季節(jié),你的心也跟著蘇醒過(guò)來(lái),醒來(lái)的心在躍躍欲試,要去尋找那份心動(dòng)的感覺(jué)。 素素陪老爸回老家,給親戚...
    曼陀羅_書(shū)簡(jiǎn)愛(ài)閱讀 541評(píng)論 4 3