dubbo源码解析四十五服务引用过程

50次阅读

共计 18945 个字符,预计需要花费 48 分钟才能阅读完成。

dubbo 服务引用过程

目标:从源码的角度分析服务引用过程。

前言

前面服务暴露过程的文章讲解到,服务引用有两种方式,一种就是直连,也就是直接指定服务的地址来进行引用,这种方式更多的时候被用来做服务测试,不建议在生产环境使用这样的方法,因为直连不适合服务治理,dubbo 本身就是一个服务治理的框架,提供了很多服务治理的功能。所以更多的时候,我们都不会选择绕过注册中心,而是通过注册中心的方式来进行服务引用。

服务引用过程

大致可以分为三个步骤:

  1. 配置加载
  2. 创建 invoker
  3. 创建服务接口代理类

引用起点

dubbo 服务的引用起点就类似于 bean 加载。dubbo 中有一个类 ReferenceBean,它实现了 FactoryBean 接口,继承了 ReferenceConfig,所以 ReferenceBean 作为 dubbo 中能生产对象的工厂 Bean,而我们要引用服务,也就是要有一个该服务的对象。

服务引用被触发有两个时机:

  • Spring 容器调用 ReferenceBean 的 afterPropertiesSet 方法时引用服务(饿汉式)
  • 在 ReferenceBean 对应的服务被注入到其他类中时引用(懒汉式)

默认情况下,Dubbo 使用懒汉式引用服务。如果需要使用饿汉式,可通过配置 <dubbo:reference> 的 init 属性开启。

因为 ReferenceBean 实现了 FactoryBean 接口的 getObject() 方法,所以在加载 bean 的时候,会调用 ReferenceBean 的 getObject() 方法

ReferenceBean 的 getObject()
public Object getObject() {return get();
}

这个 get 方法是 ReferenceConfig 的 get() 方法

ReferenceConfig 的 get()
public synchronized T get() {
    // 检查并且更新配置
    checkAndUpdateSubConfigs();

    // 如果被销毁,则抛出异常
    if (destroyed) {throw new IllegalStateException("The invoker of ReferenceConfig(" + url + ") has already destroyed!");
    }
    // 检测 代理对象 ref 是否为空,为空则通过 init 方法创建
    if (ref == null) {
        // 用于处理配置,以及调用 createProxy 生成代理类
        init();}
    return ref;
}

关于 checkAndUpdateSubConfigs() 方法前一篇文章已经讲了,我就不再讲述。这里关注 init 方法。该方法也是处理各类配置的开始。

配置加载(1)

ReferenceConfig 的 init()
private void init() {
    // 如果已经初始化过,则结束
    if (initialized) {return;}
    // 设置初始化标志为 true
    initialized = true;
    // 本地存根合法性校验
    checkStubAndLocal(interfaceClass);
    // mock 合法性校验
    checkMock(interfaceClass);
    // 用来存放配置
    Map<String, String> map = new HashMap<String, String>();

    // 存放这是消费者侧
    map.put(Constants.SIDE_KEY, Constants.CONSUMER_SIDE);

    // 添加 协议版本、发布版本,时间戳 等信息到 map 中
    appendRuntimeParameters(map);
    // 如果是泛化调用
    if (!isGeneric()) {
        // 获得版本号
        String revision = Version.getVersion(interfaceClass, version);
        if (revision != null && revision.length() > 0) {
            // 设置版本号
            map.put(Constants.REVISION_KEY, revision);
        }

        // 获得所有方法
        String[] methods = Wrapper.getWrapper(interfaceClass).getMethodNames();
        if (methods.length == 0) {logger.warn("No method found in service interface" + interfaceClass.getName());
            map.put(Constants.METHODS_KEY, Constants.ANY_VALUE);
        } else {
            // 把所有方法签名拼接起来放入 map
            map.put(Constants.METHODS_KEY, StringUtils.join(new HashSet<String>(Arrays.asList(methods)), Constants.COMMA_SEPARATOR));
        }
    }
    // 加入服务接口名称
    map.put(Constants.INTERFACE_KEY, interfaceName);
    // 添加 metrics、application、module、consumer、protocol 的所有信息到 map
    appendParameters(map, metrics);
    appendParameters(map, application);
    appendParameters(map, module);
    appendParameters(map, consumer, Constants.DEFAULT_KEY);
    appendParameters(map, this);
    Map<String, Object> attributes = null;
    if (CollectionUtils.isNotEmpty(methods)) {attributes = new HashMap<String, Object>();
        // 遍历方法配置
        for (MethodConfig methodConfig : methods) {
            // 把方法配置加入 map
            appendParameters(map, methodConfig, methodConfig.getName());
            // 生成重试的配置 key
            String retryKey = methodConfig.getName() + ".retry";
            // 如果 map 中已经有该配置,则移除该配置
            if (map.containsKey(retryKey)) {String retryValue = map.remove(retryKey);
                // 如果配置为 false,也就是不重试,则设置重试次数为 0 次
                if ("false".equals(retryValue)) {map.put(methodConfig.getName() + ".retries", "0");
                }
            }
            // 设置异步配置
            attributes.put(methodConfig.getName(), convertMethodConfig2AyncInfo(methodConfig));
        }
    }

    // 获取服务消费者 ip 地址
    String hostToRegistry = ConfigUtils.getSystemProperty(Constants.DUBBO_IP_TO_REGISTRY);
    // 如果为空,则获取本地 ip
    if (StringUtils.isEmpty(hostToRegistry)) {hostToRegistry = NetUtils.getLocalHost();
    }
    // 设置消费者 ip
    map.put(Constants.REGISTER_IP_KEY, hostToRegistry);

    // 创建代理对象
    ref = createProxy(map);

    // 生产服务 key
    String serviceKey = URL.buildKey(interfaceName, group, version);
    // 根据服务名,ReferenceConfig,代理类构建 ConsumerModel,// 并将 ConsumerModel 存入到 ApplicationModel 中
    ApplicationModel.initConsumerModel(serviceKey, buildConsumerModel(serviceKey, attributes));
}

