集群——configurator
目标：介绍 dubbo 中集群的配置规则，介绍 dubbo-cluster 下 configurator 包的源码。
前言
向注册中心写入动态配置覆盖规则。该功能通常由监控中心或治理中心的页面完成。在最新的 2.7.0 版本中有新的配置规则，我会在后续讲解 2.7.0 新特性的时候提到。这里还是根据旧版本中配置规则来讲解，可以参考官方文档：
http://dubbo.apache.org/zh-cn…
源码分析
（一）AbstractConfigurator
该类实现了 Configurator 接口，是配置规则 抽象类，配置有两种方式，一种是没有时添加配置，这种暂时没有用到，另一种是覆盖配置。
1.configure
@Override
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;
}
该方法是规则配置到 URL 中，但是关键逻辑在 configureIfMatch 方法中。
2.configureIfMatch
private URL configureIfMatch(String host, URL url) {
// 匹配 Host
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());
// 匹配 “application”
if (configApplication == null || Constants.ANY_VALUE.equals(configApplication)
|| configApplication.equals(currentApplication)) {
Set<String> conditionKeys = new HashSet<String>();
// 配置 URL 中的条件 KEYS 集合。其中下面四个 KEY，不算是条件，而是内置属性。考虑到下面要移除，所以添加到该集合中。
conditionKeys.add(Constants.CATEGORY_KEY);
conditionKeys.add(Constants.CHECK_KEY);
conditionKeys.add(Constants.DYNAMIC_KEY);
conditionKeys.add(Constants.ENABLED_KEY);
// 判断传入的 url 是否匹配配置规则 URL 的条件。
for (Map.Entry<String, String> entry : configuratorUrl.getParameters().entrySet()) {
String key = entry.getKey();
String value = entry.getValue();
// 除了 “application” 和 “side” 之外，带有 `”~”` 开头的 KEY，也是条件。
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;
}
}
}
// 移除条件 KEYS 集合，并配置到 URL 中
return doConfigure(url, configuratorUrl.removeParameters(conditionKeys));
}
}
return url;
}
该方法是当条件匹配时，才对 url 进行配置。
3.compareTo
@Override
public int compareTo(Configurator o) {
if (o == null) {
return -1;
}
// // host 升序
int ipCompare = getUrl().getHost().compareTo(o.getUrl().getHost());
// 如果 host 相同，则根据 priority 降序来对比
if (ipCompare == 0) {//host is the same, sort by priority
int i = getUrl().getParameter(Constants.PRIORITY_KEY, 0),
j = o.getUrl().getParameter(Constants.PRIORITY_KEY, 0);
return i < j ? -1 : (i == j ? 0 : 1);
} else {
return ipCompare;
}
}
这是配置的排序策略。先根据 host 升序，如果相同，再通过 priority 降序。
（二）AbsentConfigurator
public class AbsentConfigurator extends AbstractConfigurator {
public AbsentConfigurator(URL url) {
super(url);
}
@Override
public URL doConfigure(URL currentUrl, URL configUrl) {
// 当不存在时添加
return currentUrl.addParametersIfAbsent(configUrl.getParameters());
}
}
该配置方式就是当配置不存在的时候添加。
（三）AbsentConfiguratorFactory
public class AbsentConfiguratorFactory implements ConfiguratorFactory {
@Override
public Configurator getConfigurator(URL url) {
// 创建一个 AbsentConfigurator。
return new AbsentConfigurator(url);
}
}
该类是不存在时添加配置的工厂类，用来创建 AbsentConfigurator。
（四）OverrideConfigurator
public class OverrideConfigurator extends AbstractConfigurator {
public OverrideConfigurator(URL url) {
super(url);
}
@Override
public URL doConfigure(URL currentUrl, URL configUrl) {
// 覆盖添加
return currentUrl.addParameters(configUrl.getParameters());
}
}
这种是覆盖添加。是目前在用的配置方式。
（五）OverrideConfiguratorFactory
public class OverrideConfiguratorFactory implements ConfiguratorFactory {
@Override
public Configurator getConfigurator(URL url) {
// 创建 OverrideConfigurator
return new OverrideConfigurator(url);
}
}
该类是 OverrideConfigurator 的工厂类，用来提供 OverrideConfigurator 实例。
后记
该部分相关的源码解析地址：https://github.com/CrazyHZM/i…
该文章讲解了集群中关于 configurator 实现的部分，讲了两种配置方式，分别是不存在再添加和覆盖添加。接下来我将开始对集群模块关于 Directory 部分进行讲解。