Spring Bean 標簽解析

来源:https://www.cnblogs.com/Yee-Q/archive/2022/07/17/16487609.html
-Advertisement-
Play Games

上一篇文章講到了標簽在 parseDefaultElement 方法中進行解析,本篇文章將講解這部分內容 bean 標簽解析 查看 processBeanDefinition 方法,針對各個操作作具體分析: protected void processBeanDefinition(Element e ...



上一篇文章講到了標簽在 parseDefaultElement 方法中進行解析,本篇文章將講解這部分內容


bean 標簽解析

查看 processBeanDefinition 方法,針對各個操作作具體分析:

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
    // 1.解析 BeanDefinition
    BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
    if (bdHolder != null) {
        bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
        try {
            BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, this.getReaderContext().getRegistry());
        } catch (BeanDefinitionStoreException var5) {
            this.getReaderContext().error("Failed to register bean definition with name '" + bdHolder.getBeanName() + "'", ele, var5);
        }
        this.getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
    }
}

1. 解析 BeanDefinition

首先從元素解析及信息提取開始,進入 parseBeanDefinitionElement 方法

public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
    return this.parseBeanDefinitionElement(ele, (BeanDefinition)null);
}

public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
    // 1.1 解析id屬性
    String id = ele.getAttribute("id");
    // 1.2 解析name屬性
    String nameAttr = ele.getAttribute("name");
    List<String> aliases = new ArrayList();
    if (StringUtils.hasLength(nameAttr)) {
        String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, ",; ");
        aliases.addAll(Arrays.asList(nameArr));
    }

    String beanName = id;
    if (!StringUtils.hasText(id) && !aliases.isEmpty()) {
        beanName = (String)aliases.remove(0);
        if (this.logger.isTraceEnabled()) {
            this.logger.trace("No XML 'id' specified - using '" + beanName + "' as bean name and " + aliases + " as aliases");
        }
    }

    if (containingBean == null) {
        this.checkNameUniqueness(beanName, aliases, ele);
    }
	// 2. 解析其他屬性
    AbstractBeanDefinition beanDefinition = this.parseBeanDefinitionElement(ele, beanName, containingBean);
    if (beanDefinition != null) {
        if (!StringUtils.hasText(beanName)) {
            try {
                // 3. 如果不存在beanName就根據Spring提供的命名規則為當前bean生成對應的beanName
                if (containingBean != null) {
                    beanName = BeanDefinitionReaderUtils.generateBeanName(beanDefinition, this.readerContext.getRegistry(), true);
                } else {
                    beanName = this.readerContext.generateBeanName(beanDefinition);
                    String beanClassName = beanDefinition.getBeanClassName();
                    if (beanClassName != null && beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() && !this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
                        aliases.add(beanClassName);
                    }
                }

                if (this.logger.isTraceEnabled()) {
                    this.logger.trace("Neither XML 'id' nor 'name' specified - using generated bean name [" + beanName + "]");
                }
            } catch (Exception var9) {
                this.error(var9.getMessage(), ele);
                return null;
            }
        }

        String[] aliasesArray = StringUtils.toStringArray(aliases);
        // 4. 封裝到 BeanDefinitionHolder 的實例
        return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
    } else {
        return null;
    }
}

該方法完成的主要工作包括以下內容:

  1. 提取元素中的 id 以及 name 屬性
  2. 進一步解析其他屬性並統一封裝至 GenericBeanDefinition 類型的實例中
  3. 如果檢測到 bean 沒有指定 beanName,那麼使用預設規則為此 Bean 生成 beanName
  4. 將獲取到的信息封裝到 BeanDefinitionHolder 的實例中

進一步查看步驟二對標簽的其他屬性的解析過程:

public AbstractBeanDefinition parseBeanDefinitionElement(Element ele, String beanName, @Nullable BeanDefinition containingBean) {
    this.parseState.push(new BeanEntry(beanName));
    String className = null;
    // 解析class屬性
    if (ele.hasAttribute("class")) {
        className = ele.getAttribute("class").trim();
    }
	// 解析parent屬性
    String parent = null;
    if (ele.hasAttribute("parent")) {
        parent = ele.getAttribute("parent");
    }

    try {
        // 創建用於承載屬性的AbstractBeanDefinition類型的GenericBeanDefinition實例
        AbstractBeanDefinition bd = this.createBeanDefinition(className, parent);
        // 硬編碼解析預設bean的各種屬性
        this.parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
        // 提取description
        bd.setDescription(DomUtils.getChildElementValueByTagName(ele, "description"));
        // 解析元數據
        this.parseMetaElements(ele, bd);
        // 解析lookup-method屬性
        this.parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
        // 解析replaced-method屬性
        this.parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
        // 解析構造函數參數
        this.parseConstructorArgElements(ele, bd);
        // 解析property子元素
        this.parsePropertyElements(ele, bd);
        // 解析qualifier子元素
        this.parseQualifierElements(ele, bd);
        bd.setResource(this.readerContext.getResource());
        bd.setSource(this.extractSource(ele));
        AbstractBeanDefinition var7 = bd;
        return var7;
    } catch (ClassNotFoundException var13) {
        this.error("Bean class [" + className + "] not found", ele, var13);
    } catch (NoClassDefFoundError var14) {
        this.error("Class that bean class [" + className + "] depends on not found", ele, var14);
    } catch (Throwable var15) {
        this.error("Unexpected failure during bean definition parsing", ele, var15);
    } finally {
        this.parseState.pop();
    }

    return null;
}

接下來,我們繼續一些複雜標簽屬性的解析:

1.1 創建用於屬性承載的 BeanDefinition

BeanDefinition 是一個介面,在 Spring 中存在三種實現:RootBeanDefinition、ChildBeanDefinition、GenericBeanDefinition,三種實現類均繼承了 AbstractBeanDefinition

BeanDefinition 是配置文件 <bean> 元素標簽在容器中的內部表示形式,<bean> 標簽擁有 class、scope、lazy-init 等配置屬性,BeanDefinition 就提供了對應的 beanClass、scope、lazyInit 屬性

由此可見,要解析屬性首先要創建用於承載屬性的實例,也就是創建 GenericBeanDefinition 類型的實例,createBeanDefinition 方法的作用就是實現此功能

public static AbstractBeanDefinition createBeanDefinition(@Nullable String parentName, @Nullable String className, @Nullable ClassLoader classLoader) throws ClassNotFoundException {
    GenericBeanDefinition bd = new GenericBeanDefinition();
    bd.setParentName(parentName);
    if (className != null) {
        // 如果classLoader不為空,則使用傳入的classLoader載入對象
        // 否則就只是記錄className
        if (classLoader != null) {
            bd.setBeanClass(ClassUtils.forName(className, classLoader));
        } else {
            bd.setBeanClassName(className);
        }
    }

    return bd;
}
2. 解析各種屬性

當我們創建了 bean 信息的承載實例後,便可以進行 bean 信息的各種屬性解析了,parseBeanDefinitionAttributes 方法是對 element 所有元素屬性進行解析:

