ダボソースコードシリーズ5-コンシューマーサービスリファレンス

1.フロンティア

では ダボのソースコードのシリーズ4 -プロバイダ開始サービスの輸出 は、我々は、プロバイダの輸出サービスのプロセス全体を理解しています。サービスがエクスポートされた後、これらのサービスが適用され、サービスの導入です。ダボでリモートサービスを参照するには、直接サービス接続(レジストリを経由しない)とレジストリに基づくサービスの参照の2つの方法があります。実際のオンライン環境では、基本的にレジストリに基づいてサービスを参照する方法を使用します。説明この方法に関する分析

第二に、サービス参照の原則

ダボサービスリファレンスのタイミングは次のとおりです。

1. SpringコンテナがReferenceBeanのafterPropertiesSetメソッドを呼び出すときにサービスが参照されます(空腹の中国スタイル)

2. ReferenceBeanに対応するサービスが他のクラスに注入されるときの参照(レイジースタイル)

1つ目は空腹のスタイル、2つ目はレイジースタイルです。Dubboはデフォルトでレイジースタイルを使用します。レイジースタイルで空腹のスタイルを使用する必要がある場合は、<dubbo:reference init = "method">を構成できます。のinit属性

Dubboのデフォルト構成に従って分析し、分析プロセス全体ReferenceBeanのgetObjectメソッドから始まります。サービスが他のクラスに注入されると、Springは初めてgetObjectメソッドを呼び出し、このメソッドはサービス参照ロジックを実行します。

サービス参照の過程で、構成チェックと情報収集が必要です。収集された情報に基づいて、サービス参照の具体的な方法が決定されます。サービス参照には3つの方法があります。

1.参照ローカル(JVM)サービス

2.直接接続モードのリモートサービスを参照します(登録センターを経由せずに)

3.レジストリを介してリモートサービスを参照します

上記のサービスに関係なく、Invoker インスタンスキャリアを介して実行する必要があります。複数のレジストリと複数のサービスプロバイダーがある場合、この時点で一連のInvokerインスタンス(Invokerリスト)を取得します。この時点で、複数のInvokerがクラスター管理クラスClusterを介して1つのインスタンスにマージされます。マージされたInvokerインスタンスには、ローカルサービスまたはリモートサービスを呼び出す機能が既にありますが、現時点ではユーザーに公開できません。公開しないと、ユーザーのビジネスコードに侵入する可能性があります。このとき、フレームワークは、プロキシファクトリクラス(ProxyFactory)を介してサービスインターフェイスのプロキシクラスを生成し、プロキシクラスにInvokerロジックを呼び出させる必要もあります。これにより、Dubboフレームワークコードがビジネスコードに侵入するのを防ぎ、同時にフレームワークを使いやすくします。

3、サービス参照プロセス

次の図に示すように、最初にマクロの観点からサービス参照プロセスを理解しましょう。

サービス参照シーケンス図:

4、サービス参照ソースコード

サービス参照エントリは、SpringのFactoryBeanインターフェースで定義されているReferenceBeanのgetObjectメソッドです。ReferenceBeanはこのメソッドを実装します。コードは次のとおりです。

    // 1、ReferenceBean 的 getObject 方法,实现了 FactoryBean 的 getObject 接口
    @Override
    public Object getObject() {
        return get();
    }


    // 2、ReferenceConfig 的 get 方法
    public synchronized T get() {
        checkAndUpdateSubConfigs();

        if (destroyed) {
            throw new IllegalStateException("The invoker of ReferenceConfig(" + url + ") has already destroyed!");
        }
        if (ref == null) {
            // 接口代理不存在时,初始化创建代理类
            init();
        }
        return ref;
    }

4.1構成のチェックと処理

