Mybatis缓存

最新推荐文章于 2024-01-19 15:57:36 发布

痛冕

最新推荐文章于 2024-01-19 15:57:36 发布

阅读量145

点赞数 1

分类专栏：持久层框架设计实现及Mybatis源码分析文章标签： mybatis

本文链接：https://blog.csdn.net/qq_40977467/article/details/116896059

版权

持久层框架设计实现及Mybatis源码分析专栏收录该内容

15 篇文章 0 订阅

订阅专栏

Mybatis缓存

缓存就是内存中的数据，常常来自对数据库查询结果保存，使用缓存，我们可以避免频繁的与数据库进行交互，进而提高响应速度
Mybatis也提供了对缓存的支持，分为一级缓存和二级缓存，可以通过下图来理解：
在这里插入图片描述

一级缓存是SqlSession级别的缓存。在操作数据库时需要构造sqlSession对象，在对象中有一个数据结构（HashMap）用于存储缓存数据。不同的sqlSession之间的缓存数据区域（HashMap）是互相不影响的
二级缓存是mapper级别的缓存，多个SqlSession去操作同一个Mapper的sql语句，多个SqlSession可以共用二级缓存，二级缓存是跨SqlSession的

一级缓存

@Test
public void test1(){
//根据 sqlSessionFactory 产生 session
SqlSession sqlSession = sessionFactory.openSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//第一次查询，发出sql语句，并将查询出来的结果放进缓存中
User u1 = userMapper.selectUserByUserId(1);
System.out.println(u1);
//第二次查询，由于是同一个sqlSession,会在缓存中查询结果
//如果有，则直接从缓存中取出来，不和数据库进行交互
User u2 = userMapper.selectUserByUserId(1);
System.out.println(u2);
sqlSession.close();
}

在这里插入图片描述

第一次发起查询用户id为1的用户信息，先去找缓存中是否有id为1的用户信息，如果没有，从数据库查询用户信息。得到用户信息，将用户信息存储到一级缓存中。
如果中间sqlSession去执行commit操作（执行插入、更新、删除），则会清空SqlSession中的一级缓存，这样做的目的为了让缓存中存储的是最新的信息，避免脏读。
第二次发起查询用户id为1的用户信息，先去找缓存中是否有id为1的用户信息，缓存中有，直接从缓存中获取用户信息

在这里插入图片描述
首先上面说到一级缓存作用在sqlSession中，从sqlSession出发去查看一级缓存，在sqlSession的方法中看到有clearcache()，查看方法的父类和子类最后我们根据流程走到Perpetualcache中的clear()方法之后，会调用其cache.clear()方法，那么这个cache是什么东西呢？点进去发现，cache其实就是private Map cache = newHashMap()；也就是一个Map，所以说cache.clear()其实就是map.clear()，也就是说，缓存其实就是本地存放的一个map对象，每一个SqISession都会存放一个map对象的引用，那么这个cache是何时创建
的呢？
再查看Mybatis源码的过程中Executor是执行器，用来执行SQL请求，而且清除缓存的方法也在Executor中执行，所以很可能缓存的创建也很有可能在Executor中，看了一圈发现Executor中有一个createCacheKey方法，这个方法很像是创建缓存的方法啊，跟进去看看，你发现createCacheKey方法是由BaseExecutor执行的，代码如下：

CacheKey cacheKey = new CacheKey();
//MappedStatement 的 id
// id就是Sql语句的所在位置包名+类名+ SQL名称
cacheKey.update(ms.getId());
// offset 就是 0
cacheKey.update(rowBounds.getOffset());
// limit 就是 Integer.MAXVALUE
cacheKey.update(rowBounds.getLimit());
//具体的SQL语句
cacheKey.update(boundSql.getSql());
//后面是update 了 sql中带的参数
cacheKey.update(value);
...
if (configuration.getEnvironment() != null) {
	// issue #176
	cacheKey.update(configuration.getEnvironment().getId());
}

创建缓存key会经过一系列的update方法，udate方法由一个CacheKey这个对象来执行的，这个update方法最终由updateList的list来把五个值存进去
在这里插入图片描述
经过我们对一级缓存的探究之后，我们发现一级缓存更多是用于查询操作，毕竟一级缓存也叫查询缓存
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 {
...
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);
	}
...
}
// queryFromDatabase 方法
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;
}

如果查不到的话，就从数据库查，在queryFromDatabase中，会对localcache进行写入。 localcache对象的put方法最终交给Map进行存放

private Map<Object, Object> cache = new HashMap<Object, Object>();
@Override
public void putObject(Object key, Object value) { cache.put(key, value);
}

二级缓存

二级缓存的原理和一级缓存原理一样，第一次查询，会将数据放入缓存中，然后第二次查询则会直接去缓存中取。但是一级缓存是基于sqlSession的，而二级缓存是基于mapper文件的namespace的，也就是说多个sqlSession可以共享一个mapper中的二级缓存区域，并且如果两个mapper的namespace 相同，即使是两个mapper,那么这两个mapper中执行sql查询到的数据也将存在相同的二级缓存区域中
在这里插入图片描述

开启二级缓存

和一级缓存默认开启不一样，二级缓存需要我们手动开启，首先在全局配置文件sqlMapConfig.xml文件中加入如下代码：

<!--开启二级缓存-->
<settings>
<setting name="cacheEnabled" value="true"/>
</settings>

其次在Mapper.xml文件中开启缓存

<!--开启二级缓存-->
<cache></cache>

