面試：你知道MyBatis執行過程之初始化是如何執行的嗎？

前言

在瞭解MyBatis架構以及核心內容分析後，我們可以研究MyBatis執行過程，包括

• MyBatis初始化
• SQL執行過程

而且在面試會問到一下關於MyBatis初始化的問題，比如：

• Mybatis需要初始化哪些?
• MyBatis初始化的過程？

MyBatis初始化

在 MyBatis 初始化過程中，會載入 mybatis-config.xml 組態檔、Mapper.xml對映組態檔以及 Mapper 介面中的註解資訊，解析後的設定資訊會形成相應的物件並儲存到 Configuration 物件中。初始化過程可以分成三部分：

• 解析mybatis-config.xml 組態檔

  • SqlSessionFactoryBuilder
  • XMLConfigBuilder
  • Configuration

• 解析Mapper.xml對映組態檔

  • XMLMapperBuilder::parse()
  • XMLStatementBuilder::parseStatementNode()
  • XMLLanguageDriver
  • SqlSource
  • MappedStatement

• 解析Mapper介面中的註解

  • MapperRegistry

  • MapperAnnotationBuilder::parse()

解析mybatis-config.xml 組態檔

MyBatis 的初始化流程的入口是 SqlSessionFactoryBuilder::build(Reader reader, String environment, Properties properties) 方法，看看具體流程圖：

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

首先會使用XMLConfigBuilder::parser()解析mybatis-config.xml 組態檔,

• 先解析標籤configuration內的資料封裝成XNode，configuration 也是 MyBatis 中最重要的一個標籤
• 根據XNode解析mybatis-config.xml 組態檔的各個標籤轉變為各個物件

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);
    }
  }

再基於Configuration使用SqlSessionFactoryBuilder::build()生成DefaultSqlSessionFactory供給後續執行使用。

解析Mapper.xml對映組態檔

首先使用XMLMapperBuilder::parse()解析Mapper.xml，看看載入流程圖來分析分析

通過XPathParser::evalNode將mapper標籤中內容解析到XNode

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

    this.parsePendingResultMaps();
    this.parsePendingCacheRefs();
    this.parsePendingStatements();
}

再由configurationElement()方法去解析XNode中的各個標籤：

• namespace
• parameterMap
• resultMap
• select|insert|update|delete

private void configurationElement(XNode context) {
    try {
      String namespace = context.getStringAttribute("namespace");
      if (namespace == null || namespace.equals("")) {
        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"));
      //解析MapperState
      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);
    }
  }

其中，基於XMLMapperBuilder::buildStatementFromContext()，遍歷 <select />、<insert />、<update />、<delete /> 節點們，逐個建立XMLStatementBuilder物件，執行解析,通過XMLStatementBuilder::parseStatementNode()解析，

• parameterType
• resultType
• selectKey等

並會通過LanguageDriver::createSqlSource()(預設XmlLanguageDriver)解析動態sql生成SqlSource(詳細內容請看下個小節),

• 使用GenericTokenParser::parser()負責將 SQL 語句中的 #{} 替換成相應的 ?預留位置，並獲取該 ? 預留位置對應的

而且通過MapperBuilderAssistant::addMappedStatement()生成MappedStatement

