通俗理解spring源碼（四）—— 獲取Docment

来源:https://www.cnblogs.com/xiaohang123/archive/2020/04/21/12722065.html
-Advertisement-
Play Games

通俗理解spring源碼（四）—— 獲取Docment 上節講到了xmlBeanDefinitionReader.doLoadDocument(InputSource inputSource, Resource resource)方法： protected Document doLoadDocume ...


通俗理解spring源碼（四）—— 獲取Docment

上節講到了xmlBeanDefinitionReader.doLoadDocument(InputSource inputSource, Resource resource)方法：

    protected Document doLoadDocument(InputSource inputSource, Resource resource) throws Exception {
        return this.documentLoader.loadDocument(inputSource, getEntityResolver(), this.errorHandler,
                getValidationModeForResource(resource), isNamespaceAware());
    }

 getValidationModeForResource(resource)在這裡，看看getEntityResolver():

    protected EntityResolver getEntityResolver() {
        if (this.entityResolver == null) {
            // Determine default EntityResolver to use.
            ResourceLoader resourceLoader = getResourceLoader();
            if (resourceLoader != null) {
                this.entityResolver = new ResourceEntityResolver(resourceLoader);
            }
            else {
                this.entityResolver = new DelegatingEntityResolver(getBeanClassLoader());
            }
        }
        return this.entityResolver;
    }

　　這裡有兩種類型的entityResolver，對於xmlBeanDefinitionReader來說，會new一個ResourceEntityResolver，後面會解釋什麼是EntityResolver。

　　然後將EntityResolver返回作為loadDocument()的參數。

 protected Document doLoadDocument(InputSource inputSource, Resource resource) throws Exception {
        return this.documentLoader.loadDocument(inputSource, getEntityResolver(), this.errorHandler,
                getValidationModeForResource(resource), isNamespaceAware());
    }

　　調用DefaultDocumentLoader的loadDocument方法

    public Document loadDocument(InputSource inputSource, EntityResolver entityResolver,
            ErrorHandler errorHandler, int validationMode, boolean namespaceAware) throws Exception {

        DocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode, namespaceAware);
        if (logger.isTraceEnabled()) {
            logger.trace("Using JAXP provider [" + factory.getClass().getName() + "]");
        }
        DocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler);
        return builder.parse(inputSource);
    }
    protected DocumentBuilder createDocumentBuilder(DocumentBuilderFactory factory,
            @Nullable EntityResolver entityResolver, @Nullable ErrorHandler errorHandler)
            throws ParserConfigurationException {

        DocumentBuilder docBuilder = factory.newDocumentBuilder();
        if (entityResolver != null) {
            docBuilder.setEntityResolver(entityResolver);
        }
        if (errorHandler != null) {
            docBuilder.setErrorHandler(errorHandler);
        }
        return docBuilder;
    }

　　在loadDocument方法中，使用的DocumentBuilderFactory 、DocumentBuilder 等都是jdk中的類，載入xml資源也是調用的java中的方法，這裡就不多說了，重點是docBuilder.setEntityResolver(entityResolver)方法，該方法將得到的entityResolver放到docBuilder中，也就是DocumentBuilder ，然後調用docBuilder.parse()。

　　那麼EntityResolver在生成document過程中起到什麼作用呢？

1、EntityResolver

　　EntityResolver不是屬於spring定義的，是jdk中org.xml.sax下的一個介面。

　　官方是這樣解釋EntityResolver的：如果SAX應用程式實現自定義處理外部實體,則必須實現此介面，並使用setEntityResolver方法向SAX 驅動器註冊一個實例。

　　也就是說,對於解析一個xml,sax首先會讀取該xml文檔上的聲明,根據聲明去尋找相應的dtd定義，以便對文檔的進行驗證,預設的尋找規則，(即:通過網路,實現上就是聲明DTD的地址URI地址來下載DTD聲明)，併進行認證，下載的過程是一個漫長的過程,而且當網路不可用時，就會找不到相應的dtd，就會報錯。　　

　　EntityResolver 的作用就是項目本身就可以提供一個如何尋找DTD 的聲明方法，即:由程式來實現尋找DTD聲明的過程，比如我們將DTD放在項目的某處在實現時直接將此文檔讀取並返回個SAX即可，這樣就避免了通過網路來尋找DTD的聲明。

　　首先看看EntityResolver 介面聲明的方法：

    public abstract InputSource resolveEntity (String publicId,
                                               String systemId)
        throws SAXException, IOException;

