2. 程式人生 > >mybatis原始碼-解析配置檔案（二）之解析的流程

mybatis原始碼-解析配置檔案（二）之解析的流程

阿新 • • 發佈：2018-12-10

1. 簡介

在之前的文章《mybatis 初步使用（IDEA的Maven專案, 超詳細）》中， 講解了mybatis的初步使用， 並總結了以下mybatis的執行流程：

  1. 通過 Resources 工具類讀取 mybatis-config.xml， 存入 Reader；
  2. SqlSessionFactoryBuilder 使用上一步獲得的 reader 建立 SqlSessionFactory 物件;
  3. 通過 sqlSessionFactory 物件獲得 SqlSession;
  4. SqlSession物件通過 *Mapper 方法找到對應的 SQL 語句， 執行 SQL 查詢。
  5. 底層通過 JDBC 查詢後獲得 ResultSet, 對每一條記錄， 根據resultMap的對映結果對映到 Student 中， 返回 List。
  6. 最後記得關閉 SqlSession

本系列文章深入講解第 2 步， 解析配置檔案。

2. 配置檔案解析流程分析

2.1 呼叫

配置檔案的解析過程對應的是以下的程式碼：

 Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build
 
(reader);

很簡單的兩句程式碼：

  1. 通過mybatis的資源類Resources讀入“mybatis-config.xml”檔案;
  2. 使用SqlSessionFactoryBuilder類生成我們需要的SqlSessionFactory類；（真正的解析只有這一過程）

2.2 解析的目的

要理解配置檔案的解析過程， 首先要明白解析的目的是什麼， 從最直觀的呼叫程式碼來看， 是獲得SqlSessionFactory。

但是， 從原始碼來看， 更本質的應該這麼說：

mybatis解析配置檔案最本質的目的是為了獲得Configuration物件

Configuration

物件， 可以理解是mybatis的XML檔案在程式中的化身。

2.3 XML 解析流程

build(reader)函式裡面包含著SqlSessionFactory的建立邏輯。

從客戶端呼叫build(reader)函式到返回SqlSessionFactory， 可以用如下的時序圖表示： 解析時序圖

下面來看看各個步驟， 請記住，mybatis解析配置檔案的本質就是獲得Configuration物件。

2.3.1 build(parser)

其最終呼叫以下的方法

public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
    try {
      XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
      return build(parser.parse());
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();
      try {
        reader.close();
      } catch (IOException e) {
        // Intentionally ignore. Prefer previous error.
      }
    }
}

該方法： 1. 建立XMLConfigBuilder物件; 2. 使用XMLConfigBuilder物件的方法parse()來獲得Confiuration物件; 3. 通過build(configuration)， 使用Confiuration物件建立相應的SqlSessionFactory物件。

2.3.2 new XMLConfigBuilder(…);

new XMLConfigBuilder(reader, environment, properties)方法， 從字面上來理解就是建立一個XMLConfigBuilder物件。

public XMLConfigBuilder(Reader reader, String environment, Properties props) {
    this(new XPathParser(reader, true, props, new XMLMapperEntityResolver()), environment, props);
}

其最終呼叫的方法是這個：

private XMLConfigBuilder(XPathParser parser, String environment, Properties props) {
    super(new Configuration());
    ErrorContext.instance().resource("SQL Mapper Configuration");
    this.configuration.setVariables(props);
    this.parsed = false;
    this.environment = environment;
    this.parser = parser;
}

XMLConfigBuilder類繼承於BaseBuilder類， super(new Configuration())對應的方法：

public BaseBuilder(Configuration configuration) {
    this.configuration = configuration;
    this.typeAliasRegistry = this.configuration.getTypeAliasRegistry();
    this.typeHandlerRegistry = this.configuration.getTypeHandlerRegistry();
}

也就是給BaseBuilder類的各個成員變數賦值而已。

裡面的XpathParser物件是通過new XPathParser(reader, true, props, new XMLMapperEntityResolver())方法而來的。

2.3.3 new XPathParser(…)

new XPathParser(reader, true, props, new XMLMapperEntityResolver())就是建立XpathParser的過程。

public XPathParser(Reader reader, boolean validation, Properties variables, EntityResolver entityResolver) {
    commonConstructor(validation, variables, entityResolver);
    this.document = createDocument(new InputSource(reader));
}

