MyBatis 源码解析笔记

作者笔记仓库：https://github.com/seazean/javanotes

欢迎各位关注我的笔记仓库，clone 仓库到本地后使用 Typora 阅读效果更好。

笔记内容参考视频：https://www.bilibili.com/video/BV1mW411M737?p=71

---

一、运行机制

MyBatis 运行过程：

1. 加载 MyBatis 全局配置文件，通过 XPath 方式解析 XML 配置文件，首先解析核心配置文件， 标签中配置属性项有 defaultExecutorType，用来配置指定 Executor 类型，将配置文件的信息填充到 Configuration对象。最后解析映射器配置的映射文件，并 构建 MappedStatement 对象填充至 Configuration，将解析后的映射器添加到 mapperRegistry 中，用于获取代理

2. 创建一个 DefaultSqlSession 对象，根据参数创建指定类型的 Executor，二级缓存默认开启，把 Executor 包装成缓存执行器

3. DefaulSqlSession 调用 getMapper()，通过 JDK 动态代理获取 Mapper 接口的代理对象 MapperProxy

4. 执行 SQL 语句：

   • MapperProxy.invoke() 执行代理方法，通过 MapperMethod 判断执行的是增删改查中的哪个方法
   • 获取执行者对象 MappedStatement，Executor 调用 executor 开始驱动方法的执行
   • 首先通过 CachingExecutor 去二级缓存查询，查询不到去一级缓存查询，最后去数据库查询并放入一级缓存

