了解服務發布
Dubbo官方文檔說明了服務提供者暴露服務的主過程,如圖所示:
首先ServiceConfig類拿到對外提供服務的實際類ref(如:HelloWorldImpl),然后通過ProxyFactory類的 getInvoker方法使用ref生成一個AbstractProxyInvoker實例,到這一步就完成具體服務到Invoker的轉化。接下來就是Invoker轉換到Exporter的過程。Dubbo 處理服務暴露的關鍵就在Invoker轉換到Exporter的過程,上圖中的紅色部分。
源碼分析
入口分析——ServiceBean
服務發布在spring的配置文件中配置如下:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
http://code.alibabatech.com/schema/dubbo
http://code.alibabatech.com/schema/dubbo/dubbo.xsd">
<bean id="demoService" class="com.alibaba.dubbo.demo.provider.DemoServiceImpl" />
<dubbo:service interface="com.alibaba.dubbo.demo.DemoService" ref="demoService" />
</beans>
如果熟悉Spring自定義標簽,應該知道<dubbo:service>
標簽會轉換成ServiceBean。通過DubboNamespaceHandler.init()方法可知,其源碼如下:
registerBeanDefinitionParser("service",
new DubboBeanDefinitionParser(ServiceBean.class, true));
ServiceBean類結構如下圖所示:
dubbo暴露服務有兩種情況,一種是設置了延遲暴露(比如delay=”5000”),另外一種是沒有設置延遲暴露或者延遲設置為-1(delay=”-1”):
1、設置了延遲暴露,dubbo在Spring實例化bean(initializeBean)的時候會對實現了InitializingBean的類進行回調,回調方法是afterPropertySet(),如果設置了延遲暴露,dubbo在這個方法中進行服務的發布。
2、沒有設置延遲或者延遲為-1,dubbo會在Spring實例化完bean之后,在刷新容器最后一步發布ContextRefreshEvent事件的時候,通知實現了ApplicationListener的類進行回調onApplicationEvent,dubbo會在這個方法中發布服務。
但是不管延遲與否,都是使用ServiceConfig的export()方法進行服務的暴露。使用export初始化的時候會將Bean對象轉換成URL格式,所有Bean屬性轉換成URL的參數。
ServiceConfig.export()方法
ServiceConfig.export()的流程圖如下:
1、export()方法先判斷是否需要延遲暴露,如果設置了延遲,則通過一個后臺線程調用doExport()方法;反之,直接調用doExport()方法。
2、doExport方法先執行一系列的檢查方法,然后調用doExportUrls方法。檢查方法會檢測dubbo的配置是否在Spring配置文件中聲明,沒有的話讀取properties文件初始化。
3、doExportUrls方法先調用loadRegistries獲取所有的注冊中心url,然后遍歷調用doExportUrlsFor1Protocol方法。
4、doExportUrlsFor1Protocol()先將Bean屬性轉換成URL對象,然后根據不同協議將服務已URL形式發布。如果scope配置為none則不暴露,如果服務未配置成remote,則本地暴露exportLocal,如果未配置成local,則遠程暴露。
暴露服務的核心是由doExportUrlsFor1Protocol()方法處理的,其源碼如下:
private void doExportUrlsFor1Protocol(ProtocolConfig protocolConfig, List<URL> registryURLs) {
// 1、Bean屬性轉換URL
URL url = new URL(name, host, port, (contextPath == null || contextPath.length() == 0 ? "" : contextPath + "/") + path, map);
if (ExtensionLoader.getExtensionLoader(ConfiguratorFactory.class)
.hasExtension(url.getProtocol())) {
url = ExtensionLoader.getExtensionLoader(ConfiguratorFactory.class)
.getExtension(url.getProtocol()).getConfigurator(url).configure(url);
}
String scope = url.getParameter(Constants.SCOPE_KEY);
if (! Constants.SCOPE_NONE.toString().equalsIgnoreCase(scope)) {
// scope配置不是remote的情況下做本地暴露
if (!Constants.SCOPE_REMOTE.toString().equalsIgnoreCase(scope)) {
exportLocal(url);
}
// scope配置不是local則暴露為遠程服務
if (! Constants.SCOPE_LOCAL.toString().equalsIgnoreCase(scope) ){
if (registryURLs != null && registryURLs.size() > 0
&& url.getParameter("register", true)) {
for (URL registryURL : registryURLs) {
url = url.addParameterIfAbsent("dynamic", registryURL.getParameter("dynamic"));
URL monitorUrl = loadMonitor(registryURL);
if (monitorUrl != null) {
url = url.addParameterAndEncoded(Constants.MONITOR_KEY, monitorUrl.toFullString());
}
// 2、具體服務到invoker的轉換
Invoker<?> invoker = proxyFactory.getInvoker(ref, (Class) interfaceClass, registryURL.addParameterAndEncoded(Constants.EXPORT_KEY, url.toFullString()));
// 3、invoker轉換為exporter
Exporter<?> exporter = protocol.export(invoker);
exporters.add(exporter);
}
} else {
Invoker<?> invoker = proxyFactory.getInvoker(ref, (Class) interfaceClass, url);
Exporter<?> exporter = protocol.export(invoker);
exporters.add(exporter);
}
}
}
this.urls.add(url);
}
具體服務到Invoker轉換
在分析具體服務到Invoker之前,先來看看ServiceConfig的proxyFactory實例。其定義如下:
private static final ProxyFactory proxyFactory = ExtensionLoader.getExtensionLoader(ProxyFactory.class).getAdaptiveExtension();
ProxyFactory的自適應擴展點的getInvoker方法源碼如下:
public com.alibaba.dubbo.rpc.Invoker getInvoker(java.lang.Object arg0, java.lang.Class arg1, com.alibaba.dubbo.common.URL arg2) throws RpcException {
if (arg2 == null) throw new IllegalArgumentException("url == null");
com.alibaba.dubbo.common.URL url = arg2;
// 如果url沒有proxy參數,默認為javassist
String extName = url.getParameter("proxy", "javassist");
if (extName == null)
throw new IllegalStateException("Fail to get extension(com.alibaba.dubbo.rpc.ProxyFactory) name from url(" + url.toString() + ") use keys([proxy])");
com.alibaba.dubbo.rpc.ProxyFactory extension = (com.alibaba.dubbo.rpc.ProxyFactory) ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.ProxyFactory.class).getExtension(extName);
return extension.getInvoker(arg0, arg1, arg2);
}
通過上述源碼我們知道,最終獲取invoker是由JavassistProxyFactory.getInvoker方法實現的,其源碼如下:
public <T> Invoker<T> getInvoker(T proxy, Class<T> type, URL url) {
// 獲取具體服務類的包裝對象
final Wrapper wrapper = Wrapper.getWrapper(proxy.getClass().getName().indexOf('$') < 0 ? proxy.getClass() : type);
// 返回構造invoker實例
return new AbstractProxyInvoker<T>(proxy, type, url) {
@Override
protected Object doInvoke(T proxy, String methodName,
Class<?>[] parameterTypes,
Object[] arguments) throws Throwable {
return wrapper.invokeMethod(proxy, methodName, parameterTypes, arguments);
}
};
}
流程總結:
1、根據url的proxy參數獲取對應ProxyFactory類,默認為JavassistProxyFactory;
2、獲取具體服務類的包裝對象;
3、返回構造invoker實例,將服務具體類的方法調用封裝在doInvoke()方法中。
遠程暴露
通過debug源碼,protocol.export(invoker)的時序圖如下:
流程總結
1、構建invoker過濾鏈;
2、首先DubboProcotol的export方法將invoker轉換成DubboExporter,啟動Server服務,然后將DubboExporter包裝為ListenerExporterWrapper。
3、RegistryProtocol的export方法向注冊中心注冊服務提供者url和訂閱url,再次將ListenerExporterWrapper包裝為Exporter,覆蓋unexport()方法。
RegistryProtocol.export()方法的注冊和訂閱
下面我們分析下RegistryProtocol.export()方法的注冊和訂閱,其源碼如下:
public <T> Exporter<T> export(final Invoker<T> originInvoker) throws RpcException {
//export invoker
final ExporterChangeableWrapper<T> exporter = doLocalExport(originInvoker);
//registry provider
final Registry registry = getRegistry(originInvoker);
final URL registedProviderUrl = getRegistedProviderUrl(originInvoker);
registry.register(registedProviderUrl);
// 訂閱override數據
// provider://172.16.6.216:20880/com.alibaba.dubbo.demo.DemoService?anyhost=true&application=demo-provider&category=configurators&check=false&dubbo=2.5.3&interface=com.alibaba.dubbo.demo.DemoService&loadbalance=roundrobin&methods=sayHello&owner=william&pid=2154&side=provider×tamp=1520235259270
final URL overrideSubscribeUrl = getSubscribedOverrideUrl(registedProviderUrl);
final OverrideListener overrideSubscribeListener = new OverrideListener(overrideSubscribeUrl);
overrideListeners.put(overrideSubscribeUrl, overrideSubscribeListener);
registry.subscribe(overrideSubscribeUrl, overrideSubscribeListener);
//保證每次export都返回一個新的exporter實例
return new Exporter<T>() {
public Invoker<T> getInvoker() {
return exporter.getInvoker();
}
public void unexport() {
try {
exporter.unexport();
} catch (Throwable t) {
logger.warn(t.getMessage(), t);
}
try {
registry.unregister(registedProviderUrl);
} catch (Throwable t) {
logger.warn(t.getMessage(), t);
}
try {
overrideListeners.remove(overrideSubscribeUrl);
registry.unsubscribe(overrideSubscribeUrl, overrideSubscribeListener);
} catch (Throwable t) {
logger.warn(t.getMessage(), t);
}
}
};
}
注冊
由于使用zookeeper作為注冊中心,所以registry為ZookeeperRegistry。ZookeeperRegistry.registry過程如下:
ZookeeperRegistry.doRegister方法如下:
protected void doRegister(URL url) {
try {
zkClient.create(toUrlPath(url), url.getParameter(Constants.DYNAMIC_KEY, true));
} catch (Throwable e) {
throw new RpcException("Failed to register " + url + " to zookeeper " + getUrl() + ", cause: " + e.getMessage(), e);
}
}
doRegister方法將url轉換為注冊zookeeper的path,創建臨時節點。 臨時節點在zookeeper會話失效后會自動刪除的,Dubbo如何解決這個問題。
public FailbackRegistry(URL url) {
super(url);
int retryPeriod = url.getParameter(Constants.REGISTRY_RETRY_PERIOD_KEY, Constants.DEFAULT_REGISTRY_RETRY_PERIOD);
this.retryFuture = retryExecutor.scheduleWithFixedDelay(new Runnable() {
public void run() {
// 檢測并連接注冊中心
try {
retry();
} catch (Throwable t) { // 防御性容錯
logger.error("Unexpected error occur at failed retry, cause: " + t.getMessage(), t);
}
}
}, retryPeriod, retryPeriod, TimeUnit.MILLISECONDS);
}
訂閱
protected void doSubscribe(final URL url, final NotifyListener listener) {
try {
if (Constants.ANY_VALUE.equals(url.getServiceInterface())) {
String root = toRootPath();
ConcurrentMap<NotifyListener, ChildListener> listeners = zkListeners.get(url);
if (listeners == null) {
zkListeners.putIfAbsent(url, new ConcurrentHashMap<NotifyListener, ChildListener>());
listeners = zkListeners.get(url);
}
ChildListener zkListener = listeners.get(listener);
if (zkListener == null) {
listeners.putIfAbsent(listener, new ChildListener() {
public void childChanged(String parentPath, List<String> currentChilds) {
for (String child : currentChilds) {
if (! anyServices.contains(child)) {
anyServices.add(child);
subscribe(url.setPath(child).addParameters(Constants.INTERFACE_KEY, child,
Constants.CHECK_KEY, String.valueOf(false)), listener);
}
}
}
});
zkListener = listeners.get(listener);
}
zkClient.create(root, false);
List<String> services = zkClient.addChildListener(root, zkListener);
if (services != null && services.size() > 0) {
anyServices.addAll(services);
for (String service : services) {
subscribe(url.setPath(service).addParameters(Constants.INTERFACE_KEY, service,
Constants.CHECK_KEY, String.valueOf(false)), listener);
}
}
} else {
List<URL> urls = new ArrayList<URL>();
// /dubbo/com.alibaba.dubbo.demo.DemoService/configurators
for (String path : toCategoriesPath(url)) {
ConcurrentMap<NotifyListener, ChildListener> listeners = zkListeners.get(url);
if (listeners == null) {
zkListeners.putIfAbsent(url, new ConcurrentHashMap<NotifyListener, ChildListener>());
listeners = zkListeners.get(url);
}
ChildListener zkListener = listeners.get(listener);
if (zkListener == null) {
listeners.putIfAbsent(listener, new ChildListener() {
public void childChanged(String parentPath, List<String> currentChilds) {
//
ZookeeperRegistry.this.notify(url, listener, toUrlsWithEmpty(url, parentPath, currentChilds));
}
});
zkListener = listeners.get(listener);
}
zkClient.create(path, false);
List<String> children = zkClient.addChildListener(path, zkListener);
if (children != null) {
urls.addAll(toUrlsWithEmpty(url, path, children));
}
}
notify(url, listener, urls);
}
} catch (Throwable e) {
throw new RpcException("Failed to subscribe " + url + " to zookeeper " + getUrl() + ", cause: " + e.getMessage(), e);
}
}
doSubscribe方法首先將NotifyListener轉換為Zookeeper Listener,創建/dubbo/com.alibaba.dubbo.demo.DemoService/configurators
持久節點并訂閱。
為什么要訂閱/dubbo/com.alibaba.dubbo.demo.DemoService/configurators這個節點。