Dubbo 动态规则作用域说明

开篇

• 这篇文章作为Dubbo 动态规则配置分析的补充，主要是为了描述consumer和provider在响应configurators的变化时各自的响应逻辑。

匹配规则

Dubbo 配置规则

• Dubbo的配置规则如上图所示，主要摘录自Dubbo的官网。
• 这里唯一需要针对配置的ip地址格式进行额外的说明，具体配合代码进行说明。

Consumer配置规则作用域分析

private URL mergeUrl(URL providerUrl) {
    // Merge the consumer side parameters
    providerUrl = ClusterUtils.mergeUrl(providerUrl, queryMap); 

    List<Configurator> localConfigurators = this.configurators; // local reference
    if (localConfigurators != null && !localConfigurators.isEmpty()) {
        for (Configurator configurator : localConfigurators) {
            providerUrl = configurator.configure(providerUrl);
        }
    }

    providerUrl = providerUrl.addParameter(Constants.CHECK_KEY, String.valueOf(false)); // Do not check whether the connection is successful or not, always create Invoker!

    // 省略非核心代码

    return providerUrl;
}

• 1.Consumer的providerUrl保存的实际上是provider提供服务的URL信息，保存的provider的信息。
• 2.Configurators针对providerUrl进行配置变更。

public URL configure(URL url) {
    if (configuratorUrl == null || configuratorUrl.getHost() == null
            || url == null || url.getHost() == null) {
        return url;
    }
    // If override url has port, means it is a provider address. We want to control a specific provider with this override url, it may take effect on the specific provider instance or on consumers holding this provider instance.
    // 如果覆盖url具有端口，则表示它是提供者地址。我们希望使用此覆盖URL控制特定提供程序，它可以在提供端生效 也可以在消费端生效。
    if (configuratorUrl.getPort() != 0) {
        if (url.getPort() == configuratorUrl.getPort()) {
            return configureIfMatch(url.getHost(), url);
        }
    } else {// override url don't have a port, means the ip override url specify is a consumer address or 0.0.0.0
        // 1.If it is a consumer ip address, the intention is to control a specific consumer instance, it must takes effect at the consumer side, any provider received this override url should ignore;
        // 2.If the ip is 0.0.0.0, this override url can be used on consumer, and also can be used on provider
        // 配置规则，URL 没有端口，意味着override 输入消费端地址 或者 0.0.0.0
        if (url.getParameter(Constants.SIDE_KEY, Constants.PROVIDER).equals(Constants.CONSUMER)) {
            // 如果它是一个消费者ip地址，目的是控制一个特定的消费者实例，它必须在消费者一方生效，任何提供者收到这个覆盖url应该忽略;
            return configureIfMatch(NetUtils.getLocalHost(), url);// NetUtils.getLocalHost is the ip address consumer registered to registry.
        } else if (url.getParameter(Constants.SIDE_KEY, Constants.CONSUMER).equals(Constants.PROVIDER)) {
            // 如果ip为0.0.0.0，则此覆盖url可以在使用者上使用，也可以在提供者上使用
            return configureIfMatch(Constants.ANYHOST_VALUE, url);// take effect on all providers, so address must be 0.0.0.0, otherwise it won't flow to this if branch
        }
    }
    return url;
}

• 3.针对configuratorUrl包含port信息的场景，provider和consumer侧都会进行变更响应。
• 4.consumer侧响应configuratorUrl变更执行configureIfMatch()方法。
• 5.针对不包含port的configuratorUrl变更，会判断configuratorUrl携带的ip是否为consumer的本机ip进行响应处理。
• 6.步骤3和步骤5的不同之处在于步骤3是所有的consumer都会响应变更，步骤5只是特定的consumer会响应变更。

private URL configureIfMatch(String host, URL url) {
    if (Constants.ANYHOST_VALUE.equals(configuratorUrl.getHost()) || host.equals(configuratorUrl.getHost())) {
        String configApplication = configuratorUrl.getParameter(Constants.APPLICATION_KEY,
                configuratorUrl.getUsername());
        String currentApplication = url.getParameter(Constants.APPLICATION_KEY, url.getUsername());
        if (configApplication == null || Constants.ANY_VALUE.equals(configApplication)
                || configApplication.equals(currentApplication)) {
            Set<String> conditionKeys = new HashSet<String>();
            conditionKeys.add(Constants.CATEGORY_KEY);
            conditionKeys.add(Constants.CHECK_KEY);
            conditionKeys.add(Constants.DYNAMIC_KEY);
            conditionKeys.add(Constants.ENABLED_KEY);
            for (Map.Entry<String, String> entry : configuratorUrl.getParameters().entrySet()) {
                String key = entry.getKey();
                String value = entry.getValue();
                if (key.startsWith("~") || Constants.APPLICATION_KEY.equals(key) || Constants.SIDE_KEY.equals(key)) {
                    conditionKeys.add(key);
                    if (value != null && !Constants.ANY_VALUE.equals(value)
                            && !value.equals(url.getParameter(key.startsWith("~") ? key.substring(1) : key))) {
                        return url;
                    }
                }
            }
            return doConfigure(url, configuratorUrl.removeParameters(conditionKeys));
        }
    }
    return url;
}

• 7.针对步骤3的场景，host的值取自providerUrl，而且configuratorUrl.getHost()的值指的就是provider的host地址。
• 8. 针对步骤5的场景，只有本机ip和configuratorUrl的中指定的consumer的ip匹配时候才能进行动态规则变更。

Provider配置规则作用域分析

• Provider针对权重路由这些动态配置信息是不会进行变更的，只会对最大连接数、闲置时间等规则会进行响应。