快捷導(dǎo)航

Mybatis源碼解析之初始化分析

更新時(shí)間：2024年01月23日 08:32:06 作者：二狗家有礦

這篇文章主要介紹了Mybatis源碼解析之初始化分析,Mybatis的初始化過(guò)程就是mybatis配置文件的解析過(guò)程并將解析結(jié)果保存到Configuration類。,需要的朋友可以參考下

一、 Mybatis配置文件

configuation是mybatis配置文件的根節(jié)點(diǎn)。

configuration 配置
	-properties 屬性
	-settings 設(shè)置
	-typeAliases 類型別名
	-typeHandlers 類型處理器
	-objectFactory 對(duì)象工廠
	-plugins 插件
	-environments 環(huán)境
		-environment 環(huán)境變量
			-transactionManager 事務(wù)管理器
			-dataSource 數(shù)據(jù)源
			-databaseIdProvider 數(shù)據(jù)庫(kù)廠商標(biāo)識(shí)
	-mappers 映射器

本文主要講解源碼，不對(duì)配置文件展開(kāi)

二、配置文件解析過(guò)程

1. 初始化demo

下文代碼是mybatis通過(guò)解析xml配置文件進(jìn)行初始化的一個(gè)簡(jiǎn)單demo，后續(xù)我們將根據(jù)這個(gè)demo追蹤mybatis源碼的處理過(guò)程。

InputStream inputStream = Resources.getResourceAsStream("mybatis-coonfig.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
SqlSession sqlSession = sqlSessionFactory.openSession();

Mybatis初始化時(shí)序圖

2. SqlSessionFactoryBuilder#build(InputStream, String. Properties)

SqlSessionFactoryBuilder的build(inputStream)方法通過(guò)調(diào)用同名的重載方法SqlSessionFactoryBuilder#build(InputStream, String. Properties)來(lái)生成需要的SqlSessionFacotry。

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.
     }
   }
 }
   
 public SqlSessionFactory build(Configuration config) {
   return new DefaultSqlSessionFactory(config);
 }

首先，通過(guò)XmlConfigBuilder解析配置文件，并得到configuration類對(duì)象。然后根據(jù)configuration作為參數(shù)調(diào)用build得到所需的SqlSessionFactory，可以看到最終得到的SqlSessionFactory類型是DefaultSqlSessionFactory。

3. XMLConfigBuilder#parse()

public Configuration parse() {
   if (parsed) {
     throw new BuilderException("Each XMLConfigBuilder can only be used once.");
   }
   parsed = true;
   parseConfiguration(parser.evalNode("/configuration"));
   return 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);
   }
 }

可以看到，XMLConfigBuilder對(duì)xml配置文件中對(duì)configuration的子節(jié)點(diǎn)進(jìn)行逐個(gè)解析。以typeAliases為例，遍歷typeAliases的子節(jié)點(diǎn)，根據(jù)配置情況將其加入到configuration對(duì)象中對(duì)應(yīng)的typeAliasRegistry屬性，其它節(jié)點(diǎn)的解析也類似。

private void typeAliasesElement(XNode parent) {
   if (parent != null) {
     for (XNode child : parent.getChildren()) {
       if ("package".equals(child.getName())) {
         String typeAliasPackage = child.getStringAttribute("name");
         configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);
       } else {
         String alias = child.getStringAttribute("alias");
         String type = child.getStringAttribute("type");
         try {
           Class<?> clazz = Resources.classForName(type);
           if (alias == null) {
             typeAliasRegistry.registerAlias(clazz);
           } else {
             typeAliasRegistry.registerAlias(alias, clazz);
           }
         } catch (ClassNotFoundException e) {
           throw new BuilderException("Error registering typeAlias for '" + alias + "'. Cause: " + e, e);
         }
       }
     }
   }
 }

4. DefaultSqlSessionFactory#openSession()

@Override
public SqlSession openSession() {
   return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
 }
private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
  Transaction tx = null;
  try {
    final Environment environment = configuration.getEnvironment();
    final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
    tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
    final Executor executor = configuration.newExecutor(tx, execType);
    return new DefaultSqlSession(configuration, executor, autoCommit);
  } catch (Exception e) {
    closeTransaction(tx); // may have fetched a connection so lets call close()
    throw ExceptionFactory.wrapException("Error opening session.  Cause: " + e, e);
  } finally {
    ErrorContext.instance().reset();
  }
}

DefaultSqlSessionFactory#openSession()最終通過(guò)DefaultSqlSessionFactory#openSessionFromDataSource(ExecutorType, TransactionLevel, boolean)試下，可以看到最后獲得的SqlSession類型是DefaultSqlSession，其中executor類型是SimpleExecutor。

到此這篇關(guān)于Mybatis源碼解析之初始化分析的文章就介紹到這了,更多相關(guān)Mybatis初始化內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: