1 Dubbo配置方式
- XML配置:基于 Spring 的 Schema 和 XML 擴(kuò)展機(jī)制實(shí)現(xiàn);
- 屬性配置:加載 classpath 根目錄下的 dubbo.properties柔纵;
- API 配置:通過(guò)硬編碼方式配置(不推薦使用)春贸;
- 注解配置:通過(guò)注解方式配置(Dubbo-2.5.7及以上版本支持等脂,不推薦使用)欣尼;
1.1 屬性配置
對(duì)于 屬性配置 方式,可以通過(guò) 環(huán)境變量叔营、-D 啟動(dòng)參數(shù)來(lái)指定 dubbo.properties 文件撑刺,加載文件順序?yàn)椋?/p>
- -D 啟動(dòng)參數(shù)鹉胖;
- 環(huán)境變量;
- classpath 根目錄够傍;
屬性配置 加載代碼 ConfigUtils.java
如下:
public static final String DUBBO_PROPERTIES_KEY = "dubbo.properties.file";
public static final String DEFAULT_DUBBO_PROPERTIES = "dubbo.properties";
private static volatile Properties PROPERTIES;
/**
* 屬性配置加載邏輯
*/
public static Properties getProperties() {
if (PROPERTIES == null) {
synchronized (ConfigUtils.class) {
if (PROPERTIES == null) {
// 1. -D 啟動(dòng)參數(shù)
String path = System.getProperty(Constants.DUBBO_PROPERTIES_KEY);
if (path == null || path.length() == 0) {
// 2. 環(huán)境變量
path = System.getenv(Constants.DUBBO_PROPERTIES_KEY);
if (path == null || path.length() == 0) {
// 3. classpath 根目錄
path = Constants.DEFAULT_DUBBO_PROPERTIES;
}
}
PROPERTIES = ConfigUtils.loadProperties(path, false, true);
}
}
}
return PROPERTIES;
}
2 Dubbo的Schema擴(kuò)展
文章開(kāi)頭已經(jīng)提到甫菠,Dubbo XML配置方式是基于 Spring 的 Schema 和 XML 擴(kuò)展機(jī)制實(shí)現(xiàn)的。通過(guò)該機(jī)制冕屯,我們可以編寫自己的 Schema寂诱,并根據(jù)自定義的 Schema 自定義標(biāo)簽來(lái)配置 Bean。
使用 Spring 的 XML 擴(kuò)展機(jī)制有以下幾個(gè)步驟:
- 定義 Schema(編寫 .xsd 文件)安聘;
- 定義 JavaBean痰洒;
- 編寫 NamespaceHandler 和 BeanDefinitionParser 完成 Schema 解析;
- 編寫 spring.handlers 和 spring.schemas 文件串聯(lián)解析部件浴韭;
- 在 XML 文件中應(yīng)用配置丘喻;
2.1 定義 Schema
Schema 的定義體現(xiàn)在 .xsd 文件上,文件位于 dubbo-config-spring 子模塊下:
2.2 定義 JavaBean
dubbo-config-api 子模塊中定義了 Dubbo 所有標(biāo)簽對(duì)應(yīng)的 JavaBean念颈,JavaBean 里面的屬性一一對(duì)應(yīng)標(biāo)簽的各配置項(xiàng):
2.3 解析Schema
以如下Spring XML文件中的配置為例:
<context:component-scan base-package="com.demo.dubbo.server.serviceimpl"/>
<context:property-placeholder location="classpath:config.properties"/>
<tx:annotation-driven transaction-manager="transactionManager"/>
Spring是如何來(lái)解析這些配置呢泉粉?如果我們想自己定義配置該如何做呢?對(duì)于上述的XML配置,分成三個(gè)部分:
- 命名空間namespace嗡靡,如tx跺撼、context
- 元素element,如component-scan叽躯、property-placeholder财边、annotation-driven
- 屬性attribute,如base-package点骑、location、transaction-manager
Spring定義了兩個(gè)接口谍夭,來(lái)分別解析上述內(nèi)容:
- NamespaceHandler:注冊(cè)了一堆BeanDefinitionParser黑滴,利用他們來(lái)進(jìn)行解析;
- BeanDefinitionParser:用于解析每個(gè)element的內(nèi)容紧索;
來(lái)看下具體的一個(gè)案例袁辈,就以Spring的context命名空間為例,對(duì)應(yīng)的NamespaceHandler
實(shí)現(xiàn)是ContextNamespaceHandler
:
public class ContextNamespaceHandler extends NamespaceHandlerSupport {
@Override
public void init() {
registerBeanDefinitionParser("property-placeholder", new PropertyPlaceholderBeanDefinitionParser());
registerBeanDefinitionParser("property-override", new PropertyOverrideBeanDefinitionParser());
registerBeanDefinitionParser("annotation-config", new AnnotationConfigBeanDefinitionParser());
registerBeanDefinitionParser("component-scan", new ComponentScanBeanDefinitionParser());
registerBeanDefinitionParser("load-time-weaver", new LoadTimeWeaverBeanDefinitionParser());
registerBeanDefinitionParser("spring-configured", new SpringConfiguredBeanDefinitionParser());
registerBeanDefinitionParser("mbean-export", new MBeanExportBeanDefinitionParser());
registerBeanDefinitionParser("mbean-server", new MBeanServerBeanDefinitionParser());
}
}
注冊(cè)了一堆BeanDefinitionParser珠漂,如果我們想看 component-scan
是如何實(shí)現(xiàn)的晚缩,就可以去看對(duì)應(yīng)的 ComponentScanBeanDefinitionParser
的源碼了。
如果自定義了NamespaceHandler媳危,如何加入到Spring中呢荞彼?Spring默認(rèn)會(huì)加載jar包下的META-INF/spring.handlers文件下尋找NamespaceHandler,默認(rèn)的Spring文件如下:
spring.handlers
文件內(nèi)容如下:相應(yīng)的命名空間使用相應(yīng)的NamespaceHandler
http\://www.springframework.org/schema/context=org.springframework.context.config.ContextNamespaceHandler
http\://www.springframework.org/schema/jee=org.springframework.ejb.config.JeeNamespaceHandler
http\://www.springframework.org/schema/lang=org.springframework.scripting.config.LangNamespaceHandler
http\://www.springframework.org/schema/task=org.springframework.scheduling.config.TaskNamespaceHandler
http\://www.springframework.org/schema/cache=org.springframework.cache.config.CacheNamespaceHandler
同時(shí)待笑,Spring 通過(guò) spring.schemas
文件得知鸣皂,如 context
標(biāo)簽的 Schema 是 context.xsd
,并以此校驗(yàn)應(yīng)用 XML 配置文件的格式暮蹂。spring.schemas 文件內(nèi)容如下:
http\://www.springframework.org/schema/context/spring-context-2.5.xsd=org/springframework/context/config/spring-context-2.5.xsd
http\://www.springframework.org/schema/context/spring-context-3.0.xsd=org/springframework/context/config/spring-context-3.0.xsd
http\://www.springframework.org/schema/context/spring-context-3.1.xsd=org/springframework/context/config/spring-context-3.1.xsd
http\://www.springframework.org/schema/context/spring-context-3.2.xsd=org/springframework/context/config/spring-context-3.2.xsd
http\://www.springframework.org/schema/context/spring-context-4.0.xsd=org/springframework/context/config/spring-context-4.0.xsd
http\://www.springframework.org/schema/context/spring-context-4.1.xsd=org/springframework/context/config/spring-context-4.1.xsd
http\://www.springframework.org/schema/context/spring-context-4.2.xsd=org/springframework/context/config/spring-context-4.2.xsd
http\://www.springframework.org/schema/context/spring-context-4.3.xsd=org/springframework/context/config/spring-context-4.3.xsd
http\://www.springframework.org/schema/context/spring-context.xsd=org/springframework/context/config/spring-context-4.3.xsd
......
文件位置如下:
Spring框架初始化時(shí)會(huì)加載所有classpath的spring.handlers文件寞缝,把namespace URL和namespace處理器的映射存到一個(gè)Map中,Spring框架在解析bean定義文檔時(shí)仰泻,遇到了非IOC內(nèi)置(beans名稱空間下)的標(biāo)簽荆陆,會(huì)在這個(gè)Map中查找namespace處理器,使用這個(gè)自定義的處理器來(lái)進(jìn)行標(biāo)簽解析工作集侯”惶洌可以在 DefaultBeanDefinitionDocumentReader
和 BeanDefinitionParserDelegate
類中看到相關(guān)邏輯的代碼:
// org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader.java
/**
* Parse the elements at the root level in the document:
* "import", "alias", "bean".
* @param root the DOM root element of the document
*/
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
if (delegate.isDefaultNamespace(root)) {
NodeList nl = root.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
if (node instanceof Element) {
Element ele = (Element) node;
if (delegate.isDefaultNamespace(ele)) {
parseDefaultElement(ele, delegate); //解析默認(rèn)標(biāo)簽
}
else {
delegate.parseCustomElement(ele); //解析自定義標(biāo)簽
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
// org.springframework.beans.factory.xml.BeanDefinitionParserDelegate.java
public BeanDefinition parseCustomElement(Element ele) {
return parseCustomElement(ele, null);
}
public BeanDefinition parseCustomElement(Element ele, BeanDefinition containingBd) {
String namespaceUri = getNamespaceURI(ele);
NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
if (handler == null) {
error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);
return null;
}
return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
}
3 Dubbo的Schema解析
以如下Dubbo Provider的Spring配置為例:
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
xmlns="http://www.springframework.org/schema/beans"
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">
<!-- 提供方應(yīng)用信息,用于計(jì)算依賴關(guān)系 -->
<dubbo:application name="demo-provider"/>
<!-- 使用multicast廣播注冊(cè)中心暴露服務(wù)地址 -->
<dubbo:registry address="multicast://224.5.6.7:1234"/>
<!-- 用dubbo協(xié)議在20880端口暴露服務(wù) -->
<dubbo:protocol name="dubbo" port="20880"/>
<dubbo:reference id="registryService" interface="com.alibaba.dubbo.registry.RegistryService">
<property name=” check” value=” false”/>
</dubbo:reference>
<!-- 和本地bean一樣實(shí)現(xiàn)服務(wù) -->
<bean id="demoService" class="com.alibaba.dubbo.demo.provider.DemoServiceImpl"/>
<!-- 聲明需要暴露的服務(wù)接口 -->
<dubbo:service interface="com.alibaba.dubbo.demo.DemoService" ref="demoService"/>
</beans>
3.1 XML轉(zhuǎn)化beanDefinition
根據(jù)Spring可擴(kuò)展Schema浅悉,我們先去dubbo.jar
內(nèi)的META-INF/spring.handlers
配置內(nèi)容:
http\://code.alibabatech.com/schema/dubbo=com.alibaba.dubbo.config.spring.schema.DubboNamespaceHandler
我們從這個(gè)類(DubboNamespaceHandler
)開(kāi)刀吧趟据,DubboNamespaceHandler
代碼:
public class DubboNamespaceHandler extends NamespaceHandlerSupport {
static {
// 確保系統(tǒng)中只存在一份解析處理器類定義
Version.checkDuplicate(DubboNamespaceHandler.class);
}
public void init() {
// DubboBeanDefinitionParser定義了如何解析dubbo節(jié)點(diǎn)信息
// DubboBeanDefinitionParser的第一個(gè)參數(shù)是beanclass
//配置<dubbo:application>標(biāo)簽解析器
registerBeanDefinitionParser("application", new DubboBeanDefinitionParser(ApplicationConfig.class, true));
//配置<dubbo:module>標(biāo)簽解析器
registerBeanDefinitionParser("module", new DubboBeanDefinitionParser(ModuleConfig.class, true));
//配置<dubbo:registry>標(biāo)簽解析器
registerBeanDefinitionParser("registry", new DubboBeanDefinitionParser(RegistryConfig.class, true));
//配置<dubbo:monitor>標(biāo)簽解析器
registerBeanDefinitionParser("monitor", new DubboBeanDefinitionParser(MonitorConfig.class, true));
//配置<dubbo:provider>標(biāo)簽解析器
registerBeanDefinitionParser("provider", new DubboBeanDefinitionParser(ProviderConfig.class, true));
//配置<dubbo:consumer>標(biāo)簽解析器
registerBeanDefinitionParser("consumer", new DubboBeanDefinitionParser(ConsumerConfig.class, true));
//配置<dubbo:protocol>標(biāo)簽解析器
registerBeanDefinitionParser("protocol", new DubboBeanDefinitionParser(ProtocolConfig.class, true));
//配置<dubbo:service>標(biāo)簽解析器
registerBeanDefinitionParser("service", new DubboBeanDefinitionParser(ServiceBean.class, true));
//配置<dubbo:refenrence>標(biāo)簽解析器
registerBeanDefinitionParser("reference", new DubboBeanDefinitionParser(ReferenceBean.class, false));
//配置<dubbo:annotation>標(biāo)簽解析器
registerBeanDefinitionParser("annotation", new DubboBeanDefinitionParser(AnnotationBean.class, true));
}
}
按照Spring提供的機(jī)制,Dubbo把每個(gè)自定義的可使用配置元素和對(duì)應(yīng)的解析器綁定到一起术健。而真正負(fù)責(zé)把配置文件中聲明的內(nèi)容解析成對(duì)應(yīng)的BeanDefinition(可以想象為Bean的模子)是靠DubboBeanDefinitionParser.parse類完成汹碱,所有dubbo的標(biāo)簽,都統(tǒng)一用DubboBeanDefinitionParser進(jìn)行解析荞估,基于一對(duì)一屬性映射咳促,將XML標(biāo)簽解析為Bean對(duì)象稚新。具體代碼如下:
/**
* 解析dubbo自定義標(biāo)簽,往BeanDefinition設(shè)置屬性值,這個(gè)時(shí)候bean還沒(méi)有創(chuàng)建
* @param element
* @param parserContext
* @param beanClass
* @param required
* @return
*/
@SuppressWarnings("unchecked")
private static BeanDefinition parse(Element element, ParserContext parserContext, Class<?> beanClass, boolean required) {
RootBeanDefinition beanDefinition = new RootBeanDefinition();
beanDefinition.setBeanClass(beanClass);
// 設(shè)置懶加載為false,表示立即加載跪腹,spring啟動(dòng)時(shí)褂删,立刻進(jìn)行實(shí)例化
// 如果設(shè)置為true,那么要第一次向容器通過(guò)getBean索取bean時(shí)實(shí)例化冲茸,在spring bean的配置里可以配置
// 這里會(huì)設(shè)置懶加載為false屯阀,其實(shí)還可以得到一個(gè)推斷就是dubbo標(biāo)簽創(chuàng)建的bean就是單例bean(singleton bean)
// 因?yàn)閘azy-init的設(shè)置只對(duì)singleton bean有效,對(duì)原型bean(prototype無(wú)效)
beanDefinition.setLazyInit(false);
String id = element.getAttribute("id");
// 如果沒(méi)有設(shè)置bean的id
if ((id == null || id.length() == 0) && required) {
String generatedBeanName = element.getAttribute("name");
// 如果name沒(méi)有配置
if (generatedBeanName == null || generatedBeanName.length() == 0) {
// 如果是ProtocolConfig類型轴术,bean name默認(rèn)為 dubbo难衰,其他的為配置的interface值
if (ProtocolConfig.class.equals(beanClass)) {
generatedBeanName = "dubbo";
} else {
generatedBeanName = element.getAttribute("interface");
}
}
/*
* 如果generatedBeanName仍為null,那么取 beanClass 的名字逗栽,beanClass 其實(shí)就是要解析的類型
* 如:com.alibaba.dubbo.config.ApplicationConfig
*/
if (generatedBeanName == null || generatedBeanName.length() == 0) {
generatedBeanName = beanClass.getName();
}
//如果id沒(méi)有設(shè)置盖袭,那么 id = generatedBeanName,如果是ProtocolConfig類型的話,自然就是 dubbo
id = generatedBeanName;
int counter = 2;
/*
* 由于spring的bean id不能重復(fù)彼宠,但有些標(biāo)簽可能會(huì)配置多個(gè)如:dubbo:registry
* 所以 id 在后面加數(shù)字 2鳄虱、3、4 區(qū)分
*/
while(parserContext.getRegistry().containsBeanDefinition(id)) {
id = generatedBeanName + (counter ++);
}
}
if (id != null && id.length() > 0) {
// 檢查是否有 bean id 相同的
if (parserContext.getRegistry().containsBeanDefinition(id)) {
throw new IllegalStateException("Duplicate spring bean id " + id);
}
/*
* 注冊(cè) bean 定義
* org.springframework.beans.factory.support.DefaultListableBeanFactory#registerBeanDefinition
* 會(huì)按照 id 即beanName做一些檢查凭峡,判斷是否重載已加載過(guò)的bean等等
* 跟到代碼里其實(shí) bean 的注冊(cè)也是放到 ConcurrentHashMap 里
* beanName也就是這里的 id 會(huì)放到 list 里
*/
parserContext.getRegistry().registerBeanDefinition(id, beanDefinition);
// 給bean添加屬性值
beanDefinition.getPropertyValues().addPropertyValue("id", id);
}
if (ProtocolConfig.class.equals(beanClass)) { //解析<dubbo:protocol
for (String name : parserContext.getRegistry().getBeanDefinitionNames()) {
BeanDefinition definition = parserContext.getRegistry().getBeanDefinition(name);
PropertyValue property = definition.getPropertyValues().getPropertyValue("protocol");
if (property != null) {
Object value = property.getValue();
if (value instanceof ProtocolConfig && id.equals(((ProtocolConfig) value).getName())) {
// RuntimeBeanReference:這個(gè)的類的主要作用是根據(jù)bean名稱返回bean實(shí)例的引用拙已,避免客戶端顯示獲取bean實(shí)例;
definition.getPropertyValues().addPropertyValue("protocol", new RuntimeBeanReference(id));
}
}
}
} else if (ServiceBean.class.equals(beanClass)) { // 解析<dubbo:service
String className = element.getAttribute("class");// 獲取類全名
if(className != null && className.length() > 0) {
RootBeanDefinition classDefinition = new RootBeanDefinition();
// 通過(guò)反射獲取類
classDefinition.setBeanClass(ReflectUtils.forName(className));
classDefinition.setLazyInit(false);
/*
* 解析子節(jié)點(diǎn)想罕,有些配置可能是:
* <dubbo:service interface="com.alihealth.dubbo.api.drugInfo.service.DemoService" executes="10">
* <property name="ref" ref="demoService"></property>
* <property name="version" value="1.0.0"></property>
* </dubbo:service>
*/
parseProperties(element.getChildNodes(), classDefinition);
/*
* ref直接設(shè)置成了 接口名 + Impl 的bean
*/
beanDefinition.getPropertyValues().addPropertyValue("ref", new BeanDefinitionHolder(classDefinition, id + "Impl"));
}
} else if (ProviderConfig.class.equals(beanClass)) {
/*
* <dubbo:provider 為缺省配置 悠栓,所以在解析的時(shí)候,如果<dubbo:service有些值沒(méi)配置按价,那么會(huì)用<dubbo:provider值進(jìn)行填充
*/
parseNested(element, parserContext, ServiceBean.class, true, "service", "provider", id, beanDefinition);
} else if (ConsumerConfig.class.equals(beanClass)) {
/*
* 同上
*/
parseNested(element, parserContext, ReferenceBean.class, false, "reference", "consumer", id, beanDefinition);
}
Set<String> props = new HashSet<String>();
ManagedMap parameters = null;
for (Method setter : beanClass.getMethods()) {
String name = setter.getName();
// 給model注入值時(shí)惭适,如ServiceConfig,方法必須是set開(kāi)頭,并且參數(shù)數(shù)量只能為1
if (name.length() > 3 && name.startsWith("set")
&& Modifier.isPublic(setter.getModifiers())
&& setter.getParameterTypes().length == 1) {
// 方法參數(shù)類型楼镐,因?yàn)閰?shù)只能是1癞志,所以直接取[0]
Class<?> type = setter.getParameterTypes()[0];
// 根據(jù)set方法名獲取屬性值,如:setListener 得到的屬性為:listener
String property = StringUtils.camelToSplitName(name.substring(3, 4).toLowerCase() + name.substring(4), "-");
props.add(property);
Method getter = null;
try {
getter = beanClass.getMethod("get" + name.substring(3), new Class<?>[0]);
} catch (NoSuchMethodException e) {
try {
getter = beanClass.getMethod("is" + name.substring(3), new Class<?>[0]);
} catch (NoSuchMethodException e2) {
}
}
if (getter == null
|| ! Modifier.isPublic(getter.getModifiers())
|| ! type.equals(getter.getReturnType())) {
continue;
}
if ("parameters".equals(property)) {
/*
* 如果屬性為 parameters,如ProtocolConfig里的setParameters(Map<String, String> parameters)
* 那么去子節(jié)點(diǎn)獲取 <dubbo:parameter
* <dubbo:protocol name="dubbo" host="127.0.0.1" port="9998" accepts="1000" >
* <dubbo:parameter key="adsf" value="adf" />
* <dubbo:parameter key="errer" value="aerdf" />
* </dubbo:protocol>
*/
parameters = parseParameters(element.getChildNodes(), beanDefinition);
} else if ("methods".equals(property)) {
/*
* 解析 <dubbo:method 并設(shè)置 methods 值 --ServiceConfig中
*/
parseMethods(id, element.getChildNodes(), beanDefinition, parserContext);
} else if ("arguments".equals(property)) {
/*
* 同上 ,解析<dubbo:argument --- MethodConfig中
*/
parseArguments(id, element.getChildNodes(), beanDefinition, parserContext);
} else {
String value = element.getAttribute(property);
if (value != null) {
value = value.trim();
if (value.length() > 0) {
// 不發(fā)布到任何注冊(cè)中心時(shí) registry = "N/A"
if ("registry".equals(property) && RegistryConfig.NO_AVAILABLE.equalsIgnoreCase(value)) {
RegistryConfig registryConfig = new RegistryConfig();
registryConfig.setAddress(RegistryConfig.NO_AVAILABLE);
beanDefinition.getPropertyValues().addPropertyValue(property, registryConfig);
} else if ("registry".equals(property) && value.indexOf(',') != -1) {
// 多注冊(cè)中心用 , 號(hào)分隔
parseMultiRef("registries", value, beanDefinition, parserContext);
} else if ("provider".equals(property) && value.indexOf(',') != -1) {
parseMultiRef("providers", value, beanDefinition, parserContext);
} else if ("protocol".equals(property) && value.indexOf(',') != -1) {
// 同上 多協(xié)議暴露
parseMultiRef("protocols", value, beanDefinition, parserContext);
} else {
Object reference;
if (isPrimitive(type)) {//如果參數(shù)類型為 java 的基本類型
if ("async".equals(property) && "false".equals(value)
|| "timeout".equals(property) && "0".equals(value)
|| "delay".equals(property) && "0".equals(value)
|| "version".equals(property) && "0.0.0".equals(value)
|| "stat".equals(property) && "-1".equals(value)
|| "reliable".equals(property) && "false".equals(value)) {
/*
* 兼容舊版本xsd中的default值,以上配置的值在xsd中有配置defalt值
* <xsd:attribute name="version" type="xsd:string" use="optional" default="0.0.0">
*/
value = null;
}
reference = value;
} else if ("protocol".equals(property)
// 如果屬性為 protocol 那么要判斷protocol對(duì)應(yīng)的拓展點(diǎn)配置有沒(méi)有
&& ExtensionLoader.getExtensionLoader(Protocol.class).hasExtension(value)
// 檢查當(dāng)前使用的協(xié)議是否已經(jīng)解析過(guò) 可能在這里被解析過(guò)<dubbo:protocol name="dubbo"
&& (! parserContext.getRegistry().containsBeanDefinition(value)
|| ! ProtocolConfig.class.getName().equals(parserContext.getRegistry().getBeanDefinition(value).getBeanClassName()))) {
if ("dubbo:provider".equals(element.getTagName())) {
logger.warn("Recommended replace <dubbo:provider protocol=\"" + value + "\" ... /> to <dubbo:protocol name=\"" + value + "\" ... />");
}
// 兼容舊版本配置
ProtocolConfig protocol = new ProtocolConfig();
protocol.setName(value);
reference = protocol;
} else if ("monitor".equals(property)
// 同上
&& (! parserContext.getRegistry().containsBeanDefinition(value)
|| ! MonitorConfig.class.getName().equals(parserContext.getRegistry().getBeanDefinition(value).getBeanClassName()))) {
// 兼容舊版本配置
reference = convertMonitor(value);
} else if ("onreturn".equals(property)) {
// 回調(diào)方法 類似onSuccess
int index = value.lastIndexOf(".");
// bean的名字
String returnRef = value.substring(0, index);
String returnMethod = value.substring(index + 1);
reference = new RuntimeBeanReference(returnRef);
beanDefinition.getPropertyValues().addPropertyValue("onreturnMethod", returnMethod);
} else if ("onthrow".equals(property)) {
// 回調(diào) 異常執(zhí)行的方法 ,類似 onError
int index = value.lastIndexOf(".");
String throwRef = value.substring(0, index);
String throwMethod = value.substring(index + 1);
reference = new RuntimeBeanReference(throwRef);
beanDefinition.getPropertyValues().addPropertyValue("onthrowMethod", throwMethod);
} else {
if ("ref".equals(property) && parserContext.getRegistry().containsBeanDefinition(value)) {
BeanDefinition refBean = parserContext.getRegistry().getBeanDefinition(value);
/*
* 必須是單例bean(singleton),原型bean(prototype)不行,sevice初始化一次,在spring容器里也只有一個(gè) 實(shí)例
* 是不是和dubbo的冪等有關(guān)框产,如果為原型bean凄杯,那么服務(wù)就變成有狀態(tài)的了
*/
if (! refBean.isSingleton()) {
throw new IllegalStateException("The exported service ref " + value + " must be singleton! Please set the " + value + " bean scope to singleton, eg: <bean id=\"" + value+ "\" scope=\"singleton\" ...>");
}
}
reference = new RuntimeBeanReference(value);
}
/*
* 設(shè)置屬性,值為另外一個(gè)關(guān)聯(lián)的bean
* RuntimeBeanReference 固定占位符類秉宿,當(dāng)在beanfactory中作為另外一個(gè)bean的引用時(shí)戒突,作為屬性值對(duì)象,將在運(yùn)行時(shí)進(jìn)行解析
*/
beanDefinition.getPropertyValues().addPropertyValue(property, reference);
}
}
}
}
}
}
NamedNodeMap attributes = element.getAttributes();
int len = attributes.getLength();
for (int i = 0; i < len; i++) {
Node node = attributes.item(i);
String name = node.getLocalName();
// 經(jīng)過(guò)上面的解析,如果還有一些屬性沒(méi)有解析到的
if (! props.contains(name)) {
if (parameters == null) {
parameters = new ManagedMap();
}
String value = node.getNodeValue();
parameters.put(name, new TypedStringValue(value, String.class));
}
}
if (parameters != null) {
beanDefinition.getPropertyValues().addPropertyValue("parameters", parameters);
}
return beanDefinition;
}
@SuppressWarnings("unchecked")
private static void parseMultiRef(String property, String value, RootBeanDefinition beanDefinition,
ParserContext parserContext) {
// 解析 registries 描睦、providers膊存、protocols 時(shí)支持多引用
String[] values = value.split("\\s*[,]+\\s*");
ManagedList list = null;
for (int i = 0; i < values.length; i++) {
String v = values[i];
if (v != null && v.length() > 0) {
if (list == null) {
list = new ManagedList();
}
list.add(new RuntimeBeanReference(v));
}
}
beanDefinition.getPropertyValues().addPropertyValue(property, list);
}
private static void parseNested(Element element, ParserContext parserContext, Class<?> beanClass,
boolean required, String tag, String property, String ref, BeanDefinition beanDefinition) {
NodeList nodeList = element.getChildNodes();
if (nodeList != null && nodeList.getLength() > 0) {
boolean first = true;
for (int i = 0; i < nodeList.getLength(); i++) {
Node node = nodeList.item(i);
if (node instanceof Element) {
if (tag.equals(node.getNodeName())
|| tag.equals(node.getLocalName())) {
if (first) {
first = false;
String isDefault = element.getAttribute("default");
/*
* 如果 <dubbo:provider 標(biāo)簽沒(méi)有配置default開(kāi)關(guān),那么直接設(shè)置 default = "false"
* 這樣做的目的是為了讓 <dubbo:provider里的配置都只是 <dubbo:service 或 <dubbo:reference的默認(rèn)或缺省配置
*/
if (isDefault == null || isDefault.length() == 0) {
beanDefinition.getPropertyValues().addPropertyValue("default", "false");
}
}
BeanDefinition subDefinition = parse((Element) node, parserContext, beanClass, required);
if (subDefinition != null && ref != null && ref.length() > 0) {
subDefinition.getPropertyValues().addPropertyValue(property, new RuntimeBeanReference(ref));
}
}
}
}
}
}
private static void parseProperties(NodeList nodeList, RootBeanDefinition beanDefinition) {
if (nodeList != null && nodeList.getLength() > 0) {
for (int i = 0; i < nodeList.getLength(); i++) {
Node node = nodeList.item(i);
if (node instanceof Element) {
// 如果是 <property 元素
if ("property".equals(node.getNodeName())
|| "property".equals(node.getLocalName())) {
String name = ((Element) node).getAttribute("name");
if (name != null && name.length() > 0) {
String value = ((Element) node).getAttribute("value");
// 獲取 ref
String ref = ((Element) node).getAttribute("ref");
if (value != null && value.length() > 0) {
beanDefinition.getPropertyValues().addPropertyValue(name, value);
} else if (ref != null && ref.length() > 0) {
beanDefinition.getPropertyValues().addPropertyValue(name, new RuntimeBeanReference(ref));
} else {
/*
* 只支持兩種property的設(shè)置方法:
* <property ref="" name="">
* <property value="" name="">
*/
throw new UnsupportedOperationException("Unsupported <property name=\"" + name + "\"> sub tag, Only supported <property name=\"" + name + "\" ref=\"...\" /> or <property name=\"" + name + "\" value=\"...\" />");
}
}
}
}
}
}
}
@SuppressWarnings("unchecked")
private static ManagedMap parseParameters(NodeList nodeList, RootBeanDefinition beanDefinition) {
if (nodeList != null && nodeList.getLength() > 0) {
ManagedMap parameters = null;
for (int i = 0; i < nodeList.getLength(); i++) {
Node node = nodeList.item(i);
if (node instanceof Element) {
// 解析 <dubbo:parameter
if ("parameter".equals(node.getNodeName())
|| "parameter".equals(node.getLocalName())) {
if (parameters == null) {
parameters = new ManagedMap();
}
String key = ((Element) node).getAttribute("key");
String value = ((Element) node).getAttribute("value");
boolean hide = "true".equals(((Element) node).getAttribute("hide"));
if (hide) {
key = Constants.HIDE_KEY_PREFIX + key;
}
// 添加參數(shù),String 類型
parameters.put(key, new TypedStringValue(value, String.class));
}
}
}
return parameters;
}
return null;
}
@SuppressWarnings("unchecked")
private static void parseMethods(String id, NodeList nodeList, RootBeanDefinition beanDefinition,
ParserContext parserContext) {
if (nodeList != null && nodeList.getLength() > 0) {
ManagedList methods = null;
for (int i = 0; i < nodeList.getLength(); i++) {
Node node = nodeList.item(i);
if (node instanceof Element) {
Element element = (Element) node;
// <dubbo:method
if ("method".equals(node.getNodeName()) || "method".equals(node.getLocalName())) {
String methodName = element.getAttribute("name");
if (methodName == null || methodName.length() == 0) {
throw new IllegalStateException("<dubbo:method> name attribute == null");
}
if (methods == null) {
methods = new ManagedList();
}
// 解析 <dubbo:method MethodConfig
BeanDefinition methodBeanDefinition = parse(((Element) node),
parserContext, MethodConfig.class, false);
String name = id + "." + methodName;
BeanDefinitionHolder methodBeanDefinitionHolder = new BeanDefinitionHolder(
methodBeanDefinition, name);
methods.add(methodBeanDefinitionHolder);
}
}
}
if (methods != null) {
beanDefinition.getPropertyValues().addPropertyValue("methods", methods);
}
}
}
解析的最終目的是返回 RootBeanDefinition 對(duì)象,RootBeanDefinition包含了解析出來(lái)的關(guān)于bean的所有信息隔崎,注意今艺,在bean的解析完后其實(shí)只是spring將其轉(zhuǎn)化成spring內(nèi)部的一種抽象的數(shù)據(jù)對(duì)象結(jié)構(gòu),bean的創(chuàng)建(實(shí)例化)是第一次調(diào)用 getBean 時(shí)創(chuàng)建的爵卒。
3.2 beanDefinition轉(zhuǎn)化Bean
beanDefinition轉(zhuǎn)化bean的過(guò)程其實(shí)都是有Spring來(lái)完成的虚缎,這部分是屬于Spring的內(nèi)容,下圖大體描述了Spring內(nèi)部是如何初始化bean: