Mybatis一二级缓存的源码研究

Posted 2021-08-10 赵晓东-Nastu

Mybatis的一级缓存

Mybatis对缓存提供支持，但是在没有配置的默认情况下，它只开启一级缓存，一级缓存只是相对于同一个SqlSession而言。所以在参数和SQL完全一样的情况下，我们使用同一个SqlSession对象调用一个Mapper方法，往往只执行一次SQL，因为使用SelSession第一次查询后，MyBatis会将其放在缓存中，以后再查询的时候，如果没有声明需要刷新，并且缓存没有超时的情况下，SqlSession都会取出当前缓存的数据，而不会再次发送SQL到数据库。

一级缓存简介

1、默认开启
2、作用域: 一级缓存 是SqlSession 级别的 , 回话之间共享
3、增加 修改 默认为true , 查询默认为false, 在XML可以用 flushCache=true 来进行清空缓存
4、也就是说当执行update操作的时候, 一级缓存就失效了
5、用hashmap存储

一级缓存的缺点

一级缓存是SqlSession 级别的 , 也就是别的会话进行了update操作, 其他会话并不知道, 这是其他会话就读取的是脏数据
•线程不安全

一级缓存的生命周期有多长？

a、MyBatis在开启一个数据库会话时，会 创建一个新的SqlSession对象，SqlSession对象中会有一个新的Executor对象。Executor对象中持有一个新的PerpetualCache对象；当会话结束时，SqlSession对象及其内部的Executor对象还有PerpetualCache对象也一并释放掉。
b、如果SqlSession调用了close()方法，会释放掉一级缓存PerpetualCache对象，一级缓存将不可用。
c、如果SqlSession调用了clearCache()，会清空PerpetualCache对象中的数据，但是该对象仍可使用。
d、SqlSession中执行了任何一个update操作(update()、delete()、insert()) ，都会清空PerpetualCache对象的数据，但是该对象可以继续使用

怎么判断两次查询是完全相同的查询？

2.1 传入的statementId
2.2 查询时要求的结果集中的结果范围
2.3. 这次查询所产生的最终要传递给JDBC java.sql.Preparedstatement的Sql语句字符串（boundSql.getSql() ）
2.4 传递给java.sql.Statement要设置的参数值

验证Mybatis的一级缓存功能

    @Test
    public void testStart() throws IOException {
        //1、mybatis主配置文件
        String config = "mybatis-config.xml";
        //2、读取配置文件
        InputStream in = Resources.getResourceAsStream(config);
        //3、创建sqlSessionFactory对象，目的是获取sqlSession
        SqlSessionFactory factory =new SqlSessionFactoryBuilder().build(in);
        //4、获取SqlSession,SqlSession能执行sql语句
        SqlSession session = factory.openSession();
        //5、执行sqlSession的selectList()
        List<Object> studentList = session.selectList("com.bjpowernode.dao.StudentDao.selectStudents");
        List<Object> studentList2 = session.selectList("com.bjpowernode.dao.StudentDao.selectStudents");
        //6、循环输出查询结果
        studentList.forEach(student-> System.out.println(student));
        studentList2.forEach(student-> System.out.println(student));
        //7、关闭SqlSession，释放资源
        session.close();

    }

可以看出我们用的是一个sqlSession,现在我们打印日志