Dubboは、フレームワークの動作やパフォーマンスなどを調整および最適化するための多くの構成を提供します。Dubboがサービスを参照またはエクスポートするとき、最初にこれらの構成をチェックおよび処理して、構成が正しいことを確認します。構成分析チェックロジックは、ReferenceConfigのcheckAndUpdateSubConfigsメソッドにカプセル化されています。コードは次のとおりです。

    /**
     * This method should be called right after the creation of this class's instance, before any property in other config modules is used.
     * Check each config modules are created properly and override their properties if necessary.
     */
    // 1、ReferenceConfig 的 checkAndUpdateSubConfigs 方法
    public void checkAndUpdateSubConfigs() {
        // 检测接口名合法性
        if (StringUtils.isEmpty(interfaceName)) {
            throw new IllegalStateException("<dubbo:reference interface=\"\" /> interface not allow null!");
        }
        // 完成application、module、registries、monitor配置信息填充
        completeCompoundConfigs();
        // configCenter 配置信息设置
        startConfigCenter();
        // get consumer's global configuration
        // 检测 consumer 变量是否为空,为空则创建默认的 consumer
        checkDefault();
        this.refresh();
        if (getGeneric() == null && getConsumer() != null) {
            // 设置 generic
            setGeneric(getConsumer().getGeneric());
        }
        if (ProtocolUtils.isGeneric(getGeneric())) {
            // 检测是否为泛化接口
            interfaceClass = GenericService.class;
        } else {
            try {
                // 加载接口类
                interfaceClass = Class.forName(interfaceName, true, Thread.currentThread()
                        .getContextClassLoader());
            } catch (ClassNotFoundException e) {
                throw new IllegalStateException(e.getMessage(), e);
            }
            // 检查配置的方法名列表是否都在接口类中存在
            checkInterfaceAndMethods(interfaceClass, methods);
        }
        // 解析文件,获取接口名对应的配置信息赋值给 url 属性
        resolveFile();
        // 检查application配置信息
        checkApplication();
        // 检查 metadataReport配置信息
        checkMetadataReport();
    }


    // 2、ReferenceConfig 的 resolveFile 方法
    private void resolveFile() {
        // 从系统变量中获取与接口名对应的属性值
        String resolve = System.getProperty(interfaceName);
        String resolveFile = null;
        if (StringUtils.isEmpty(resolve)) {
            // 从系统属性中获取解析文件路径
            resolveFile = System.getProperty("dubbo.resolve.file");
            if (StringUtils.isEmpty(resolveFile)) {
                // 获取指定目录下的 dubbo-resolve.properties 配置文件
                File userResolveFile = new File(new File(System.getProperty("user.home")), "dubbo-resolve.properties");
                if (userResolveFile.exists()) {
                    resolveFile = userResolveFile.getAbsolutePath();
                }
            }
            if (resolveFile != null && resolveFile.length() > 0) {
                Properties properties = new Properties();
                try (FileInputStream fis = new FileInputStream(new File(resolveFile))) {
                    // 加载文件中的配置信息
                    properties.load(fis);
                } catch (IOException e) {
                    throw new IllegalStateException("Failed to load " + resolveFile + ", cause: " + e.getMessage(), e);
                }
                // 获取与接口名对应的配置
                resolve = properties.getProperty(interfaceName);
            }
        }
        if (resolve != null && resolve.length() > 0) {
            // 将接口名对应的配置信息 resolve 赋值给 url
            url = resolve;
            if (logger.isWarnEnabled()) {
                if (resolveFile != null) {
                    logger.warn("Using default dubbo resolve file " + resolveFile + " replace " + interfaceName + "" + resolve + " to p2p invoke remote service.");
                } else {
                    logger.warn("Using -D" + interfaceName + "=" + resolve + " to p2p invoke remote service.");
                }
            }
        }
    }

構成チェックは、主に次のチェックを実装します。

1)コンシューマー、アプリケーション、モニターなどの構成情報を確認します。consumerConfigインスタンスが存在しない場合は、システム変数またはdubbo.properties構成ファイルを使用してConsumerConfigのフィールドに入力します。

2)インターフェースとメソッドの合法性、メソッドはインターフェースで定義する必要があります

3)ファイルを解析し、インターフェイス名に対応する構成情報を取得して、ポイントツーポイント呼び出しに使用されるurl属性に割り当てます。