public AbstractBeanDefinition parseBeanDefinitionAttributes(Element ele, String beanName, @Nullable BeanDefinition containingBean, AbstractBeanDefinition bd) {
    // 解析scope屬性
    if (ele.hasAttribute("singleton")) {
        this.error("Old 1.x 'singleton' attribute in use - upgrade to 'scope' declaration", ele);
    } else if (ele.hasAttribute("scope")) {
        bd.setScope(ele.getAttribute("scope"));
    } else if (containingBean != null) {
        bd.setScope(containingBean.getScope());
    }
	// 解析singleton屬性
    if (ele.hasAttribute("abstract")) {
        bd.setAbstract("true".equals(ele.getAttribute("abstract")));
    }
	// 解析lazy-init屬性
    String lazyInit = ele.getAttribute("lazy-init");
    if (this.isDefaultValue(lazyInit)) {
        lazyInit = this.defaults.getLazyInit();
    }
	// 若沒有設置或設置成其他字元都會被設置為false
    bd.setLazyInit("true".equals(lazyInit));
    String autowire = ele.getAttribute("autowire");
    bd.setAutowireMode(this.getAutowireMode(autowire));
    String autowireCandidate;
    if (ele.hasAttribute("depends-on")) {
        autowireCandidate = ele.getAttribute("depends-on");
        bd.setDependsOn(StringUtils.tokenizeToStringArray(autowireCandidate, ",; "));
    }
	// 解析autowire屬性
    autowireCandidate = ele.getAttribute("autowire-candidate");
    String destroyMethodName;
    if (this.isDefaultValue(autowireCandidate)) {
        destroyMethodName = this.defaults.getAutowireCandidates();
        if (destroyMethodName != null) {
            String[] patterns = StringUtils.commaDelimitedListToStringArray(destroyMethodName);
            bd.setAutowireCandidate(PatternMatchUtils.simpleMatch(patterns, beanName));
        }
    } else {
        bd.setAutowireCandidate("true".equals(autowireCandidate));
    }
	// 解析primary屬性
    if (ele.hasAttribute("primary")) {
        bd.setPrimary("true".equals(ele.getAttribute("primary")));
    }
	// 解析init-method屬性
    if (ele.hasAttribute("init-method")) {
        destroyMethodName = ele.getAttribute("init-method");
        bd.setInitMethodName(destroyMethodName);
    } else if (this.defaults.getInitMethod() != null) {
        bd.setInitMethodName(this.defaults.getInitMethod());
        bd.setEnforceInitMethod(false);
    }
	// 解析destroy-method屬性
    if (ele.hasAttribute("destroy-method")) {
        destroyMethodName = ele.getAttribute("destroy-method");
        bd.setDestroyMethodName(destroyMethodName);
    } else if (this.defaults.getDestroyMethod() != null) {
        bd.setDestroyMethodName(this.defaults.getDestroyMethod());
        bd.setEnforceDestroyMethod(false);
    }
	// 解析factory-method屬性
    if (ele.hasAttribute("factory-method")) {
        bd.setFactoryMethodName(ele.getAttribute("factory-method"));
    }
	// 解析factory-bean屬性
    if (ele.hasAttribute("factory-bean")) {
        bd.setFactoryBeanName(ele.getAttribute("factory-bean"));
    }
    return bd;
}

註冊解析的 BeanDefinition

得到 BeanDefinition 後,剩下的工作就是註冊了,也就是 processBeanDefinition 方法中的

registerBeanDefinition 方法

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
    BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
    if (bdHolder != null) {
        bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);

        try {
            // 註冊解析的 BeanDefinition
            BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, this.getReaderContext().getRegistry());
        } catch (BeanDefinitionStoreException var5) {
            this.getReaderContext().error("Failed to register bean definition with name '" + bdHolder.getBeanName() + "'", ele, var5);
        }
        this.getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
    }
}

public static void registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry) throws BeanDefinitionStoreException {
    // 使用beanName做唯一標識註冊
    String beanName = definitionHolder.getBeanName();
    registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
    // 註冊所有的別名
    String[] aliases = definitionHolder.getAliases();
    if (aliases != null) {
        String[] var4 = aliases;
        int var5 = aliases.length;
        for(int var6 = 0; var6 < var5; ++var6) {
            String alias = var4[var6];
            registry.registerAlias(beanName, alias);
        }
    }
}

解析的 beanDefinition 都會被註冊到 BeanDefinitionRegistry 類型的實例 registry 中,而對於 beanDefinition 的註冊分成兩個部分:通過 beanName 註冊以及通過別名註冊

