Mybatis 源碼(二)Mybatis 初始化

Mybatis 初始化是由SqlSessionFactoryBuilder來完成的戏锹,主要的工作解析XML文件,并將解析的類容封裝到Configuration類中,最后將Configuration類封裝到SqlSessionFactory中并返回,自此初始化完成笋熬。

完成對XML文件解析的是XMLConfigBuilderXMLMapperBuilder腻菇、XMLStatementBuilder三個類來完成:

  • XMLConfigBuilder:負責全局配置文件(mybatis-config.xml)中除了mappers節(jié)點的解析胳螟。
  • XMLMapperBuilder:負責解析xxxMapper.xml映射文件中cache-ref昔馋、cacheparameterMap糖耸、resultMap秘遏、sql節(jié)點;根據(jù) namespace 將Mapper接口的動態(tài)代理工廠注冊到 MapperRegistry 中嘉竟。
  • XMLStatementBuilder:負責解析xxxMapper.xml映射文件中SQL語句節(jié)點邦危,如:selectinsert舍扰、update倦蚪、delete
  • XMLScriptBuilder:負責解析SQL腳本边苹,然后封裝成SqlSource陵且。

Mybatis 初始化流程

SqlSessionFactoryBuilder

SqlSessionFactoryBuilder會將解析任務托給XMLConfigBuilder類,源碼如下:

public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
  try {
    // 委托給XMLConfigBuilder去解析配置文件
    XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
    // 開始解析
    return build(parser.parse());
  } 
  ...
}

public SqlSessionFactory build(Configuration config) {
  return new DefaultSqlSessionFactory(config);
}

XMLConfigBuilder

負責全局配置文件(mybatis-config.xml)中除了mappers節(jié)點的解析个束。解析<mappers>節(jié)點委托給XMLMapperBuilder解析器慕购。

private void parseConfiguration(XNode root) {
  try {
    //issue #117 read properties first
    // 解析<properties>節(jié)點
    propertiesElement(root.evalNode("properties"));
    // 解析<settings>節(jié)點
    Properties settings = settingsAsProperties(root.evalNode("settings"));
    loadCustomVfs(settings);
    loadCustomLogImpl(settings);
    // 解析<typeAliases>節(jié)點
    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"));
    // 解析<mappers>節(jié)點
    mapperElement(root.evalNode("mappers"));
  } catch (Exception e) {
    throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
  }
}

private void mapperElement(XNode parent) throws Exception {
  if (parent != null) {

    for (XNode child : parent.getChildren()) {
      if ("package".equals(child.getName())) {
        String mapperPackage = child.getStringAttribute("name");
        configuration.addMappers(mapperPackage);
      } else {
        String resource = child.getStringAttribute("resource");
        String url = child.getStringAttribute("url");
        String mapperClass = child.getStringAttribute("class");
        if (resource != null && url == null && mapperClass == null) {
          ErrorContext.instance().resource(resource);
          InputStream inputStream = Resources.getResourceAsStream(resource);
          // 委托XMLMapperBuilder來解析映射文件
          XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
          mapperParser.parse();
        } else if (resource == null && url != null && mapperClass == null) {
          ErrorContext.instance().resource(url);
          InputStream inputStream = Resources.getUrlAsStream(url);
          // 委托XMLMapperBuilder來解析映射文件
          XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
          mapperParser.parse();
        } else if (resource == null && url == null && mapperClass != null) {
          Class<?> mapperInterface = Resources.classForName(mapperClass);
          configuration.addMapper(mapperInterface);
        } else {
          throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
        }
      }
    }
  }
}

XMLMapperBuilder

負責解析xxxMapper.xml映射文件中cache-ref、cache茬底、parameterMap沪悲、resultMap、sql節(jié)點阱表;根據(jù) namespace 將Mapper接口的動態(tài)代理工廠(MapperProxyFactory)注冊到 MapperRegistry 中殿如。