構成を確認した後、構成を処理する必要があります。処理ロジックは、ReferenceConfigのinitメソッドにカプセル化されています。コードは次のとおりです。

    private void init() {
        if (initialized) {
            // 已初始化直接返回
            return;
        }
        // 检查本地存根配置合法性,主要检查本地存根类是否实现了接口类,以及检查带有参数who类型的本地存根类构造函数是否是接口类类型
        checkStubAndLocal(interfaceClass);
        // mock检查
        checkMock(interfaceClass);
        Map<String, String> map = new HashMap<String, String>();

        // 添加side、dubbo version、pid等参数到map中
        map.put(SIDE_KEY, CONSUMER_SIDE);
        appendRuntimeParameters(map);

        if (!isGeneric()) {
            // 非泛化处理
            String revision = Version.getVersion(interfaceClass, version);
            if (revision != null && revision.length() > 0) {
                // revision 参数添加到map
                map.put(REVISION_KEY, revision);
            }

            // 获取方法列表,并将方法名以“,”拼接,methods 参数添加到map
            String[] methods = Wrapper.getWrapper(interfaceClass).getMethodNames();
            if (methods.length == 0) {
                logger.warn("No method found in service interface " + interfaceClass.getName());
                map.put(METHODS_KEY, ANY_VALUE);
            } else {
                map.put(METHODS_KEY, StringUtils.join(new HashSet<String>(Arrays.asList(methods)), COMMA_SEPARATOR));
            }
        }
        // interface 参数添加到map
        map.put(INTERFACE_KEY, interfaceName);
        // 将 ApplicationConfig、ConsumerConfig、ReferenceConfig 等对象的字段信息添加到 map 中
        appendParameters(map, metrics);
        appendParameters(map, application);
        appendParameters(map, module);
        // remove 'default.' prefix for configs from ConsumerConfig
        // appendParameters(map, consumer, Constants.DEFAULT_KEY);
        appendParameters(map, consumer);
        appendParameters(map, this);
        Map<String, Object> attributes = null;
        if (CollectionUtils.isNotEmpty(methods)) {
            attributes = new HashMap<String, Object>();
            for (MethodConfig methodConfig : methods) {
                // 添加 MethodConfig 对象的字段信息到 map 中,键 = 方法名.属性名
                appendParameters(map, methodConfig, methodConfig.getName());
                String retryKey = methodConfig.getName() + ".retry";
                if (map.containsKey(retryKey)) {
                    String retryValue = map.remove(retryKey);
                    if ("false".equals(retryValue)) {
                        // 添加重试次数配置 methodName.retries 到map,不允许重试时,值为0
                        map.put(methodConfig.getName() + ".retries", "0");
                    }
                }
                // 添加 MethodConfig 中的“属性”字段到 attributes, 例如 onreturn、onthrow、oninvoke 等
                attributes.put(methodConfig.getName(), convertMethodConfig2AsyncInfo(methodConfig));
            }
        }

        // 获取服务消费者ip地址
        String hostToRegistry = ConfigUtils.getSystemProperty(DUBBO_IP_TO_REGISTRY);
        if (StringUtils.isEmpty(hostToRegistry)) {
            hostToRegistry = NetUtils.getLocalHost();
        } else if (isInvalidLocalHost(hostToRegistry)) {
            throw new IllegalArgumentException("Specified invalid registry ip from property:" + DUBBO_IP_TO_REGISTRY + ", value:" + hostToRegistry);
        }
        // 添加服务消费者ip参数到map
        map.put(REGISTER_IP_KEY, hostToRegistry);

        // 创建接口代理类
        ref = createProxy(map);

        // 获取消费者服务名,例如:org.apache.dubbo.demo.DemoService
        String serviceKey = URL.buildKey(interfaceName, group, version);
        // 根据服务名,ReferenceConfig,代理类构建 ConsumerModel,并将 ConsumerModel 存入到 ApplicationModel 的消费者集合map中
        ApplicationModel.initConsumerModel(serviceKey, buildConsumerModel(serviceKey, attributes));
        initialized = true;
    }

構成処理は、主に次のタスクを完了します。

1)さまざまな構成情報を収集し、構成をマップに保存します

2)、主にサービスコンシューマIPの分析に使用されます

3)、インターフェイスプロキシクラスを作成します

4)サービス名に従ってConsumerModelを構築し、ApplicationModelのコンシューマーコレクションマップにConsumerModelを格納します。

4.2レファレンスサービス