Created connection 1278852808.
Setting autocommit to false on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@4c39bec8]
==>  Preparing: select id,name,email,age from student
==> Parameters: 
<==    Columns: id, name, email, age
<==        Row: 1, 梁佳宝, [e-mail], 25
<==        Row: 2, 马珂, [e-mail], 26
<==        Row: 3, 闫伟强, [e-mail], 21
<==        Row: 4, 赫于富, [e-mail], 22
<==        Row: 5, 吉莹, [e-mail], 23
<==        Row: 6, 赵晓东, [e-mail], 24
<==      Total: 6
Student(id=1, name=梁佳宝, email=[e-mail], age=25)
Student(id=2, name=马珂, email=[e-mail], age=26)
Student(id=3, name=闫伟强, email=[e-mail], age=21)
Student(id=4, name=赫于富, email=[e-mail], age=22)
Student(id=5, name=吉莹, email=[e-mail], age=23)
Student(id=6, name=赵晓东, email=[e-mail], age=24)
Student(id=1, name=梁佳宝, email=[e-mail], age=25)
Student(id=2, name=马珂, email=[e-mail], age=26)
Student(id=3, name=闫伟强, email=[e-mail], age=21)
Student(id=4, name=赫于富, email=[e-mail], age=22)
Student(id=5, name=吉莹, email=[e-mail], age=23)
Student(id=6, name=赵晓东, email=[e-mail], age=24)
Resetting autocommit to true on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@4c39bec8]
Closing JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@4c39bec8]
Returned connection 1278852808 to pool.

Process finished with exit code 0

可以从日志看出，就查了一次数据库

一级缓存源码分析

