Java Mybatis的初始化之Mapper.xml對映檔案的詳解

2022-08-18 14:01:10

解析Mapper檔案入口

XMLMapperBuilder的parse()方法：

public void parse() {
    if (!configuration.isResourceLoaded(resource)) {
      configurationElement(parser.evalNode("/mapper"));
      configuration.addLoadedResource(resource);
      bindMapperForNamespace();
    }

    parsePendingResultMaps();
    parsePendingCacheRefs();
    parsePendingStatements();
  }

當前Mapper檔案沒有載入過就呼叫configurationElement()方法解析Mapper檔案
新增到Configuration.loadedResources集合中，防止重複載入
獲取Mapper檔案對應的Mapper介面並註冊
處理解析失敗的<resultMap>標籤
處理解析失敗的<cache-ref>標籤
處理解析失敗的SQL語句

重點看一下XMLMapperBuilder類的configurationElement()方法

解析Mapper檔案

MLMapperBuilder類的configurationElement()方法：

private void configurationElement(XNode context) {
    try {
      String namespace = context.getStringAttribute("namespace");
      if (namespace == null || namespace.isEmpty()) {
        throw new BuilderException("Mapper's namespace cannot be empty");
      }
      builderAssistant.setCurrentNamespace(namespace);
      cacheRefElement(context.evalNode("cache-ref"));
      cacheElement(context.evalNode("cache"));
      parameterMapElement(context.evalNodes("/mapper/parameterMap"));
      resultMapElements(context.evalNodes("/mapper/resultMap"));
      sqlElement(context.evalNodes("/mapper/sql"));
      buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing Mapper XML. The XML location is '" + resource + "'. Cause: " + e, e);
    }
  }

解析Mapper檔案的namespace屬性
解析<cache-ref>標籤，這個標籤是用來參照別的Cache快取
解析<cache>標籤，這個標籤是用來啟用Mybatis的二級快取的，一級快取是預設開啟的，在這個方法裡解析到MapperBuilderAssistant類完成Cache的建立，儲存在Configuration.caches的集合中，集合的key是namespace，值是Cache物件
解析<parameterMap>標籤，這個標籤已經廢棄了，一般使用parameterType 來定義引數的類名
解析<resultMap>標籤，這個標籤是結果對映，它標籤下的所有子標籤解析後儲存在ResultMap物件中，具體會解析先獲取resultMap中的type，type是結果集對映成的java物件，然後解析resultMap標籤的子標籤，包括<constructor>、<id>、<result>、<collection>等標籤，這些標籤生成ResultMapping物件，然後獲取id extends等屬性，構建ResultMapResolver物件，建立ResultMap物件儲存到Configuration.resultMaps集合中
解析sql標籤，這個標籤是用來定義重複的sql片段的，解析出儲存在Configuration.sqlFragments中
解析<select>、<insert>、<update>、<delete>等SQL節點，這些標籤大家肯定就熟悉了，就是我們的增刪改查的sql語句，通過XMLStatementBuilder來進行解析，它會先解析<include>標籤，然後解析<selectKey>標籤，儲存到Configuration.keyGenerators集合中，最後通過LanguageDriver.createSqlSource()方法建立SqlSource物件，構建MappedStatement物件，MappedStatement的sqlSource記錄sql語句，sqlCommandType記錄SQL語句的型別，儲存在Configuration.mappedStatements集合中

總結

文章主要講了Mapper對映檔案的解析，包括namespace、cache、resultMap、sql等標籤，最終這些資訊都會儲存到Configuration中，理解Mapper的對映邏輯還是非常重要的，因為我們開發的時候主要就是編寫Mapper檔案。

到此這篇關於Java Mybatis的初始化之Mapper.xml對映檔案的詳解的文章就介紹到這了,更多相關Java Mapper.xml對映檔案內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

Java Mybatis的初始化之Mapper.xml對映檔案的詳解

目錄

解析Mapper檔案入口

解析Mapper檔案

總結

熱門文章