聊聊Dubbo(四):核心原始碼-切入Spring

猿碼道發表於2019-03-04

1 Dubbo配置方式

  1. XML配置:基於 Spring 的 Schema 和 XML 擴充套件機制實現;
  2. 屬性配置:載入 classpath 根目錄下的 dubbo.properties;
  3. API 配置:通過硬編碼方式配置(不推薦使用);
  4. 註解配置:通過註解方式配置(Dubbo-2.5.7及以上版本支援,不推薦使用);

1.1 屬性配置

對於 屬性配置 方式,可以通過 環境變數、-D 啟動引數來指定 dubbo.properties 檔案,載入檔案順序為:

  1. -D 啟動引數;
  2. 環境變數;
  3. 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 啟動引數
                String path = System.getProperty(Constants.DUBBO_PROPERTIES_KEY);
                if (path == null || path.length() == 0) {
                    // 2. 環境變數
                    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擴充套件

文章開頭已經提到,Dubbo XML配置方式是基於 Spring 的 Schema 和 XML 擴充套件機制實現的。通過該機制,我們可以編寫自己的 Schema,並根據自定義的 Schema 自定義標籤來配置 Bean

使用 Spring 的 XML 擴充套件機制有以下幾個步驟:

  1. 定義 Schema(編寫 .xsd 檔案);
  2. 定義 JavaBean;
  3. 編寫 NamespaceHandler 和 BeanDefinitionParser 完成 Schema 解析;
  4. 編寫 spring.handlers 和 spring.schemas 檔案串聯解析部件;
  5. 在 XML 檔案中應用配置;

2.1 定義 Schema

Schema 的定義體現在 .xsd 檔案上,檔案位於 dubbo-config-spring 子模組下

dubbo.xsd

2.2 定義 JavaBean

dubbo-config-api 子模組中定義了 Dubbo 所有標籤對應的 JavaBean,JavaBean 裡面的屬性一一對應標籤的各配置項:

Dubbo標籤對應的JavaBean

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是如何來解析這些配置呢?如果我們想自己定義配置該如何做呢?對於上述的XML配置,分成三個部分:

  1. 名稱空間namespace,如tx、context
  2. 元素element,如component-scan、property-placeholder、annotation-driven
  3. 屬性attribute,如base-package、location、transaction-manager

Spring定義了兩個介面,來分別解析上述內容:

  1. NamespaceHandler:註冊了一堆BeanDefinitionParser,利用他們來進行解析;
  2. BeanDefinitionParser:用於解析每個element的內容;

來看下具體的一個案例,就以Spring的context名稱空間為例,對應的NamespaceHandler實現是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());
	}

}
複製程式碼

註冊了一堆BeanDefinitionParser,如果我們想看 component-scan 是如何實現的,就可以去看對應的 ComponentScanBeanDefinitionParser 的原始碼了。

如果自定義了NamespaceHandler,如何加入到Spring中呢?Spring預設會載入jar包下的META-INF/spring.handlers檔案下尋找NamespaceHandler,預設的Spring檔案如下:

META-INF/spring.handlers

spring.handlers檔案內容如下:相應的名稱空間使用相應的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
複製程式碼

同時,Spring 通過 spring.schemas 檔案得知,如 context 標籤的 Schema 是 context.xsd,並以此校驗應用 XML 配置檔案的格式。spring.schemas 檔案內容如下:

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.handlers&spring.schemas檔案

Spring框架初始化時會載入所有classpath的spring.handlers檔案,把namespace URL和namespace處理器的對映存到一個Map中,Spring框架在解析bean定義文件時,遇到了非IOC內建(beans名稱空間下)的標籤,會在這個Map中查詢namespace處理器,使用這個自定義的處理器來進行標籤解析工作。可以在 DefaultBeanDefinitionDocumentReaderBeanDefinitionParserDelegate 類中看到相關邏輯的程式碼:

 // 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); //解析預設標籤
                    }
                    else {
                        delegate.parseCustomElement(ele); //解析自定義標籤
                    }
                }
            }
    }
    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">

    <!-- 提供方應用資訊,用於計算依賴關係 -->
    <dubbo:application name="demo-provider"/>
    <!-- 使用multicast廣播註冊中心暴露服務地址 -->
    <dubbo:registry address="multicast://224.5.6.7:1234"/>
    <!-- 用dubbo協議在20880埠暴露服務 -->
    <dubbo:protocol name="dubbo" port="20880"/>
    
    <dubbo:reference id="registryService" interface="com.alibaba.dubbo.registry.RegistryService">
        <property name= checkvalue= false”/>
    </dubbo:reference>
    <!-- 和本地bean一樣實現服務 -->
    <bean id="demoService" class="com.alibaba.dubbo.demo.provider.DemoServiceImpl"/>
    <!-- 宣告需要暴露的服務介面 -->
    <dubbo:service interface="com.alibaba.dubbo.demo.DemoService" ref="demoService"/>