構成情報を確認して処理したら、サービスを参照します。参照サービスのエントリはcreateProxyメソッドです。このメソッドは文字通りプロキシオブジェクトを作成しますが、実際にはこのようにはなりません。ソースコードに従ってみましょう。見つけるために。

    private T createProxy(Map<String, String> map) {
        if (shouldJvmRefer(map)) {
            // 本地服务引用
            // 生成本地引用 URL,协议为 injvm,ip 为 127.0.0.1,port 为 0
            URL url = new URL(LOCAL_PROTOCOL, LOCALHOST_VALUE, 0, interfaceClass.getName()).addParameters(map);
            // 先调用 AbstractProtocol 的 refer 方法,然后调用 InjvmProtocol 的 protocolBindingRefer 方法构建 InjvmInvoker 实例
            invoker = REF_PROTOCOL.refer(interfaceClass, url);
            if (logger.isInfoEnabled()) {
                logger.info("Using injvm service " + interfaceClass.getName());
            }
        } else {
            // 远程服务引用
            urls.clear(); // reference retry init will add url to urls, lead to OOM
            if (url != null && url.length() > 0) {
                // user specified URL, could be peer-to-peer address, or register center's address.
                // 配置了url,可能想使用点对点调用
                String[] us = SEMICOLON_SPLIT_PATTERN.split(url);
                if (us != null && us.length > 0) {
                    for (String u : us) {
                        URL url = URL.valueOf(u);
                        if (StringUtils.isEmpty(url.getPath())) {
                            // 设置接口全限定名为 url 路径,例如:org.apache.dubbo.demo.DemoService
                            url = url.setPath(interfaceName);
                        }
                        // 检测 url 协议是否为 registry,若是,表明要使用指定的注册中心
                        if (REGISTRY_PROTOCOL.equals(url.getProtocol())) {
                            // 将 map 转换为查询字符串,并作为 refer 参数的值添加到 url 中
                            urls.add(url.addParameterAndEncoded(REFER_KEY, StringUtils.toQueryString(map)));
                        } else {
                            // 合并 url,移除服务提供者的一些配置(这些配置来源于用户配置的 url 属性),
                            // 比如线程池相关配置。并保留服务提供者的部分配置,比如版本,group,时间戳等
                            // 最后将合并后的配置设置为 url 查询字符串中。
                            urls.add(ClusterUtils.mergeUrl(url, map));
                        }
                    }
                }
            } else { // assemble URL from register center's configuration
                // if protocols not injvm checkRegistry
                // protocols 非 injvm时,即
                if (!LOCAL_PROTOCOL.equalsIgnoreCase(getProtocol())){
                    // 检查 RegistryConfig 配置是否存在,并且将 registries 和 registryIds 转换为 RegistryConfig 对象
                    checkRegistry();
                    // 加载注册中心链接
                    List<URL> us = loadRegistries(false);
                    if (CollectionUtils.isNotEmpty(us)) {
                        for (URL u : us) {
                            // 加载 monitor 配置
                            URL monitorUrl = loadMonitor(u);
                            if (monitorUrl != null) {
                                // monitor 参数添加到map
                                map.put(MONITOR_KEY, URL.encode(monitorUrl.toFullString()));
                            }
                            urls.add(u.addParameterAndEncoded(REFER_KEY, StringUtils.toQueryString(map)));
                        }
                    }
                    if (urls.isEmpty()) {
                        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) {
                // 调用 RegistryProtocol 的 refer 构建 Invoker 实例
                invoker = REF_PROTOCOL.refer(interfaceClass, urls.get(0));
            } else {
                // 存在多个注册中心或者服务提供者
                List<Invoker<?>> invokers = new ArrayList<Invoker<?>>();
                URL registryURL = null;
                // 根据url获取所有的invoker
                for (URL url : urls) {
                    // 通过 refprotocol 调用 refer 构建 Invoker,refprotocol 会在运行时
                    // 根据 url 协议头加载指定的 Protocol 实例,并调用实例的 refer 方法
                    invokers.add(REF_PROTOCOL.refer(interfaceClass, url));
                    if (REGISTRY_PROTOCOL.equals(url.getProtocol())) {
                        // use last registry url
                        // 对于 url 协议是 registry 的,registryURL 使用最后的 url
                        registryURL = url;
                    }
                }
                if (registryURL != null) {
                    // registry url is available
                    // use RegistryAwareCluster only when register's CLUSTER is available
                    // 如果注册中心链接不为空,则将使用 RegistryAwareCluster
                    URL u = registryURL.addParameter(CLUSTER_KEY, RegistryAwareCluster.NAME);
                    // The invoker wrap relation would be: RegistryAwareClusterInvoker(StaticDirectory) -> FailoverClusterInvoker(RegistryDirectory, will execute route) -> Invoker
                    // 创建 StaticDirectory 实例,并由 Cluster 对多个 Invoker 进行合并
                    invoker = CLUSTER.join(new StaticDirectory(u, invokers));
                } else { // not a registry url, must be direct invoke.
                    invoker = CLUSTER.join(new StaticDirectory(invokers));
                }
            }
        }

        if (shouldCheck() && !invoker.isAvailable()) {
            // 检查invoker是否可用,即提供者服务是否可用
            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());
        }
        /**
         * @since 2.7.0
         * ServiceData Store
         * 保存消费者的Metadata数据
         */
        MetadataReportService metadataReportService = null;
        if ((metadataReportService = getMetadataReportService()) != null) {
            URL consumerURL = new URL(CONSUMER_PROTOCOL, map.remove(REGISTER_IP_KEY), 0, map.get(INTERFACE_KEY), map);
            metadataReportService.publishConsumer(consumerURL);
        }
        // create service proxy
        // 创建服务代理类
        return (T) PROXY_FACTORY.getProxy(invoker);
    }

createProxyメソッドは、次の関数を実装します。

1)ローカルサービス呼び出しの場合は、InjvmProtocolのreferメソッドを呼び出して、InjvmInvokerインスタンスを生成します。

2)urlパラメータが設定されている場合、すべてのURLはパスに設定されるか、参照またはマージされ、最終的にURLリストに追加されます。

3)urlパラメータが設定されていない場合は、registriesパラメータから登録センターリンクURLを読み込み、参照処理を設定してURLリストにURLを追加します。

4)urls要素が1の場合、RegistryProtocolのreferを直接呼び出して、Invokerインスタンスを構築します

5)urls要素が1より大きい場合、urlプロトコルヘッダーに従って指定されたプロトコルインスタンスをロードし、インスタンスのreferメソッドを呼び出してInvokerインスタンスを構築し、最後にクラスターを介して複数のInvokerをマージします

6)、消費者のメタデータデータを保存します

7)、ProxyFactoryのgetproxyメソッドを呼び出して、サービスプロキシクラスを作成します

4.2.1呼び出し元の作成

Invokerは、実行可能ファイルを表すDubboのコアモデルです。前の記事で述べたように、プロバイダー(サービスプロバイダー)では、Invokerを使用してサービスプロバイダークラスを呼び出します。コンシューマー(サービスコンシューマー)では、呼び出し元を使用してリモート呼び出しを実行します。Invokerは、Protocol実装クラスによって構築されます。多くのプロトコル実装クラスがあります。分析の例として最も一般的に使用される2つ、RegistryProtocolとDubboProtocolを取り上げましょう。