从localCache中获取数据也就是一级缓存

    public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
        ErrorContext.instance().resource(ms.getResource()).activity("executing a query").object(ms.getId());
        if (this.closed) {
            throw new ExecutorException("Executor was closed.");
        } else {
            if (this.queryStack == 0 && ms.isFlushCacheRequired()) {
                this.clearLocalCache();
            }

            List list;
            try {
                ++this.queryStack;
                list = resultHandler == null ? (List)this.localCache.getObject(key) : null;
                if (list != null) {
                    this.handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
                } else {
                    list = this.queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
                }
            } finally {
                --this.queryStack;
            }

如果缓存中没有那么就从数据库中查询

    private <E> List<E> queryFromDatabase(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
        this.localCache.putObject(key, ExecutionPlaceholder.EXECUTION_PLACEHOLDER);

        List list;
        try {
            list = this.doQuery(ms, parameter, rowBounds, resultHandler, boundSql);
        } finally {
            this.localCache.removeObject(key);
        }
//查询后的值，放入到缓存中
        this.localCache.putObject(key, list);
        if (ms.getStatementType() == StatementType.CALLABLE) {
            this.localOutputParameterCache.putObject(key, parameter);
        }

        return list;
    }

二级缓存

SqlSessionFactory层面上的二级缓存默认是不开启的，二级缓存的开席需要进行配置，实现二级缓存的时候，MyBatis要求返回的POJO必须是可序列化的。 也就是要求实现Serializable接口，配置方法很简单，只需要在映射XML文件配置就可以开启缓存了，

二级缓存简介

• 默认不开启
• 作用域: namespace 中共享 , 跨会话 跨线程
• sqlsession 在提交的时候才会存入二级缓存
• 二级缓存命中率更高
• 什么时候开启二级缓存
• 以查询为主的namespace , 因为增删改会频繁清空二级缓存
• 一般分布式 高并发的项目都使用第三方插件管理, 独立的服务器作为缓存服务器
• 存储缓存的也是hashmap

二级缓存开启与不开启对比

二级缓存不开启

   @Test
    public void testStart() throws IOException {
        //1、mybatis主配置文件
        String config = "mybatis-config.xml";
        //2、读取配置文件
        InputStream in = Resources.getResourceAsStream(config);
        //3、创建sqlSessionFactory对象，目的是获取sqlSession
        SqlSessionFactory factory =new SqlSessionFactoryBuilder().build(in);
        //4、获取SqlSession,SqlSession能执行sql语句
        SqlSession session = factory.openSession();
        SqlSession session2 = factory.openSession();
        //5、执行sqlSession的selectList()
        List<Object> studentList = session.selectList("com.bjpowernode.dao.StudentDao.selectStudents");
        List<Object> studentList2 = session.selectList("com.bjpowernode.dao.StudentDao.selectStudents");
        List<Object> studentList3 =session2.selectList("com.bjpowernode.dao.StudentDao.selectStudents");
        //6、循环输出查询结果
        studentList.forEach(student-> System.out.println(student));
        studentList2.forEach(student-> System.out.println(student));
        studentList3.forEach(student-> System.out.println(student));
        //7、关闭SqlSession，释放资源
        session.close();

    }

Created connection 1278852808.
Setting autocommit to false on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@4c39bec8]
==>  Preparing: select id,name,email,age from student
==> Parameters: 
<==    Columns: id, name, email, age
<==        Row: 1, 梁佳宝, [e-mail], 25
<==        Row: 2, 马珂, [e-mail], 26
<==        Row: 3, 闫伟强, [e-mail], 21
<==        Row: 4, 赫于富, [e-mail], 22
<==        Row: 5, 吉莹, [e-mail], 23
<==        Row: 6, 赵晓东, [e-mail], 24
<==      Total: 6
Opening JDBC Connection
Created connection 1431467659.
Setting autocommit to false on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@5552768b]
==>  Preparing: select id,name,email,age from student
==> Parameters: 
<==    Columns: id, name, email, age
<==        Row: 1, 梁佳宝, [e-mail], 25
<==        Row: 2, 马珂, [e-mail], 26
<==        Row: 3, 闫伟强, [e-mail], 21
<==        Row: 4, 赫于富, [e-mail], 22
<==        Row: 5, 吉莹, [e-mail], 23
<==        Row: 6, 赵晓东, [e-mail], 24
<==      Total: 6
Student(id=1, name=梁佳宝, email=[e-mail], age=25)
Student(id=2, name=马珂, email=[e-mail], age=26)
Student(id=3, name=闫伟强, email=[e-mail], age=21)
Student(id=4, name=赫于富, email=[e-mail], age=22)
Student(id=5, name=吉莹, email=[e-mail], age=23)
Student(id=6, name=赵晓东, email=[e-mail], age=24)
Student(id=1, name=梁佳宝, email=[e-mail], age=25)
Student(id=2, name=马珂, email=[e-mail], age=26)
Student(id=3, name=闫伟强, email=[e-mail], age=21)
Student(id=4, name=赫于富, email=[e-mail], age=22)
Student(id=5, name=吉莹, email=[e-mail], age=23)
Student(id=6, name=赵晓东, email=[e-mail], age=24)
Student(id=1, name=梁佳宝, email=[e-mail], age=25)
Student(id=2, name=马珂, email=[e-mail], age=26)
Student(id=3, name=闫伟强, email=[e-mail], age=21)
Student(id=4, name=赫于富, email=[e-mail], age=22)
Student(id=5, name=吉莹, email=[e-mail], age=23)
Student(id=6, name=赵晓东, email=[e-mail], age=24)
Resetting autocommit to true on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@4c39bec8]
Closing JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@4c39bec8]
Returned connection 1278852808 to pool.
Resetting autocommit to true on JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@5552768b]
Closing JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@5552768b]
Returned connection 1431467659 to pool.

Process finished with exit code 0

从日志中可以看出进行了二次的查询

二级缓存开启

（1）对实体类进行序列化

@Data
public class Student implements Serializable {
    //属性名和列名一样
    private Integer id;
    private String name;
    private String email;
    private Integer age;
}

（2）在映射文件中开启二级缓存

（3）在mybatis-config.xml中开启二级缓存

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <!--这个配置使全局的映射器(二级缓存)启用或禁用缓存-->
        <setting name="cacheEnabled" value="true" />
        以上是关于Mybatis一二级缓存的源码研究的主要内容，如果未能解决你的问题，请参考以下文章
 
 mybatis 源码分析一二级缓存分析
 Mybatis源码解析MyBatis的二级缓存源码解析
 Mybatis源码剖析：二级缓存源码剖析
 MyBatis源码分析五MyBatis的缓存
 MyBatis源码分析五MyBatis的缓存
 Mybatis缓存的使用和源码分析