七、Mybatis缓存
缓存就是内存中的数据，常常来自对数据库查询结果的保存，使用缓存、可以避免频繁的与数据库进行交互，进而提高响应速度
一级缓存是sqlSession级别的缓存，在操作数据库时需要构造sqlsession对象，在对象中有一个数据结构（hashmap）用于存储缓存数据，不同的sqlsession的缓存数据区域是互相不影响的。
二级缓存是mapper级别的缓存，多个sqlsession去操作同一个mapper的sql语句，多个sqlsession可以共用二级缓存、二级缓存是跨sqlsession的。
1.一级缓存
操作：
- 在一个sqlSession中，对User表根据id进行两次查询，查看他们发出sql语句的情况
@Test
public void firstLevelTest(){
//第一次查询，发出sql语句，并将查询出来的结果放进缓存中
User u1 = userMapper.findUserById(1);
System.out.println(u1);
//第二次查询，由于是同⼀个sqlSession,会在缓存中查询结果
//如果有，则直接从缓存中取出来，不和数据库进行交互
User u2 = userMapper.findUserById(1);
System.out.println(u2);
System.out.println(u1==u2);
sqlSession.close();
}
- 同样是对user表进行两次查询，两次查询之间进行一次update操作
@Test
public void firstLevelTest(){
//第一次查询，发出sql语句，并将查询出来的结果放进缓存中
User u1 = userMapper.findUserById(1);
System.out.println(u1);
User user = new User();
user.setId(1);
user.setUsername("cookie");
user.setPassword("123");
userMapper.updateUser(user);
sqlSession.commit();
sqlSession.clearCache();
//第二次查询，由于是同⼀个sqlSession,会在缓存中查询结果
//如果有，则直接从缓存中取出来，不和数据库进⾏交互
User u2 = userMapper.findUserById(1);
System.out.println(u2);
System.out.println(u1==u2);
sqlSession.close();
}
总结：
- 第一次发起查询用户id为1的用户信息，先去找缓存中是否有id为1的用户信息，如果没有，从数据库查询用户信息。得到用户信息，将用户信息存储到一级缓存中
- 如果中间sqlSession去执行commit操作（执行插入、更新、删除），则会清空SqlSession中的 一级缓存，这样做的目的为了让缓存中存储的是最新的信息，避免脏读。
- 第二次发起查询用户id为1的用户信息，先去找缓存中是否有id为1的用户信息，缓存中有，直接从缓存中获取用户信息
、
1.1 一级缓存原理探究与源码分析
直接从SqlSession看看有没有创建缓存或者与缓存有关的属性或者方法
上述所有方法中，好像只有clearCache()和缓存沾点关系，直接从这个方法入手，分析源码时，要看它(此类)是谁，它的父类和子类分别又是谁，对如上关系了解了，才会对这个类有更深的认识，分析后得到如下这个流程图**：
流程走到Perpetualcache中的clear()方法之后，会调用其cache.clear()方法。点进去发现，cache其实就是private Map cache = new HashMap()；也就是一个Map，所以说cache.clear()其实就是map.clear()，缓存其实就是本地存放的一个map对象，每⼀个SqISession都会存放⼀个map对象的引用。
最有可能创建缓存的地方是Executor**，因为Executor是执行器，用来执行SQL请求，而且清除缓存的方法也在Executor中执行，所以很可能缓存的创建也很有可能在Executor中，Executor中有一个createCacheKey方法，createCacheKey方法是由BaseExecutor执行的。
public CacheKey createCacheKey(MappedStatement ms, Object parameterObject, RowBounds rowBounds, BoundSql boundSql) {
if (this.closed) {
throw new ExecutorException("Executor was closed.");
} else {
CacheKey cacheKey = new CacheKey();
cacheKey.update(ms.getId());
cacheKey.update(rowBounds.getOffset());
cacheKey.update(rowBounds.getLimit());
cacheKey.update(boundSql.getSql());
List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
TypeHandlerRegistry typeHandlerRegistry = ms.getConfiguration().getTypeHandlerRegistry();
Iterator var8 = parameterMappings.iterator();
while(var8.hasNext()) {
ParameterMapping parameterMapping = (ParameterMapping)var8.next();
if (parameterMapping.getMode() != ParameterMode.OUT) {
String propertyName = parameterMapping.getProperty();
Object value;
if (boundSql.hasAdditionalParameter(propertyName)) {
value = boundSql.getAdditionalParameter(propertyName);
} else if (parameterObject == null) {
value = null;
} else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
value = parameterObject;
} else {
MetaObject metaObject = this.configuration.newMetaObject(parameterObject);
value = metaObject.getValue(propertyName);
}
cacheKey.update(value);
}
}
if (this.configuration.getEnvironment() != null) {
cacheKey.update(this.configuration.getEnvironment().getId());
}
return cacheKey;
}
}
创建缓存key会经过⼀系列的update方法，udate方法由一个CacheKey这个对象来执行的，这个 update方法最终由updateList的list来把五个值存进去：
最后⼀个值，configuration.getEnvironment().getId()是定义在mybatis-config.xml中的标签。
<environments default="development">
<environment id="development">
<!--当前事务交给JDBC处理-->
<transactionManager type="JDBC"/>
<!--当前使用mybatis提供的连接池-->
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
创建完缓存使用：Executor的query方法
@Override
public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
BoundSql boundSql = ms.getBoundSql(parameter);
//创建缓存
CacheKey key = createCacheKey(ms, parameter, rowBounds, boundSql);
return query(ms, parameter, rowBounds, resultHandler, key, boundSql);
}
@SuppressWarnings("unchecked")
@Override
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;
}
@Override
public void putObject(Object key, Object value) {
cache.put(key, value);
}
先查缓存，缓存没有查数据库并放入缓存中。
2.二级缓存
二级缓存的原理和一级缓存原理一样，第一次查询，会将数据放入缓存中，然后第二次查询则会直接去缓存中取。 但是一级缓存是基于sqlSession的，而⼆级缓存是基于mapper文件的namespace的，也就是说多个sqlSession可以共享一个mapper中的⼆级缓存区域，并且如果两个mapper的namespace 相同，即使是两个mapper,那么这两 个mapper中执行sql查询到的数据也将存在相同的⼆级缓存区域中。
2.1 如何使用二级缓存
①开启二级缓存
和一级缓存默认开启不一样，⼆级缓存需要手动开启，首先在全局配置文件sqlMapConfig.xml文件中加入如下代码:
<!--开启二级缓存-->
<settings>
<setting name="cacheEnabled" value="true"/>
</settings>
其次在UserMapper.xml文件中开启缓存
<!--开启⼆级缓存-->
<cache></cache>
mapper.xml文件中就这么一个空标签，这里可以配置,PerpetualCache这个类是mybatis默认实现缓存功能的类。不写type就使用mybatis默认的缓存，也可以去实现Cache接口来自定义缓存。
public class PerpetualCache implements Cache {
private final String id;
private Map<Object, Object> cache = new HashMap<Object, Object>();
public PerpetualCache(String id) {
this.id = id;
}
}
二级缓存底层还是HashMap结构
public class User implements Serializable {
private Integer id;
private String username;
private String password;
private Date birthday;
}
开启了二级缓存后，还需要将要缓存的pojo实现Serializable接口，为了将缓存数据取出执行反序列化操 作，因为二级缓存数据存储介质多种多样，不⼀定只存在内存中，有可能存在硬盘中，如果我们要再取 这个缓存的话，就需要反序列化了，所以mybatis中的pojo都去实现Serializable接口
②测试
1.测试二级缓存和sqlSession无关
@Test
public void secondLevelTest(){
SqlSession sqlSession1 = sqlSessionFactory.openSession();
SqlSession sqlSession2 = sqlSessionFactory.openSession();
UserMapper mapper1 = sqlSession1.getMapper(UserMapper.class);
UserMapper mapper2 = sqlSession2.getMapper(UserMapper.class);
//第⼀次查询，发出sql语句，并将查询的结果放⼊缓存中
User u1 = userMapper1.selectUserByUserId(1);
System.out.println(u1);
sqlSession1.close(); //第⼀次查询完后关闭 sqlSession
//第⼆次查询，即使sqlSession1已经关闭了，这次查询依然不发出sql语句
User u2 = userMapper2.selectUserByUserId(1);
System.out.println(u2);
sqlSession2.close();
}
上面两个不同的sqlSession,第一个关闭了，第二次查询依然不发出sql查询语句
2.测试执行commit()操作，二级缓存数据清空
@Test
public void testTwoCache(){
//根据 sqlSessionFactory 产生 session
SqlSession sqlSession1 = sessionFactory.openSession();
SqlSession sqlSession2 = sessionFactory.openSession();
SqlSession sqlSession3 = sessionFactory.openSession();
String statement = "com.cookie.pojo.UserMapper.selectUserByUserld" ;
UserMapper userMapper1 = sqlSession1.getMapper(UserMapper. class );
UserMapper userMapper2 = sqlSession2.getMapper(UserMapper. class );
UserMapper userMapper3 = sqlSession2.getMapper(UserMapper. class );
//第⼀次查询，发出sql语句，并将查询的结果放⼊缓存中
User u1 = userMapperl.selectUserByUserId(1);
System.out.println(u1);
sqlSessionl.close(); //第一次查询完后关闭sqlSession
//执⾏更新操作，commit()
u1.setUsername("aaa");
userMapper3.updateUserByUserId(u1);
sqlSession3.commit();
//第⼆次查询，由于上次更新操作，缓存数据已经清空(防⽌数据脏读)，这⾥必须再次发出sql语句
User u2 = userMapper2.selectUserByUserId(1);
System.out.println(u2);
sqlSession2.close();
}
③useCache和flushCache
mybatis中还可以配置userCache和flushCache等配置项，userCache是用来设置是否禁用⼆级缓存的，在statement中设置useCache=false可以禁用当前select语句的⼆级缓存，即每次查询都会发出 sql去查询，默认情况是true,即该sql使用⼆级缓存
<select id="selectUserByUserId" useCache="false" resultType="com.cookie.pojo.User" parameterType="int">
select * from user where id=#{id}
</select>
这种情况是针对每次查询都需要最新的数据sql,要设置成useCache=false，禁用二级缓存，直接从数据库中获取。在mapper的同一个namespace中，如果有其它insert、update, delete操作数据后需要刷新缓存，如果不执行刷新缓存会出现脏读。 设置statement配置中的flushCache="true”属性，默认情况下为true,即刷新缓存，如果改成false则 不会刷新。使用缓存时如果手动修改数据库表中的查询数据会出现脏读。
<select id="selectUserByUserId" flushCache="true" useCache="false" resultType="com.cookie.pojo.User" parameterType="int">
select * from user where id=#{id}
</select>
一般执行完commit操作都需要刷新缓存，flushCache=true表示刷新缓存，这样可以避免数据库脏读。所以不用设置，默认即可
3.二级缓存整合Redis
mybatis自带的二级缓存是单服务器工作，无法实现分布式缓存。 假设现在有两个服务器1和2,用户访问的时候访问了 1服务器，查询后的缓存就会放在1服务器上，假设现在有个用户访问的是2服务器，那么他在2服务器上就无法获取刚刚那个缓存，如下图所示：
为了解决这个问题，就得找一个分布式的缓存，专门用来存储缓存数据的，这样不同的服务器要缓存数据都往它那里存，取缓存数据也从它那里取，如下图所示：
如上图所示，在几个不同的服务器之间，使用第三方缓存框架，将缓存都放在这个第三方框架中, 然后无论有多少台服务器，都能从缓存中获取数据。
mybatis与redis的整合：
mybatis提供了一个cache接口，如果要实现自己的缓存逻辑，实现cache接口开发即可。** **
mybatis本身默认实现了一个，但是这个缓存的实现无法实现分布式缓存， redis分布式缓存可以，mybatis提供了一个针对cache接口的redis实现类，该类存在mybatis-redis包中
实现：
1.pom
<!--mybatis-redis-->
<dependency>
<groupId>org.mybatis.caches</groupId>
<artifactId>mybatis-redis</artifactId>
<version>1.0.0-beta2</version>
</dependency>
2.配置文件
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.lagou.mapper.IUserMapper">
<cache type="org.mybatis.caches.redis.RedisCache" />
<select id="findAll" resultType="com.lagou.pojo.User" useCache="true">
select * from user
</select>
注解方式：
@CacheNamespace(implementation = RedisCache.class) //开启二级缓存
public interface UserMapper {
List<User> findAll();
List<User> findAllUserAndRole();
}
3.redis.properties
redis.host=localhost
redis.port=6379
redis.connectionTimeout=5000
redis.password=
redis.database=0
4.测试
@Test
public void SecondLevelCache(){
SqlSession sqlSession1 = sqlSessionFactory.openSession();
SqlSession sqlSession2 = sqlSessionFactory.openSession();
SqlSession sqlSession3 = sqlSessionFactory.openSession();
IUserMapper mapper1 = sqlSession1.getMapper(IUserMapper.class);
lUserMapper mapper2 = sqlSession2.getMapper(lUserMapper.class);
lUserMapper mapper3 = sqlSession3.getMapper(IUserMapper.class);
User user1 = mapper1.findUserById(1);
sqlSession1.close(); //清空⼀级缓存
User user = new User();
user.setId(1);
user.setUsername("lisi");
mapper3.updateUser(user);
sqlSession3.commit();
User user2 = mapper2.findUserById(1);
System.out.println(user1==user2);
}
源码分析：
RedisCache和普遍实现Mybatis的缓存方案大同小异，无非是实现Cache接口，并使用jedis操作缓存；不过该项目在设计细节上有⼀些区别；
public final class RedisCache implements Cache {
public RedisCache(final String id) {
if (id == null) {
throw new IllegalArgumentException("Cache instances require an ID");
}
this.id = id;
RedisConfig redisConfig = RedisConfigurationBuilder.getInstance().parseConfiguration();
pool = new JedisPool(redisConfig, redisConfig.getHost(), redisConfig.getPort(),
redisConfig.getConnectionTimeout(), redisConfig.getSoTimeout(), redisConfig.getPassword(),
redisConfig.getDatabase(), redisConfig.getClientName());
}
}
RedisCache在mybatis启动的时候，由MyBatis的CacheBuilder创建，创建的方式很简单，就是调用 RedisCache 的带有String参数的构造方法，即RedisCache(String id)；而在RedisCache的构造方法中， 调用了 RedisConfigurationBuilder 来创建 RedisConfig 对象，并使用 RedisConfig 来创建JedisPool。 RedisConfig类继承了 JedisPoolConfig，并提供了 host,port等属性的包装，看一下RedisConfig的属性：
public class RedisConfig extends JedisPoolConfig {
private String host = Protocol.DEFAULT_HOST;
private int port = Protocol.DEFAULT_PORT;
private int connectionTimeout = Protocol.DEFAULT_TIMEOUT;
private int soTimeout = Protocol.DEFAULT_TIMEOUT;
private String password;
private int database = Protocol.DEFAULT_DATABASE;
private String clientName;
}
RedisConfig对象是由RedisConfigurationBuilder创建的，简单看下这个类的主要方法：
public RedisConfig parseConfiguration(ClassLoader classLoader) {
Properties config = new Properties();
InputStream input = classLoader.getResourceAsStream(redisPropertiesFilename);
if (input != null) {
try {
config.load(input);
} catch (IOException e) {
throw new RuntimeException(
"An error occurred while reading classpath property '"
+ redisPropertiesFilename
+ "', see nested exceptions", e);
} finally {
try {
input.close();
} catch (IOException e) {
// close quietly
}
}
}
RedisConfig jedisConfig = new RedisConfig();
setConfigProperties(config, jedisConfig);
return jedisConfig;
}
核心的方法就是parseConfiguration方法，该方法从classpath中读取一个redis.properties文件:
redis.host=localhost
redis.port=6379
redis.connectionTimeout=5000
redis.password=
redis.database=0
并将该配置文件中的内容设置到RedisConfig对象中，并返回；接下来，就是RedisCache使用 RedisConfig类创建完成JedisPool；在RedisCache中实现了⼀个简单的模板方法，用来操作Redis：
private Object execute(RedisCallback callback) {
Jedis jedis = pool.getResource();
try {
return callback.doWithRedis(jedis);
} finally {
jedis.close();
}
}
模板接口为RedisCallback，这个接口中就只需要实现了一个doWithRedis方法而已
public interface RedisCallback {
Object doWithRedis(Jedis jedis);
}
Cache中最重要的两个方法：putObject和getObject，通过这两个方法来查看mybatis-redis 储存数据
的格式：
public void putObject(final Object key, final Object value) {
this.execute(new RedisCallback() {
public Object doWithRedis(Jedis jedis) {
jedis.hset(RedisCache.this.id.toString().getBytes(), key.toString().getBytes(), SerializeUtil.serialize(value));
return null;
}
});
}
public Object getObject(final Object key) {
return this.execute(new RedisCallback() {
public Object doWithRedis(Jedis jedis) {
return SerializeUtil.unserialize(jedis.hget(RedisCache.this.id.toString().getBytes(), key.toString().getBytes()));
}
});
}
可以很清楚的看到，mybatis-redis在存储数据的时候，是使用的hash结构，把cache的id作为这个hash的key (cache的id在mybatis中就是mapper的namespace)；这个mapper中的查询缓存数据作为 hash的field,需要缓存的内容直接使用SerializeUtil存储，SerializeUtil和其他的序列化类差不多，负责对象的序列化和反序列化；