1. 通過 beanName 註冊

public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) throws BeanDefinitionStoreException {
    Assert.hasText(beanName, "Bean name must not be empty");
    Assert.notNull(beanDefinition, "BeanDefinition must not be null");
    if (beanDefinition instanceof AbstractBeanDefinition) {
        try {
            // 註冊前的最後一次校驗
            ((AbstractBeanDefinition)beanDefinition).validate();
        } catch (BeanDefinitionValidationException var8) {
            throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName, "Validation of bean definition failed", var8);
        }
    }
    // 處理beanName已經註冊的情況
    BeanDefinition existingDefinition = (BeanDefinition)this.beanDefinitionMap.get(beanName);
    if (existingDefinition != null) {
        // 如果對應BeanName已經註冊且在配置中配置了bean不允許被覆蓋,則拋出異常
        if (!this.isAllowBeanDefinitionOverriding()) {
            throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition);
        }

        if (existingDefinition.getRole() < beanDefinition.getRole()) {
            if (this.logger.isInfoEnabled()) {
                this.logger.info("Overriding user-defined bean definition for bean '" + beanName + "' with a framework-generated bean definition: replacing [" + existingDefinition + "] with [" + beanDefinition + "]");
            }
        } else if (!beanDefinition.equals(existingDefinition)) {
            if (this.logger.isDebugEnabled()) {
                this.logger.debug("Overriding bean definition for bean '" + beanName + "' with a different definition: replacing [" + existingDefinition + "] with [" + beanDefinition + "]");
            }
        } else if (this.logger.isTraceEnabled()) {
            this.logger.trace("Overriding bean definition for bean '" + beanName + "' with an equivalent definition: replacing [" + existingDefinition + "] with [" + beanDefinition + "]");
        }

        this.beanDefinitionMap.put(beanName, beanDefinition);
    } else {
        // 檢查工廠是否處於bean創建階段
        if (this.hasBeanCreationStarted()) {
            // 因為beanDefinitionMap是全局變數,會存在併發訪問的情況
            synchronized(this.beanDefinitionMap) {
                this.beanDefinitionMap.put(beanName, beanDefinition);
                List<String> updatedDefinitions = new ArrayList(this.beanDefinitionNames.size() + 1);
                updatedDefinitions.addAll(this.beanDefinitionNames);
                updatedDefinitions.add(beanName);
                this.beanDefinitionNames = updatedDefinitions;
                this.removeManualSingletonName(beanName);
            }
        } else {
            // 註冊beanDefinition
            this.beanDefinitionMap.put(beanName, beanDefinition);
            // 記錄beanName
            this.beanDefinitionNames.add(beanName);
            this.removeManualSingletonName(beanName);
        }

        this.frozenBeanDefinitionNames = null;
    }

    if (existingDefinition == null && !this.containsSingleton(beanName)) {
        if (this.isConfigurationFrozen()) {
            this.clearByTypeCache();
        }
    } else {
        this.resetBeanDefinition(beanName);
    }
}

在對於 bean 的註冊處理方式上,主要進行了幾個步驟:

  1. 對 AbstractBeanDefinition 校驗
  2. 加入 map 緩存
  3. 清楚解析之前留下的對應的 beanName 的緩存

2. 通過別名註冊 BeanDefinition