　　接收2個參數,publicId ,systemId ,並返回一個InputStream對象

　　如果我們在解析驗證模式為xsd的配置文件,代碼如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
...
</beans>

　　讀取得到以下參數
　　publicId : null
　　systemId : http://www.springframework.org/schema/beans/spring-beans-2.5.xsd

　　如果我們解析的是DTD的配置文件，代碼如下

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC  "-//SPRING//DTD BEAN//EN"  "http://www.springframework.org/dtd/spring-beans.dtd">
<beans>
        ...
</beans>

　　上面說過，EntityResolver 會被set到DocumentBuilder 對象中，也就是說，在 DocumentBuilder .parse()過程中，EntityResolver 對象的resolveEntity會得到相應的參數publicId 和systemId ，然後調用其resolveEntity （）方法，返回的流InputSource 就是相應的DTD文件流或者XSD文件流，然後完成校驗工作。

　　所以，現在重點就是，不同的EntityResolver實現是以何種方式返回DTD或XSD文件流的。來看具體實現。

2、DelegatingEntityResolver

    public InputSource resolveEntity(@Nullable String publicId, @Nullable String systemId)
            throws SAXException, IOException {

        if (systemId != null) {
            if (systemId.endsWith(DTD_SUFFIX)) {
                return this.dtdResolver.resolveEntity(publicId, systemId);
            }
            else if (systemId.endsWith(XSD_SUFFIX)) {
                return this.schemaResolver.resolveEntity(publicId, systemId);
            }
        }

        // Fall back to the parser's default behavior.
        return null;
    }

　　根據systemId尾碼，委派給dtdResolver和schemaResolver完成，dtdResolver和schemaResolver也是EntityResolver的實現，在 DelegatingEntityResolver構造中初始化。

    public DelegatingEntityResolver(@Nullable ClassLoader classLoader) {
        this.dtdResolver = new BeansDtdResolver();
        this.schemaResolver = new PluggableSchemaResolver(classLoader);
    }

3、BeansDtdResolver

　　BeansDtdResolver負責找到classpath下spring-beans.dtd文件的位置，返迴文件流。

    public InputSource resolveEntity(@Nullable String publicId, @Nullable String systemId) throws IOException {
        if (logger.isTraceEnabled()) {
            logger.trace("Trying to resolve XML entity with public ID [" + publicId +
                    "] and system ID [" + systemId + "]");
        }

        if (systemId != null && systemId.endsWith(DTD_EXTENSION)) {
            int lastPathSeparator = systemId.lastIndexOf('/');
            int dtdNameStart = systemId.indexOf(DTD_NAME, lastPathSeparator);
            if (dtdNameStart != -1) {
                String dtdFile = DTD_NAME + DTD_EXTENSION;
                //dtdFile="spring-beans.dtd"
                if (logger.isTraceEnabled()) {
                    logger.trace("Trying to locate [" + dtdFile + "] in Spring jar on classpath");
                }
                try {
                    //定位classpath資源文件
                    Resource resource = new ClassPathResource(dtdFile, getClass());
                    InputSource source = new InputSource(resource.getInputStream());
                    source.setPublicId(publicId);
                    source.setSystemId(systemId);
                    if (logger.isTraceEnabled()) {
                        logger.trace("Found beans DTD [" + systemId + "] in classpath: " + dtdFile);
                    }
                    return source;
                }
                catch (FileNotFoundException ex) {
                    if (logger.isDebugEnabled()) {
                        logger.debug("Could not resolve beans DTD [" + systemId + "]: not found in classpath", ex);
                    }
                }
            }
        }

        // Fall back to the parser's default behavior.
        return null;
    }

 

spring-beans.dtd文件在如下位置：

 

4、PluggableSchemaResolver

    public static final String DEFAULT_SCHEMA_MAPPINGS_LOCATION = "META-INF/spring.schemas";
    private volatile Map<String, String> schemaMappings;
    public PluggableSchemaResolver(@Nullable ClassLoader classLoader) {
        this.classLoader = classLoader;
        this.schemaMappingsLocation = DEFAULT_SCHEMA_MAPPINGS_LOCATION;
    }

　　PluggableSchemaResolver是重點，負責找到相對應的XSD文件，一般我們都是使用XSD作為檢驗文件。 　

　　DEFAULT_SCHEMA_MAPPINGS_LOCATION ，指明資源文件路徑。

 　　可以看到，spring很貼心的將所有版本的xsd文件都準備了，即使沒有指定版本號，也會有預設的xsd文件。

