Java Mybatis的初始化之Mapper.xml映射文件的詳解

Posted on by

前言：

解析完全局配置文件後接下來就是解析Mapper文件瞭，它是通過XMLMapperBuilder來進行解析的

解析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映射文件 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：