public void parse() {
  // 防止重復解析
  if (!configuration.isResourceLoaded(resource)) {
    // 解析xxxMapper.xml 映射文件中的 mapper節(jié)點
    configurationElement(parser.evalNode("/mapper"));
    // 標記為已經(jīng)加載過
    configuration.addLoadedResource(resource);
    // 根據(jù) namespace 將Mapper接口的動態(tài)代理工廠注冊到 MapperRegistry 中
    bindMapperForNamespace();
  }
  // 兜底
  parsePendingResultMaps();
  parsePendingCacheRefs();
  parsePendingStatements();
}

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);
    // 解析<cache-ref>節(jié)點
    cacheRefElement(context.evalNode("cache-ref"));
    // 解析<cache>節(jié)點
    cacheElement(context.evalNode("cache"));
    // 解析<parameterMap>節(jié)點
    parameterMapElement(context.evalNodes("/mapper/parameterMap"));
    // 解析<resultMap>節(jié)點
    resultMapElements(context.evalNodes("/mapper/resultMap"));
    sqlElement(context.evalNodes("/mapper/sql"));
    // 解析<select|insert|update|delete>節(jié)點
    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);
  }
}

private void buildStatementFromContext(List<XNode> list) {
  if (configuration.getDatabaseId() != null) {
    buildStatementFromContext(list, configuration.getDatabaseId());
  }
  buildStatementFromContext(list, null);
}

private void buildStatementFromContext(List<XNode> list, String requiredDatabaseId) {
  for (XNode context : list) {
    // 解析<select|insert|update|delete>節(jié)點委托給 XMLStatementBuilder
    final XMLStatementBuilder statementParser = new XMLStatementBuilder(configuration, builderAssistant, context, requiredDatabaseId);
    try {
      statementParser.parseStatementNode();
    } catch (IncompleteElementException e) {
      configuration.addIncompleteStatement(statementParser);
    }
  }
}

XMLStatementBuilder

負責解析xxxMapper.xml映射文件中SQL語句節(jié)點,如:select最爬、insert握截、update、delete烂叔。解析<select|insert|update|delete>節(jié)點委托給XMLStatementBuilder解析器。

public void parseStatementNode() {
  String id = context.getStringAttribute("id");
  String databaseId = context.getStringAttribute("databaseId");

  if (!databaseIdMatchesCurrent(id, databaseId, this.requiredDatabaseId)) {
    return;
  }

  // 根據(jù)節(jié)點的名稱來判斷SQL語句的類型(select|insert|update|delete)
  String nodeName = context.getNode().getNodeName();
  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);

  // Include Fragments before parsing
  // 解析<include>節(jié)點
  XMLIncludeTransformer includeParser = new XMLIncludeTransformer(configuration, builderAssistant);
  includeParser.applyIncludes(context.getNode());

  String parameterType = context.getStringAttribute("parameterType");
  Class<?> parameterTypeClass = resolveClass(parameterType);

  String lang = context.getStringAttribute("lang");
  LanguageDriver langDriver = getLanguageDriver(lang);

  // Parse selectKey after includes and remove them.
  // 解析<selectKey>節(jié)點固歪,并在XML中刪除<selectKey>節(jié)點
  processSelectKeyNodes(id, parameterTypeClass, langDriver);

  // Parse the SQL (pre: <selectKey> and <include> were parsed and removed)
  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;
  }

  // 解析SQL語句蒜鸡,然后封裝成SqlSource
  SqlSource sqlSource = langDriver.createSqlSource(configuration, context, parameterTypeClass);
  StatementType statementType = StatementType.valueOf(context.getStringAttribute("statementType", StatementType.PREPARED.toString()));
  Integer fetchSize = context.getIntAttribute("fetchSize");
  Integer timeout = context.getIntAttribute("timeout");
  String parameterMap = context.getStringAttribute("parameterMap");
  String resultType = context.getStringAttribute("resultType");
  Class<?> resultTypeClass = resolveClass(resultType);
  String resultMap = context.getStringAttribute("resultMap");
  String resultSetType = context.getStringAttribute("resultSetType");
  ResultSetType resultSetTypeEnum = resolveResultSetType(resultSetType);
  if (resultSetTypeEnum == null) {
    resultSetTypeEnum = configuration.getDefaultResultSetType();
  }
  String keyProperty = context.getStringAttribute("keyProperty");
  String keyColumn = context.getStringAttribute("keyColumn");
  String resultSets = context.getStringAttribute("resultSets");

  // 使用建造者模式構(gòu)建MappedStatement對象
  builderAssistant.addMappedStatement(id, sqlSource, statementType, sqlCommandType,
      fetchSize, timeout, parameterMap, parameterTypeClass, resultMap, resultTypeClass,
      resultSetTypeEnum, flushCache, useCache, resultOrdered,
      keyGenerator, keyProperty, keyColumn, databaseId, langDriver, resultSets);
}

