由 Mybatis 源码畅谈软件设计（七）：从根上理解 Mybatis 一级缓存

作者：京东保险 王奕龙

本篇我们来讲 一级缓存，重点关注它的实现原理：何时生效、生效范围和何时失效，在未来设计缓存使用时，提供一些借鉴和参考。

1. 准备工作

定义实体

public class Department {

    public Department(String id) {
        this.id = id;
    }

    private String id;

    /**
     * 部门名称
     */
    private String name;

    /**
     * 部门电话
     */
    private String tel;

    /**
     * 部门成员
     */
    private Set<User> users;
}

public class User {

    private String id;

    private String name;

    private Integer age;

    private LocalDateTime birthday;

    private Department department;
}

定义 Mapper.xml

DepartmentMapper.xml，两条 SQL：一条根据 ID 查询；一条清除缓存，标记了 fulshCache 标签，将其设置为 true 后，只要语句被调用，都会将本地缓存和二级缓存清空（默认值为 false）

<select id="findById" resultType="Department">
    select * from department
    where id = #{id}
</select>

<select id="cleanCathe" resultType="int" flushCache="true">
    select count(department.id) from department;
</select>

UserMapper.xml，联表查询用户信息：

<select id="findAll" resultMap="userMap">
    select u.*, td.id, td.name as department_name
    from user u
    left join department td
    on u.department_id = td.id
</select>

2. 一级缓存

一级缓存的生效范围 SqlSession 级别的，不同 SqlSession 间不共享缓存，它默认情况下是启用的。主要作用是减少在同一个查询 SQL 会话中对数据库的重复查询，从而提高性能。以如下用例为例：

    public static void main(String[] args) throws IOException {
        InputStream xml = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        // 开启二级缓存需要在同一个SqlSessionFactory下，二级缓存存在于 SqlSessionFactory 生命周期，如此才能命中二级缓存
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(xml);

        SqlSession sqlSession = sqlSessionFactory.openSession();
        DepartmentMapper departmentMapper = sqlSession.getMapper(DepartmentMapper.class);
        System.out.println("----------department第一次查询 ↓------------");
        departmentMapper.findById("18ec781fbefd727923b0d35740b177ab");
        System.out.println("----------department一级缓存生效，控制台看不见SQL ↓------------");
        departmentMapper.findById("18ec781fbefd727923b0d35740b177ab");

    }

可以发现在第二次查询时，一级缓存生效，控制台没有出现SQL：

而我们清空下一级缓存再试试：

    public static void main(String[] args) throws IOException {
        InputStream xml = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        // 开启二级缓存需要在同一个SqlSessionFactory下，二级缓存存在于 SqlSessionFactory 生命周期，如此才能命中二级缓存
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(xml);

        SqlSession sqlSession = sqlSessionFactory.openSession();
        DepartmentMapper departmentMapper = sqlSession.getMapper(DepartmentMapper.class);
        System.out.println("----------department第一次查询 ↓------------");
        departmentMapper.findById("18ec781fbefd727923b0d35740b177ab");
        System.out.println("----------department一级缓存生效，控制台看不见SQL ↓------------");
        departmentMapper.findById("18ec781fbefd727923b0d35740b177ab");
        System.out.println("----------清除一级缓存 ↓------------");
        departmentMapper.cleanCathe();
        System.out.println("----------清除后department再一次查询，SQL再次出现 ↓------------");
        departmentMapper.findById("18ec781fbefd727923b0d35740b177ab");
    }

控制台日志很清晰，清除缓存后又重新查了一遍：

接下来我们看一下不同 SqlSession 间一级缓存是否共享，创建一个新的 SqlSession sqlSession1 执行相同的SQL：

    public static void main(String[] args) throws IOException {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        SqlSession sqlSession1 = sqlSessionFactory.openSession();
        DepartmentMapper departmentMapper = sqlSession.getMapper(DepartmentMapper.class);
        DepartmentMapper departmentMapper1 = sqlSession1.getMapper(DepartmentMapper.class);
        System.out.println("----------department第一次查询 ↓------------");
        departmentMapper.findById("18ec781fbefd727923b0d35740b177ab");
        System.out.println("----------sqlSession1下department执行相同的SQL，控制台出现SQL ↓------------");
        departmentMapper1.findById("18ec781fbefd727923b0d35740b177ab");
    }

如控制台日志所示，可以发现在不同的 SqlSession 下不共享一级缓存：

3. 一级缓存原理

一级缓存在查询方法 org.apache.ibatis.executor.BaseExecutor#query 中生效，如下所示：

public abstract class BaseExecutor implements Executor {
    // ...
    