次の図に示すように、createProxyメソッドで一連の呼び出しロジックが実行された後。

呼び出しスタックをデバッグして調べ、呼び出しプロセス全体を確認します。createProxy(ReferenceConfig)-> ref(ProtocolListenerWrapper)-> ref(ProtocolFilterWrapper)-> ref(RegistryProtocol)、最後にRegistryProtocolのrefメソッドを呼び出します

RegistryProtocolのrefメソッドから始めましょう。コードは次のとおりです。

    public <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException {
        // 从 url 中获取 registry 参数值,不存在时默认为 dubbo,并设置为 url 协议头
        // url变化前:registry://192.168.1.235:2181/org.apache.dubbo.registry.RegistryService?registry=zookeeper&.....
        // url变化后:zookeeper://192.168.1.235:2181/org.apache.dubbo.registry.RegistryService?.....
        url = URLBuilder.from(url)
                .setProtocol(url.getParameter(REGISTRY_KEY, DEFAULT_REGISTRY))
                .removeParameter(REGISTRY_KEY)
                .build();
        // 由于测试使用的是 Zookeeper 注册中心,这里获取就是 zk 客户端
        Registry registry = registryFactory.getRegistry(url);
        if (RegistryService.class.equals(type)) {
            return proxyFactory.getInvoker((T) registry, type, url);
        }

        // group="a,b" or group="*"
        // 将 url 中的 refer 参数值对应的查询字符串转为 Map
        Map<String, String> qs = StringUtils.parseQueryString(url.getParameterAndDecoded(REFER_KEY));
        String group = qs.get(GROUP_KEY);
        if (group != null && group.length() > 0) {
            // 多个group时 或者 group 为 “*” 时,cluster 使用 MergeableCluster
            if ((COMMA_SPLIT_PATTERN.split(group)).length > 1 || "*".equals(group)) {
                // 通过 SPI 方法获取 MergeableCluster 实例,调用 doRefer 方法执行服务引用
                return doRefer(getMergeableCluster(), registry, type, url);
            }
        }
        // 调用 doRefer 方法执行服务引用
        return doRefer(cluster, registry, type, url);
    }



    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);
        // all attributes of REFER_KEY
        Map<String, String> parameters = new HashMap<String, String>(directory.getUrl().getParameters());
        // 构建服务消费者链接
        // 例如:consumer:///org.apache.dubbo.demo.DemoService?application=demo-consumer&check=false&dubbo=2.0.2&
        // interface=org.apache.dubbo.demo.DemoService&lazy=false&methods=sayHello&pid=18888&qos.port=33333&side=consumer&
        // sticky=false&timestamp=1572576516380
        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));
            // 注册服务消费者,在 consumers 目录下创建节点,节点数据:
            // consumer:///org.apache.dubbo.demo.DemoService?application=demo-consumer&category=consumers&
            // check=false&dubbo=2.0.2&interface=org.apache.dubbo.demo.DemoService&lazy=false&methods=sayHello&
            // pid=18888&qos.port=33333&side=consumer&sticky=false&timestamp=1572576516380
            registry.register(directory.getRegisteredConsumerUrl());
        }
        // 构建路由器链条,为服务调用路由使用
        directory.buildRouterChain(subscribeUrl);
        // 订阅 Zookeeper /dubbo/org.apache.dubbo.demo.DemoService 目录下的 providers、configurators、routers 节点信息
        directory.subscribe(subscribeUrl.addParameter(CATEGORY_KEY,
                PROVIDERS_CATEGORY + "," + CONFIGURATORS_CATEGORY + "," + ROUTERS_CATEGORY));

        // 一个注册中心可能有多个服务提供者 provider,因此这里需要将多个服务提供者合并为一个
        Invoker invoker = cluster.join(directory);
        // 向服务提供者与消费者注册表中注册服务消费者,即consumer
        ProviderConsumerRegTable.registerConsumer(invoker, url, subscribeUrl, directory);
        return invoker;
    }

上記のコードは主にいくつかの作業を完了します。

1)コンシューマーリンクのURLを作成し、そのURLをZookeeperに登録します。つまり、URLノードを作成します。

2)、RegistryDirectoryは、Zookeeperの現在のインターフェイスディレクトリにあるプロバイダー、コンフィギュレーター、ルーターのノード情報をサブスクライブします

3)クラスタークラスターは、複数のサービスプロバイダーの処理を1つのプロバイダーに結合します。つまり、呼び出し元を生成します。

4)サービスコンシューマーをサービスプロバイダーとコンシューマーレジストリに登録します。つまり、コンシューマーです。

Zookeeperに登録されているコンシューマーURLは、次の図に示すとおりです。

次の図に示すように、org.apache.dubbo.demo.DemoServiceインターフェイスに対応するプロデューサーURLとコンシューマーURLがZookeeperに登録されます。