public void parseStatementNode() {
  //獲得 id 屬性，編號
  String id = context.getStringAttribute("id");
  String databaseId = context.getStringAttribute("databaseId");
  // 判斷 databaseId 是否匹配
  if (!databaseIdMatchesCurrent(id, databaseId, this.requiredDatabaseId)) {
    return;
  }
  //解析獲得各種屬性
  Integer fetchSize = context.getIntAttribute("fetchSize");
  Integer timeout = context.getIntAttribute("timeout");
  String parameterMap = context.getStringAttribute("parameterMap");
  String parameterType = context.getStringAttribute("parameterType");
  Class<?> parameterTypeClass = resolveClass(parameterType);
  String resultMap = context.getStringAttribute("resultMap");
  String resultType = context.getStringAttribute("resultType");
  String lang = context.getStringAttribute("lang");
  //獲得 lang 對應的 LanguageDriver 物件
  LanguageDriver langDriver = getLanguageDriver(lang);
  //獲得 resultType 對應的類
  Class<?> resultTypeClass = resolveClass(resultType);
  String resultSetType = context.getStringAttribute("resultSetType");
  //獲得 statementType 對應的列舉值
  StatementType statementType = StatementType.valueOf(context.getStringAttribute("statementType", StatementType.PREPARED.toString()));
  //獲得 resultSet 對應的列舉值
  ResultSetType resultSetTypeEnum = resolveResultSetType(resultSetType);

  String nodeName = context.getNode().getNodeName();
  //獲得 SQL 對應的 SqlCommandType 列舉值
  SqlCommandType sqlCommandType = SqlCommandType.valueOf(nodeName.toUpperCase(Locale.ENGLISH));
  boolean isSelect = sqlCommandType == SqlCommandType.SELECT;
  //解析獲得各種屬性
  boolean flushCache = context.getBooleanAttribute("flushCache", !isSelect);
  boolean useCache = context.getBooleanAttribute("useCache", isSelect);
  boolean resultOrdered = context.getBooleanAttribute("resultOrdered", false);

  //建立 XMLIncludeTransformer 物件，並替換 <include /> 標籤相關的內容
  XMLIncludeTransformer includeParser = new XMLIncludeTransformer(configuration, builderAssistant);
  includeParser.applyIncludes(context.getNode());

  //解析 <selectKey /> 標籤
  processSelectKeyNodes(id, parameterTypeClass, langDriver);
  
  //建立 SqlSource生成動態sql
  SqlSource sqlSource = langDriver.createSqlSource(configuration, context, parameterTypeClass);
  String resultSets = context.getStringAttribute("resultSets");
  String keyProperty = context.getStringAttribute("keyProperty");
  String keyColumn = context.getStringAttribute("keyColumn");
  KeyGenerator keyGenerator;
  String keyStatementId = id + SelectKeyGenerator.SELECT_KEY_SUFFIX;
  keyStatementId = builderAssistant.applyCurrentNamespace(keyStatementId, true);
  if (configuration.hasKeyGenerator(keyStatementId)) {
    keyGenerator = configuration.getKeyGenerator(keyStatementId);
  } else {
    keyGenerator = context.getBooleanAttribute("useGeneratedKeys",
        configuration.isUseGeneratedKeys() && SqlCommandType.INSERT.equals(sqlCommandType))
        ? Jdbc3KeyGenerator.INSTANCE : NoKeyGenerator.INSTANCE;
  }
  //建立 MappedStatement 物件
  this.builderAssistant.addMappedStatement(id, sqlSource, statementType, sqlCommandType, 					fetchSize, timeout, parameterMap, parameterTypeClass, 
                    resultMap, resultTypeClass, resultSetTypeEnum, flushCache, 
                    useCache, resultOrdered, (KeyGenerator)keyGenerator, keyProperty, 
                    keyColumn, databaseId, langDriver, resultSets);
}

解析Mapper介面中的註解

當執行完XMLMapperBuilder::configurationElement()方法後,會呼叫XMLMapperBuilder::bindMapperForNamespace()會轉換成對介面上註解進行掃描，具體通過MapperRegistry::addMapper()呼叫MapperAnnotationBuilder實現的

MapperAnnotationBuilder::parse()是註解構造器，負責解析 Mapper 介面上的註解,解析時需要注意避免和 XMLMapperBuilder::parse() 方法衝突，重複解析，最終使用parseStatement解析，那怎麼操作？

public void parse() {
  String resource = type.toString();
  //判斷當前 Mapper 介面是否應載入過。
  if (!configuration.isResourceLoaded(resource)) {
    //載入對應的 XML Mapper,注意避免和 `XMLMapperBuilder::parse()` 方法衝突
    loadXmlResource();
    //標記該 Mapper 介面已經載入過
    configuration.addLoadedResource(resource);
    assistant.setCurrentNamespace(type.getName());
    //解析 @CacheNamespace 註解
    parseCache();
    parseCacheRef();
     //遍歷每個方法，解析其上的註解
    Method[] methods = type.getMethods();
    for (Method method : methods) {
      try {
        if (!method.isBridge()) {
          //執行解析
          parseStatement(method);
        }
      } catch (IncompleteElementException e) {
        configuration.addIncompleteMethod(new MethodResolver(this, method));
      }
    }
  }
  //解析待定的方法
  parsePendingMethods();
}