　　schemaMappings負責保存資源路徑與校驗文件url的映射。即systemId為key，resourceLocation為value。

    public InputSource resolveEntity(@Nullable String publicId, @Nullable String systemId) throws IOException {
        if (logger.isTraceEnabled()) {
            logger.trace("Trying to resolve XML entity with public id [" + publicId +
                    "] and system id [" + systemId + "]");
        }

        if (systemId != null) {
            //根據systemId，也就是驗證文件的url，找到本地文件路徑
            String resourceLocation = getSchemaMappings().get(systemId);
            //如果沒有找到，並且url是https開頭，就轉換為http開頭的url
            if (resourceLocation == null && systemId.startsWith("https:")) {
                // Retrieve canonical http schema mapping even for https declaration
                resourceLocation = getSchemaMappings().get("http:" + systemId.substring(6));
            }
            //定位本地資源文件
            if (resourceLocation != null) {
                Resource resource = new ClassPathResource(resourceLocation, this.classLoader);
                try {
                    InputSource source = new InputSource(resource.getInputStream());
                    source.setPublicId(publicId);
                    source.setSystemId(systemId);
                    if (logger.isTraceEnabled()) {
                        logger.trace("Found XML schema [" + systemId + "] in classpath: " + resourceLocation);
                    }
                    return source;
                }
                catch (FileNotFoundException ex) {
                    if (logger.isDebugEnabled()) {
                        logger.debug("Could not find XML schema [" + systemId + "]: " + resource, ex);
                    }
                }
            }
        }

        // Fall back to the parser's default behavior.
        return null;
    }

　　其中getSchemaMappings獲取或初始化map容器，這裡用到了懶載入

    private Map<String, String> getSchemaMappings() {
        Map<String, String> schemaMappings = this.schemaMappings;
        if (schemaMappings == null) {
            synchronized (this) {
                schemaMappings = this.schemaMappings;
                if (schemaMappings == null) {
                    if (logger.isTraceEnabled()) {
                        logger.trace("Loading schema mappings from [" + this.schemaMappingsLocation + "]");
                    }
                    try {
                        //這裡負責初始化map
                        Properties mappings =
                                PropertiesLoaderUtils.loadAllProperties(this.schemaMappingsLocation, this.classLoader);
                        if (logger.isTraceEnabled()) {
                            logger.trace("Loaded schema mappings: " + mappings);
                        }
                        schemaMappings = new ConcurrentHashMap<>(mappings.size());
                        CollectionUtils.mergePropertiesIntoMap(mappings, schemaMappings);
                        this.schemaMappings = schemaMappings;
                    }
                    catch (IOException ex) {
                        throw new IllegalStateException(
                                "Unable to load schema mappings from location [" + this.schemaMappingsLocation + "]", ex);
                    }
                }
            }
        }
        return schemaMappings;
    }

　　 通過調試，可以看到map中的中的內容

 4、ResourceEntityResolver

　　在xmlBeanDefinitionReader中，預設會用這種EntityResolver。

public class ResourceEntityResolver extends DelegatingEntityResolver {
public InputSource resolveEntity(@Nullable String publicId, @Nullable String systemId)
            throws SAXException, IOException {

        InputSource source = super.resolveEntity(publicId, systemId);
        //調用父類DelegatingEntityResolver的方法，如果沒有，就從網路獲取
        if (source == null && systemId != null) {
            String resourcePath = null;
            try {
                String decodedSystemId = URLDecoder.decode(systemId, "UTF-8");
                String givenUrl = new URL(decodedSystemId).toString();
                String systemRootUrl = new File("").toURI().toURL().toString();
                // Try relative to resource base if currently in system root.
                if (givenUrl.startsWith(systemRootUrl)) {
                    resourcePath = givenUrl.substring(systemRootUrl.length());
                }
            }
            catch (Exception ex) {
                // Typically a MalformedURLException or AccessControlException.
                if (logger.isDebugEnabled()) {
                    logger.debug("Could not resolve XML entity [" + systemId + "] against system root URL", ex);
                }
                // No URL (or no resolvable URL) -> try relative to resource base.
                resourcePath = systemId;
            }
            if (resourcePath != null) {
                if (logger.isTraceEnabled()) {
                    logger.trace("Trying to locate XML entity [" + systemId + "] as resource [" + resourcePath + "]");
                }
                Resource resource = this.resourceLoader.getResource(resourcePath);
                source = new InputSource(resource.getInputStream());
                source.setPublicId(publicId);
                source.setSystemId(systemId);
                if (logger.isDebugEnabled()) {
                    logger.debug("Found XML entity [" + systemId + "]: " + resource);
                }
            }
            else if (systemId.endsWith(DTD_SUFFIX) || systemId.endsWith(XSD_SUFFIX)) {
                // External dtd/xsd lookup via https even for canonical http declaration
                String url = systemId;
                if (url.startsWith("http:")) {
                    url = "https:" + url.substring(5);
                }
                try {
                    source = new InputSource(new URL(url).openStream());
                    source.setPublicId(publicId);
                    source.setSystemId(systemId);
                }
                catch (IOException ex) {
                    if (logger.isDebugEnabled()) {
                        logger.debug("Could not resolve XML entity [" + systemId + "] through URL [" + url + "]", ex);
                    }
                    // Fall back to the parser's default behavior.
                    source = null;
                }
            }
        }

        return source;
    }

}

