dubbo服务暴露过程
目标：从源码的角度分析服务暴露过程。
前言
本来这一篇一个写异步化改造的内容，但是最近我一直在想，某一部分的优化改造该怎么去撰写才能更加的让读者理解。我觉得还是需要先从整个调用链入手，先弄清楚了该功能在哪一个时机发生的，说通俗一点，这块代码是什么时候或者什么场景被执行的，然后再去分析内部是如何实现，最后阐述这样改造的好处。
我在前面的文章都很少提及各个调用链的关系，各模块之间也没有串起来，并且要讲解异步化改造我认为先弄懂服务的暴露和引用过程是非常有必要的，所以我将用两片文章来讲解服务暴露和服务引用的过程。
服务暴露过程
服务暴露过程大致可分为三个部分：
- 前置工作，主要用于检查参数，组装 URL。
- 导出服务，包含暴露服务到本地 (JVM)，和暴露服务到远程两个过程。
- 向注册中心注册服务，用于服务发现。
暴露起点
Spring中有一个ApplicationListener接口，其中定义了一个onApplicationEvent()方法，在当容器内发生任何事件时，此方法都会被触发。
Dubbo中ServiceBean类实现了该接口，并且实现了onApplicationEvent方法：
@Override
public void onApplicationEvent(ContextRefreshedEvent event) {
// 如果服务没有被暴露并且服务没有被取消暴露，则打印日志
if (!isExported() && !isUnexported()) {
if (logger.isInfoEnabled()) {
logger.info("The service ready on spring started. service: " + getInterface());
}
// 导出
export();
}
}只要服务没有被暴露并且服务没有被取消暴露，就暴露服务。执行export方法。接下来就是跟官网的时序图有关，对照着时序图来看下面的过程。
我会在下面的小标题加上时序图的每一步操作范围，比如下面要讲到的前置工作其实就是时序图中的1:export()，那我会在标题括号里面写1。
其中服务暴露的第八步已经没有了。
前置工作（1）
前置工作主要包含两个部分，分别是配置检查，以及 URL 装配。在暴露服务之前，Dubbo 需要检查用户的配置是否合理，或者为用户补充缺省配置。配置检查完成后，接下来需要根据这些配置组装 URL。在 Dubbo 中，URL 的作用十分重要。Dubbo 使用 URL 作为配置载体，所有的拓展点都是通过 URL 获取配置。
配置检查
在调用export方法之后，执行的是ServiceConfig中的export方法。
public synchronized void export() {
//检查并且更新配置
checkAndUpdateSubConfigs();
// 如果不应该暴露，则直接结束
if (!shouldExport()) {
return;
}
// 如果使用延迟加载，则延迟delay时间后暴露服务
if (shouldDelay()) {
delayExportExecutor.schedule(this::doExport, delay, TimeUnit.MILLISECONDS);
} else {
// 暴露服务
doExport();
}
}可以看到首先做的就是对配置的检查和更新，执行的是ServiceConfig中的checkAndUpdateSubConfigs方法。然后检测是否应该暴露，如果不应该暴露，则直接结束，然后检测是否配置了延迟加载，如果是，则使用定时器来实现延迟加载的目的。
checkAndUpdateSubConfigs()
public void checkAndUpdateSubConfigs() {
// Use default configs defined explicitly on global configs
// 用于检测 provider、application 等核心配置类对象是否为空，
// 若为空，则尝试从其他配置类对象中获取相应的实例。
completeCompoundConfigs();
// Config Center should always being started first.
// 开启配置中心
startConfigCenter();
// 检测 provider 是否为空，为空则新建一个，并通过系统变量为其初始化
checkDefault();
// 检查application是否为空
checkApplication();
// 检查注册中心是否为空
checkRegistry();
// 检查protocols是否为空
checkProtocol();
this.refresh();
// 核对元数据中心配置是否为空
checkMetadataReport();
// 服务接口名不能为空，否则抛出异常
if (StringUtils.isEmpty(interfaceName)) {
throw new IllegalStateException("<dubbo:service interface=\"\" /> interface not allow null!");
}
// 检测 ref 是否为泛化服务类型
if (ref instanceof GenericService) {
// 设置interfaceClass为GenericService
interfaceClass = GenericService.class;
if (StringUtils.isEmpty(generic)) {
// 设置generic = true
generic = Boolean.TRUE.toString();
}
} else {
try {
// 获得接口类型
interfaceClass = Class.forName(interfaceName, true, Thread.currentThread()
.getContextClassLoader());
} catch (ClassNotFoundException e) {
throw new IllegalStateException(e.getMessage(), e);
}
// 对 interfaceClass，以及 <dubbo:method> 标签中的必要字段进行检查
checkInterfaceAndMethods(interfaceClass, methods);
// 对 ref 合法性进行检测
checkRef();
generic = Boolean.FALSE.toString();
}
// stub local一样都是配置本地存根
if (local != null) {
if ("true".equals(local)) {
local = interfaceName + "Local";
}
Class<?> localClass;
try {
localClass = ClassHelper.forNameWithThreadContextClassLoader(local);
} catch (ClassNotFoundException e) {
throw new IllegalStateException(e.getMessage(), e);
}
if (!interfaceClass.isAssignableFrom(localClass)) {
throw new IllegalStateException("The local implementation class " + localClass.getName() + " not implement interface " + interfaceName);
}
}
if (stub != null) {
if ("true".equals(stub)) {
stub = interfaceName + "Stub";
}
Class<?> stubClass;
try {
stubClass = ClassHelper.forNameWithThreadContextClassLoader(stub);
} catch (ClassNotFoundException e) {
throw new IllegalStateException(e.getMessage(), e);
}
if (!interfaceClass.isAssignableFrom(stubClass)) {
throw new IllegalStateException("The stub implementation class " + stubClass.getName() + " not implement interface " + interfaceName);
}
}
// 本地存根合法性校验
checkStubAndLocal(interfaceClass);
// mock合法性校验
checkMock(interfaceClass);
}可以看到，该方法中是对各类配置的校验，并且更新部分配置。其中检查的细节我就不展开，因为服务暴露整个过程才是本文重点。
在经过shouldExport()和shouldDelay()两个方法检测后，会执行ServiceConfig的doExport()方法
doExport()
protected synchronized void doExport() {
// 如果调用不暴露的方法，则unexported值为true
if (unexported) {
throw new IllegalStateException("The service " + interfaceClass.getName() + " has already unexported!");
}
// 如果服务已经暴露了，则直接结束
if (exported) {
return;
}
// 设置已经暴露
exported = true;
// 如果path为空，则赋值接口名称
if (StringUtils.isEmpty(path)) {
path = interfaceName;
}
// 多协议多注册中心暴露服务
doExportUrls();
}该方法就是对于服务是否暴露在一次校验，然后会执行ServiceConfig的doExportUrls()方法，对于多协议多注册中心暴露服务进行支持。
doExportUrls()
private void doExportUrls() {
// 加载注册中心链接
List<URL> registryURLs = loadRegistries(true);
// 遍历 protocols，并在每个协议下暴露服务
for (ProtocolConfig protocolConfig : protocols) {
// 以path、group、version来作为服务唯一性确定的key
String pathKey = URL.buildKey(getContextPath(protocolConfig).map(p -> p + "/" + path).orElse(path), group, version);
ProviderModel providerModel = new ProviderModel(pathKey, ref, interfaceClass);
ApplicationModel.initProviderModel(pathKey, providerModel);
// 组装 URL
doExportUrlsFor1Protocol(protocolConfig, registryURLs);
}
}从该方法可以看到：
- loadRegistries()方法是加载注册中心链接。
- 服务的唯一性是通过path、group、version一起确定的。
- doExportUrlsFor1Protocol()方法开始组装URL。
loadRegistries()
protected List<URL> loadRegistries(boolean provider) {
// check && override if necessary
List<URL> registryList = new ArrayList<URL>();
// 如果registries为空，直接返回空集合
if (CollectionUtils.isNotEmpty(registries)) {
// 遍历注册中心配置集合registries
for (RegistryConfig config : registries) {
// 获得地址
String address = config.getAddress();
// 若地址为空，则设置为0.0.0.0
if (StringUtils.isEmpty(address)) {
address = Constants.ANYHOST_VALUE;
}
// 如果地址为N/A，则跳过
if (!RegistryConfig.NO_AVAILABLE.equalsIgnoreCase(address)) {
Map<String, String> map = new HashMap<String, String>();
// 添加 ApplicationConfig 中的字段信息到 map 中
appendParameters(map, application);
// 添加 RegistryConfig 字段信息到 map 中
appendParameters(map, config);
// 添加path
map.put(Constants.PATH_KEY, RegistryService.class.getName());
// 添加 协议版本、发布版本，时间戳 等信息到 map 中
appendRuntimeParameters(map);
// 如果map中没有protocol，则默认为使用dubbo协议
if (!map.containsKey(Constants.PROTOCOL_KEY)) {
map.put(Constants.PROTOCOL_KEY, Constants.DUBBO_PROTOCOL);
}
// 解析得到 URL 列表，address 可能包含多个注册中心 ip，因此解析得到的是一个 URL 列表
List<URL> urls = UrlUtils.parseURLs(address, map);
// 遍历URL 列表
for (URL url : urls) {
// 将 URL 协议头设置为 registry
url = URLBuilder.from(url)
.addParameter(Constants.REGISTRY_KEY, url.getProtocol())
.setProtocol(Constants.REGISTRY_PROTOCOL)
.build();
// 通过判断条件，决定是否添加 url 到 registryList 中，条件如下：
// 如果是服务提供者，并且是注册中心服务 或者 是消费者端，并且是订阅服务
// 则加入到registryList
if ((provider && url.getParameter(Constants.REGISTER_KEY, true))
|| (!provider && url.getParameter(Constants.SUBSCRIBE_KEY, true))) {
registryList.add(url);
}
}
}
}
}
return registryList;
}组装URL
我在以前的文章也提到过，dubbo内部用URL来携带各类配置，贯穿整个调用链，它就是配置的载体。服务的配置被组装到URL中就是从这里开始，上面提到遍历每个协议配置，在每个协议下都暴露服务，就会执行ServiceConfig的doExportUrlsFor1Protocol()方法，该方法前半部分实现了组装URL的逻辑，后半部分实现了暴露dubbo服务等逻辑，其中为用分割线分隔了。
doExportUrlsFor1Protocol()
private void doExportUrlsFor1Protocol(ProtocolConfig protocolConfig, List<URL> registryURLs) {
// 获取协议名
String name = protocolConfig.getName();
// 如果为空，则是默认的dubbo
if (StringUtils.isEmpty(name)) {
name = Constants.DUBBO;
}
Map<String, String> map = new HashMap<String, String>();
// 设置服务提供者册
map.put(Constants.SIDE_KEY, Constants.PROVIDER_SIDE);
// 添加 协议版本、发布版本，时间戳 等信息到 map 中
appendRuntimeParameters(map);
// 添加metrics、application、module、provider、protocol的所有信息到map
appendParameters(map, metrics);
appendParameters(map, application);
appendParameters(map, module);
appendParameters(map, provider, Constants.DEFAULT_KEY);
appendParameters(map, protocolConfig);
appendParameters(map, this);
// 如果method的配置列表不为空
if (CollectionUtils.isNotEmpty(methods)) {
// 遍历method配置列表
for (MethodConfig method : methods) {
// 把方法名加入map
appendParameters(map, method, method.getName());
// 添加 MethodConfig 对象的字段信息到 map 中，键 = 方法名.属性名。
// 比如存储 <dubbo:method name="sayHello" retries="2"> 对应的 MethodConfig，
// 键 = sayHello.retries，map = {"sayHello.retries": 2, "xxx": "yyy"}
String retryKey = method.getName() + ".retry";
if (map.containsKey(retryKey)) {
String retryValue = map.remove(retryKey);
// 如果retryValue为false，则不重试，设置值为0
if ("false".equals(retryValue)) {
map.put(method.getName() + ".retries", "0");
}
}
// 获得ArgumentConfig列表
List<ArgumentConfig> arguments = method.getArguments();
if (CollectionUtils.isNotEmpty(arguments)) {
// 遍历ArgumentConfig列表
for (ArgumentConfig argument : arguments) {
// convert argument type
// // 检测 type 属性是否为空，或者空串
if (argument.getType() != null && argument.getType().length() > 0) {
// 利用反射获取该服务的所有方法集合
Method[] methods = interfaceClass.getMethods();
// visit all methods
if (methods != null && methods.length > 0) {
// 遍历所有方法
for (int i = 0; i < methods.length; i++) {
// 获得方法名
String methodName = methods[i].getName();
// target the method, and get its signature
// 找到目标方法
if (methodName.equals(method.getName())) {
// 通过反射获取目标方法的参数类型数组 argtypes
Class<?>[] argtypes = methods[i].getParameterTypes();
// one callback in the method
// 如果下标为-1
if (argument.getIndex() != -1) {
// 检测 argType 的名称与 ArgumentConfig 中的 type 属性是否一致
if (argtypes[argument.getIndex()].getName().equals(argument.getType())) {
// 添加 ArgumentConfig 字段信息到 map 中
appendParameters(map, argument, method.getName() + "." + argument.getIndex());
} else {
// 不一致，则抛出异常
throw new IllegalArgumentException("Argument config error : the index attribute and type attribute not match :index :" + argument.getIndex() + ", type:" + argument.getType());
}
} else {
// multiple callbacks in the method
// 遍历参数类型数组 argtypes，查找 argument.type 类型的参数
for (int j = 0; j < argtypes.length; j++) {
Class<?> argclazz = argtypes[j];
if (argclazz.getName().equals(argument.getType())) {
// 如果找到，则添加 ArgumentConfig 字段信息到 map 中
appendParameters(map, argument, method.getName() + "." + j);
if (argument.getIndex() != -1 && argument.getIndex() != j) {
throw new IllegalArgumentException("Argument config error : the index attribute and type attribute not match :index :" + argument.getIndex() + ", type:" + argument.getType());
}
}
}
}
}
}
}
} else if (argument.getIndex() != -1) {
// 用户未配置 type 属性，但配置了 index 属性，且 index != -1，则直接添加到map
appendParameters(map, argument, method.getName() + "." + argument.getIndex());
} else {
// 抛出异常
throw new IllegalArgumentException("Argument config must set index or type attribute.eg: <dubbo:argument index='0' .../> or <dubbo:argument type=xxx .../>");
}
}
}
} // end of methods for
}
// 如果是泛化调用，则在map中设置generic和methods
if (ProtocolUtils.isGeneric(generic)) {
map.put(Constants.GENERIC_KEY, generic);
map.put(Constants.METHODS_KEY, Constants.ANY_VALUE);
} else {
// 获得版本号
String revision = Version.getVersion(interfaceClass, version);
// 放入map
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());
// 设置method为*
map.put(Constants.METHODS_KEY, Constants.ANY_VALUE);
} else {
// 否则加入方法集合
map.put(Constants.METHODS_KEY, StringUtils.join(new HashSet<String>(Arrays.asList(methods)), ","));
}
}
// 把token 的值加入到map中
if (!ConfigUtils.isEmpty(token)) {
if (ConfigUtils.isDefault(token)) {
map.put(Constants.TOKEN_KEY, UUID.randomUUID().toString());
} else {
map.put(Constants.TOKEN_KEY, token);
}
}
// export service
// 获得地址
String host = this.findConfigedHosts(protocolConfig, registryURLs, map);
// 获得端口号
Integer port = this.findConfigedPorts(protocolConfig, name, map);
// 生成 URL
URL url = new URL(name, host, port, getContextPath(protocolConfig).map(p -> p + "/" + path).orElse(path), map);
// —————————————————————————————————————分割线———————————————————————————————————————
// 加载 ConfiguratorFactory，并生成 Configurator 实例，判断是否有该协议的实现存在
if (ExtensionLoader.getExtensionLoader(ConfiguratorFactory.class)
.hasExtension(url.getProtocol())) {
// 通过实例配置 url
url = ExtensionLoader.getExtensionLoader(ConfiguratorFactory.class)
.getExtension(url.getProtocol()).getConfigurator(url).configure(url);
}
String scope = url.getParameter(Constants.SCOPE_KEY);
// don't export when none is configured
// // 如果 scope = none，则什么都不做
if (!Constants.SCOPE_NONE.equalsIgnoreCase(scope)) {
// export to local if the config is not remote (export to remote only when config is remote)
// // scope != remote，暴露到本地
if (!Constants.SCOPE_REMOTE.equalsIgnoreCase(scope)) {
// 暴露到本地
exportLocal(url);
}
// export to remote if the config is not local (export to local only when config is local)
// // scope != local，导出到远程
if (!Constants.SCOPE_LOCAL.equalsIgnoreCase(scope)) {
if (logger.isInfoEnabled()) {
logger.info("Export dubbo service " + interfaceClass.getName() + " to url " + url);
}
// 如果注册中心链接集合不为空
if (CollectionUtils.isNotEmpty(registryURLs)) {
// 遍历注册中心
for (URL registryURL : registryURLs) {
// 添加dynamic配置
url = url.addParameterIfAbsent(Constants.DYNAMIC_KEY, registryURL.getParameter(Constants.DYNAMIC_KEY));
// 加载监视器链接
URL monitorUrl = loadMonitor(registryURL);
if (monitorUrl != null) {
// 添加监视器配置
url = url.addParameterAndEncoded(Constants.MONITOR_KEY, monitorUrl.toFullString());
}
if (logger.isInfoEnabled()) {
logger.info("Register dubbo service " + interfaceClass.getName() + " url " + url + " to registry " + registryURL);
}
// For providers, this is used to enable custom proxy to generate invoker
// 获得代理方式
String proxy = url.getParameter(Constants.PROXY_KEY);
if (StringUtils.isNotEmpty(proxy)) {
// 添加代理方式到注册中心到url
registryURL = registryURL.addParameter(Constants.PROXY_KEY, proxy);
}
// 为服务提供类(ref)生成 Invoker
Invoker<?> invoker = proxyFactory.getInvoker(ref, (Class) interfaceClass, registryURL.addParameterAndEncoded(Constants.EXPORT_KEY, url.toFullString()));
// DelegateProviderMetaDataInvoker 用于持有 Invoker 和 ServiceConfig
DelegateProviderMetaDataInvoker wrapperInvoker = new DelegateProviderMetaDataInvoker(invoker, this);
// 暴露服务，并且生成Exporter
Exporter<?> exporter = protocol.export(wrapperInvoker);
// 加入到暴露者集合中
exporters.add(exporter);
}
} else {
// 不存在注册中心，则仅仅暴露服务，不会记录暴露到地址
Invoker<?> invoker = proxyFactory.getInvoker(ref, (Class) interfaceClass, url);
DelegateProviderMetaDataInvoker wrapperInvoker = new DelegateProviderMetaDataInvoker(invoker, this);
Exporter<?> exporter = protocol.export(wrapperInvoker);
exporters.add(exporter);
}
/**
* @since 2.7.0
* ServiceData Store
*/
MetadataReportService metadataReportService = null;
// 如果元数据中心服务不为空，则发布该服务，也就是在元数据中心记录url中到部分配置
if ((metadataReportService = getMetadataReportService()) != null) {
metadataReportService.publishProvider(url);
}
}
}
this.urls.add(url);
}先看分割线上面部分，就是组装URL的全过程，我觉得大致可以分为一下步骤：
- 它把metrics、application、module、provider、protocol等所有配置都放入map中，
- 针对method都配置，先做签名校验，先找到该服务是否有配置的方法存在，然后该方法签名是否有这个参数存在，都核对成功才将method的配置加入map。
- 将泛化调用、版本号、method或者methods、token等信息加入map
- 获得服务暴露地址和端口号，利用map内数据组装成URL。
创建invoker（2，3）
暴露到远程的源码直接看doExportUrlsFor1Protocol()方法分割线下半部分。当生成暴露者的时候，服务已经暴露，接下来会细致的分析这暴露内部的过程。可以发现无论暴露到本地还是远程，都会通过代理工厂创建invoker。这个时候就走到了上述时序图的ProxyFactory。我在这篇文章中有讲到invoker：dubbo源码解析（十九）远程调用——开篇，首先我们来看看invoker如何诞生的。Invoker 是由 ProxyFactory 创建而来，Dubbo 默认的 ProxyFactory 实现类是 JavassistProxyFactory。JavassistProxyFactory中有一个getInvoker()方法。
获取invoker方法
getInvoker()
public <T> Invoker<T> getInvoker(T proxy, Class<T> type, URL url) {
// TODO Wrapper cannot handle this scenario correctly: the classname contains '$'
// // 为目标类创建 Wrapper
final Wrapper wrapper = Wrapper.getWrapper(proxy.getClass().getName().indexOf('$') < 0 ? proxy.getClass() : type);
// 创建匿名 Invoker 类对象，并实现 doInvoke 方法。
return new AbstractProxyInvoker<T>(proxy, type, url) {
@Override
protected Object doInvoke(T proxy, String methodName,
Class<?>[] parameterTypes,
Object[] arguments) throws Throwable {
// 调用 Wrapper 的 invokeMethod 方法，invokeMethod 最终会调用目标方法
return wrapper.invokeMethod(proxy, methodName, parameterTypes, arguments);
}
};
}可以看到，该方法就是创建了一个匿名的Invoker类对象，在doInvoke()方法中调用wrapper.invokeMethod()方法。Wrapper 是一个抽象类，仅可通过 getWrapper(Class) 方法创建子类。在创建 Wrapper 子类的过程中，子类代码生成逻辑会对 getWrapper 方法传入的 Class 对象进行解析，拿到诸如类方法，类成员变量等信息。以及生成 invokeMethod 方法代码和其他一些方法代码。代码生成完毕后，通过 Javassist 生成 Class 对象，最后再通过反射创建 Wrapper 实例。那么我们先来看看getWrapper()方法：
getWrapper()
public static Wrapper getWrapper(Class<?> c) {
while (ClassGenerator.isDynamicClass(c)) // can not wrapper on dynamic class.
{
// 返回该对象的超类
c = c.getSuperclass();
}
// 如果超类就是Object，则返回子类Wrapper
if (c == Object.class) {
return OBJECT_WRAPPER;
}
// 从缓存中获取 Wrapper 实例
Wrapper ret = WRAPPER_MAP.get(c);
// 如果没有命中，则创建 Wrapper
if (ret == null) {
// 创建Wrapper
ret = makeWrapper(c);
// 写入缓存
WRAPPER_MAP.put(c, ret);
}
return ret;
}该方法只是对Wrapper 做了缓存。主要的逻辑在makeWrapper()。
makeWrapper()
// 检测 c 是否为基本类型，若是则抛出异常
if (c.isPrimitive()) {
throw new IllegalArgumentException("Can not create wrapper for primitive type: " + c);
}
// 获得类名
String name = c.getName();
// 获得类加载器
ClassLoader cl = ClassHelper.getClassLoader(c);
// c1 用于存储 setPropertyValue 方法代码
StringBuilder c1 = new StringBuilder("public void setPropertyValue(Object o, String n, Object v){ ");
// c2 用于存储 getPropertyValue 方法代码
StringBuilder c2 = new StringBuilder("public Object getPropertyValue(Object o, String n){ ");
// c3 用于存储 invokeMethod 方法代码
StringBuilder c3 = new StringBuilder("public Object invokeMethod(Object o, String n, Class[] p, Object[] v) throws " + InvocationTargetException.class.getName() + "{ ");
// 生成类型转换代码及异常捕捉代码，比如：
// DemoService w; try { w = ((DemoServcie) $1); }}catch(Throwable e){ throw new IllegalArgumentException(e); }
c1.append(name).append(" w; try{ w = ((").append(name).append(")$1); }catch(Throwable e){ throw new IllegalArgumentException(e); }");
c2.append(name).append(" w; try{ w = ((").append(name).append(")$1); }catch(Throwable e){ throw new IllegalArgumentException(e); }");
c3.append(name).append(" w; try{ w = ((").append(name).append(")$1); }catch(Throwable e){ throw new IllegalArgumentException(e); }");
// pts 用于存储成员变量名和类型
Map<String, Class<?>> pts = new HashMap<>(); // <property name, property types>
// ms 用于存储方法描述信息（可理解为方法签名）及 Method 实例
Map<String, Method> ms = new LinkedHashMap<>(); // <method desc, Method instance>
// mns 为方法名列表
List<String> mns = new ArrayList<>(); // method names.
// dmns 用于存储“定义在当前类中的方法”的名称
List<String> dmns = new ArrayList<>(); // declaring method names.
// get all public field.
// 获取 public 访问级别的字段，并为所有字段生成条件判断语句
for (Field f : c.getFields()) {
String fn = f.getName();
Class<?> ft = f.getType();
if (Modifier.isStatic(f.getModifiers()) || Modifier.isTransient(f.getModifiers())) {
// 忽略关键字 static 或 transient 修饰的变量
continue;
}
// 生成条件判断及赋值语句，比如：
// if( $2.equals("name") ) { w.name = (java.lang.String) $3; return;}
// if( $2.equals("age") ) { w.age = ((Number) $3).intValue(); return;}
c1.append(" if( $2.equals(\"").append(fn).append("\") ){ w.").append(fn).append("=").append(arg(ft, "$3")).append("; return; }");
// 生成条件判断及返回语句，比如：
// if( $2.equals("name") ) { return ($w)w.name; }
c2.append(" if( $2.equals(\"").append(fn).append("\") ){ return ($w)w.").append(fn).append("; }");
// 存储 <字段名, 字段类型> 键值对到 pts 中
pts.put(fn, ft);
}
// 获得c类的所有方法
Method[] methods = c.getMethods();
// get all public method.
// 检测 c 中是否包含在当前类中声明的方法
boolean hasMethod = hasMethods(methods);
// 如果包含
if (hasMethod) {
c3.append(" try{");
for (Method m : methods) {
//ignore Object's method.
// 忽略 Object 中定义的方法
if (m.getDeclaringClass() == Object.class) {
continue;
}
// 获得方法的名称
String mn = m.getName();
// 生成方法名判断语句，比如：
// if ( "sayHello".equals( $2 )
c3.append(" if( \"").append(mn).append("\".equals( $2 ) ");
int len = m.getParameterTypes().length;
// 生成“运行时传入的参数数量与方法参数列表长度”判断语句，比如：
// && $3.length == 2
c3.append(" && ").append(" $3.length == ").append(len);
boolean override = false;
for (Method m2 : methods) {
// 检测方法是否存在重载情况，条件为：方法对象不同 && 方法名相同
if (m != m2 && m.getName().equals(m2.getName())) {
override = true;
break;
}
}
// 对重载方法进行处理，考虑下面的方法：
// 1. void sayHello(Integer, String)
// 2. void sayHello(Integer, Integer)
// 方法名相同，参数列表长度也相同，因此不能仅通过这两项判断两个方法是否相等。
// 需要进一步判断方法的参数类型
if (override) {
if (len > 0) {
for (int l = 0; l < len; l++) {
c3.append(" && ").append(" $3[").append(l).append("].getName().equals(\"")
.append(m.getParameterTypes()[l].getName()).append("\")");
}
}
}
// 添加 ) {，完成方法判断语句，此时生成的代码可能如下（已格式化）：
// if ("sayHello".equals($2)
// && $3.length == 2
// && $3[0].getName().equals("java.lang.Integer")
// && $3[1].getName().equals("java.lang.String")) {
c3.append(" ) { ");
// 根据返回值类型生成目标方法调用语句
if (m.getReturnType() == Void.TYPE) {
// w.sayHello((java.lang.Integer)$4[0], (java.lang.String)$4[1]); return null;
c3.append(" w.").append(mn).append('(').append(args(m.getParameterTypes(), "$4")).append(");").append(" return null;");
} else {
// return w.sayHello((java.lang.Integer)$4[0], (java.lang.String)$4[1]);
c3.append(" return ($w)w.").append(mn).append('(').append(args(m.getParameterTypes(), "$4")).append(");");
}
c3.append(" }");
// 添加方法名到 mns 集合中
mns.add(mn);
// 检测当前方法是否在 c 中被声明的
if (m.getDeclaringClass() == c) {
// 若是，则将当前方法名添加到 dmns 中
dmns.add(mn);
}
ms.put(ReflectUtils.getDesc(m), m);
}
// 添加异常捕捉语句
c3.append(" } catch(Throwable e) { ");
c3.append(" throw new java.lang.reflect.InvocationTargetException(e); ");
c3.append(" }");
}
// 添加NoSuchMethodException异常
c3.append(" throw new " + NoSuchMethodException.class.getName() + "(\"Not found method \\\"\"+$2+\"\\\" in class " + c.getName() + ".\"); }");
// deal with get/set method.
Matcher matcher;
// 处理 get/set 方法
for (Map.Entry<String, Method> entry : ms.entrySet()) {
// 获得方法名称
String md = entry.getKey();
// 获得Method方法
Method method = entry.getValue();
// 如果是get开头的方法
if ((matcher = ReflectUtils.GETTER_METHOD_DESC_PATTERN.matcher(md)).matches()) {
// 获取属性名
String pn = propertyName(matcher.group(1));
// 生成属性判断以及返回语句，示例如下：
// if( $2.equals("name") ) { return ($w).w.getName(); }
c2.append(" if( $2.equals(\"").append(pn).append("\") ){ return ($w)w.").append(method.getName()).append("(); }");
pts.put(pn, method.getReturnType());
} else if ((matcher = ReflectUtils.IS_HAS_CAN_METHOD_DESC_PATTERN.matcher(md)).matches()) {
String pn = propertyName(matcher.group(1));
c2.append(" if( $2.equals(\"").append(pn).append("\") ){ return ($w)w.").append(method.getName()).append("(); }");
// 存储属性名和返回类型到pts
pts.put(pn, method.getReturnType());
} else if ((matcher = ReflectUtils.SETTER_METHOD_DESC_PATTERN.matcher(md)).matches()) {
// 如果是set开头的方法
// 获得参数类型
Class<?> pt = method.getParameterTypes()[0];
// 获得属性名
String pn = propertyName(matcher.group(1));
// 生成属性判断以及 setter 调用语句，示例如下：
// if( $2.equals("name") ) { w.setName((java.lang.String)$3); return; }
c1.append(" if( $2.equals(\"").append(pn).append("\") ){ w.").append(method.getName()).append("(").append(arg(pt, "$3")).append("); return; }");
pts.put(pn, pt);
}
}
// 添加 NoSuchPropertyException 异常抛出代码
c1.append(" throw new " + NoSuchPropertyException.class.getName() + "(\"Not found property \\\"\"+$2+\"\\\" field or setter method in class " + c.getName() + ".\"); }");
c2.append(" throw new " + NoSuchPropertyException.class.getName() + "(\"Not found property \\\"\"+$2+\"\\\" field or setter method in class " + c.getName() + ".\"); }");
// make class
long id = WRAPPER_CLASS_COUNTER.getAndIncrement();
// 创建类生成器
ClassGenerator cc = ClassGenerator.newInstance(cl);
// 设置类名及超类
cc.setClassName((Modifier.isPublic(c.getModifiers()) ? Wrapper.class.getName() : c.getName() + "$sw") + id);
cc.setSuperClass(Wrapper.class);
// 添加默认的构造函数
cc.addDefaultConstructor();
// 添加字段
cc.addField("public static String[] pns;"); // property name array.
cc.addField("public static " + Map.class.getName() + " pts;"); // property type map.
cc.addField("public static String[] mns;"); // all method name array.
cc.addField("public static String[] dmns;"); // declared method name array.
for (int i = 0, len = ms.size(); i < len; i++) {
cc.addField("public static Class[] mts" + i + ";");
}
// 添加方法
cc.addMethod("public String[] getPropertyNames(){ return pns; }");
cc.addMethod("public boolean hasProperty(String n){ return pts.containsKey($1); }");
cc.addMethod("public Class getPropertyType(String n){ return (Class)pts.get($1); }");
cc.addMethod("public String[] getMethodNames(){ return mns; }");
cc.addMethod("public String[] getDeclaredMethodNames(){ return dmns; }");
cc.addMethod(c1.toString());
cc.addMethod(c2.toString());
cc.addMethod(c3.toString());
try {
// 生成类
Class<?> wc = cc.toClass();
// setup static field.
// 设置字段值
wc.getField("pts").set(null, pts);
wc.getField("pns").set(null, pts.keySet().toArray(new String[0]));
wc.getField("mns").set(null, mns.toArray(new String[0]));
wc.getField("dmns").set(null, dmns.toArray(new String[0]));
int ix = 0;
for (Method m : ms.values()) {
wc.getField("mts" + ix++).set(null, m.getParameterTypes());
}
// 创建 Wrapper 实例
return (Wrapper) wc.newInstance();
} catch (RuntimeException e) {
throw e;
} catch (Throwable e) {
throw new RuntimeException(e.getMessage(), e);
} finally {
cc.release();
ms.clear();
mns.clear();
dmns.clear();
}
}该方法有点长，大致可以分为几个步骤：
- 初始化了c1、c2、c3、pts、ms、mns、dmns变量，向 c1、c2、c3 中添加方法定义和类型转换代码。
- 为 public 级别的字段生成条件判断取值与赋值代码
- 为定义在当前类中的方法生成判断语句，和方法调用语句。
- 处理 getter、setter 以及以 is/has/can 开头的方法。处理方式是通过正则表达式获取方法类型（get/set/is/...），以及属性名。之后为属性名生成判断语句，然后为方法生成调用语句。
- 通过 ClassGenerator 为刚刚生成的代码构建 Class 类，并通过反射创建对象。ClassGenerator 是 Dubbo 自己封装的，该类的核心是 toClass() 的重载方法 toClass(ClassLoader, ProtectionDomain)，该方法通过 javassist 构建 Class。
服务暴露
服务暴露分为暴露到本地 (JVM)，和暴露到远程。doExportUrlsFor1Protocol()方法分割线下半部分就是服务暴露的逻辑。根据scope的配置分为：
- scope = none，不暴露服务
- scope != remote，暴露到本地
- scope != local，暴露到远程
暴露到本地
导出本地执行的是ServiceConfig中的exportLocal()方法。
exportLocal()（4）
private void exportLocal(URL url) {
// 如果协议不是injvm
if (!Constants.LOCAL_PROTOCOL.equalsIgnoreCase(url.getProtocol())) {
// 生成本地的url,分别把协议改为injvm，设置host和port
URL local = URLBuilder.from(url)
.setProtocol(Constants.LOCAL_PROTOCOL)
.setHost(LOCALHOST_VALUE)
.setPort(0)
.build();
// 通过代理工程创建invoker
// 再调用export方法进行暴露服务，生成Exporter
Exporter<?> exporter = protocol.export(
proxyFactory.getInvoker(ref, (Class) interfaceClass, local));
// 把生成的暴露者加入集合
exporters.add(exporter);
logger.info("Export dubbo service " + interfaceClass.getName() + " to local registry");
}
}本地暴露调用的是injvm协议方法，也就是InjvmProtocol 的 export()方法。
export()（5）
public <T> Exporter<T> export(Invoker<T> invoker) throws RpcException {
return new InjvmExporter<T>(invoker, invoker.getUrl().getServiceKey(), exporterMap);
}该方法只是创建了一个，因为暴露到本地，所以在同一个jvm中。所以不需要其他操作。
暴露到远程
暴露到远程的逻辑要比本地复杂的多，它大致可以分为服务暴露和服务注册两个过程。先来看看服务暴露。我们知道dubbo有很多协议实现，在doExportUrlsFor1Protocol()方法分割线下半部分中，生成了Invoker后，就需要调用protocol 的 export()方法，很多人会认为这里的export()就是配置中指定的协议实现中的方法，但这里是不对的。因为暴露到远程后需要进行服务注册，而RegistryProtocol的 export()方法就是实现了服务暴露和服务注册两个过程。所以这里的export()调用的是RegistryProtocol的 export()。
export()
public <T> Exporter<T> export(final Invoker<T> originInvoker) throws RpcException {
// 获得注册中心的url
URL registryUrl = getRegistryUrl(originInvoker);
// url to export locally
//获得已经注册的服务提供者url
URL providerUrl = getProviderUrl(originInvoker);
// Subscribe the override data
// FIXME When the provider subscribes, it will affect the scene : a certain JVM exposes the service and call
// the same service. Because the subscribed is cached key with the name of the service, it causes the
// subscription information to cover.
// 获取override订阅 URL
final URL overrideSubscribeUrl = getSubscribedOverrideUrl(providerUrl);
// 创建override的监听器
final OverrideListener overrideSubscribeListener = new OverrideListener(overrideSubscribeUrl, originInvoker);
// 把监听器添加到集合
overrideListeners.put(overrideSubscribeUrl, overrideSubscribeListener);
// 根据override的配置来覆盖原来的url，使得配置是最新的。
providerUrl = overrideUrlWithConfig(providerUrl, overrideSubscribeListener);
//export invoker
// 服务暴露
final ExporterChangeableWrapper<T> exporter = doLocalExport(originInvoker, providerUrl);
// url to registry
// 根据 URL 加载 Registry 实现类，比如ZookeeperRegistry
final Registry registry = getRegistry(originInvoker);
// 返回注册到注册表的url并过滤url参数一次
final URL registeredProviderUrl = getRegisteredProviderUrl(providerUrl, registryUrl);
// 生成ProviderInvokerWrapper，它会保存服务提供方和消费方的调用地址和代理对象
ProviderInvokerWrapper<T> providerInvokerWrapper = ProviderConsumerRegTable.registerProvider(originInvoker,
registryUrl, registeredProviderUrl);
// ————————————————————————————————分割线——————————————————————————————————————
//to judge if we need to delay publish
// 获取 register 参数
boolean register = registeredProviderUrl.getParameter("register", true);
// 如果需要注册服务
if (register) {
// 向注册中心注册服务
register(registryUrl, registeredProviderUrl);
// 设置reg为true，表示服务注册
providerInvokerWrapper.setReg(true);
}
// Deprecated! Subscribe to override rules in 2.6.x or before.
// 向注册中心进行订阅 override 数据
registry.subscribe(overrideSubscribeUrl, overrideSubscribeListener);
// 设置注册中心url
exporter.setRegisterUrl(registeredProviderUrl);
// 设置override数据订阅的url
exporter.setSubscribeUrl(overrideSubscribeUrl);
//Ensure that a new exporter instance is returned every time export
// 创建并返回 DestroyableExporter
return new DestroyableExporter<>(exporter);
}从代码上看，我用分割线分成两部分，分别是服务暴露和服务注册。该方法的逻辑大致分为以下几个步骤：
- 获得服务提供者的url，再通过override数据重新配置url，然后执行doLocalExport()进行服务暴露。
- 加载注册中心实现类，向注册中心注册服务。
- 向注册中心进行订阅 override 数据。
- 创建并返回 DestroyableExporter
服务暴露先调用的是RegistryProtocol的doLocalExport()方法
private <T> ExporterChangeableWrapper<T> doLocalExport(final Invoker<T> originInvoker, URL providerUrl) {
String key = getCacheKey(originInvoker);
// 加入缓存
return (ExporterChangeableWrapper<T>) bounds.computeIfAbsent(key, s -> {
// 创建 Invoker 为委托类对象
Invoker<?> invokerDelegate = new InvokerDelegate<>(originInvoker, providerUrl);
// 调用 protocol 的 export 方法暴露服务
return new ExporterChangeableWrapper<>((Exporter<T>) protocol.export(invokerDelegate), originInvoker);
});
}这里的逻辑比较简单，主要是在这里根据不同的协议配置，调用不同的protocol实现。跟暴露到本地的时候实现InjvmProtocol一样。我这里假设配置选用的是dubbo协议，来继续下面的介绍。
DubboProtocol的export()
《dubbo源码解析（二十四）远程调用——dubbo协议》中的（三）DubboProtocol有export()相关的源码分析， 从源码中可以看出做了一些本地存根的处理，关键的就是openServer，来启动服务器。
DubboProtocol的openServer()
《dubbo源码解析（二十四）远程调用——dubbo协议》中的（三）DubboProtocol有openServer()相关的源码分析， 不过该文章中的代码是2.6.x的代码，最新的版本中加入了 DCL。其中reset方法则是重置服务器的一些配置。例如在同一台机器上（单网卡），同一个端口上仅允许启动一个服务器实例。若某个端口上已有服务器实例，此时则调用 reset 方法重置服务器的一些配置。主要来看其中的createServer()方法。
DubboProtocol的createServer()
《dubbo源码解析（二十四）远程调用——dubbo协议》中的（三）DubboProtocol有createServer()相关的源码分析，其中最新版本的默认远程通讯服务端实现方式已经改为netty4。该方法大致可以分为以下几个步骤：
- 对服务端远程通讯服务端实现方式配置是否支持的检测
- 创建服务器实例，也就是调用bind()方法
- 对服务端远程通讯客户端实现方式配置是否支持的检测
Exchangers的bind()
可以参考《dubbo源码解析（十）远程通信——Exchange层》中的（二十一）Exchangers。
public static ExchangeServer bind(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，默认为 HeaderExchanger。
// 紧接着调用 HeaderExchanger 的 bind 方法创建 ExchangeServer 实例
return getExchanger(url).bind(url, handler);
}HeaderExchanger的bind()
可以参考《dubbo源码解析（十）远程通信——Exchange层》（十六）HeaderExchanger，其中bind()方法做了大致以下步骤：
- 创建HeaderExchangeHandler
- 创建DecodeHandler
- Transporters.bind()，创建服务器实例。
- 创建HeaderExchangeServer
其中HeaderExchangeHandler、DecodeHandler、HeaderExchangeServer可以参考《dubbo源码解析（十）远程通信——Exchange层》中的讲解。
Transporters的bind()（6）
public static Server bind(URL url, ChannelHandler... handlers) throws RemotingException {
if (url == null) {
throw new IllegalArgumentException("url == null");
}
if (handlers == null || handlers.length == 0) {
throw new IllegalArgumentException("handlers == null");
}
ChannelHandler handler;
if (handlers.length == 1) {
handler = handlers[0];
} else {
// 如果 handlers 元素数量大于1，则创建 ChannelHandler 分发器
handler = new ChannelHandlerDispatcher(handlers);
}
// 获取自适应 Transporter 实例，并调用实例方法
return getTransporter().bind(url, handler);
}getTransporter() 方法获取的 Transporter 是在运行时动态创建的，类名为 TransporterAdaptive，也就是自适应拓展类。TransporterAdaptive 会在运行时根据传入的 URL 参数决定加载什么类型的 Transporter，默认为基于Netty4的实现。假设是 NettyTransporter 的 bind 方法。
NettyTransporter的bind()（6）
可以参考《dubbo源码解析（十七）远程通信——Netty4》的（六）NettyTransporter。
public Server bind(URL url, ChannelHandler listener) throws RemotingException {
// 创建NettyServer
return new NettyServer(url, listener);
}NettyServer的构造方法（7）
可以参考《dubbo源码解析（十七）远程通信——Netty4》的（五）NettyServer
public NettyServer(URL url, ChannelHandler handler) throws RemotingException {
super(url, ChannelHandlers.wrap(handler, ExecutorUtil.setThreadName(url, SERVER_THREAD_POOL_NAME)));
}调用的是父类AbstractServer构造方法
AbstractServer的构造方法（7）
可以参考《dubbo源码解析（九）远程通信——Transport层》的（三）AbstractServer中的构造方法。
服务器实例创建完以后，就是开启服务器了，AbstractServer中的doOpen是抽象方法，还是拿netty4来讲解，也就是看NettyServer的doOpen()的方法。
NettyServer的doOpen()
可以参考《dubbo源码解析（十七）远程通信——Netty4》中的（五）NettyServer中的源码分析。这里执行完成后，服务器被开启，服务也暴露出来了。接下来就是讲解服务注册的内容。
服务注册（9）
dubbo服务注册并不是必须的，因为dubbo支持直连的方式就可以绕过注册中心。直连的方式很多时候用来做服务测试。
回过头去看一下RegistryProtocol的 export()方法的分割线下面部分。其中服务注册先调用的是register()方法。
RegistryProtocol的register()
public void register(URL registryUrl, URL registeredProviderUrl) {
// 获取 Registry
Registry registry = registryFactory.getRegistry(registryUrl);
// 注册服务
registry.register(registeredProviderUrl);
}所以服务注册大致可以分为两步：
- 获得注册中心实例
- 注册服务
获得注册中心首先执行的是AbstractRegistryFactory的getRegistry()方法
AbstractRegistryFactory的getRegistry()
可以参考《dubbo源码解析（三）注册中心——开篇》的（七）support包下的AbstractRegistryFactory中的源码解析。大概的逻辑就是先从缓存中取，如果没有命中，则创建注册中心实例，这里的createRegistry()是一个抽象方法，具体的实现逻辑由子类完成，假设这里使用zookeeper作为注册中心，则调用的是ZookeeperRegistryFactory的createRegistry()。
ZookeeperRegistryFactory的createRegistry()
public Registry createRegistry(URL url) {
return new ZookeeperRegistry(url, zookeeperTransporter);
}就是创建了一个ZookeeperRegistry，执行了ZookeeperRegistry的构造方法。
ZookeeperRegistry的构造方法
可以参考《dubbo源码解析（七）注册中心——zookeeper》的（一）ZookeeperRegistry中的源码分析。大致的逻辑可以分为以下几个步骤：
- 创建zookeeper客户端
- 添加监听器
主要看ZookeeperTransporter的connect方法，因为当connect方法执行完后，注册中心创建过程就结束了。首先执行的是AbstractZookeeperTransporter的connect方法。
AbstractZookeeperTransporter的connect()
public ZookeeperClient connect(URL url) {
ZookeeperClient zookeeperClient;
// 获得所有url地址
List<String> addressList = getURLBackupAddress(url);
// The field define the zookeeper server , including protocol, host, port, username, password
// 从缓存中查找可用的客户端，如果有，则直接返回
if ((zookeeperClient = fetchAndUpdateZookeeperClientCache(addressList)) != null && zookeeperClient.isConnected()) {
logger.info("find valid zookeeper client from the cache for address: " + url);
return zookeeperClient;
}
// avoid creating too many connections， so add lock
synchronized (zookeeperClientMap) {
if ((zookeeperClient = fetchAndUpdateZookeeperClientCache(addressList)) != null && zookeeperClient.isConnected()) {
logger.info("find valid zookeeper client from the cache for address: " + url);
return zookeeperClient;
}
// 创建客户端
zookeeperClient = createZookeeperClient(toClientURL(url));
logger.info("No valid zookeeper client found from cache, therefore create a new client for url. " + url);
// 加入缓存
writeToClientMap(addressList, zookeeperClient);
}
return zookeeperClient;
}看上面的源码，主要是执行了createZookeeperClient()方法，而该方法是一个抽象方法，由子类实现，这里是CuratorZookeeperTransporter的createZookeeperClient()
CuratorZookeeperTransporter的createZookeeperClient()
public ZookeeperClient createZookeeperClient(URL url) {
return new CuratorZookeeperClient(url);
}这里就是执行了CuratorZookeeperClient的构造方法。
CuratorZookeeperClient的构造方法
可以参考《dubbo源码解析（十八）远程通信——Zookeeper》的（四）CuratorZookeeperClient中的源码分析，其中逻辑主要用于创建和启动 CuratorFramework 实例，基本都是调用Curator框架的API。
创建完注册中心的实例后，我们就要进行注册服务了。也就是调用的是FailbackRegistry的register()方法。
FailbackRegistry的register()
可以参考《dubbo源码解析（三）注册中心——开篇》的（六）support包下的FailbackRegistry中的源码分析。可以看到关键是执行了doRegister()方法，该方法是抽象方法，由子类完成。这里因为假设是zookeeper，所以执行的是ZookeeperRegistry的doRegister()。
ZookeeperRegistry的doRegister()
可以参考《dubbo源码解析（七）注册中心——zookeeper》的（一）ZookeeperRegistry中的源代码，可以看到逻辑就是调用Zookeeper 客户端创建服务节点。节点路径由 toUrlPath 方法生成。而这里create方法执行的是AbstractZookeeperClient的create() 方法
AbstractZookeeperClient的create()
可以参考dubbo源码解析（十八）远程通信——Zookeeper》的（二）AbstractZookeeperClient中的源代码分析。createEphemeral()和createPersistent()是抽象方法，具体实现由子类完成，也就是CuratorZookeeperClient类。代码逻辑比较简单。我就不再赘述。到这里为止，服务也就注册完成。
关于向注册中心进行订阅 override 数据的规则在最新版本有一些大变动，跟2.6.x及以前的都不一样。所以这部分内容在新特性中去讲解。
后记
参考官方文档：https://dubbo.apache.org/zh-c...
该文章讲解了dubbo的服务暴露过程，也是为了之后讲2.7新特性做铺垫，下一篇讲解服务的引用过程。
java
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用。你还可以使用@来通知其他用户。