</beans>
複製程式碼

3.1 XML轉化beanDefinition

根據Spring可擴充套件Schema,我們先去dubbo.jar內的META-INF/spring.handlers配置內容:

http://code.alibabatech.com/schema/dubbo=com.alibaba.dubbo.config.spring.schema.DubboNamespaceHandler
複製程式碼

我們從這個類(DubboNamespaceHandler)開刀吧,DubboNamespaceHandler程式碼:

public class DubboNamespaceHandler extends NamespaceHandlerSupport {
    static {
        // 確保系統中只存在一份解析處理器類定義
        Version.checkDuplicate(DubboNamespaceHandler.class);
    }
    public void init() {
        // DubboBeanDefinitionParser定義瞭如何解析dubbo節點資訊
        // DubboBeanDefinitionParser的第一個引數是beanclass
        // 配置<dubbo:application>標籤解析器
	registerBeanDefinitionParser("application", new DubboBeanDefinitionParser(ApplicationConfig.class, true));
        // 配置<dubbo:module>標籤解析器
	registerBeanDefinitionParser("module", new DubboBeanDefinitionParser(ModuleConfig.class, true));
        //配置<dubbo:registry>標籤解析器
	registerBeanDefinitionParser("registry", new DubboBeanDefinitionParser(RegistryConfig.class, true));
        //配置<dubbo:monitor>標籤解析器
	registerBeanDefinitionParser("monitor", new DubboBeanDefinitionParser(MonitorConfig.class, true));
        //配置<dubbo:provider>標籤解析器
	registerBeanDefinitionParser("provider", new DubboBeanDefinitionParser(ProviderConfig.class, true));
        //配置<dubbo:consumer>標籤解析器
	registerBeanDefinitionParser("consumer", new DubboBeanDefinitionParser(ConsumerConfig.class, true));
        //配置<dubbo:protocol>標籤解析器
	registerBeanDefinitionParser("protocol", new DubboBeanDefinitionParser(ProtocolConfig.class, true));
	//配置<dubbo:service>標籤解析器
	registerBeanDefinitionParser("service", new DubboBeanDefinitionParser(ServiceBean.class, true));
	//配置<dubbo:refenrence>標籤解析器
	registerBeanDefinitionParser("reference", new DubboBeanDefinitionParser(ReferenceBean.class, false));
	//配置<dubbo:annotation>標籤解析器
	registerBeanDefinitionParser("annotation", new DubboBeanDefinitionParser(AnnotationBean.class, true));
    }
}
複製程式碼

按照Spring提供的機制,Dubbo把每個自定義的可使用配置元素和對應的解析器繫結到一起。而真正負責把配置檔案中宣告的內容解析成對應的BeanDefinition(可以想象為Bean的模子)是靠DubboBeanDefinitionParser.parse類完成,所有dubbo的標籤,都統一用DubboBeanDefinitionParser進行解析,基於一對一屬性對映,將XML標籤解析為Bean物件。具體程式碼如下:

/** 
 * 解析dubbo自定義標籤,往BeanDefinition設定屬性值,這個時候bean還沒有建立 
 * @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);  
    // 設定懶載入為false,表示立即載入,spring啟動時,立刻進行例項化  
    // 如果設定為true,那麼要第一次向容器通過getBean索取bean時例項化,在spring bean的配置裡可以配置  
    // 這裡會設定懶載入為false,其實還可以得到一個推斷就是dubbo標籤建立的bean就是單例bean(singleton bean)  
    // 因為lazy-init的設定只對singleton bean有效,對原型bean(prototype無效)  
    beanDefinition.setLazyInit(false);  
    String id = element.getAttribute("id");  
    // 如果沒有設定bean的id  
    if ((id == null || id.length() == 0) && required) {  
        String generatedBeanName = element.getAttribute("name");  
        // 如果name沒有配置  
        if (generatedBeanName == null || generatedBeanName.length() == 0) {  
            // 如果是ProtocolConfig型別,bean name預設為 dubbo,其他的為配置的interface值  
            if (ProtocolConfig.class.equals(beanClass)) {  
                generatedBeanName = "dubbo";  
            } else {  
                generatedBeanName = element.getAttribute("interface");  
            }  
        }  
        /* 
         * 如果generatedBeanName仍為null,那麼取 beanClass 的名字,beanClass 其實就是要解析的型別
         * 如:com.alibaba.dubbo.config.ApplicationConfig 
         */  
        if (generatedBeanName == null || generatedBeanName.length() == 0) {  
            generatedBeanName = beanClass.getName();  
        }  
        //如果id沒有設定,那麼 id = generatedBeanName,如果是ProtocolConfig型別的話,自然就是 dubbo  
        id = generatedBeanName;   
        int counter = 2;  
        /* 
         * 由於spring的bean id不能重複,但有些標籤可能會配置多個如:dubbo:registry 
         * 所以 id 在後面加數字 2、3、4 區分 
         */  
        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);  
        }  
        /* 
         * 註冊 bean 定義 
         * org.springframework.beans.factory.support.DefaultListableBeanFactory#registerBeanDefinition 
         * 會按照 id 即beanName做一些檢查,判斷是否過載已載入過的bean等等 
         * 跟到程式碼裡其實 bean 的註冊也是放到 ConcurrentHashMap 裡 
         * beanName也就是這裡的 id 會放到 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:這個的類的主要作用是根據bean名稱返回bean例項的引用,避免客戶端顯示獲取bean例項;  
                    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();  
            // 通過反射獲取類  
            classDefinition.setBeanClass(ReflectUtils.forName(className));  
            classDefinition.setLazyInit(false);  
            /* 
             *   解析子節點,有些配置可能是: 
             *   <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直接設定成了 介面名 + Impl 的bean
             */  
            beanDefinition.getPropertyValues().addPropertyValue("ref", new BeanDefinitionHolder(classDefinition, id + "Impl"));  
        }  
    } else if (ProviderConfig.class.equals(beanClass)) {  
        /* 
         *   <dubbo:provider 為預設配置 ,所以在解析的時候,如果<dubbo:service有些值沒配置,那麼會用<dubbo:provider值進行填充 
         */  
        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注入值時,如ServiceConfig,方法必須是set開頭,並且引數數量只能為1  
        if (name.length() > 3 && name.startsWith("set")  
                && Modifier.isPublic(setter.getModifiers())  
                && setter.getParameterTypes().length == 1) {  
            // 方法引數型別,因為引數只能是1,所以直接取[0]  
            Class<?> type = setter.getParameterTypes()[0];  
            // 根據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) 
                 * 那麼去子節點獲取 <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 並設定 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) {  
                        // 不釋出到任何註冊中心時 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) {  
                            // 多註冊中心用 , 號分隔  
                            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) {  
                            // 同上 多協議暴露  
                            parseMultiRef("protocols", value, beanDefinition, parserContext);  
                        } else {  
                            Object reference;  
                            if (isPrimitive(type)) {//如果引數型別為 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對應的擴充點配置有沒有  
                                    && ExtensionLoader.getExtensionLoader(Protocol.class).hasExtension(value)  
                                    // 檢查當前使用的協議是否已經解析過 可能在這裡被解析過<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)) {  
                                // 回撥方法 類似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)) {  
                                // 回撥 異常執行的方法 ,類似 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容器裡也只有一個 例項 
                                     *  是不是和dubbo的冪等有關,如果為原型bean,那麼服務就變成有狀態的了 
                                     */  
                                    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);  
                            }  
                            /* 
                             *  設定屬性,值為另外一個關聯的bean 
                             *  RuntimeBeanReference 固定佔位符類,當在beanfactory中作為另外一個bean的引用時,作為屬性值物件,將在執行時進行解析 
                             */  
                            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));  
        }  
    }  
    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 時支援多引用  
    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 標籤沒有配置default開關,那麼直接設定 default = "false" 
                          *  這樣做的目的是為了讓 <dubbo:provider裡的配置都只是 <dubbo:service 或 <dubbo:reference的預設或預設配置 
                          */  
                         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的設定方法: 
                             *   <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;  
                    }  
                    // 新增引數,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 物件,RootBeanDefinition包含了解析出來的關於bean的所有資訊,注意,在bean的解析完後其實只是spring將其轉化成spring內部的一種抽象的資料物件結構,bean的建立(例項化)是第一次呼叫 getBean 時建立的

3.2 beanDefinition轉化Bean

beanDefinition轉化bean的過程其實都是有Spring來完成的,這部分是屬於Spring的內容,下圖大體描述了Spring內部是如何初始化bean:

Spring獲取Bean例項

相關文章