该方法大致分为以下几个步骤:

  1. 检测本地存根和 mock 合法性。
  2. 添加协议版本、发布版本,时间戳、metrics、application、module、consumer、protocol 等的所有信息到 map 中
  3. 单独处理方法配置,设置重试次数配置以及设置该方法对异步配置信息。
  4. 添加消费者 ip 地址到 map
  5. 创建代理对象
  6. 生成 ConsumerModel 存入到 ApplicationModel 中

在这里处理配置到逻辑比较清晰。下面就是看 ReferenceConfig 的 createProxy() 方法。

创建 invoker

ReferenceConfig 的 createProxy()
private T createProxy(Map<String, String> map) {
    // 根据配置检查是否为本地调用
    if (shouldJvmRefer(map)) {
        // 生成 url,protocol 使用的是 injvm
        URL url = new URL(Constants.LOCAL_PROTOCOL, Constants.LOCALHOST_VALUE, 0, interfaceClass.getName()).addParameters(map);
        // 利用 InjvmProtocol 的 refer 方法生成 InjvmInvoker 实例
        invoker = refprotocol.refer(interfaceClass, url);
        if (logger.isInfoEnabled()) {logger.info("Using injvm service" + interfaceClass.getName());
        }
    } else {
        // 如果 url 不为空,则用户可能想进行直连来调用
        if (url != null && url.length() > 0) { // user specified URL, could be peer-to-peer address, or register center's address.
            // 当需要配置多个 url 时,可用分号进行分割,这里会进行切分
            String[] us = Constants.SEMICOLON_SPLIT_PATTERN.split(url);
            // 遍历所有的 url
            if (us != null && us.length > 0) {for (String u : us) {URL url = URL.valueOf(u);
                    if (StringUtils.isEmpty(url.getPath())) {
                        // 设置接口全限定名为 url 路径
                        url = url.setPath(interfaceName);
                    }
                    // 检测 url 协议是否为 registry,若是,表明用户想使用指定的注册中心
                    if (Constants.REGISTRY_PROTOCOL.equals(url.getProtocol())) {
                        // 将 map 转换为查询字符串,并作为 refer 参数的值添加到 url 中
                        urls.add(url.addParameterAndEncoded(Constants.REFER_KEY, StringUtils.toQueryString(map)));
                    } else {
                        // 合并 url,移除服务提供者的一些配置(这些配置来源于用户配置的 url 属性),// 比如线程池相关配置。并保留服务提供者的部分配置,比如版本,group,时间戳等
                        // 最后将合并后的配置设置为 url 查询字符串中。urls.add(ClusterUtils.mergeUrl(url, map));
                    }
                }
            }
        } else { // assemble URL from register center's configuration
            // 校验注册中心
            checkRegistry();
            // 加载注册中心的 url
            List<URL> us = loadRegistries(false);
            if (CollectionUtils.isNotEmpty(us)) {
                // 遍历所有的注册中心
                for (URL u : us) {
                    // 生成监控 url
                    URL monitorUrl = loadMonitor(u);
                    if (monitorUrl != null) {
                        // 加入监控中心 url 的配置
                        map.put(Constants.MONITOR_KEY, URL.encode(monitorUrl.toFullString()));
                    }
                    // 添加 refer 参数到 url 中,并将 url 添加到 urls 中
                    urls.add(u.addParameterAndEncoded(Constants.REFER_KEY, StringUtils.toQueryString(map)));
                }
            }
            // 如果 urls 为空,则抛出异常
            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.");
            }
        }

        // 如果只有一个注册中心,则直接调用 refer 方法
        if (urls.size() == 1) {
            // 调用 RegistryProtocol 的 refer 构建 Invoker 实例
            invoker = refprotocol.refer(interfaceClass, urls.get(0));
        } else {List<Invoker<?>> invokers = new ArrayList<Invoker<?>>();
            URL registryURL = null;
            // 遍历所有的注册中心 url
            for (URL url : urls) {
                // 通过 refprotocol 调用 refer 构建 Invoker,// refprotocol 会在运行时根据 url 协议头加载指定的 Protocol 实例,并调用实例的 refer 方法
                // 把生成的 Invoker 加入到集合中
                invokers.add(refprotocol.refer(interfaceClass, url));
                // 如果是注册中心的协议
                if (Constants.REGISTRY_PROTOCOL.equals(url.getProtocol())) {
                    // 则设置 registryURL
                    registryURL = url; // use last registry url
                }
            }
            // 优先用注册中心的 url
            if (registryURL != null) { // registry url is available
                // use RegistryAwareCluster only when register's cluster is available
                // 只有当注册中心当链接可用当时候,采用 RegistryAwareCluster
                URL u = registryURL.addParameter(Constants.CLUSTER_KEY, RegistryAwareCluster.NAME);
                // The invoker wrap relation would be: RegistryAwareClusterInvoker(StaticDirectory) -> FailoverClusterInvoker(RegistryDirectory, will execute route) -> Invoker
                // 由集群进行多个 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()) {
        // make it possible for consumer to retry later if provider is temporarily unavailable
        // 修改初始化标志为 false
        initialized = false;
        // 抛出异常
        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
     */
    // 元数据中心服务
    MetadataReportService metadataReportService = null;
    // 加载元数据服务,如果成功
    if ((metadataReportService = getMetadataReportService()) != null) {
        // 生成 url
        URL consumerURL = new URL(Constants.CONSUMER_PROTOCOL, map.remove(Constants.REGISTER_IP_KEY), 0, map.get(Constants.INTERFACE_KEY), map);
        // 把消费者配置加入到元数据中心中
        metadataReportService.publishConsumer(consumerURL);
    }
    // create service proxy
    // 创建服务代理
    return (T) proxyFactory.getProxy(invoker);
}

该方法的大致逻辑可用分为以下几步:

  1. 如果是本地调用,则直接使用 InjvmProtocol 的 refer 方法生成 Invoker 实例。
  2. 如果不是本地调用,但是是选择直连的方式来进行调用,则分割配置的多个 url。如果协议是配置是 registry,则表明用户想使用指定的注册中心,配置 url 后将 url 并且保存到 urls 里面,否则就合并 url,并且保存到 urls。
  3. 如果是通过注册中心来进行调用,则先校验所有的注册中心,然后加载注册中心的 url,遍历每个 url,加入监控中心 url 配置,最后把每个 url 保存到 urls。
  4. 针对 urls 集合的数量,如果是单注册中心,直接引用 RegistryProtocol 的 refer 构建 Invoker 实例,如果是多注册中心,则对每个 url 都生成 Invoker,利用集群进行多个 Invoker 合并。
  5. 最终输出一个 invoker。

Invoker 是 Dubbo 的核心模型,代表一个可执行体。在服务提供方,Invoker 用于调用服务提供类。在服务消费方,Invoker 用于执行远程调用。Invoker 是由 Protocol 实现类构建而来。关于这几个接口的定义介绍可以参考《dubbo 源码解析(十九)远程调用——开篇》,Protocol 实现类有很多,下面会分析 RegistryProtocol 和 DubboProtocol,我们可以看到上面的源码中讲到,当只有一个注册中心的时候,会直接使用 RegistryProtocol。所以先来看看 RegistryProtocol 的 refer() 方法。

RegistryProtocol 生成 invoker

RegistryProtocol 的 refer()
public <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException {
    // 取 registry 参数值,并将其设置为协议头,默认是 dubbo
    url = URLBuilder.from(url)
            .setProtocol(url.getParameter(REGISTRY_KEY, DEFAULT_REGISTRY))
            .removeParameter(REGISTRY_KEY)
            .build();
    // 获得注册中心实例
    Registry registry = registryFactory.getRegistry(url);
    // 如果是注册中心服务,则返回注册中心服务的 invoker
    if (RegistryService.class.equals(type)) {return proxyFactory.getInvoker((T) registry, type, url);
    }

    // group="a,b" or group="*"
    // 将 url 查询字符串转为 Map
    Map<String, String> qs = StringUtils.parseQueryString(url.getParameterAndDecoded(REFER_KEY));
    // 获得 group 值
    String group = qs.get(Constants.GROUP_KEY);
    if (group != null && group.length() > 0) {
        // 如果有多个组,或者组配置为 *,则使用 MergeableCluster,并调用 doRefer 继续执行服务引用逻辑
        if ((COMMA_SPLIT_PATTERN.split(group)).length > 1 || "*".equals(group)) {return doRefer(getMergeableCluster(), registry, type, url);
        }
    }
    // 只有一个组或者没有组配置,则直接执行 doRefer
    return doRefer(cluster, registry, type, url);
}

上面的逻辑比较简单,如果是注册服务中心,则直接创建代理。如果不是,先处理组配置,根据组配置来决定 Cluster 的实现方式,然后调用 doRefer 方法。

RegistryProtocol 的 doRefer()
private <T> Invoker<T> doRefer(Cluster cluster, Registry registry, Class<T> type, URL url) {
    // 创建 RegistryDirectory 实例
    RegistryDirectory<T> directory = new RegistryDirectory<T>(type, url);
    // 设置注册中心
    directory.setRegistry(registry);
    // 设置协议
    directory.setProtocol(protocol);
    // all attributes of REFER_KEY
    // 所有属性放到 map 中
    Map<String, String> parameters = new HashMap<String, String>(directory.getUrl().getParameters());
    // 生成服务消费者链接
    URL subscribeUrl = new URL(CONSUMER_PROTOCOL, parameters.remove(REGISTER_IP_KEY), 0, type.getName(), parameters);
    // 注册服务消费者,在 consumers 目录下新节点
    if (!ANY_VALUE.equals(url.getServiceInterface()) && url.getParameter(REGISTER_KEY, true)) {directory.setRegisteredConsumerUrl(getRegisteredConsumerUrl(subscribeUrl, url));
        // 注册服务消费者
        registry.register(directory.getRegisteredConsumerUrl());
    }
    // 创建路由规则链
    directory.buildRouterChain(subscribeUrl);
    // 订阅 providers、configurators、routers 等节点数据
    directory.subscribe(subscribeUrl.addParameter(CATEGORY_KEY,
            PROVIDERS_CATEGORY + "," + CONFIGURATORS_CATEGORY + "," + ROUTERS_CATEGORY));
    // 一个注册中心可能有多个服务提供者,因此这里需要将多个服务提供者合并为一个,生成一个 invoker
    Invoker invoker = cluster.join(directory);
    // 在服务提供者处注册消费者
    ProviderConsumerRegTable.registerConsumer(invoker, url, subscribeUrl, directory);
    return invoker;
}

该方法大致可以分为以下步骤:

  1. 创建一个 RegistryDirectory 实例,然后生成服务者消费者链接。
  2. 向注册中心进行注册。
  3. 紧接着订阅 providers、configurators、routers 等节点下的数据。完成订阅后,RegistryDirectory 会收到这几个节点下的子节点信息。
  4. 由于一个服务可能部署在多台服务器上,这样就会在 providers 产生多个节点,这个时候就需要 Cluster 将多个服务节点合并为一个,并生成一个 Invoker。关于 RegistryDirectory 和 Cluster,可以看我前面写的一些文章介绍。

DubboProtocol 生成 invoker

首先还是从 DubboProtocol 的 refer() 开始。

DubboProtocol 的 refer()
public <T> Invoker<T> refer(Class<T> serviceType, URL url) throws RpcException {optimizeSerialization(url);

    // create rpc invoker.
    // 创建一个 DubboInvoker 实例
    DubboInvoker<T> invoker = new DubboInvoker<T>(serviceType, url, getClients(url), invokers);
    // 加入到集合中
    invokers.add(invoker);

    return invoker;
}

创建 DubboInvoker 比较简单,调用了构造方法,这里主要讲这么生成 ExchangeClient,也就是 getClients 方法。

DubboProtocol 的 getClients()

可以参考《dubbo 源码解析(二十四)远程调用——dubbo 协议》的(三)DubboProtocol 中的源码分析。最新版本基本没有什么变化,只是因为加入了配置中心,配置的优先级更加明确了,所以增加了 xml 配置优先级高于 properties 配置的代码逻辑,都比较容易理解。

其中如果是配置的共享,则获得共享客户端对象,也就是 getSharedClient() 方法,否则新建客户端也就是 initClient() 方法。

DubboProtocol 的 getSharedClient()

可以参考《dubbo 源码解析(二十四)远程调用——dubbo 协议》的(三)DubboProtocol 中的源码分析,该方法比较简单,先访问缓存,若缓存未命中,则通过 initClient 方法创建新的 ExchangeClient 实例,并将该实例传给 ReferenceCountExchangeClient 构造方法创建一个带有引用计数功能的 ExchangeClient 实例。

DubboProtocol 的 initClient()

可以参考《dubbo 源码解析(二十四)远程调用——dubbo 协议》的(三)DubboProtocol 中的源码分析,initClient 方法首先获取用户配置的客户端类型,最新版本已经改为默认 netty4。然后设置用户心跳配置,然后检测用户配置的客户端类型是否存在,不存在则抛出异常。最后根据 lazy 配置决定创建什么类型的客户端。这里的 LazyConnectExchangeClient 代码并不是很复杂,该类会在 request 方法被调用时通过 Exchangers 的 connect 方法创建 ExchangeClient 客户端。下面我们分析一下 Exchangers 的 connect 方法。

Exchangers 的 connect()
public static ExchangeClient connect(URL url, ExchangeHandler handler) throws RemotingException {if (url == null) {throw new IllegalArgumentException("url == null");
    }
    if (handler == null) {throw new IllegalArgumentException("handler == null");
    }
    url = url.addParameterIfAbsent(Constants.CODEC_KEY, "exchange");
    // 获取 Exchanger 实例,默认为 HeaderExchangeClient
    return getExchanger(url).connect(url, handler);
}

getExchanger 会通过 SPI 加载 HeaderExchangeClient 实例,这个方法比较简单。接下来分析 HeaderExchangeClient 的 connect 的实现。

HeaderExchangeClient 的 connect()
public ExchangeClient connect(URL url, ExchangeHandler handler) throws RemotingException {
    // 创建 HeaderExchangeHandler 对象
    // 创建 DecodeHandler 对象
    // 通过 Transporters 构建 Client 实例
    // 创建 HeaderExchangeClient 对象
    return new HeaderExchangeClient(Transporters.connect(url, new DecodeHandler(new HeaderExchangeHandler(handler))), true);
}

其中 HeaderExchangeHandler、DecodeHandler 等可以参考《dubbo 源码解析(九)远程通信——Transport 层》和《dubbo 源码解析(十)远程通信——Exchange 层》的分析。这里重点关注 Transporters 构建 Client,也就是 Transporters 的 connect 方法。

Transporters 的 connect()

可以参考《dubbo 源码解析(八)远程通信——开篇》的(十)Transporters 中源码分析。其中获得自适应拓展类,该类会在运行时根据客户端类型加载指定的 Transporter 实现类。若用户未配置客户端类型,则默认加载 NettyTransporter,并调用该类的 connect 方法。假设是 netty4 的实现,则执行以下代码。

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

到这里为止,DubboProtocol 生成 invoker 过程也结束了。再回到 createProxy 方法的最后一句代码,根据 invoker 创建服务代理对象。

创建代理

为服务接口生成代理对象。有了代理对象,即可进行远程调用。首先来看 AbstractProxyFactory 的 getProxy() 方法。

AbstractProxyFactory 的 getProxy()

可以参考《dubbo 源码解析(二十三)远程调用——Proxy》的(一)AbstractProxyFactory 的源码分析。可以看到第二个 getProxy 方法其实就是获取 interfaces 数组,调用到第三个 getProxy 方法时,该 getProxy 是个抽象方法,由子类来实现,我们还是默认它的代理实现方式为 Javassist。所以可以看 JavassistProxyFactory 的 getProxy 方法。

JavassistProxyFactory 的 getProxy()
public <T> T getProxy(Invoker<T> invoker, Class<?>[] interfaces) {
    // 生成 Proxy 子类(Proxy 是抽象类)。并调用 Proxy 子类的 newInstance 方法创建 Proxy 实例
    return (T) Proxy.getProxy(interfaces).newInstance(new InvokerInvocationHandler(invoker));
}

我们重点看 Proxy 的 getProxy 方法。

/**
 * Get proxy.
 *
 * @param ics interface class array.
 * @return Proxy instance.
 */
public static Proxy getProxy(Class<?>... ics) {
    // 获得 Proxy 的类加载器来进行生成代理类
    return getProxy(ClassHelper.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) {if (ics.length > Constants.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) { }
        // 检测接口是否相同,这里 tmp 有可能为空,也就是该接口无法被类加载器加载的。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.
    // 使用拼接后的接口名作为 key
    String key = sb.toString();

    // get cache by class loader.
    Map<String, Object> cache;
    // 把该类加载器加到本地缓存
    synchronized (ProxyCacheMap) {cache = ProxyCacheMap.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 == PendingGenerationMarker) {
                try {
                    // 其他线程在此处进行等待
                    cache.wait();} catch (InterruptedException e) {}} else {
                // 放置标志位到缓存中,并跳出 while 循环进行后续操作
                cache.put(key, PendingGenerationMarker);
                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++) {
            // 检测接口访问级别是否为 protected 或 privete
            if (!Modifier.isPublic(ics[i].getModifiers())) {
                // 获取接口包名
                String npkg = ics[i].getPackage().getName();
                if (pkg == null) {pkg = npkg;} else {
                    // 非 public 级别的接口必须在同一个包下,否者抛出异常
                    if (!pkg.equals(npkg)) {throw new IllegalArgumentException("non-public interfaces from different packages");
                    }
                }
            }
            // 添加接口到 ClassGenerator 中
            ccp.addInterface(ics[i]);

            // 遍历接口方法
            for (Method method : ics[i].getMethods()) {
                // 获取方法描述,可理解为方法签名
                String desc = ReflectUtils.getDesc(method);
                // 如果方法描述字符串已在 worked 中,则忽略。考虑这种情况,// A 接口和 B 接口中包含一个完全相同的方法
                if (worked.contains(desc)) {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[1...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 = PACKAGE_NAME;}

        // create ProxyInstance class.
        // 构建接口代理类名称:pkg + ".proxy" + id,比如 org.apache.dubbo.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();
        // 生成接口代理类
        Class<?> clazz = ccp.toClass();
        clazz.getField("methods").set(null, methods.toArray(new Method[0]));

        // create Proxy class.
        // 构建 Proxy 子类名称,比如 Proxy1,Proxy2 等
        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 new org.apache.dubbo.proxy0($1);
        // }
        ccm.addMethod("public Object newInstance(" + InvocationHandler.class.getName() + "h){return new" + pcn + "($1); }");
        Class<?> pc = ccm.toClass();
        // 生成 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;
}

代码比较多,大致可以分为以下几步:

  1. 对接口进行校验,检查是否是一个接口,是否不能被类加载器加载。
  2. 做并发控制,保证只有一个线程可以进行后续的代理生成操作。
  3. 创建 cpp,用作为服务接口生成代理类。首先对接口定义以及包信息进行处理。
  4. 对接口的方法进行处理,包括返回类型,参数类型等。最后添加方法名、访问控制符、参数列表、方法代码等信息到 ClassGenerator 中。
  5. 创建接口代理类的信息,比如名称,默认构造方法等。
  6. 生成接口代理类。
  7. 创建 ccm,ccm 则是用于为 org.apache.dubbo.common.bytecode.Proxy 抽象类生成子类,主要是实现 Proxy 类的抽象方法。
  8. 设置名称、创建构造方法、添加方法
  9. 生成 Proxy 实现类。
  10. 释放资源
  11. 创建弱引用,写入缓存,唤醒其他线程。

到这里,接口代理类生成后,服务引用也就结束了。

后记

参考官方文档:https://dubbo.apache.org/zh-c…

该文章讲解了 dubbo 的服务引用过程,下一篇就讲解 2.7 中异步化改造。

正文完
 0