4.2.2エージェントの作成

呼び出し元が作成されたら、次に行うことは、サービスインターフェイスのプロキシオブジェクトを生成することです。これにより、リモート呼び出しを行うことができます。プロキシオブジェクトによって生成されるエントリポイントは、AbstractProxyFactoryのgetProxyメソッドあり、コードは次のとおりです。

    // 1、AbstractProxyFactory 的 getProxy 方法
    @Override
    public <T> T getProxy(Invoker<T> invoker, boolean generic) throws RpcException {
        Class<?>[] interfaces = null;
        // 获取url中interfaces配置的接口列表
        String config = invoker.getUrl().getParameter(INTERFACES);
        if (config != null && config.length() > 0) {
            String[] types = COMMA_SPLIT_PATTERN.split(config);
            if (types != null && types.length > 0) {
                interfaces = new Class<?>[types.length + 2];
                // 设置服务接口类和 EchoService.class 到 interfaces 中
                interfaces[0] = invoker.getInterface();
                interfaces[1] = EchoService.class;
                for (int i = 0; i < types.length; i++) {
                    // TODO can we load successfully for a different classloader?.
                    // 反射加载接口类
                    interfaces[i + 2] = ReflectUtils.forName(types[i]);
                }
            }
        }
        if (interfaces == null) {
            interfaces = new Class<?>[]{invoker.getInterface(), EchoService.class};
        }

        // 为 http 和 hessian 协议提供泛化调用支持
        if (!GenericService.class.isAssignableFrom(invoker.getInterface()) && generic) {
            int len = interfaces.length;
            Class<?>[] temp = interfaces;
            interfaces = new Class<?>[len + 1];
            System.arraycopy(temp, 0, interfaces, 0, len);
            interfaces[len] = com.alibaba.dubbo.rpc.service.GenericService.class;
        }

        // 调用重载方法,具体实现代理类的getProxy方法,
        // dubbo中默认使用的是 Javassist 代理,故这里调用的是 JavassistProxyFactory 的 getProxy 方法
        return getProxy(invoker, interfaces);
    }


    // 2、JavassistProxyFactory 的 getProxy 方法
    @Override
    @SuppressWarnings("unchecked")
    public <T> T getProxy(Invoker<T> invoker, Class<?>[] interfaces) {
        // 首先是通过 Proxy 的 getProxy 方法获取 Proxy 子类,然后创建 InvokerInvocationHandler 对象,并将该对象传给 newInstance 生成 Proxy 实例。
        // InvokerInvocationHandler 实现自 JDK 的 InvocationHandler 接口,具体的用途是拦截接口类调用
        return (T) Proxy.getProxy(interfaces).newInstance(new InvokerInvocationHandler(invoker));
    }


    // 3、Proxy 的 getProxy 方法
    /**
     * Get proxy.
     *
     * @param ics interface class array.
     * @return Proxy instance.
     */
    public static Proxy getProxy(Class<?>... ics) {
        // 调用重载方法
        return getProxy(ClassUtils.getClassLoader(Proxy.class), ics);
    }

    /**
     * Get proxy.
     *
     * @param cl  class loader.
     * @param ics interface class array.
     * @return Proxy instance.
     */
    public static Proxy getProxy(ClassLoader cl, Class<?>... ics) {
        // 代理接口上线不能超过 65535 个
        if (ics.length > MAX_PROXY_COUNT) {
            throw new IllegalArgumentException("interface limit exceeded");
        }

        StringBuilder sb = new StringBuilder();
        // 遍历接口列表
        for (int i = 0; i < ics.length; i++) {
            String itf = ics[i].getName();
            if (!ics[i].isInterface()) {
                throw new RuntimeException(itf + " is not a interface.");
            }

            Class<?> tmp = null;
            try {
                // 重新加载接口类
                tmp = Class.forName(itf, false, cl);
            } catch (ClassNotFoundException e) {
            }

            if (tmp != ics[i]) {
                throw new IllegalArgumentException(ics[i] + " is not visible from class loader");
            }

            // 以";"拼接所有的接口全限定名(带上包路径的接口)
            sb.append(itf).append(';');
        }

        // use interface class name list as key.
        String key = sb.toString();

        // get cache by class loader.
        final Map<String, Object> cache;
        synchronized (PROXY_CACHE_MAP) {
            cache = PROXY_CACHE_MAP.computeIfAbsent(cl, k -> new HashMap<>());
        }

        Proxy proxy = null;
        synchronized (cache) {
            do {
                // 缓存中获取 Reference<Proxy> 实例
                Object value = cache.get(key);
                if (value instanceof Reference<?>) {
                    proxy = (Proxy) ((Reference<?>) value).get();
                    if (proxy != null) {
                        return proxy;
                    }
                }

                // 并发锁控制,只有一个线程可以操作
                if (value == PENDING_GENERATION_MARKER) {
                    try {
                        // 其他线程等待
                        cache.wait();
                    } catch (InterruptedException e) {
                    }
                } else {
                    // 放置标志位到缓存中,并跳出 while 循环进行后续操作
                    cache.put(key, PENDING_GENERATION_MARKER);
                    break;
                }
            }
            while (true);
        }

        // 代理类计数器自增
        long id = PROXY_CLASS_COUNTER.getAndIncrement();
        String pkg = null;
        ClassGenerator ccp = null, ccm = null;
        try {
            // 创建 ClassGenerator 对象
            ccp = ClassGenerator.newInstance(cl);

            Set<String> worked = new HashSet<>();
            List<Method> methods = new ArrayList<>();

            for (int i = 0; i < ics.length; i++) {
                if (!Modifier.isPublic(ics[i].getModifiers())) {
                    // 接口访问级别非public
                    // 获取接口包名
                    String npkg = ics[i].getPackage().getName();
                    if (pkg == null) {
                        pkg = npkg;
                    } else {
                        if (!pkg.equals(npkg)) {
                            // 非public级别的接口必须在同一包路径下
                            throw new IllegalArgumentException("non-public interfaces from different packages");
                        }
                    }
                }
                ccp.addInterface(ics[i]);

                // 遍历接口方法
                for (Method method : ics[i].getMethods()) {
                    // 获取方法描述,可理解为方法签名
                    String desc = ReflectUtils.getDesc(method);
                    // 如果方法描述字符串已在 worked 中,则忽略。考虑这种情况,
                    // A 接口和 B 接口中包含一个完全相同的方法
                    if (worked.contains(desc)) {
                        continue;
                    }
                    if (ics[i].isInterface() && Modifier.isStatic(method.getModifiers())) {
                        // static 访问级别的方法忽略
                        continue;
                    }
                    worked.add(desc);

                    int ix = methods.size();
                    // 获取方法返回值类型
                    Class<?> rt = method.getReturnType();
                    // 获取方法参数列表
                    Class<?>[] pts = method.getParameterTypes();

                    // 生成 Object[] args = new Object[1...N]
                    StringBuilder code = new StringBuilder("Object[] args = new Object[").append(pts.length).append("];");
                    for (int j = 0; j < pts.length; j++) {
                        // 生成 args[0...N] = ($w)$1...N;
                        code.append(" args[").append(j).append("] = ($w)$").append(j + 1).append(";");
                    }
                    // 生成 InvokerHandler 接口的 invoker 方法调用语句,如下:
                    // Object ret = handler.invoke(this, methods[1...N], args);
                    code.append(" Object ret = handler.invoke(this, methods[").append(ix).append("], args);");
                    // 返回值不为 void
                    if (!Void.TYPE.equals(rt)) {
                        // 生成返回语句,形如 return (java.lang.String) ret;
                        code.append(" return ").append(asArgument(rt, "ret")).append(";");
                    }

                    methods.add(method);
                    // 添加方法名、访问控制符、方法参数列表、方法返回值代码等信息到 ClassGenerator 中
                    ccp.addMethod(method.getName(), method.getModifiers(), rt, pts, method.getExceptionTypes(), code.toString());
                }
            }

            if (pkg == null) {
                // pkg 默认是 org.apache.dubbo.common.bytecode
                pkg = PACKAGE_NAME;
            }

            // create ProxyInstance class.
            // 创建接口代理类名称:pkg + ".proxy" + id,例如: org.apache.dubbo.common.bytecode.proxy0
            String pcn = pkg + ".proxy" + id;
            ccp.setClassName(pcn);
            ccp.addField("public static java.lang.reflect.Method[] methods;");
            // 生成 private java.lang.reflect.InvocationHandler handler;  语句
            ccp.addField("private " + InvocationHandler.class.getName() + " handler;");
            // 为接口代理类添加带有 InvocationHandler 参数的构造方法,比如:
            // porxy0(java.lang.reflect.InvocationHandler arg0) {
            //     handler=$1;
            // }
            ccp.addConstructor(Modifier.PUBLIC, new Class<?>[]{InvocationHandler.class}, new Class<?>[0], "handler=$1;");
            // 为接口代理类添加默认构造方法
            ccp.addDefaultConstructor();
            // 创建接口代理类,为服务接口(org.apache.dubbo.demo.DemoService)生成代理类
            Class<?> clazz = ccp.toClass();
            clazz.getField("methods").set(null, methods.toArray(new Method[0]));
            // 在 E 盘ccp目录下输出接口代理类
            ccp.getClassPool().get(pcn).debugWriteFile("E:\\ccp\\");

            // create Proxy class.
            // 创建 Proxy 子类名称,比如 Proxy1,Proxy2 等,例如:org.apache.dubbo.common.bytecode.Proxy0
            String fcn = Proxy.class.getName() + id;
            ccm = ClassGenerator.newInstance(cl);
            ccm.setClassName(fcn);
            ccm.addDefaultConstructor();
            ccm.setSuperClass(Proxy.class);
            // 为 Proxy 的抽象方法 newInstance 生成实现代码,形如:
            // public Object newInstance(java.lang.reflect.InvocationHandler h) {
            //     return org.apache.dubbo.demo.proxy0($1);
            // }
            ccm.addMethod("public Object newInstance(" + InvocationHandler.class.getName() + " h){ return new " + pcn + "($1); }");
            // 生成 Proxy 实现类, 为org.apache.dubbo.common.bytecode.Proxy 抽象类生成子类,主要是实现 Proxy 类的抽象
            Class<?> pc = ccm.toClass();
            // 在 E 盘ccm目录下输出 Proxy 实现类
            ccm.getClassPool().get(fcn).debugWriteFile("E:\\ccm\\");
            // 通过反射创建 Proxy 实例
            proxy = (Proxy) pc.newInstance();
        } catch (RuntimeException e) {
            throw e;
        } catch (Exception e) {
            throw new RuntimeException(e.getMessage(), e);
        } finally {
            // release ClassGenerator
            // 释放资源
            if (ccp != null) {
                ccp.release();
            }
            if (ccm != null) {
                ccm.release();
            }
            synchronized (cache) {
                if (proxy == null) {
                    cache.remove(key);
                } else {
                    // 放入缓存
                    cache.put(key, new WeakReference<Proxy>(proxy));
                }
                // 唤醒其他等待线程
                cache.notifyAll();
            }
        }
        return proxy;
    }