Mybatis 初始化流程圖

mybatis初始化過程.png

核心數(shù)據(jù)結(jié)構(gòu)類

Configuration

Configuration其實就是XML配置文件的Java形態(tài),Configuration是單例的牢裳,生命周期是應用級的逢防;

configuration.png

ResultMap

對應xxxMapper.xml映射文件中的resultMap節(jié)點。<resultMap>節(jié)點中的子節(jié)點使用ResultMapping來封裝蒲讯,如:<id>忘朝、<result>等節(jié)點。

ResultMap.png

MappedStatement

對應xxxMapper.xml映射文件中的<select>判帮、<insert>局嘁、<update><delete>節(jié)點溉箕。

MappedStatment.png

SqlSource

對應xxxMapper.xml映射文件中的sql語句,經(jīng)過解析SqlSource包含的語句最終僅僅包含悦昵?占位符肴茄,可以直接提交給數(shù)據(jù)庫執(zhí)行;

MapperRegistry

它是Mapper接口動態(tài)代理工廠類的注冊中心但指。在MyBatis中寡痰,通過MapperProxy實現(xiàn)InvocationHandler接口,通過MapperProxyFactory生成動態(tài)代理的實例對象棋凳;

MyBatis建造者類圖

Mybatis的整個初始化過程使用了建造者模式拦坠。建造者模式比較適合生成復雜對象,主要關注對象的實例化具體細節(jié)剩岳。


MyBatis建造者類圖.png

Mybatis 源碼中文注釋

https://github.com/xiaolyuh/mybatis

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末贞滨,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子卢肃,更是在濱河造成了極大的恐慌疲迂,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,423評論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件莫湘,死亡現(xiàn)場離奇詭異尤蒿,居然都是意外死亡,警方通過查閱死者的電腦和手機幅垮,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,147評論 2 385
  • 文/潘曉璐 我一進店門腰池,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人忙芒,你說我怎么就攤上這事示弓。” “怎么了呵萨?”我有些...
    開封第一講書人閱讀 157,019評論 0 348
  • 文/不壞的土叔 我叫張陵奏属,是天一觀的道長。 經(jīng)常有香客問我潮峦,道長囱皿,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,443評論 1 283
  • 正文 為了忘掉前任忱嘹,我火速辦了婚禮嘱腥,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘拘悦。我一直安慰自己齿兔,他們只是感情好,可當我...
    茶點故事閱讀 65,535評論 6 385
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著分苇,像睡著了一般添诉。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上组砚,一...
    開封第一講書人閱讀 49,798評論 1 290
  • 那天吻商,我揣著相機與錄音,去河邊找鬼糟红。 笑死艾帐,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的盆偿。 我是一名探鬼主播柒爸,決...
    沈念sama閱讀 38,941評論 3 407
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼事扭!你這毒婦竟也來了捎稚?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,704評論 0 266
  • 序言:老撾萬榮一對情侶失蹤求橄,失蹤者是張志新(化名)和其女友劉穎今野,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體罐农,經(jīng)...
    沈念sama閱讀 44,152評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡条霜,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,494評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了涵亏。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片宰睡。...
    茶點故事閱讀 38,629評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖气筋,靈堂內(nèi)的尸體忽然破棺而出拆内,到底是詐尸還是另有隱情,我是刑警寧澤宠默,帶...
    沈念sama閱讀 34,295評論 4 329
  • 正文 年R本政府宣布麸恍,位于F島的核電站,受9級特大地震影響搀矫,放射性物質(zhì)發(fā)生泄漏抹沪。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,901評論 3 313
  • 文/蒙蒙 一艾君、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧肄方,春花似錦冰垄、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,742評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽逝薪。三九已至,卻和暖如春蝴罪,著一層夾襖步出監(jiān)牢的瞬間董济,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,978評論 1 266
  • 我被黑心中介騙來泰國打工要门, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留虏肾,地道東北人。 一個月前我還...
    沈念sama閱讀 46,333評論 2 360
  • 正文 我出身青樓欢搜,卻偏偏與公主長得像封豪,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子炒瘟,可洞房花燭夜當晚...
    茶點故事閱讀 43,499評論 2 348

推薦閱讀更多精彩內(nèi)容