那其中最重要的parseStatement()是怎麼操作？其實跟解析Mapper.xml型別主要處理流程類似：

• 通過載入LanguageDriver,GenericTokenParser等為生成SqlSource動態sql作準備
• 使用MapperBuilderAssistant::addMappedStatement()生成註解@mapper,@CacheNamespace等的MappedStatement資訊

void parseStatement(Method method) {
    //獲取介面引數型別	
    Class<?> parameterTypeClass = getParameterType(method);
    //載入語言處理器，預設XmlLanguageDriver
    LanguageDriver languageDriver = getLanguageDriver(method);
    //根據LanguageDriver，GenericTokenParser生成動態SQL
    SqlSource sqlSource = getSqlSourceFromAnnotations(method, parameterTypeClass, languageDriver);
    if (sqlSource != null) {
      //獲取其他屬性
        Options options = method.getAnnotation(Options.class);
        final String mappedStatementId = type.getName() + "." + method.getName();
        Integer fetchSize = null;
        Integer timeout = null;
        StatementType statementType = StatementType.PREPARED;
        ResultSetType resultSetType = null;
        SqlCommandType sqlCommandType = getSqlCommandType(method);
        boolean isSelect = sqlCommandType == SqlCommandType.SELECT;
        boolean flushCache = !isSelect;
        boolean useCache = isSelect;

        //獲得 KeyGenerator 物件
        KeyGenerator keyGenerator;
        String keyProperty = null;
        String keyColumn = null;
        if (SqlCommandType.INSERT.equals(sqlCommandType) || SqlCommandType.UPDATE.equals(sqlCommandType)) { // 有
            // first check for SelectKey annotation - that overrides everything else
            //如果有 @SelectKey 註解，則進行處理
            SelectKey selectKey = method.getAnnotation(SelectKey.class);
            if (selectKey != null) {
                keyGenerator = handleSelectKeyAnnotation(selectKey, mappedStatementId, getParameterType(method), languageDriver);
                keyProperty = selectKey.keyProperty();
            //如果無 @Options 註解，則根據全域性設定處理
            } else if (options == null) {
                keyGenerator = configuration.isUseGeneratedKeys() ? Jdbc3KeyGenerator.INSTANCE : NoKeyGenerator.INSTANCE;
            // 如果有 @Options 註解，則使用該註解的設定處理
            } else {
                keyGenerator = options.useGeneratedKeys() ? Jdbc3KeyGenerator.INSTANCE : NoKeyGenerator.INSTANCE;
                keyProperty = options.keyProperty();
                keyColumn = options.keyColumn();
            }
        // 無
        } else {
            keyGenerator = NoKeyGenerator.INSTANCE;
        }

        //初始化各種屬性
        if (options != null) {
            if (FlushCachePolicy.TRUE.equals(options.flushCache())) {
                flushCache = true;
            } else if (FlushCachePolicy.FALSE.equals(options.flushCache())) {
                flushCache = false;
            }
            useCache = options.useCache();
            fetchSize = options.fetchSize() > -1 || options.fetchSize() == Integer.MIN_VALUE ? options.fetchSize() : null; //issue #348
            timeout = options.timeout() > -1 ? options.timeout() : null;
            statementType = options.statementType();
            resultSetType = options.resultSetType();
        }

        // 獲得 resultMapId 編號字串
        String resultMapId = null;
        //如果有 @ResultMap 註解，使用該註解為 resultMapId 屬性
        ResultMap resultMapAnnotation = method.getAnnotation(ResultMap.class);
        if (resultMapAnnotation != null) {
            String[] resultMaps = resultMapAnnotation.value();
            StringBuilder sb = new StringBuilder();
            for (String resultMap : resultMaps) {
                if (sb.length() > 0) {
                    sb.append(",");
                }
                sb.append(resultMap);
            }
            resultMapId = sb.toString();
        // 如果無 @ResultMap 註解，解析其它註解，作為 resultMapId 屬性
        } else if (isSelect) {
            resultMapId = parseResultMap(method);
        }
      //構建 MappedStatement 物件
      assistant.addMappedStatement(
          mappedStatementId,
          sqlSource,
          statementType,
          sqlCommandType,
          fetchSize,
          timeout,
          // ParameterMapID
          null,
          parameterTypeClass,
          resultMapId,
          getReturnType(method),
          resultSetType,
          flushCache,
          useCache,
          // TODO gcode issue #577
          false,
          keyGenerator,
          keyProperty,
          keyColumn,
          // DatabaseID
          null,
          languageDriver,
          // ResultSets
          options != null ? nullOrEmpty(options.resultSets()) : null);
    }
  }

