Dubbbo spring配置方式解析
Posted 秋风兮月
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Dubbbo spring配置方式解析相关的知识，希望对你有一定的参考价值。
我们知道dubbo使用了spring的自定义标签。在使用自定义标签的时候，需要建立自定义标签的解析类BeanDefinitionParser，Dubbo中的BeanDefinitionParser为com.alibaba.dubbo.config.spring.schema.DubboBeanDefinitionParser，建立处理类NamespaceHandlerSupport，Dubbo中为com.alibaba.dubbo.config.spring.schema.DubboNamespaceHandler。还需要建立xsd文件，用来校验自定义标签的有效性，Dubbo中创建了dubbo.xsd文件。另外为了让spring读取我们自定义的的schema和handlers，默认是根据spring.handlers和spring.schemas来读取的，这两个文件默认放在META-INF下。对于Dubbo的这两个文件的内容如下：
spring.handlers
http\\://code.alibabatech.com/schema/dubbo=com.alibaba.dubbo.config.spring.schema.DubboNamespaceHandlerspring.schemas
http\\://code.alibabatech.com/schema/dubbo/dubbo.xsd=META-INF/dubbo.xsd从DubboNamespaceHandler的源码如下：
public class DubboNamespaceHandler extends NamespaceHandlerSupport
static
Version.checkDuplicate(DubboNamespaceHandler.class);
public void init()
registerBeanDefinitionParser("application", new DubboBeanDefinitionParser(ApplicationConfig.class, true));
registerBeanDefinitionParser("module", new DubboBeanDefinitionParser(ModuleConfig.class, true));
registerBeanDefinitionParser("registry", new DubboBeanDefinitionParser(RegistryConfig.class, true));
registerBeanDefinitionParser("monitor", new DubboBeanDefinitionParser(MonitorConfig.class, true));
registerBeanDefinitionParser("provider", new DubboBeanDefinitionParser(ProviderConfig.class, true));
registerBeanDefinitionParser("consumer", new DubboBeanDefinitionParser(ConsumerConfig.class, true));
registerBeanDefinitionParser("protocol", new DubboBeanDefinitionParser(ProtocolConfig.class, true));
registerBeanDefinitionParser("service", new DubboBeanDefinitionParser(ServiceBean.class, true));
registerBeanDefinitionParser("reference", new DubboBeanDefinitionParser(ReferenceBean.class, false));
registerBeanDefinitionParser("annotation", new DubboBeanDefinitionParser(AnnotationBean.class, true));
这里注册了一些自定义标签的解析器，从代码里我们可以看明白，对于registry、monitor、provider、consumer、protocol等标签，在xml定义的属性所配置的都是相应的xxxConfig对象的属性，而不是xxx的本身的属性，根据这些标签所创建的对象实际上是xxxConfig对象，然后dubbo再根据这些config里所配置的属性来创建相应的xxx对象。这里不要搞混了。
对于这个解析操作核心的就是DubboBeanDefinitionParser类中的private static BeanDefinition parse(Element element, ParserContext parserContext, Class<?> beanClass, boolean required)函数。下面对这个函数的代码进行解析。
private static BeanDefinition parse(Element element, ParserContext parserContext, Class<?> beanClass, boolean required)
RootBeanDefinition beanDefinition = new RootBeanDefinition();
beanDefinition.setBeanClass(beanClass);
beanDefinition.setLazyInit(false);
String id = element.getAttribute("id");
/**
* 这里的代码主要是用来获取id
* 主要是从name属性去获取，如果name为空，如果beanClass是ProtocolConfig类，那么就赋值为dubbo，该值为默认值
* 否则可以从inteface属性来获取。如果generatedBeanName仍然为空，那么就使用beanClass的name
*/
if ((id == null || id.length() == 0) && required)
String generatedBeanName = element.getAttribute("name");
if (generatedBeanName == null || generatedBeanName.length() == 0)
if (ProtocolConfig.class.equals(beanClass))
generatedBeanName = "dubbo";
else
generatedBeanName = element.getAttribute("interface");
if (generatedBeanName == null || generatedBeanName.length() == 0)
generatedBeanName = beanClass.getName();
id = generatedBeanName;
int counter = 2;
while(parserContext.getRegistry().containsBeanDefinition(id))
id = generatedBeanName + (counter ++);
/**
* 将该id的beanDefinition加入到BeanDefinitionRegistry中去
*/
if (id != null && id.length() > 0)
if (parserContext.getRegistry().containsBeanDefinition(id))
throw new IllegalStateException("Duplicate spring bean id " + id);
parserContext.getRegistry().registerBeanDefinition(id, beanDefinition);
beanDefinition.getPropertyValues().addPropertyValue("id", id);
/**
* 如果beanClass是ProtocolConfig.class，即标签是"<dubbo:protocol>“的形式，
* 那么需要遍历已有的BeanDefinition。如果已有的beanDefinition有protocol属性，并且和该ProtocolConfig的id一致，
* 就需要将该beanDefinition的protocol的值替换成当前的ProtocolConfig的BeanDefinition。
* 这里是因为如果含有该protocol属性的beanDefinition是在该ProtocolConfig的BeanDefinition之前就创建了，
* 那么就直接new了一个新的name为配置的的protocol属性值的ProtocolConfig对象。可以参见后面的代码
*/
if (ProtocolConfig.class.equals(beanClass))
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()))
definition.getPropertyValues().addPropertyValue("protocol", new RuntimeBeanReference(id));
/**
* 如果beanClass是ServiceBean.class，即标签是"<dubbo:service>“的形式，如果标签中含有classs属性，
* 那么需要解析该标签下的子标签"<property>"，根据该属性创建对应class属性值的RootBeanDefinition。
* 这里是直接在<dubbo:service>指定所引用的bean，而不是使用ref属性来指定。
*/
else if (ServiceBean.class.equals(beanClass))
String className = element.getAttribute("class");
if(className != null && className.length() > 0)
RootBeanDefinition classDefinition = new RootBeanDefinition();
classDefinition.setBeanClass(ReflectUtils.forName(className));
classDefinition.setLazyInit(false);
parseProperties(element.getChildNodes(), classDefinition);
beanDefinition.getPropertyValues().addPropertyValue("ref", new BeanDefinitionHolder(classDefinition, id + "Impl"));
/**
* 如果beanClass是ProviderConfig.class，即标签为"<dubbo:provider>"的形式。调用了parseNested来解析
* parseNested方法的作用是解析该标签下的指定名称的子元素，并将解析的子元素的相应的property的value指定为该beanDefinition。
* 例如对于ProviderConfig，就去解析下面的<dubbo:service>子元素，创建beanClass为ServiceBean.class的beanDefinition，
* 并将创建的beanDefinition的provider属性值设置为ProviderConfig.class的beanDefinition
*/
else if (ProviderConfig.class.equals(beanClass))
parseNested(element, parserContext, ServiceBean.class, true, "service", "provider", id, beanDefinition);
/**
* 如果beanClass是ConsumerConfig.class，即标签为"<dubbo:consumer>"的形式。调用了parseNested来解析
*/
else if (ConsumerConfig.class.equals(beanClass))
parseNested(element, parserContext, ReferenceBean.class, false, "reference", "consumer", id, beanDefinition);
/**
* 下面为通用的xml相关属性的解析过程
*/
Set<String> props = new HashSet<String>();
ManagedMap parameters = null;
/**
* 主要根据bean的getter和setter方法来设置对应的属性值
*/
for (Method setter : beanClass.getMethods())
String name = setter.getName();
if (name.length() > 3 && name.startsWith("set")
&& Modifier.isPublic(setter.getModifiers())
&& setter.getParameterTypes().length == 1)
Class<?> type = setter.getParameterTypes()[0];
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;
/**
* 如果bean中含有parameters属性，那么在xml中标签的子元素中解析<dubbo:parameter>的属性值赋值给parameters
*/
if ("parameters".equals(property))
parameters = parseParameters(element.getChildNodes(), beanDefinition);
/**
* 如果bean中含有methods属性，那么在xml中标签的子元素中解析<dubbo:method>的属性值，赋值给beanDefinition的methods属性
*/
else if ("methods".equals(property))
parseMethods(id, element.getChildNodes(), beanDefinition, parserContext);
/**
* 如果bean中含有arguments属性，那么在xml中标签的子元素中解析<dubbo:argument>的属性值，赋值给beanDefinition的arguments属性
*/
else if ("arguments".equals(property))
parseArguments(id, element.getChildNodes(), beanDefinition, parserContext);
// 其他属性的处理逻辑
else
String value = element.getAttribute(property);
if (value != null)
value = value.trim();
if (value.length() > 0)
/**
* 对于registry属性，如果value是"N/A"时，直接new一个RegistryConfig对象赋值给beanDefinition的registry属性
*/
if ("registry".equals(property) && RegistryConfig.NO_AVAILABLE.equalsIgnoreCase(value))
RegistryConfig registryConfig = new RegistryConfig();
registryConfig.setAddress(RegistryConfig.NO_AVAILABLE);
beanDefinition.getPropertyValues().addPropertyValue(property, registryConfig);
/**
* 对于registry属性，如果属性值是以","分隔的属性值，那么将使用registries属性解析赋值
*/
else if ("registry".equals(property) && value.indexOf(',') != -1)
parseMultiRef("registries", value, beanDefinition, parserContext);
/**
* 对于provider属性，如果属性值是以","分隔的属性值，那么将使用providers属性解析赋值
*/
else if ("provider".equals(property) && value.indexOf(',') != -1)
parseMultiRef("providers", value, beanDefinition, parserContext);
/**
* 对于protocol属性，如果属性值是以","分隔的属性值，那么将使用protocols属性解析赋值
*/
else if ("protocol".equals(property) && value.indexOf(',') != -1)
parseMultiRef("protocols", value, beanDefinition, parserContext);
else
Object reference;
// java原生类型的数据
if (isPrimitive(type))
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值
value = null;
reference = value;
/**
* 如果属性是"protocol"，在含有该名称的protocol对象时，
* 如果BeanDefinitionRegistry中还没有id为该value的ProtocolConfig的beanDefinition，
* 或者有该id的beanDefinition，但是类型却不是ProtocolConfig.class的时候，
* 就去new一个新的ProtocolConfig对象。
* 如果后续又扫描到了id为该value的ProtocolConfig的beanDefinition的时候，
* 就会将new的新的ProtocolConfig对象替换成扫描到的beanDefinition的引用。这一点前面已经说过
*/
else if ("protocol".equals(property)
&& ExtensionLoader.getExtensionLoader(Protocol.class).hasExtension(value)
&& (! 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;
/**
* 属性是"monitor"的处理和protocol类似
*/
else if ("monitor".equals(property)
&& (! parserContext.getRegistry().containsBeanDefinition(value)
|| ! MonitorConfig.class.getName().equals(parserContext.getRegistry().getBeanDefinition(value).getBeanClassName())))
// 兼容旧版本配置
reference = convertMonitor(value);
/**
* 属性是"onreturn"的处理。value值是xxx.method
*/
else if ("onreturn".equals(property))
int index = value.lastIndexOf(".");
String returnRef = value.substring(0, index);
String returnMethod = value.substring(index + 1);
reference = new RuntimeBeanReference(returnRef);
beanDefinition.getPropertyValues().addPropertyValue("onreturnMethod", returnMethod);
/**
* 属性是"onthrow"的处理。value值是xxx.method
*/
else if ("onthrow".equals(property))
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);
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);
beanDefinition.getPropertyValues().addPropertyValue(property, reference);
/**
* 对于没有getter和setter方法的属性的处理，加入到parameters中
*/
NamedNodeMap attributes = element.getAttributes();
int len = attributes.getLength();
for (int i = 0; i < len; i++)
Node node = attributes.item(i);
String name = node.getLocalName();
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;
以上是关于Dubbbo spring配置方式解析的主要内容，如果未能解决你的问题，请参考以下文章
Spring源码剖析-事务源码之@Transactionl解析