Mybatis源码分析:SqlSessionManager

SqlSessionManager

   SqlSessionManager本身实现了SqlSessionFactory, SqlSession两个接口,所以本身能够构建Sqlsession和使用Sqlsesion声明的CURD相关的查询方法。SqlSessionManager不能通过构造器进行实例化,只能通过newInstance()方法进行实例化,事实上,在newInstance()方法中调用了SqlSessionFactoryBuilder.build()方法实例化了一个DefaultSqlsessionFactory。然后再使用构造器进行实例化。

   SqlSessionManager内部维护着三个属性sqlSessionFactory,sqlSessionProxy,localSqlSession。其中sqlSessionFactory的作用就是参与对sqlSessionProxy的构建,从下面的构造器代码就知道，sqlSessionProxy使用了动态代理模式创建了SqlSession的代理对象。在以后操作CURD相关方法时候,都会委托给这个代理对象。最后一个属性localSqlSession由一个本地线程进行维护,这样保证了并发安全,除了此功能外,这个属性体现了“纳管”这一概念,在执行完startManagedSession()方法后,会将对应线程的SqlSession进行管理，在使用代理模式创建代理实例时,不再通过opensession()方法进行获取,而是直接从本地线程中进行获取。除了这一点差异之外, SqlSessionManager还提供了多个额外的方法用于操作本地线程中的SqlSession对象。如下列方法:

• isManagedSessionStarted() 判断是否受到SqlSessionManager的管制,其本质是判断SqlSeesion对象是否在本地线程对象中
• getConnection() 从本地线程中获取连接对象
• close(); 关闭线程所属的SqlSession对象,并将SqlSession对象置为NULL

SqlSessionManager构造器代码和newInstance()方法

  private SqlSessionManager(SqlSessionFactory sqlSessionFactory) {
    this.sqlSessionFactory = sqlSessionFactory;
    this.sqlSessionProxy = (SqlSession) Proxy.newProxyInstance(
        SqlSessionFactory.class.getClassLoader(),
        new Class[]{SqlSession.class},
        new SqlSessionInterceptor());
  }
  //通过InputStream进行实例化
  public static SqlSessionManager newInstance(InputStream inputStream, Properties properties) {
    return new SqlSessionManager(new SqlSessionFactoryBuilder().build(inputStream, null, properties));
  }
//通过SqlSessionFactory 进行实例化
  public static SqlSessionManager newInstance(SqlSessionFactory sqlSessionFactory) {
    return new SqlSessionManager(sqlSessionFactory);
  }
//通过Reader进行实例化
  public static SqlSessionManager newInstance(Reader reader, String environment) {
    return new SqlSessionManager(new SqlSessionFactoryBuilder().build(reader, environment, null));

   我们知道使用JDK动态代理必须实现InvocationHandler接口并且覆写invoke()方法,SqlSessionManager构造器在实例化代理类时SqlSessionInterceptor类就实现了InvocationHandler接口,观察invoke()方法。invoke第一行代码尝试从本地线程中拿到Sqlsession，但如果未调用startManagedSession()方法,那么永远拿到的都是null值,也就是说,invoke每次通过openSession()方法拿到新实例。

 private class SqlSessionInterceptor implements InvocationHandler {
    public SqlSessionInterceptor() {
        // Prevent Synthetic Access
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        //从本地线程中获取获取SqlSession,使用SqlSessionManager时并不会向本地线程中放置Sqlsession,此时sqlsession实例为null,除非启用了startManagedSession()
      final SqlSession sqlSession = SqlSessionManager.this.localSqlSession.get();
      if (sqlSession != null) {
        try {
          return method.invoke(sqlSession, args);
        } catch (Throwable t) {
          throw ExceptionUtil.unwrapThrowable(t);
        }
      } else {
          //通过sqlSessionFactory获取SqlSession
        final SqlSession autoSqlSession = openSession();
        try {
          final Object result = method.invoke(autoSqlSession, args);
          autoSqlSession.commit();
          return result;
        } catch (Throwable t) {
          autoSqlSession.rollback();
          throw ExceptionUtil.unwrapThrowable(t);
        } finally {
          autoSqlSession.close();
        }
      }
    }
  }

运行一个实例

对比使用了startManagedSession()方法的SqlSessionManager和直接newInstance()的测试有什么不同。首先配置一个SqlMapper,存在一个list方法,查询学生表中的学生id,姓名,年纪三个值。

• SqlMapper接口

package com.zzz.mybatis.mapper;

import java.util.List;
import java.util.Map;
import org.apache.ibatis.annotations.Flush;
import org.apache.ibatis.annotations.MapKey;
import org.apache.ibatis.annotations.Select;

public interface SqlMapper {
    @Select("select id,name,age from student")
    public List<Map<String, Object>> list();

    @Flush
    public void flush();

    @MapKey(value="id")
    @Select("select id,name,age from student")
    public Map<String,Map<String,String>> listByMapkey();
}

• 单元测试类

package com.zzz.mybatis.service;

import org.apache.ibatis.session.SqlSessionManager;
import org.junit.Test;

public class SqlSessionManagerTest {
    @Test
    public void SqlSessionManagerByNewInstance() {
        SqlSessionManager manager=SqlSessionManager.newInstance(getClass().getResourceAsStream("/mybatis-config.xml"));
        Object rs=manager.selectOne("com.zzz.mybatis.mapper.SqlMapper.list");
        System.out.println(rs.toString());
    }

    @Test
    public void SqlSessionManagerByLocalThread() {
        SqlSessionManager manager=SqlSessionManager.newInstance(getClass().getResourceAsStream("/mybatis-config.xml"));
        manager.startManagedSession();
        Object rs=manager.selectOne("com.zzz.mybatis.mapper.SqlMapper.list");
        System.out.println(rs.toString());
        rs=manager.selectOne("com.zzz.mybatis.mapper.SqlMapper.list");
        System.out.println(rs.toString());
    }

}

• 运行结果

Setting autocommit to false on JDBC Connection [com.mysql.jdbc.JDBC4Connection@5e853265]
==>  Preparing: select id,name,age from student 
==> Parameters: 
<==    Columns: id, name, age
<==        Row: 1, zhangsan, 22
<==      Total: 1
Setting autocommit to false on JDBC Connection [com.mysql.jdbc.JDBC4Connection@57e1b0c]
==>  Preparing: select id,name,age from student 
==> Parameters: 
<==    Columns: id, name, age
<==        Row: 1, zhangsan, 22
<==      Total: 1

两者的区别和联系

   两者的查询方式都是通过JDK的动态代理实现,只不过在sqlSessionProxy内部一个使用了本地线程获取SqlSession实例,一个使用openSession()方法获取SqlSession实例。使用debug观察使用了非manager.startManagedSession();所使用的SqlSession对象,可以看到localSqlSession中取到的值为NULL,SqlSession必须通过openSessiom()方法获取实例。

• 使用非startManagedSession()生成SqlSession实例

 

如果启用了startManagedSession()方法,则会从localSqlSession中获取SqlSession实例,可以看到两次的id号都是71,也就是两次查询都是同一个实例。

• 使用startManagedSession()生成SqlSession实例