我们可以看到mapper.xml文件中就这么一个空标签，其实这里可以配置,PerpetualCache这个类是mybatis默认实现缓存功能的类。我们不写type就使用mybatis默认的缓存，也可以去实现Cache接口来自定义缓存。

public class PerpetualCache implements Cache {
private final String id;
private MapcObject, Object> cache = new HashMapC);
public PerpetualCache(St ring id) { this.id = id;
}

二级缓存底层还是HashMap结构
开启了二级缓存后，还需要将要缓存的pojo实现Serializable接口，为了将缓存数据取出执行反序列化操作，因为二级缓存数据存储介质多种多样，不一定只存在内存中，有可能存在硬盘中，如果我们要再取这个缓存的话，就需要反序列化了。所以mybatis中的pojo都去实现Serializable接口

public class User implements Serializable

useCache和flushCache

mybatis中还可以配置userCache和flushCache等配置项，userCache是用来设置是否禁用二级缓存的，在statement中设置useCache=false可以禁用当前select语句的二级缓存，即每次查询都会发出 sql去查询，默认情况是true,即该sql使用二级缓存

<select id="selectUserByUserId" useCache="false" resultType="com.lagou.pojo.User" parameterType="int">
	select * from user where id=#{id}
</select>

要设置成useCache=false，禁用二级缓存，直接从数据库中获取。
在mapper的同一个namespace中，如果有其它insert、update, delete操作数据后需要刷新缓存，如果不执行刷新缓存会出现脏读。
设置statement配置中的flushCache="true”属性，默认情况下为true,即刷新缓存，如果改成false则不会刷新。使用缓存时如果手动修改数据库表中的查询数据会出现脏读。

<select id="selectUserByUserId" flushCache="true" useCache="false" resultType="com.lagou.pojo.User" parameterType="int">
	select * from user where id=#{id}
</select>

一般下执行完commit操作都需要刷新缓存，flushCache=true表示刷新缓存，这样可以避免数据库脏读。所以我们不用设置，默认即可

二级缓存整合redis

上面我们介绍了 mybatis自带的二级缓存，但是这个缓存是单服务器工作，无法实现分布式缓存。那么什么是分布式缓存呢？假设现在有两个服务器1和2,用户访问的时候访问了 1服务器，查询后的缓存就会放在1服务器上，假设现在有个用户访问的是2服务器，那么他在2服务器上就无法获取刚刚那个缓存，如下图所示：
在这里插入图片描述
为了解决这个问题，就得找一个分布式的缓存，专门用来存储缓存数据的，这样不同的服务器要缓存数据都往它那里存，取缓存数据也从它那里取，如下图所示：

我们使用第三方缓存框架，将缓存都放在这个第三方框架中, 然后无论有多少台服务器，我们都能从缓存中获取数据。
这里我们介绍mybatis与redis的整合。redis分布式缓存就可以，mybatis提供了一个针对cache接口的redis实现类，该类存在mybatis-redis包
中

引入redis坐标

<dependency>
	<groupId>org.mybatis.caches</groupId>
	<artifactId>mybatis-redis</artifactId>
	<version>1.0.0-beta2</version>
</dependency>

配置文件

mapper.xml中设置cache type绑定redis

<?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" />

redis.properties

redis.host=localhost
redis.port=6379
redis.connectionTimeout=5000
redis.password=
redis.database=0

源码分析：

RedisCache和大家普遍实现Mybatis的缓存方案大同小异，无非是实现Cache接口，并使用jedis操作缓存；不过该项目在设计细节上有一些区别；

public final class RedisCache implements Cache {
	public RedisCache(final String id) {
		if (id == null) {
			throw new IllegalArgumentException("Cache instances require anID");
		}
		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的构造方法中，调用了 RedisConfigu rationBuilder 来创建 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文件。
并将该配置文件中的内容设置到RedisConfig对象中，并返回；接下来，就是RedisCache使用RedisConfig类创建完成edisPool；在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储存数据的格式：

@Override
public void putObject(final Object key, final Object value) {
	execute(new RedisCallback() {
		@Override
		public Object doWithRedis(Jedis jedis) {
			jedis.hset(id.toString().getBytes(), key.toString().getBytes(),
			SerializeUtil.serialize(value));
			return null;
		}
	});
}
@Override
public Object getObject(final Object key) {
	return execute(new RedisCallback() {
		@Override
		public Object doWithRedis(Jedis jedis) {
			return SerializeUtil.unserialize(jedis.hget(id.toString().getBytes(),
			key.toString().getBytes()));
		}
	});
}

可以很清楚的看到，mybatis-redis在存储数据的时候，是使用的hash结构，把cache的id作为这个hash的key (cache的id在mybatis中就是mapper的namespace)；这个mapper中的查询缓存数据作为 hash的field,需要缓存的内容直接使用SerializeUtil存储，SerializeUtil和其他的序列化类差不多，负责对象的序列化和反序列化；

痛冕

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
4
评论
Mybatis缓存

Mybatis缓存缓存就是内存中的数据，常常来自对数据库查询结果保存，使用缓存，我们可以避免频繁的与数据库进行交互，进而提高响应速度Mybatis也提供了对缓存的支持，分为一级缓存和二级缓存，可以通过下图来理解：一级缓存是SqlSession级别的缓存。在操作数据库时需要构造sqlSession对象，在对象中有一个数据结构（HashMap）用于存储缓存数据。不同的sqlSession之间的缓存数据区域（HashMap）是互相不影响的二级缓存是mapper级别的缓存，多个SqlSession去操作
复制链接

扫一扫

专栏目录