呼叫了以下兩個函式:

private void commonConstructor(boolean validation, Properties variables, EntityResolver entityResolver) {
    this.validation = validation;
    this.entityResolver = entityResolver;
    this.variables = variables;
    XPathFactory factory = XPathFactory.newInstance();
    this.xpath = factory.newXPath();
}
private Document createDocument(InputSource inputSource) {
    // important: this must only be called AFTER common constructor
    try {
      DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
      factory.setValidating(validation);

      factory.setNamespaceAware(false);
      factory.setIgnoringComments(true);
      factory.setIgnoringElementContentWhitespace(false);
      factory.setCoalescing(false);
      factory.setExpandEntityReferences(true);

      DocumentBuilder builder = factory.newDocumentBuilder();
      builder.setEntityResolver(entityResolver);
      builder.setErrorHandler(new ErrorHandler() {
        @Override
        public void error(SAXParseException exception) throws SAXException {
          throw exception;
        }

        @Override
        public void fatalError(SAXParseException exception) throws SAXException {
          throw exception;
        }

        @Override
        public void warning(SAXParseException exception) throws SAXException {
        }
      });
      return builder.parse(inputSource);
    } catch (Exception e) {
      throw new BuilderException("Error creating document instance.  Cause: " + e, e);
    }
}

注意這兩個函式是有先後順序的， createDocument函式務必在commonConstructor函式之後執行。

createDocument函式， 其實就是通過 DOM 解析 XML 檔案的過程中的幾個步驟，獲得document， 具體可以參見 「mybatis 解析配置檔案（一）之XML的DOM解析方式」， 裡面提到了 Java 中使用 DOM 解析 XML 的步驟， 大致如下：

  1. 建立 DocumentBuilderFactory 物件;
  2. 通過 DocumentBuilderFactory 建立DocumentBuilder物件;
  3. 通過DocumentBuilder， 從檔案或流中建立通過Document物件;
  4. 建立XPathFactory物件， 並通過XPathFactory建立XPath物件;
  5. 通過XPath解析出XPathExpression物件;
  6. 使用XPathExpression在文件中搜索出相應的節點。

剛剛提到的兩個函式， 已經完成了前4部分， 獲得了Document物件， Xpath物件， 並返回後將其賦值給了相應的成員變數。

也就是說， 到了這一步， 我們已經獲得了XpathParser物件， 該物件中已經含有 mybatis-config.xml 檔案對應的 Document Object， 即document和xpath。 通過document和xpath，我們可以對 mybatis-config.xml 進行後兩部操作操作。

後面幾個步驟， 是在XMLConfiguration物件的parse()函式中使用到， 詳情見 2.3.5。

2.3.4 new Configuration()

之前提到過， 配置檔案解析的本質就是獲得Configuration物件。

現在， Configuration物件在解析的過程中第一次出現了。

那我們就可以返回這個物件了？

當然不是， 這個物件現在只是建立， 後續還有很多成員變數需要根據 XML 配置檔案解析後來賦值。

2.3.5 parser.parse()

這裡的parser是XMLConfigBuilder物件。

public Configuration parse() {
    if (parsed) {
      throw new BuilderException("Each XMLConfigBuilder can only be used once.");
    }
    parsed = true;
    parseConfiguration(parser.evalNode("/configuration"));
    return configuration;
}

這個函式返回的Configuration物件就是最終寫入SqlSessionFatory對應成員變數的物件。

由於配置檔案解析的本質就是獲得Configuration物件, 因此， 這個函式就是解析的核心。