　　該類首先會調用父類DelegatingEntityResolver的方法獲取資源文件，如果沒有就會從網路獲取。不過一般都能從本地獲取到。 

 

　　走的太遠，不要忘記為什麼出發！

　　再來看看這個方法，是不是清楚多了？

    protected Document doLoadDocument(InputSource inputSource, Resource resource) throws Exception {
        return this.documentLoader.loadDocument(inputSource, getEntityResolver(), this.errorHandler,
                getValidationModeForResource(resource), isNamespaceAware());
    }

 　　至此，document對象獲取完成。

　　參考：spring源碼深度解析。


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

-Advertisement-
Play Games
更多相關文章
  • 字元串在Python內部是如何省記憶體的？案例詳解
    起步 Python3 起，str 就採用了 Unicode 編碼（註意這裡並不是 utf8 編碼，儘管 .py 文件預設編碼是 utf8 ）。 每個標準 Unicode 字元占用 4 個位元組。這對於記憶體來說，無疑是一種浪費。 Unicode 是表示了一種字元集，而為了傳輸方便，衍生出里如 utf8  ...
  • 給Python初學者的最好練手項目，值得收藏
    有很多朋友問我學習了Python後，有沒有什麼好的項目可以練手。 其實，做項目主要還是根據需求來的。但是對於一個初學者來說，很多複雜的項目沒辦法獨立完成，因此博主挑選了一個非常適合初學者的項目，內容不是很複雜，但是非常有趣，我相信對於初學者小白來說是再好不過的項目了。 這個項目中，我們將要建立一個比 ...
  • 從Student類和Teacher類多重派生Graduate類 代碼參考
    1 #include <iostream> 2 #include <cstring> 3 4 using namespace std; 5 6 class Person 7 { 8 private: 9 char Name[10]; 10 char Sex; 11 int Age; 12 publi ...
  • 解決SpringMVC的亂碼問題：CharacterEncodingFilter
    在使用 SpringMVC 框架的過程中，如果前臺有包含中文的請求，或者後臺有包含中文的響應，有可能會出現亂碼的情況。在以前的 Servlet 中，我們使用 和 來設置請求和響應的編碼。在 SpringMVC 中，框架直接給我們提供了一個用來解決請求和響應的亂碼問題的過濾器 。 註意：請將 Char ...
  • C++ 預設參數
    C++ 預設參數 預設參數是指當函數調用中省略了實參時自動使用的一個值。 對於帶參數列表的函數，必須從右向左添加預設值。 實參按從左到右的順序一次被賦給相應的形參，而不能跳過任何參數。 註意：只有原型指定了預設值，函數定義與沒有預設參數時完全相同。 ...
  • Laravel 7.6 發佈
    Laravel 團隊昨天發佈了 v7.6.0，其中包含 13 個新功能以及 7.x 分支的最新修複和更改： 集合新增 “until” 方法 Jason McCreary 貢獻了 Collection::until() 方法， 該方法可以迴圈遍歷集合直到元素滿足條件再將該元素返回： // Before ...
  • search（6）- elastic4s-CRUD
    如果我們把ES作為某種資料庫來使用的話，必須熟練掌握ES的CRUD操作。在這之前先更正一下上篇中關於檢查索引是否存在的方法：elastic4s的具體調用如下： //刪除索引 val rspExists = client.execute(indexExists("company")).await if ...
  • LeetCode 560. 和為K的子數組
    我的LeetCode：https://leetcode cn.com/u/ituring/ 我的LeetCode刷題源碼[GitHub]：https://github.com/izhoujie/Algorithmcii LeetCode 560. 和為K的子數組 題目 給定一個整數數組和一個整數 k ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類