• Configuration 对象根据 标签的 statementType 属性创建 StatementHandler 对象，在 StatementHandler 的构造方法中，创建了 ParameterHandler 和 ResultSetHandler 对象 最后获取 JDBC 原生的 Connection 对象，创建 Statement 执行者对象，然后进行参数的设置 通过 ParameterHandler 设置预编译参数，通过 StatementHandler 调用原生的执行者对象执行增删改查，最后调用ResultsetHandler 封装查询结果 四大对象： StatementHandler：执行 SQL 语句的对象 ParameterHandler：设置预编译参数用的 ResultHandler：处理结果集 Executor：执行器，真正进行 Java 与数据库交互的对象 二、获取工厂 SqlSessionFactoryBuilder.build(InputStream, String, Properties)：构建工厂 XMLConfigBuilder.parse()：解析核心配置文件每个标签的信息（XPath） parseConfiguration(parser.evalNode("/configuration"))：读取节点内数据， 是 MyBatis 配置文件中的顶层标签 settings = settingsAsProperties(root.evalNode("settings"))：读取核心配置文件中的 标签 settingsElement(settings)：设置框架相关的属性 configuration.setDefaultExecutorType()：设置 Executor 类型到 configuration，默认是 SIMPLE mapperElement(root.evalNode("mappers"))：解析 mappers 信息，分为 package 和 单个注册两种 Configuration.addMappers()：将核心配置文件配置的映射器添加到 mapperRegistry 中，用来获取代理对象 if...else...：根据映射方法选择合适的读取方式 XMLMapperBuilder.parse()：解析 mapper 的标签的信息 configurationElement(parser.evalNode("/mapper"))：解析 mapper 文件，顶层节点 buildStatementFromContext(context.evalNodes("select..."))：解析操作标签 XMLStatementBuilder.parseStatementNode()：解析操作标签的所有的属性 builderAssistant.addMappedStatement(...)：封装成 MappedStatement 对象加入 return configuration：返回配置完成的 configuration 对象 return new DefaultSqlSessionFactory(config)：返回工厂对象 总结：解析 XML 是对 Configuration 中的属性进行填充，那么可以在一个类中创建 Configuration 对象，自定义其中属性的值来达到配置的效果 三、获取会话 DefaultSqlSessionFactory.openSession()：获取 Session 对象，并且创建 Executor 对象 DefaultSqlSessionFactory.openSessionFromDataSource(...)：ExecutorType 为 Executor 的类型，TransactionIsolationLevel 为事务隔离级别，autoCommit 是否开启事务 transactionFactory.newTransaction(DataSource, IsolationLevel, boolean：事务对象 configuration.newExecutor(tx, execType)：根据参数创建指定类型的 Executor 批量操作笔记的部分有讲解到 的属性 defaultExecutorType，根据配置创建对象 二级缓存默认开启，会包装 Executor 对象 new CachingExecutor(executor) return new DefaultSqlSession(configuration, executor, autoCommit)：返回 DefaultSqlSession 对象 四、获取代理 Configuration.getMapper(Class, SqlSession)：获取代理的 mapper 对象 MapperRegistry.getMapper(Class, SqlSession)：MapperRegistry 是 Configuration 属性，在获取工厂对象时初始化 (MapperProxyFactory<T>) knownMappers.get(type)：获取接口信息封装为 MapperProxyFactory 对象 mapperProxyFactory.newInstance(sqlSession)：创建代理对象 new MapperProxy<>(sqlSession, mapperInterface, methodCache)：包装对象 methodCache 是并发安全的 ConcurrentHashMap 集合，存放要执行的方法 MapperProxy<T> implements InvocationHandler 说明 MapperProxy 默认是一个 InvocationHandler 对象 Proxy.newProxyInstance()：JDK 动态代理创建 MapperProxy 对象 五、执行SQL MapperProxy.invoke()：执行 SQL 语句，Object 类的方法直接执行 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { try { // 当前方法是否是属于 Object 类中的方法 if (Object.class.equals(method.getDeclaringClass())) { return method.invoke(this, args); // 当前方法是否是默认方法 } else if (isDefaultMethod(method)) { return invokeDefaultMethod(proxy, method, args); } } catch (Throwable t) { throw ExceptionUtil.unwrapThrowable(t); } // 包装成一个 MapperMethod 对象并初始化该对象 final MapperMethod mapperMethod = cachedMapperMethod(method); // 【根据 switch-case 判断使用的什么类型的 SQL 进行逻辑处理】，此处分析查询语句的查询操作 return mapperMethod.execute(sqlSession, args); } sqlSession.selectOne(String, Object)：查询数据 public Object execute(SqlSession sqlSession, Object[] args) { //..... // 解析传入的参数 Object param = method.convertArgsToSqlCommandParam(args); result = sqlSession.selectOne(command.getName(), param); } // DefaultSqlSession.selectList(String, Object) public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) { // 获取执行者对象 MappedStatement ms = configuration.getMappedStatement(statement); // 开始执行查询语句，参数通过 wrapCollection() 包装成集合类 return executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER); } Executor#query()： CachingExecutor.query()：先执行 CachingExecutor 去二级缓存获取数据 MappedStatement.getBoundSql(parameterObject)：把 parameterObject 封装成 BoundSql 构造函数中有：this.parameterObject = parameterObject CachingExecutor.createCacheKey()：创建缓存对象 ms.getCache()：获取二级缓存 tcm.getObject(cache, key)：尝试从二级缓存中获取数据 BaseExecutor.query()：获取不到缓存继续执行该方法 localCache.getObject(key) ：尝试从本地缓存（一级缓存）获取数据 BaseExecutor.queryFromDatabase()：缓存获取数据失败，开始从数据库获取数据，并放入本地缓存 SimpleExecutor.doQuery()：执行 query configuration.newStatementHandler()：创建 StatementHandler 对象 根据 标签的 statementType 属性，根据属性选择创建哪种对象
• 判断 BoundSql 是否被创建，没有创建会重新封装参数信息到 BoundSql
• StatementHandler 的构造方法中，创建了 ParameterHandler 和 ResultSetHandler 对象
• interceptorChain.pluginAll(statementHandler)：拦截器链

prepareStatement()：通过 StatementHandler 创建 JDBC 原生的 Statement 对象

• getConnection()：获取 JDBC 的 Connection 对象
• handler.prepare()：初始化 Statement 对象
  • instantiateStatement(Connection connection)：Connection 中的方法实例化对象
    • 获取普通执行者对象：Connection.createStatement()
    • 获取预编译执行者对象：Connection.prepareStatement()
• handler.parameterize()：进行参数的设置
  • ParameterHandler.setParameters()：通过 ParameterHandler 设置参数
    • typeHandler.setParameter()：底层通过 TypeHandler 实现

StatementHandler.query()：封装成 JDBC 的 PreparedStatement 执行 SQL

resultSetHandler.handleResultSets(ps)：通过 ResultSetHandler 对象封装结果集

localCache.putObject(key, list)：放入本地缓存

return list.get(0)：返回结果集的第一个数据