private void parseConfiguration(XNode root) {
    try {
      //issue #117 read properties first
      propertiesElement(root.evalNode("properties"));
      Properties settings = settingsAsProperties(root.evalNode("settings"));
      loadCustomVfs(settings);
      typeAliasesElement(root.evalNode("typeAliases"));
      pluginElement(root.evalNode("plugins"));
      objectFactoryElement(root.evalNode("objectFactory"));
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      reflectorFactoryElement(root.evalNode("reflectorFactory"));
      settingsElement(settings);
      // read it after objectFactory and objectWrapperFactory issue #631
      environmentsElement(root.evalNode("environments"));
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      typeHandlerElement(root.evalNode("typeHandlers"));
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
}

其對應的過程就是解析 XML 配置檔案中 properties, settings, typeAliases, plugins, objectFactory, objectWrapperFactory, reflectorFactory, environments, databaseIdProvider, typeHandlers, mappers， 這些子節點。

其中的evalNode函式， 在其函式過程中， 會呼叫XParhParser中的函式， 對 xml 節點進行解析：

private Object evaluate(String expression, Object root, QName returnType) {
    try {
      return xpath.evaluate(expression, root, returnType);
    } catch (Exception e) {
      throw new BuilderException("Error evaluating XPath.  Cause: " + e, e);
    }
}

以上過程就是我們 2.3.3 中提到的第 5， 6 步過程。

具體的在後續的文章中在深入瞭解。

2.3.6 build(configuration)

該函式就是建立一個具體的SqlSessionFactory物件。

public SqlSessionFactory build(Configuration config) {
    return new DefaultSqlSessionFactory(config);
}
public DefaultSqlSessionFactory(Configuration configuration) {
    this.configuration = configuration;
}

就是建立DefaultSqlSessionFactory物件， 並將configuration賦值給相應的成員變數。

更具體的解析配置的過程， 後續分享。

相關推薦

mybatis原始碼-解析配置檔案（二）之解析的流程

1. 簡介 在之前的文章《mybatis 初步使用（IDEA的Maven專案, 超詳細）》中， 講解了mybatis的初步使用， 並總結了以下mybatis的執行流程： 通過 Resources 工具類讀取 mybatis-config.xml，

mybatis原始碼-解析配置檔案（三）之配置檔案Configuration解析(超詳細， 值得收藏)

1. 簡介 1.1 系列內容 本系列文章講解的是mybatis解析配置檔案內部的邏輯， 即 Reader reader = Resources.getResourceAsReader("mybatis-config.xml"); SqlSessionFact

mybatis原始碼-解析配置檔案（四）之配置檔案Mapper解析

其中， mappers作為configuration節點的一部分配置， 在本文章中， 我們講解解析mappers節點， 即 xxxMapper.xml 檔案的解析。 1 解析入口 在解析 mybatis-config.xml 時， 會進行解析 xxxMapper.xml 的檔案。 在圖示流程的 XMLCo

mybatis 解析配置檔案（一）之XML的DOM解析方式

簡介 在之前的文章《mybatis 初步使用（IDEA的Maven專案, 超詳細）》中， 講解了mybatis的初步使用， 並總結了以下mybatis的執行流程： 通過 Resources 工具類讀取 mybatis-config.xml， 存入 Reader； SqlSessionFactoryBuil

mybatis源碼-解析配置文件（二）之解析的流程

close ria 操作 exp 記得 resource build reset sed 1. 簡介 在之前的文章《mybatis 初步使用（IDEA的Maven項目, 超詳細）》中， 講解了mybatis的初步使用， 並總結了以下mybatis的執行流程： 通過 Re

解析XML檔案（二）

解析XML（二） 繼續（一）的內容，接下來依然進行XML檔案的解析。 7.建立新節點，即Element；為節點新增屬性和子節點；將新節點新增到原來所有節點之後和中間 程式碼如下： public class Demo05 { public stati

【無私分享：ASP.NET CORE 專案實戰（第八章）】讀取配置檔案（二） 讀取自定義配置檔案

目錄索引 簡介 　　但隨之產生了問題：我們使用的是在 Startup.cs 中（如下圖）來實現配置讀取，有兩個問題 ① 我們如果定義N種配置，是否要再這裡新增N條這樣的配置 ； ② 如果我們的配置不想寫在appsettings.json中呢  　　 解決問題

win7配置IIS（二）之常見錯誤解決方案

上一篇主要記錄瞭如何配置IIS，那麼這一篇就著重記錄下其中遇到的一些錯誤。 一、檢測到在整合的託管管道模式下不適用的ASP.NET設定（如圖一所示） 這個我們需要修改應用程式池下的預設程式池（DefaultAppPool），將託管管道模式設定為經典模式（Classic），

利用模板匯出檔案（二）之jacob利用word模板匯出word檔案（Java2word）

先下載jacob.jar包。解壓後將jacob.dll放到windows/system32下面或\jre\bin下面。將jacob.jar加入專案。 這樣專案的環境基本上搭建完成，接下來就是書寫相關的程式碼： /** * 傳入資料為HashMap物件，物件中的Key代表w

精盡Spring MVC原始碼分析 - HandlerMapping 元件（二）之 HandlerInterceptor 攔截器

> 該系列文件是本人在學習 Spring MVC 的原始碼過程中總結下來的，可能對讀者不太友好，請結合我的原始碼註釋 [Spring MVC 原始碼分析 GitHub 地址](https://github.com/liu844869663/spring-framework) 進行閱讀 > > Spring

精盡Spring MVC原始碼分析 - HandlerAdapter 元件（二）之 ServletInvocableHandlerMethod

> 該系列文件是本人在學習 Spring MVC 的原始碼過程中總結下來的，可能對讀者不太友好，請結合我的原始碼註釋 [Spring MVC 原始碼分析 GitHub 地址](https://github.com/liu844869663/spring-framework) 進行閱讀 > > Spring

mybatis原始碼-解析配置檔案（四-1）之配置檔案Mapper解析(cache)

1. 簡介 本文章主要講解的是， xxxMapper.xml 檔案中， cache 節點的原始碼。 2. 解析 XMLMapperBuilder.cacheElement() 方法主要負責解析 <cache> private void cacheElement(XNode context)

精盡MyBatis原始碼分析 - MyBatis初始化（二）之載入 Mapper 介面與 XML 對映檔案

> 該系列文件是本人在學習 Mybatis 的原始碼過程中總結下來的，可能對讀者不太友好，請結合我的原始碼註釋（[Mybatis原始碼分析 GitHub 地址](https://github.com/liu844869663/mybatis-3)、[Mybatis-Spring 原始碼分析 GitHub 地址

Spring整合Struts2和Hibernate+Maven（二）之SSH的配置檔案

上次講到的是maven專案的建立以及pom.xml的配置。 這裡推薦一個網站：maven整合jar包，這裡可以查詢並生成配置檔案中jar包匯入格式的文字，複製貼上到pom.xml中即可由idea自動下載並匯入專案。 resources資料夾 建立ssh的配置檔案至上章圖片中的res

mybatis學習筆記之——mybatis的XML配置檔案（全域性配置檔案）

MyBatis的配置檔案包含了會深深影響MyBatis行為的設定（settings）和屬性（properties）資訊。我們詳細瞭解一下MyBatis的各種標籤的作用以及使用方法。 properties properties：配置，mybatis可以使用properties標籤來引入外部pr

【Spark核心原始碼】解析“spark-shell”（二）

接著【初探Spark核心】解析“spark-shell”（一）來看 根據main的執行日誌來看，我們直接看一下org.apache.spark.repl.Main.main方法： main方法中建立了SparkILoop物件，作為引數傳遞給了doMain方法，並呼叫了doMain

【原創】從原始碼剖析IO流（二）檔案流--轉載請註明出處

一、FileInputStream 在FileInputStream中，首先我們需要進行關注的方法，就是read()方法，下面可以來看一下read()方法的原始碼： public int read() throws IOException { return read0()

Java眼中的XML---檔案讀取（二）SAX解析XML檔案

目錄 （一）SAX解析是什麼？ （二）SAX解析和DOM解析的區別？ （三）SAX方法解析XML的步驟 （四）SAX解析Java程式碼實現 （一）SAX解析是什麼？ SAX（simple API for XML）是一種XML解析的

（二）從解析DTS到建立device_DTS的匹配和解析（結合原始碼）

kernel啟動流程_DTS解析（原始碼層面） 此篇部落格有很多參考其他文章的內容，由於參考內容繁雜，不一一標註角標了，在末尾會貼上所有參考部落格的link，如有侵權，請聯絡本人處理，謝謝。 深入，並且廣泛 -沉默犀牛 我認為作為初學者去學習kernel程式碼的一個

tomcat原始碼淺析（二）之server.xml的解析

server.xml的解析是使用Digester來解析的，Digester的詳細規則如下： Catalina.createstartdigester程式碼 protected Digester createSta