上記の主なロジックは、ccpとccmの役割は何ですか?何が別々に生成されますか?次のように:

1)、ccpはサービスインターフェイスのプロキシクラスを生成するために使用されます。たとえば、DemoServiceインターフェイスがあり、このインターフェイスプロキシクラスはccpによって生成されます。

2)、ccmは、主にProxyクラスの抽象メソッドを実装するために、org.apache.dubbo.common.bytecode.Proxy抽象クラスのサブクラスを生成するために使用されます。

ccp.getClassPool()。get(pcn).debugWriteFile( "E:\\ ccp \\"); ccm.getClassPool()。get(fcn).debugWriteFile( "E:\\ ccm)をソースコードに追加します 。\\ "); これらの2つの文は、ccpとccmによって生成されたプロキシクラスを次のように出力します。

1)以下に示すように、ccpによって生成されたproxy0.classプロキシクラス。

proxy0.classコードは次のとおりです。

package org.apache.dubbo.common.bytecode;

import com.alibaba.dubbo.rpc.service.EchoService;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import org.apache.dubbo.demo.DemoService;

public class proxy0
  implements ClassGenerator.DC, EchoService, DemoService
{
  public static Method[] methods;
  private InvocationHandler handler;

  public String sayHello(String paramString)
  {
    Object[] arrayOfObject = new Object[1];
    arrayOfObject[0] = paramString;
    Object localObject = this.handler.invoke(this, methods[0], arrayOfObject);
    return (String)localObject;
  }

  public Object $echo(Object paramObject)
  {
    Object[] arrayOfObject = new Object[1];
    arrayOfObject[0] = paramObject;
    Object localObject = this.handler.invoke(this, methods[1], arrayOfObject);
    return (Object)localObject;
  }

  public proxy0()
  {
  }

  public proxy0(InvocationHandler paramInvocationHandler)
  {
    this.handler = paramInvocationHandler;
  }
}