生成動態SqlSource

當在執行langDriver::createSqlSource(configuration, context, parameterTypeClass)中的時候， 是怎樣從 Mapper XML 或方法註解上讀取SQL內容生成動態SqlSource的呢？現在來一探究竟，

首先需要獲取langDriver實現XMLLanguageDriver/RawLanguageDriver，現在使用預設的XMLLanguageDriver::createSqlSource(configuration, context, parameterTypeClass)開啟建立，再使用XMLScriptBuilder::parseScriptNode()解析生成SqlSource

• DynamicSqlSource： 動態的 SqlSource 實現類 , 適用於使用了 OGNL 表示式，或者使用了 ${} 表示式的 SQL
• RawSqlSource： 原始的 SqlSource 實現類 , 適用於僅使用 #{} 表示式，或者不使用任何表示式的情況

public SqlSource parseScriptNode() {
        MixedSqlNode rootSqlNode = this.parseDynamicTags(this.context);
        Object sqlSource;
        if (this.isDynamic) {
            sqlSource = new DynamicSqlSource(this.configuration, rootSqlNode);
        } else {
            sqlSource = new RawSqlSource(this.configuration, rootSqlNode, this.parameterType);
        }

        return (SqlSource)sqlSource;
    }

那就選擇其中一種來分析一下RawSqlSource，怎麼完成構造的呢？看看RawSqlSource建構函式：

 public RawSqlSource(Configuration configuration, String sql, Class<?> parameterType) {
        SqlSourceBuilder sqlSourceParser = new SqlSourceBuilder(configuration);
        Class<?> clazz = parameterType == null ? Object.class : parameterType;
        this.sqlSource = sqlSourceParser.parse(sql, clazz, new HashMap());
    }

使用SqlSourceBuilder::parse()去解析SQl，裡面又什麼神奇的地方呢？

 public SqlSource parse(String originalSql, Class<?> parameterType, Map<String, Object> additionalParameters) {
        SqlSourceBuilder.ParameterMappingTokenHandler handler = new SqlSourceBuilder.ParameterMappingTokenHandler(this.configuration, parameterType, additionalParameters);
     	//建立基於#{}的GenericTokenParser
        GenericTokenParser parser = new GenericTokenParser("#{", "}", handler);
        String sql = parser.parse(originalSql);
        return new StaticSqlSource(this.configuration, sql, handler.getParameterMappings());
    }

ParameterMappingTokenHandler 是 SqlSourceBuilder 的內部私有靜態類, ParameterMappingTokenHandler ，負責將匹配到的 #{ 和 } 對，替換成相應的 ? 預留位置，並獲取該 ? 預留位置對應的 org.apache.ibatis.mapping.ParameterMapping 物件。

並基於ParameterMappingTokenHandler使用GenericTokenParser::parse()將SQL中的#{}轉化預留位置? 預留位置後建立一個StaticSqlSource返回。

總結

在 MyBatis 初始化過程中，會載入 mybatis-config.xml 組態檔、Mapper.xml對映組態檔以及 Mapper 介面中的註解資訊，解析後的設定資訊會形成相應的物件並全部儲存到 Configuration 物件中，並建立DefaultSqlSessionFactory供SQl執行過程建立出頂層介面SqlSession供給使用者進行操作。

各位看官還可以嗎？喜歡的話，動動手指點個贊💗唄！！謝謝支援！
歡迎掃碼關注，原創技術文章第一時間推出