Mybatis的解析和运行原理：SqlSession运行过程

桃扇骨 2023-09-26 21:33 15阅读 0赞

使用Mybatis时，最常看见的语句之一：

XXXMapper mapper = sqlSession.getMapper(XXXMapper.class);
    复制代码

通过`getMapper()`方法得到了一个`XXXMapper`的对象。

要知道`XXXMapper`本身是一个接口，而我们代码是没有写实现类的。所以该对象是由Mybatis通过：反射和动态代理，这两项技术创建了一个**代理对象**，现在我们来分析一下这个工程。

`SqlSession`是一个接口，有一个实现类`DefaultSqlSession`，实现了`getMapper`方法：

![format_png][]

@Override
    public <T> T getMapper(Class<T> type) {
      return configuration.getMapper(type, this);
    }
    复制代码

我们会发现它调用了`configuration.getMapper`方法，回想一下这个`configuration`怎么来的。

![format_png 1][]

回顾：

`build`方式创建`SqlSessionFactory`时，`SqlSessionFactory`也是一个接口，它的默认实现类是`DefaultSqlSessionFactory`。

sqlSessionFactory = new SqlSessionFactoryBuilder().build(xml);
    复制代码

**`configuration`通过`parser.parse()`返回**

return build(parser.parse());
    复制代码

并且调用`build(Configuration config)`方法，创建了`SqlSessionFactory`，拿到它后，我们要调用其`openSession()`方法。

public SqlSessionFactory build(Configuration config) {
      return new DefaultSqlSessionFactory(config);
    }
    复制代码

## 拿到SqlSession ##

`sqlSessionFactory`通过`openSession()`方法，获得`SqlSession`

SqlSession sqlSession = sqlSessionFactory.openSession();
    复制代码

我们知道`sqlSessionFactory`实质上是`DefaultSqlSessionFactory`，所以其底层是调用`DefaultSqlSessionFactory`的方法，而配置`configuration`已经作为参数被传入其中了：

@Override
    public SqlSession openSession() {
      return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
    }
    复制代码

我们会发现`DefaultSqlSessionFactory`又调用了`openSessionFromDataSource`，并且将`configuration.getDefaultExecutorType()`作为参数传入。

先看`openSessionFromDataSource`定义：

private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
    复制代码

我们注意到它是一个`ExecutorType`类，我们去看

configuration.getDefaultExecutorType()
    复制代码

会发现它就是配置了mybatis的默认执行器：`SIMPLE`。 最后通过调用构造函数返回SqlSession，该构造器就是我们开头看见的代码：

![format_png 2][]

public DefaultSqlSession(Configuration configuration, Executor executor, boolean autoCommit) {
      this.configuration = configuration;
      this.executor = executor;
      this.dirty = false;
      this.autoCommit = autoCommit;
    }
    复制代码

1.  `SqlSession`是一个接口，有一个实现类`DefaultSqlSession`，实现了`getMapper`方法。
2.  `SqlSessionFactory`是一个接口，它的默认实现类是`DefaultSqlSessionFactory`，它调用`openSession`方法，执行`openSessionFromDataSource`，去生成`DefaultSqlSession`。:

@Override
    public SqlSession openSession() {
      return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
    }
    复制代码

private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
      Transaction tx = null;
      try {
        ...
        return new DefaultSqlSession(configuration, executor, autoCommit);
      } catch (Exception e) {
        ...
      } finally {
        ...
      }
    }
    复制代码

## 拿到代理 ##

回过头来，它是调用`configuration.getMapper(type, this);`生成对象的。

@Override
    public <T> T getMapper(Class<T> type) {
      return configuration.getMapper(type, this);
    }
    复制代码

该方法如下，将`DefaultSqlSession`类作为参数传递，又调用了`mapperRegistry.getMapper(type, sqlSession)`：

public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
      return mapperRegistry.getMapper(type, sqlSession);
    }
    复制代码

这里先不展开`mapperRegistry`，它是一个映射器的注册器。我们就看调用的这个方法：

public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
     #1 final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
     #2 if (mapperProxyFactory == null) {
        throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
      }
      try {
        return mapperProxyFactory.newInstance(sqlSession); // 看这里
      } catch (Exception e) {
        throw new BindingException("Error getting mapper instance. Cause: " + e, e);
      }
    }
    复制代码

`#1` 和 `#2`，一看抛出的异常，我们就理解了，我们的映射器如果没有注册在配置文件中的话，就会抛出`"Type " + type + " is not known to the MapperRegistry."`异常。所以这里我们又可以倒回去去仔细研究配置文件中哪里去配置了这个`knownMappers`。

--------------------

（待补充）

这里贴出核心代码，在`XMLConfigBuilder`中有这样一行代码，其中`mapperClass`是字符串，我们通常会注册时写，写入的是mapper接口的全类路径名：

<mapper class="top.chengyunlai.mapper.UserAnnotationMapper"/>
    复制代码

Class<?> mapperInterface = Resources.classForName(mapperClass);
    configuration.addMapper(mapperInterface);
    复制代码

![format_png 3][]

如果注册在配置文件中的话，我们就要执行`mapperProxyFactory.newInstance(sqlSession)`

protected T newInstance(MapperProxy<T> mapperProxy) {
      return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
    }
    
    public T newInstance(SqlSession sqlSession) {
      final MapperProxy<T> mapperProxy = new MapperProxy<>(sqlSession, mapperInterface, methodCache);
      return newInstance(mapperProxy);
    }
    复制代码

这里就明了，它是使用动态代理的方式。

[format_png]: https://img-blog.csdnimg.cn/img_convert/85e4a905582b9dcd83edea2230453e3c.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/fe324786561f30b0b679f5309561620e.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/8d1e5ba62c69b65e56732a6e795b5e57.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/a5c817460fb8b9e0ba9974053e79ed5e.webp?x-oss-process=image/format,png