剑指源码-Mybatis-(二)-主流程分析与核心组件关系

本文最后更新于：2024年4月22日下午

demo整体流程概述，分析核心组件的作用以及关系

demo地址：https://github.com/hyq965672903/sourcecode-learn-mybatis.git

/**
 * 使用MyBatis API方式
 * @throws IOException
 */
@Test
public void test1() throws IOException {
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

    SqlSession session = sqlSessionFactory.openSession();
    try {
        User user = (User) session.selectOne("cn.hyqup.mapper.UserMapper.selectAll", 1);
        System.out.println(user);
    } finally {
        session.close();
    }
}
/**
 * 通过 SqlSession.getMapper(XXXMapper.class)  接口方式
 */
@Test
public void test2() throws IOException {
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

    SqlSession session = sqlSessionFactory.openSession(); // ExecutorType.BATCH
    try {
        UserMapper mapper = session.getMapper(UserMapper.class);

        List<User> users = mapper.selectAll();
        System.out.println(users);
    } finally {
        session.close();
    }
}

整体流程分析

通过 SqlSession.getMapper(XXXMapper.class) 接口方式为例，流程分析

创建SqlSessionFactory的过程

首先根据mybatis-config.xml创建一个inputStream

然后new一个SqlSessionFactoryBuilder对象，使用inputStream调用build方法得到SqlSessionFactory对象

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 {
       if (inputStream != null) {
         inputStream.close();
       }
    } catch (IOException e) {
      // Intentionally ignore. Prefer previous error.
    }
  }
}

XMLConfigBuilder创建的parser解析器对象，会去解析每一个xml节点信息，对应的相关配置信息保存在一个Configuration对象中
同时这个时候会解析到mapper信息，XMLConfigBuilder内部构建了一个XMLMapperBuilder，XMLMapperBuilder对象会将mappper信息解析到Configuration的mappedStatements这个Map对象中。而这个mappedStatements包含多个MappedStatement，MappedStatement中包含了mapper中每一个标签信息
解析完mapper之后，将mapper的信息放入Configuration对象中，返回Configuration对象
build中传入的Configuration对象被用来创建了一个DefaultSqlSessionFactory对象。创建sqlSessionFactory所做的工作就是，将所有配置文件的信息解析并且保存在Configuration对象中，返回包含了Configuration对象的DefaultSqlSessionFactory对象。

获取sqlSession对象的过程

首先调用DefaultSqlSessionFactory的openSession()方法
openSession里面调用openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false)方法
openSessionFromDataSource里面会创建Transaction一个事务，同时会创建一个Executor对象
根据Executor在全局配置中的类型（目前类型有3种，simple，batch，reuse），创建出SimpleExecutor、ReuseExecutor或者BatchExecutor。Executor是一个接口，里面规定了一些增删改查的接口方法。默认就是simple类型
如果开启了二级缓存，会通过CacheExecutor对Executor进行包装，CacheExecutor本质就是装饰者模式
executor = (Executor) interceptorChain.pluginAll(executor)，pluginAll方法会拿到每一个拦截器的plugin方法包装一下executor，开发插件就是这里织入
最后创建DefaultSqlSession并返回

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);
      //这里去创建Executor
    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();
  }
}

创建Executor代码逻辑

public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
  executorType = executorType == null ? defaultExecutorType : executorType;
  executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
  Executor executor;
  if (ExecutorType.BATCH == executorType) {
    executor = new BatchExecutor(this, transaction);
  } else if (ExecutorType.REUSE == executorType) {
    executor = new ReuseExecutor(this, transaction);
  } else {
    executor = new SimpleExecutor(this, transaction);
  }
  if (cacheEnabled) {
    executor = new CachingExecutor(executor);
  }
  executor = (Executor) interceptorChain.pluginAll(executor);
  return executor;
}

获取Mapper的代理对象（MapperProxy）的过程

调用DefaultSqlSession对象的getMapper(type)方法。（type是Mapper接口的class，例如XXXMapper.class）
进一步里面会调用configuration.getMapper(type,sqlSession),调用configuration对象中mapperRegistry的getMapper
然后根据class类型获取MapperProxyFactory，调用其newInstance，进而使用MapperProxy动态代理创建代理对象，并返回

执行增删改查方法的过程

Mapper都是接口，所以最终执行都会执行到MapperProxy的invoke方法
MapperProxy的invoke会执行MapperMethod的execute，execute方法会判断当前要执行的sql语句的类型
当前是selectAll，于是执行到executeForMany方法，进而sqlSession执行到selectList方法
selectList方法中获取MappedStatement对象，调用executor(CachingExecutor)执行query
获取BoundSql对象，里面包含sql语句的详细信息。sql语句是什么、sql语句的参数是什么等详细信息
调用真正的simpleExecutor的query方法进行查询，query是BaseExecutor中的，真正执行到doQuery方法
doQuery里面会创建StatementHandler，默认就是PreparedStatementHandler。StatementHandler被用于创建Statement对象。同时这里StatementHandler会执行interceptorChain的pluginAll进行插件加载
在StatementHandler会调用父类BaseStatementHandler的构造方法进一步创建ParameterHandler和ResultSetHandler
1. ParameterHandler用于处理参数设置的，设置sql语句的预编译参数
2. ResultSetHandler用于处理结果返回封装的
ParameterHandler和ResultsetHandler都会借助TypeHandler来进行数据库类型和Java Bean类型的转换
ParameterHandler设置参数的时候是调用的TypeHandler给sql预编译设置参数
查出数据之后，使用ResultHandler处理结果，里面也是使用TypeHandler包装value值
后续操作完成数据库连接相关
流程结束

Executor、ParameterHandler、ResultsetHandler、TypeHandler四大对象之间的关系

Executor用于执行增删改查操作；StatementHandler用ParameterHandler设置参数；使用ResultsetHandler处理结果；过程中又采用TypeHandler来实现数据库类型和JavaBean类型之间的转换

Java > Mybatis源码

剑指源码-Mybatis-(二)-主流程分析与核心组件关系

https://hyq965672903.gitee.io/posts/597465dd.html

作者

灼华

发布于

2022年8月11日

许可协议

JVM与GC调优(一)-字节码篇上一篇

剑指源码-Mybatis-(一)-序章下一篇