public void registerAlias(String name, String alias) {
    Assert.hasText(name, "'name' must not be empty");
    Assert.hasText(alias, "'alias' must not be empty");
    synchronized(this.aliasMap) {
        // 如果beanName和alias相同的話不記錄alias,並刪除對應的alias
        if (alias.equals(name)) {
            this.aliasMap.remove(alias);
            if (this.logger.isDebugEnabled()) {
                this.logger.debug("Alias definition '" + alias + "' ignored since it points to same name");
            }
        } else {
            String registeredName = (String)this.aliasMap.get(alias);
            if (registeredName != null) {
                if (registeredName.equals(name)) {
                    return;
                }

                if (!this.allowAliasOverriding()) {
                    throw new IllegalStateException("Cannot define alias '" + alias + "' for name '" + name + "': It is already registered for name '" + registeredName + "'.");
                }

                if (this.logger.isDebugEnabled()) {
                    this.logger.debug("Overriding alias '" + alias + "' definition for registered name '" + registeredName + "' with new target name '" + name + "'");
                }
            }
			// 檢查是否存在迴圈指向,如A->B,A->C->B
            this.checkForAliasCircle(name, alias);
            this.aliasMap.put(alias, name);
            if (this.logger.isTraceEnabled()) {
                this.logger.trace("Alias definition '" + alias + "' registered for name '" + name + "'");
            }
        }
    }
}

註冊 alias 的步驟如下:

  1. alias 與 beanName 相同情況處理
  2. alias 迴圈檢查
  3. 註冊 alias


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • [] 在運行代碼時,我們常常想要知道代碼運行記憶體占用情況。很多情況下我們想知道是不是自己哪個迴圈寫的太繁瑣了,或者是在哪一步可以用更小的記憶體來實現等。所以需要我們對程式整體、某一部分代碼、某一變數運行記憶體使用有更直觀的瞭解。 在本地運行代碼如PyCharm和遠程運行代碼如VScode中都是如何查看內 ...
  • JVM
    JVM 一、什麼是JVM 定義 Java Virtual Machine,JAVA程式的運行環境(JAVA二進位位元組碼的運行環境) 好處 一次編寫,到處運行 自動記憶體管理,垃圾回收機制 數組下標越界檢查 比較 JVM JRE JDK的區別 二、記憶體結構 整體架構 1、程式計數器 作用 用於保存JVM ...
  • 常用的JVM配置參數: -Xms2g:初始化堆大小為 2g; -Xmx2g:堆最大記憶體為 2g; -XX:NewRatio=4:設置年輕的和老年代的記憶體比例為 1:4; -XX:SurvivorRatio=8:設置新生代 Eden 和 Survivor 比例為 8:2; –XX:+UseParNew ...
  • 先認識java的基礎知識 1.變數命名規則 :1)變數名由數字字母下劃線組成,2)不能使用java的關鍵字,比如public這種,3)遵循小駝峰命名法 2.數據類型 2.1基本數據類型有8種 其中分為四種:1)整數型:byte short int long;2)浮點型:float double;3) ...
  • 設計協議 相對於 HTTP 的用處,RPC 更多的是負責應用間的通信,所以性能要求相對更高。但 HTTP 協議的數據包大小相對請求數據本身要大很多,又需要加入很多無用的內容,比如換行符號、回車符等; 還有一個更重要的原因是,HTTP 協議屬於無狀態協議,客戶端無法對請求和響應進行關聯,每次請求都需要 ...
  • JVM線程屬於用戶態還是內核態 當進程運行在ring3級別時為用戶態,ring0級別時為內核態 有些操作需要有內核許可權才能進行,那麼有三種由用戶態切換到內核態的情況: 系統調用:操作系統封裝內核指令,統一管理硬體資源,然後向用戶程式提供系統服務,用戶程式進行系統調用,操作系統進行檢查確保全全然後再進 ...
  • 1.簡單介紹java起源: 1995年,詹姆斯-高斯林在sun公司開發出java編程語言.到2010年,sun公司被Oracle公司收購,而詹姆斯-高斯林也離開了Oracle公司.所以,如今想要安轉jdk,需要到Oracle官網下載. 2.jdk的安裝以及環境變數的配置 2.1jdk的下載: 前面提 ...
  • 看《C++ Primer Plus》時整理的學習筆記,部分內容完全摘抄自《C++ Primer Plus》(第6版)中文版,Stephen Prata 著,張海龍 袁國忠譯。只做學習記錄用途。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...