2)以下に示すように、ccmによって生成されたProxy0.classのプロキシクラス。

Proxy0.classコードは次のとおりです。

package org.apache.dubbo.common.bytecode;

import java.lang.reflect.InvocationHandler;

public class Proxy0 extends Proxy
  implements ClassGenerator.DC
{
  public Object newInstance(InvocationHandler paramInvocationHandler)
  {
    return new proxy0(paramInvocationHandler);
  }
}

 

この時点で、エージェントの作成についても説明します。プロセス全体を理解するのは難しいので、辛抱強く注意深く見れば常にやりがいがあります。

コンシューマーのサービス参照はすべてここで解析されます。サービス参照プロセスのフローチャートとシーケンス図を振り返り、ソースコードプロセスと比較すると、一貫性があることがわかります。

総括する

この記事では詳細に分析 中のサービス参照のプロセス全体構成の検出、ロードレジストリリンク、URLの構築と登録、実行者の作成、プロキシ作成、飼育係のノード情報にRegistryDirectoryサブスクリプション(プロバイダ、コンフィギュレータ、ルータ)を含め、消費者の起動プロセスをし、など。記事にはたくさんの内容が含まれているので、読むのに十分な忍耐力が必要です。エラーがあれば訂正してください。ディレクトリとクラスターの役割はここでは説明されておらず、フォローアップで個別に説明されます。

参照:

https://dubbo.apache.org/zh-cn/docs/source_code_guide/refer-service.html

おすすめ

転載: blog.csdn.net/ywlmsm1224811/article/details/102832885