    // 一级缓存
    protected PerpetualCache 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 (closed) {
            throw new ExecutorException("Executor was closed.");
        }
        // 判断是否刷新本地缓存
        if (queryStack == 0 && ms.isFlushCacheRequired()) {
            clearLocalCache();
        }
        List<E> list;
        try {
            queryStack++;
            // 判断一级缓存是否存在，存在则直接作为结果返回，否则查询数据库
            list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;
            if (list != null) {
                // 存储过程相关逻辑
                handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
            } else {
                // 未命中一级缓存，查询数据库
                list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
            }
        } finally {
            queryStack--;
        }
        if (queryStack == 0) {
            for (DeferredLoad deferredLoad : deferredLoads) {
                deferredLoad.load();
            }
            // issue #601
            deferredLoads.clear();
            if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) {
                // issue #482
                clearLocalCache();
            }
        }
        return list;
    }

    private <E> List<E> queryFromDatabase(MappedStatement ms, Object parameter, RowBounds rowBounds,
                                          ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
        List<E> list;
        // 一级缓存占位
        localCache.putObject(key, EXECUTION_PLACEHOLDER);
        try {
            list = doQuery(ms, parameter, rowBounds, resultHandler, boundSql);
        } finally {
            // 查询完成后清除一级缓存
            localCache.removeObject(key);
        }
        // 添加到一级缓存中
        localCache.putObject(key, list);
        // 存储过程相关逻辑
        if (ms.getStatementType() == StatementType.CALLABLE) {
            localOutputParameterCache.putObject(key, parameter);
        }
        return list;
    }
}

其中 PerpetualCache localCache 便是一级缓存，它的实现借助了 HashMap：

public class PerpetualCache implements Cache {

    private final String id;

    private final Map<Object, Object> cache = new HashMap<>();
 
    // ...
}

一级缓存生效的逻辑也非常简单，如下所示：

queryFromDatabase 方法中有一段蛮有意思的逻辑 localCache.putObject(key, EXECUTION_PLACEHOLDER);：在添加一级缓存前会先添加缓存 占位符 EXECUTION_PLACEHOLDER，但是这个占位符并没有被用作一个明确的同步机制来阻止其他线程的查询执行，所以它只是标记一个查询正在进行，提供了 防止在同一事务上下文中重复执行相同的查询的 基础，这种设计可能是 MyBatis 开发者认为在多数情况下，数据库查询的开销相对较小或同一事务中几乎不执行多次相同的查询，而不是为了在多线程环境下保证不击穿数据库，降低数据库的压力。

这种设计模式在分布式缓存系统中很常见，一般用于 解决 ”缓存击穿“ 问题，帮助系统在高并发环境下保持稳定性。

一级缓存失效场景

• 两次相同查询SQL间有 Insert、Delete、Update 语句执行时：Insert、Delete、Update 的 flushCache标签 默认为 true ，执行它们时，会将一级缓存清空
• 调用 sqlSession#clearCache 方法
• SqlSession 被关闭时，一级缓存也会被清空

缓存的是对象的引用

以如下代码为例，第一次查询结果中 name 字段的值为 null，将其赋值再进行第二次查询：

        System.out.println("----------department第一次查询 ↓------------");
        Department department = departmentMapper.findById("18ec781fbefd727923b0d35740b177ab");
        System.out.println(department);
        department.setName("   把名字改了");

        System.out.println("----------department一级缓存生效，控制台看不见SQL ↓------------");
        System.out.println(departmentMapper.findById("18ec781fbefd727923b0d35740b177ab"));

可以发现第二次查询取缓存的结果是 更改name结果之后的：

这是因为一级缓存中 存放的数据其实是对象的引用，导致第二次从一级缓存中查询到的数据，就是我们刚刚改过的数据，而并不是数据库中真实的数据。在同一个 SqlSession 中，如果对缓存中返回的对象进行了修改，而没有同步更新数据库，那么在后续的查询中会返回被修改的对象，而不是数据库中的最新数据，导致脏读。

4. 总结

• 一级缓存基于 SqlSession，不同 SqlSession 间不共享一级缓存
• 一级缓存被保存在 BaseExecutor 的 PerpetualCache 中，本质上是 HashMap
• 执行 Insert、Delete、Update 语句会使一级缓存失效
• 一级缓存存放的数据是对象的引用，若对它进行修改，则之后取出的缓存为修改后的数据

巨人的肩膀

• 为什么要实现序列化：MyBatis的一级缓存、二级缓存演示以及讲解，序列化异常的处理
• 为什么MyBatis二级缓存Cache Hit Ratio始终等于0：二级缓存的生命周期在同一个SqlSessionFactory中