使用 Redis 做 MyBatis 二級緩存

1. 首先安裝 Redis Server，設置好用戶名密碼，然後 pom 裏添加依賴：

<dependency>
	<groupId>redis.clients</groupId>
	<artifactId>jedis</artifactId>
	<version>2.7.1</version>
</dependency>
<dependency>
	<groupId>org.springframework.data</groupId>
	<artifactId>spring-data-redis</artifactId>
	<version>1.6.2.RELEASE</version>
</dependency>

2. mybatis-config.xml 文件開啓緩存：

<setting name="cacheEnabled" value="true" /> 

3. Spring 容器裏定義 redisTemplate Bean:

<bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig">
	<property name="maxIdle" value="100" />
	<property name="maxTotal" value="500" />
	<property name="testOnBorrow" value="true" />
</bean>

<bean id="connectionFactory"  class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory">
	<property name="hostName" value="127.0.0.1" />
	<property name="port" value="6379" />
	<property name="password" value="" />
	<property name="poolConfig" ref="poolConfig" />
</bean>

<bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate">
	<property name="connectionFactory" ref="connectionFactory" />
</bean>

4. 實現二級緩存處理類：

package com.hebta.vinci.controller;

import java.io.Serializable;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;

import org.apache.ibatis.cache.Cache;
import org.apache.log4j.Logger;
import org.springframework.dao.DataAccessException;
import org.springframework.data.redis.connection.RedisConnection;
import org.springframework.data.redis.core.RedisCallback;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.JdkSerializationRedisSerializer;
import org.springframework.web.context.ContextLoader;

public class RedisCache implements Cache {
	private static final Logger logger = Logger.getLogger(RedisCache.class);

	private final ReadWriteLock readWriteLock = new ReentrantReadWriteLock();

	/*
	 * 由於 Mapper.xml 是運行時通過反射生成代理類，所以無法註冊爲 Spring Bean，
	 * 也就無法通過依賴注入 redisTemplate, 需要在方法調用的時候初始化此變量
	 */	
	private RedisTemplate<Serializable, Serializable> redisTemplate;  

	private String id;

	private JdkSerializationRedisSerializer jdkSerializer = new JdkSerializationRedisSerializer();

	// 通過 ContextLoader 靜態方法獲取 Bean，初始化 redisTemplate 屬性
	private RedisTemplate<Serializable, Serializable> getRedisTemplate(){
		if (redisTemplate == null){
			redisTemplate = (RedisTemplate<Serializable, Serializable>) ContextLoader.getCurrentWebApplicationContext().getBean("redisTemplate"); 
		}
		return redisTemplate;
	}

	@Override
	public void putObject(Object key, Object value) {
		logger.info("enter RedisCache.putObject(), key is ##  " + key);
		if (value != null) {
			getRedisTemplate().opsForValue().set(key.toString(), jdkSerializer.serialize(value), 1, TimeUnit.DAYS);
		}
	}

	@Override
	public Object getObject(Object key) {
		logger.info("enter RedisCache.getObject(), the key is :: " + key);
		try {
			if (key != null) {
				Object obj = getRedisTemplate().opsForValue().get(key.toString());
				return jdkSerializer.deserialize((byte[]) obj);
			}
		} catch (Exception e) {
			logger.error("redis " + e.getMessage());
		}
		return null;
	}

	@Override
	public Object removeObject(Object key) {
		try {
			if (key != null) {
				getRedisTemplate().expire(key.toString(), 1, TimeUnit.SECONDS);
			}
		} catch (Exception e) {
			logger.error("redis " + e.getMessage());
		}
		return null;
	}

	@Override
	public void clear() {
		// jedis not support
	}

	@Override
	public int getSize() {
		Long size = getRedisTemplate().execute(new RedisCallback<Long>() {
			@Override
			public Long doInRedis(RedisConnection connection) throws DataAccessException {
				return connection.dbSize();
			}
		});
		return size.intValue();
	}

	@Override
	public ReadWriteLock getReadWriteLock() {
		return readWriteLock;
	}

	public RedisCache() {
		super();
	}

	public RedisCache(final String id) {
		this.id = id;
	}

	@Override
	public String getId() {
		return this.id;
	}
}

5. 將二級緩存實現類註冊到 **Mapper.xml 裏：

6. POJO 類需要實現序列化接口：

項目中所有需要二級緩存的 Mapper.xml 和對應 POJO 類都要做第 5，6 步。

Mybatis 的 CacheKey 的 key 實在太長了，它的 toString() 方法按照下列規則生成：

1. mapper id : mapper.xml 的全限定名+方法名
2. 查詢結果返回條數的 offset 和 limit
3. 查詢語句字符串，所有入參
這些條件被用來計算 checksum 和 hashcode, 整個 key.toString() = hashcode + checksum + id + offset + limit + sql + parameters, 
中間以分號分隔，尤其當 sql/parameters 很長的話，key 就非常長，作爲 redis 裏面的 key 不合適。

一個例子：

這個 key 被 MyBatis 用來作爲一級緩存的，也可以用來作爲二級緩存的，第 88 行判斷是否開啓了二級緩存，是則在 101 行將當前查詢結果放入二級緩存。所以上面定義的二級緩存實現類，最好要對 key.toString() 返回的字符串進行壓縮，這樣可以使 key 在 redis 容器裏簡短。