Spring AOP實現Redis緩存數據庫查詢源碼
應用場景
我們希望能夠將數據庫查詢結果緩存到Redis中，這樣在第二次做同樣的查詢時便可以直接從redis取結果，從而減少數據庫讀寫次數。
需要解決的問題
操作緩存的代碼寫在哪？必須要做到與業(yè)務邏輯代碼完全分離。
如何避免臟讀？ 從緩存中讀出的數據必須與數據庫中的數據一致。
如何為一個數據庫查詢結果生成一個唯一的標識？即通過該標識(Redis中為Key)，能唯一確定一個查詢結果，同一個查詢結果，一定能映射到同一個key。只有這樣才能保證緩存內容的正確性
如何序列化查詢結果？查詢結果可能是單個實體對象，也可能是一個List。
解決方案
避免臟讀
我們緩存了查詢結果，那么一旦數據庫中的數據發(fā)生變化，緩存的結果就不可用了。為了實現這一保證，可以在執(zhí)行相關表的更新查詢(update, delete, insert)查詢前，讓相關的緩存過期。這樣下一次查詢時程序就會重新從數據庫中讀取新數據緩存到redis中。那么問題來了，在執(zhí)行一條insert前我怎么知道應該讓哪些緩存過期呢？對于Redis，我們可以使用Hash Set數據結構，讓一張表對應一個Hash Set，所有在這張表上的查詢都保存到該Set下。這樣當表數據發(fā)生變動時，直接讓Set過期即可。我們可以自定義一個注解，在數據庫查詢方法上通過注解的屬性注明這個操作與哪些表相關，這樣在執(zhí)行過期操作時，就能直接從注解中得知應該讓哪些Set過期了。
為查詢生成唯一標識
對于MyBatis，我們可以直接使用SQL字符串做為key。但是這樣就必須編寫基于MyBatis的攔截器，從而使你的緩存代碼與MyBatis緊緊耦合在一起。如果哪天更換了持久層的框架，你的緩存代碼就白寫了，所以這個方案并不完美。
仔細想一想，其實如果兩次查詢調用的類名、方法名和參數值相同，我們就可以確定這兩次查詢結果一定是相同的（在數據沒有變動的前提下）。因此，我們可以將這三個元素組合成一個字符串做為key, 就解決了標識問題。
序列化查詢結果
最方便的序列化方式就是使用JDK自帶的ObjectOutputStream和ObjectInputStream。優(yōu)點是幾乎任何一個對象，只要實現了Serializable接口，都用同一套代碼能被序列化和反序列化。但缺點也很致命，那就是序列化的結果容量偏大，在redis中會消耗大量內存（是對應JSON格式的3倍左右）。那么我們只剩下JSON這一個選擇了。
JSON的優(yōu)點是結構緊湊，可讀性強，但美中不足的是，反序列化對象時必須提供具體的類型參數(Class對象)，如果是List對象，還必須提供List和List中的元素類型兩種信息，才能被正確反序列化。這樣就增加了代碼的復雜度。不過這些困難都是可以克服的，所以我們還是選擇JSON作為序列化存儲方式。
代碼寫在哪
毫無疑問，該AOP上場了。在我們的例子中，持久化框架使用的是MyBatis，因此我們的任務就是攔截Mapper接口方法的調用，通過Around(環(huán)繞通知)編寫以下邏輯：
方法被調用之前，根據類名、方法名和參數值生成Key
通過Key向Redis發(fā)起查詢
如果緩存命中，則將緩存結果反序列化作為方法調用的返回值 ，并阻止被代理方法的調用。
如果緩存未命中，則執(zhí)行代理方法，得到查詢結果，序列化，用當前的Key將序列化結果放入redis中。
代碼實現
因為我們要攔截的是Mapper接口方法，因此必須命令spring使用JDK的動態(tài)代理而不是cglib的代理。為此，我們需要做以下配置：
<!-- 當proxy-target-class為false時使用JDK動態(tài)代理 --> <!-- 為true時使用cglib --> <!-- cglib無法攔截接口方法 --> <aop:aspectj-autoproxy proxy-target-class="false" />
然后定義兩個標注在接口方法上的注解，用于傳遞類型參數：
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface RedisCache {
Class type();
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface RedisEvict {
Class type();
}
注解的使用方式如下：
// 表示該方法需要執(zhí)行 (緩存是否命中 ? 返回緩存并阻止方法調用 : 執(zhí)行方法并緩存結果)的緩存邏輯 @RedisCache(type = JobPostModel.class) JobPostModel selectByPrimaryKey(Integer id);
// 表示該方法需要執(zhí)行清除緩存邏輯 @RedisEvict(type = JobPostModel.class) int deleteByPrimaryKey(Integer id);
AOP的代碼如下:
@Aspect
@Component
public class RedisCacheAspect {
public static final Logger infoLog = LogUtils.getInfoLogger();
@Qualifier("redisTemplateForString")
@Autowired
StringRedisTemplate rt;
/**
* 方法調用前，先查詢緩存。如果存在緩存，則返回緩存數據，阻止方法調用;
* 如果沒有緩存，則調用業(yè)務方法，然后將結果放到緩存中
* @param jp
* @return
* @throws Throwable
*/
@Around("execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.select*(..))" +
"|| execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.get*(..))" +
"|| execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.find*(..))" +
"|| execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.search*(..))")
public Object cache(ProceedingJoinPoint jp) throws Throwable {
// 得到類名、方法名和參數
String clazzName = jp.getTarget().getClass().getName();
String methodName = jp.getSignature().getName();
Object[] args = jp.getArgs();
// 根據類名，方法名和參數生成key
String key = genKey(clazzName, methodName, args);
if (infoLog.isDebugEnabled()) {
infoLog.debug("生成key:{}", key);
}
// 得到被代理的方法
Method me = ((MethodSignature) jp.getSignature()).getMethod();
// 得到被代理的方法上的注解
Class modelType = me.getAnnotation(RedisCache.class).type();
// 檢查redis中是否有緩存
String value = (String)rt.opsForHash().get(modelType.getName(), key);
// result是方法的最終返回結果
Object result = null;
if (null == value) {
// 緩存未命中
if (infoLog.isDebugEnabled()) {
infoLog.debug("緩存未命中");
}
// 調用數據庫查詢方法
result = jp.proceed(args);
// 序列化查詢結果
String json = serialize(result);
// 序列化結果放入緩存
rt.opsForHash().put(modelType.getName(), key, json);
} else {
// 緩存命中
if (infoLog.isDebugEnabled()) {
infoLog.debug("緩存命中, value = {}", value);
}
// 得到被代理方法的返回值類型
Class returnType = ((MethodSignature) jp.getSignature()).getReturnType();
// 反序列化從緩存中拿到的json
result = deserialize(value, returnType, modelType);
if (infoLog.isDebugEnabled()) {
infoLog.debug("反序列化結果 = {}", result);
}
}
return result;
}
/**
* 在方法調用前清除緩存，然后調用業(yè)務方法
* @param jp
* @return
* @throws Throwable
*/
@Around("execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.insert*(..))" +
"|| execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.update*(..))" +
"|| execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.delete*(..))" +
"|| execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.increase*(..))" +
"|| execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.decrease*(..))" +
"|| execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.complaint(..))" +
"|| execution(* com.fh.taolijie.dao.mapper.JobPostModelMapper.set*(..))")
public Object evictCache(ProceedingJoinPoint jp) throws Throwable {
// 得到被代理的方法
Method me = ((MethodSignature) jp.getSignature()).getMethod();
// 得到被代理的方法上的注解
Class modelType = me.getAnnotation(RedisEvict.class).type();
if (infoLog.isDebugEnabled()) {
infoLog.debug("清空緩存:{}", modelType.getName());
}
// 清除對應緩存
rt.delete(modelType.getName());
return jp.proceed(jp.getArgs());
}
/**
* 根據類名、方法名和參數生成key
* @param clazzName
* @param methodName
* @param args 方法參數
* @return
*/
protected String genKey(String clazzName, String methodName, Object[] args) {
StringBuilder sb = new StringBuilder(clazzName);
sb.append(Constants.DELIMITER);
sb.append(methodName);
sb.append(Constants.DELIMITER);
for (Object obj : args) {
sb.append(obj.toString());
sb.append(Constants.DELIMITER);
}
return sb.toString();
}
protected String serialize(Object target) {
return JSON.toJSONString(target);
}
protected Object deserialize(String jsonString, Class clazz, Class modelType) {
// 序列化結果應該是List對象
if (clazz.isAssignableFrom(List.class)) {
return JSON.parseArray(jsonString, modelType);
}
// 序列化結果是普通對象
return JSON.parseObject(jsonString, clazz);
}
}
這樣我們就完成了數據庫查詢緩存的實現。
UPDATE:
最好為Hash Set設置一個過期時間，這樣即使緩存策略有誤（導致讀出臟數據），過期時間到了以后依然可以與數據庫保持同步：
// 序列化結果放入緩存
rt.execute(new RedisCallback<Object>() {
@Override
public Object doInRedis(RedisConnection redisConn) throws DataAccessException {
// 配置文件中指定了這是一個String類型的連接
// 所以這里向下強制轉換一定是安全的
StringRedisConnection conn = (StringRedisConnection) redisConn;
// 判斷hash名是否存在
// 如果不存在，創(chuàng)建該hash并設置過期時間
if (false == conn.exists(hashName) ){
conn.hSet(hashName, key, json);
conn.expire(hashName, Constants.HASH_EXPIRE_TIME);
} else {
conn.hSet(hashName, key, json);
}
return null;
}
});
總結
本文關于Spring AOP實現Redis緩存數據庫查詢源碼的介紹就到這里，希望對大家有所幫助。感興趣的朋友可以參閱本站其他相關專題，在此非常感謝大家對腳本之家的支持！
相關文章
Caused by: java.lang.ClassNotFoundException: org.apache.comm
這篇文章主要介紹了Caused by: java.lang.ClassNotFoundException: org.objectweb.asm.Type異常，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-07-07
java ThreadPool線程池的使用,線程池工具類用法說明
這篇文章主要介紹了java ThreadPool線程池的使用,線程池工具類用法說明，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-10-10
這篇文章主要介紹了SpringBoot返回所有接口詳細信息的方法,簡單來說就是我們通過訪問一個接口能看到我們所有的API接口的數量,以及路徑和請求方法,文中有詳細的代碼供大家參考,需要的朋友可以參考下2025-04-04
這篇文章主要介紹了java中字符串常見的方法及總結，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-12-12
這篇文章主要介紹了Spring實戰(zhàn)之屬性占位符配置器用法,結合實例形式分析了spring屬性占位符配置器的具體配置及使用技巧,需要的朋友可以參考下2019-12-12
git stash 和unstash的使用操作,git unstash failed
這篇文章主要介紹了git stash 和unstash的使用操作,git unstash failed，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-02-02
這篇文章主要為大家介紹了java線程池參數位置導致的奪命故障宿主機打不開的問題解決，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-06-06
這篇文章主要介紹了Java通過BCrypt加密過程詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-07-07
在java中經常會遇到需要對數據進行類型轉換的場景,這篇文章主要給大家介紹了關于Java中將String類型轉換為int類型的幾種常見方法,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2024-07-07
AC自動機是一個多模式匹配算法，在模式匹配領域被廣泛應用。本文將詳細為大家介紹AC自動機的原理與實現方法，感興趣的可以了解一下2022-05-05