一、spring初始化时为什么可以解析dubbo的配置?
dubbo基于Spring可扩展Schema提供自定义配置支持。dubbo是依赖spring提供的这种机制来处理配置文件解析的,首先找到dubbo.jar下的META-INF/spring.handlers配置,内容如下:
http\://code.alibabatech.com/schema/dubbo=com.alibaba.dubbo.config.spring.schema.DubboNamespaceHandler也就是说我们在dubbo的xml配置头文件中配置的这个xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"指向的是哪个具体的类,通过这个类作为入口来对此xml中对应的dubbo配置内容进行解析并初始化,spring对xml的配置解析不在此篇范畴。
二、DubboNamespaceHandler这个入口类都做了些什么?
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
/**
* DubboNamespaceHandler 此类继承自spring的xml解析命名空间处理类,只是简单的一个init方法引用公共类进行
*
* @author william.liangf
* @export
*/
public class DubboNamespaceHandler extends NamespaceHandlerSupport {
static {
Version.checkDuplicate(DubboNamespaceHandler.class);
}
public void init() {
/*最后将定义好的bean装入到spring的bean容器中进行管理
*/
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));
}
}
三、DubboBeanDefinitionParser公共类进行解读,主要讲述parse方法
/*
*DubboBeanDefinitionParser implements BeanDefinitionParser的parse方法,源码如下:
*/
public BeanDefinition parse(Element element, ParserContext parserContext) {
/*直接调用本类中的一个静态方法,进行xml元素转换为bean的操作*/
return parse(element, parserContext, beanClass, required);
}
/*这里需要注意的是,本类并不负责xml的读取以及节点等内容的转换,如果需要知道xml是怎么被读取以及操作的,可以沿着ParserContext找XmlBeanDefinitionReader以及相关的Resource接口实现类来进行了解*/
private static BeanDefinition parse(Element element, ParserContext parserContext, Class<?> beanClass, boolean required) {
/*首先创建一个spring中的RootBeanDefinition对象,此对象继承自spring中的AbstractBeanDefinition,这也是spring中对xml中bean定义解析的核心类*/
RootBeanDefinition beanDefinition = new RootBeanDefinition();
/*将DubboNamespaceHandler类中传入的类名设置*/
beanDefinition.setBeanClass(beanClass);
/*将DubboNamespaceHandler类中传入的boolean值设置是否懒加载*/
beanDefinition.setLazyInit(false);
String id = element.getAttribute("id");
/*不存在id属性,并且是懒加载的*/
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属性,并且从已注册的bean中比对是否存在相同名称,是的话则抛出异常,不相同则进行注册*/
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);
}
/*如果是协议配置类*/
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));
}
}
}
/*如果是暴露服务配置类*/
} 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"));
}
/*如果是服务提供者配置类*/
} else if (ProviderConfig.class.equals(beanClass)) {
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;
/*接下来就是对各个配置类的属性进行校验以及调用set,get方法封装了*/
for (Method setter : beanClass.getMethods()) {
String name = setter.getName();
/*如果是public类型的set方法,如果这里getName拿到的是get***则不处理接着循环*/
if (name.length() > 3 && name.startsWith("set")
&& Modifier.isPublic(setter.getModifiers())
&& setter.getParameterTypes().length == 1) {
Class<?> type = setter.getParameterTypes()[0];
/*对set方法的属性名称进行转换,让其都转换为小写字母,如果其中有驼峰命名的则使用中横线连接,如:setNaMe 则会变成na-me*/
String property = StringUtils.camelToSplitName(name.substring(3, 4).toLowerCase() + name.substring(4), "-");
props.add(property);
Method getter = null;
try {
/*有没有get方法,有的话会取到get方法的全限定名,比如ApplicationConfig.class有个getName,那么得到整体为public java.lang.String com.alibaba.dubbo.config.ApplicationConfig.getName()*/
getter = beanClass.getMethod("get" + name.substring(3), new Class<?>[0]);
} catch (NoSuchMethodException e) {
try {
/*如果报错了,再试下是否为boolean类型的方法*/
getter = beanClass.getMethod("is" + name.substring(3), new Class<?>[0]);
} catch (NoSuchMethodException e2) {
}
}
/*如果不是public方法也不是,也不是get方法,同时set方法属性类型与get方法返回值类型不一致,就不往下执行了*/
if (getter == null
|| !Modifier.isPublic(getter.getModifiers())
|| !type.equals(getter.getReturnType())) {
continue;
}
/*下面就是对属性名称一一的匹配,区分开特殊的bean*/
if ("parameters".equals(property)) {
/*遍历子节点集合的key,value装入map中,key,value都封装为string类型*/
parameters = parseParameters(element.getChildNodes(), beanDefinition);
} else if ("methods".equals(property)) {
/*遍历方法标签子节点,进行深层次再次封装,方法名称不能为null,否则将会抛出throw new IllegalStateException("<dubbo:method> name attribute == null");异常*/
parseMethods(id, element.getChildNodes(), beanDefinition, parserContext);
} 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,值为N/A。则手动创建一个registryConfig,并设置为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);
/*如果属性名称为registry,值又是逗号分隔的多个*/
} else if ("registry".equals(property) && value.indexOf(',') != -1) {
parseMultiRef("registries", value, beanDefinition, parserContext);
/*如果属性名称为provider,值又是逗号分隔的多个*/
} else if ("provider".equals(property) && value.indexOf(',') != -1) {
parseMultiRef("providers", value, beanDefinition, parserContext);
/*如果属性名称为protocol,值又是逗号分隔的多个*/
} else if ("protocol".equals(property) && value.indexOf(',') != -1) {
parseMultiRef("protocols", value, beanDefinition, parserContext);
} else {
Object reference;
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)) {
/* 鍏煎鏃х増鏈瑇sd涓殑default鍊�*/
value = null;
}
reference = value;
} 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;
} 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);
} 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);
}
}
}
}
}
}
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));
}
}
/*最后将封装好的属性map,都绑定给对应的bean*/
if (parameters != null) {
beanDefinition.getPropertyValues().addPropertyValue("parameters", parameters);
}
/*最后返回这个定义好的bean*/
return beanDefinition;
}
以上是dubbo的xml中配置的属性解析并转换为bean的操作,这里暂不涉及服务的暴露注册以及服务的消费订阅,细心的可能发现
在DubboNamespaceHandler入口中,针对parse的入参最下面几个服务提供方,服务消费方以及注解都是通过子类的继承来实现功能的扩展。