Spring AOP實現(xiàn)Redis緩存數(shù)據(jù)庫查詢源碼
應(yīng)用場景
我們希望能夠?qū)?shù)據(jù)庫查詢結(jié)果緩存到Redis中,這樣在第二次做同樣的查詢時便可以直接從redis取結(jié)果,從而減少數(shù)據(jù)庫讀寫次數(shù)。
需要解決的問題
操作緩存的代碼寫在哪?必須要做到與業(yè)務(wù)邏輯代碼完全分離。
如何避免臟讀? 從緩存中讀出的數(shù)據(jù)必須與數(shù)據(jù)庫中的數(shù)據(jù)一致。
如何為一個數(shù)據(jù)庫查詢結(jié)果生成一個唯一的標(biāo)識?即通過該標(biāo)識(Redis中為Key),能唯一確定一個查詢結(jié)果,同一個查詢結(jié)果,一定能映射到同一個key。只有這樣才能保證緩存內(nèi)容的正確性
如何序列化查詢結(jié)果?查詢結(jié)果可能是單個實體對象,也可能是一個List。
解決方案
避免臟讀
我們緩存了查詢結(jié)果,那么一旦數(shù)據(jù)庫中的數(shù)據(jù)發(fā)生變化,緩存的結(jié)果就不可用了。為了實現(xiàn)這一保證,可以在執(zhí)行相關(guān)表的更新查詢(update, delete, insert)查詢前,讓相關(guān)的緩存過期。這樣下一次查詢時程序就會重新從數(shù)據(jù)庫中讀取新數(shù)據(jù)緩存到redis中。那么問題來了,在執(zhí)行一條insert前我怎么知道應(yīng)該讓哪些緩存過期呢?對于Redis,我們可以使用Hash Set數(shù)據(jù)結(jié)構(gòu),讓一張表對應(yīng)一個Hash Set,所有在這張表上的查詢都保存到該Set下。這樣當(dāng)表數(shù)據(jù)發(fā)生變動時,直接讓Set過期即可。我們可以自定義一個注解,在數(shù)據(jù)庫查詢方法上通過注解的屬性注明這個操作與哪些表相關(guān),這樣在執(zhí)行過期操作時,就能直接從注解中得知應(yīng)該讓哪些Set過期了。
為查詢生成唯一標(biāo)識
對于MyBatis,我們可以直接使用SQL字符串做為key。但是這樣就必須編寫基于MyBatis的攔截器,從而使你的緩存代碼與MyBatis緊緊耦合在一起。如果哪天更換了持久層的框架,你的緩存代碼就白寫了,所以這個方案并不完美。
仔細想一想,其實如果兩次查詢調(diào)用的類名、方法名和參數(shù)值相同,我們就可以確定這兩次查詢結(jié)果一定是相同的(在數(shù)據(jù)沒有變動的前提下)。因此,我們可以將這三個元素組合成一個字符串做為key, 就解決了標(biāo)識問題。
序列化查詢結(jié)果
最方便的序列化方式就是使用JDK自帶的ObjectOutputStream和ObjectInputStream。優(yōu)點是幾乎任何一個對象,只要實現(xiàn)了Serializable接口,都用同一套代碼能被序列化和反序列化。但缺點也很致命,那就是序列化的結(jié)果容量偏大,在redis中會消耗大量內(nèi)存(是對應(yīng)JSON格式的3倍左右)。那么我們只剩下JSON這一個選擇了。
JSON的優(yōu)點是結(jié)構(gòu)緊湊,可讀性強,但美中不足的是,反序列化對象時必須提供具體的類型參數(shù)(Class對象),如果是List對象,還必須提供List和List中的元素類型兩種信息,才能被正確反序列化。這樣就增加了代碼的復(fù)雜度。不過這些困難都是可以克服的,所以我們還是選擇JSON作為序列化存儲方式。
代碼寫在哪
毫無疑問,該AOP上場了。在我們的例子中,持久化框架使用的是MyBatis,因此我們的任務(wù)就是攔截Mapper接口方法的調(diào)用,通過Around(環(huán)繞通知)編寫以下邏輯:
方法被調(diào)用之前,根據(jù)類名、方法名和參數(shù)值生成Key
通過Key向Redis發(fā)起查詢
如果緩存命中,則將緩存結(jié)果反序列化作為方法調(diào)用的返回值 ,并阻止被代理方法的調(diào)用。
如果緩存未命中,則執(zhí)行代理方法,得到查詢結(jié)果,序列化,用當(dāng)前的Key將序列化結(jié)果放入redis中。
代碼實現(xiàn)
因為我們要攔截的是Mapper接口方法,因此必須命令spring使用JDK的動態(tài)代理而不是cglib的代理。為此,我們需要做以下配置:
<!-- 當(dāng)proxy-target-class為false時使用JDK動態(tài)代理 --> <!-- 為true時使用cglib --> <!-- cglib無法攔截接口方法 --> <aop:aspectj-autoproxy proxy-target-class="false" />
然后定義兩個標(biāo)注在接口方法上的注解,用于傳遞類型參數(shù):
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) @Documented public @interface RedisCache { Class type(); }
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface RedisEvict { Class type(); }
注解的使用方式如下:
// 表示該方法需要執(zhí)行 (緩存是否命中 ? 返回緩存并阻止方法調(diào)用 : 執(zhí)行方法并緩存結(jié)果)的緩存邏輯 @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; /** * 方法調(diào)用前,先查詢緩存。如果存在緩存,則返回緩存數(shù)據(jù),阻止方法調(diào)用; * 如果沒有緩存,則調(diào)用業(yè)務(wù)方法,然后將結(jié)果放到緩存中 * @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 { // 得到類名、方法名和參數(shù) String clazzName = jp.getTarget().getClass().getName(); String methodName = jp.getSignature().getName(); Object[] args = jp.getArgs(); // 根據(jù)類名,方法名和參數(shù)生成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是方法的最終返回結(jié)果 Object result = null; if (null == value) { // 緩存未命中 if (infoLog.isDebugEnabled()) { infoLog.debug("緩存未命中"); } // 調(diào)用數(shù)據(jù)庫查詢方法 result = jp.proceed(args); // 序列化查詢結(jié)果 String json = serialize(result); // 序列化結(jié)果放入緩存 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("反序列化結(jié)果 = {}", result); } } return result; } /** * 在方法調(diào)用前清除緩存,然后調(diào)用業(yè)務(wù)方法 * @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()); } // 清除對應(yīng)緩存 rt.delete(modelType.getName()); return jp.proceed(jp.getArgs()); } /** * 根據(jù)類名、方法名和參數(shù)生成key * @param clazzName * @param methodName * @param args 方法參數(shù) * @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) { // 序列化結(jié)果應(yīng)該是List對象 if (clazz.isAssignableFrom(List.class)) { return JSON.parseArray(jsonString, modelType); } // 序列化結(jié)果是普通對象 return JSON.parseObject(jsonString, clazz); } }
這樣我們就完成了數(shù)據(jù)庫查詢緩存的實現(xiàn)。
UPDATE:
最好為Hash Set設(shè)置一個過期時間,這樣即使緩存策略有誤(導(dǎo)致讀出臟數(shù)據(jù)),過期時間到了以后依然可以與數(shù)據(jù)庫保持同步:
// 序列化結(jié)果放入緩存 rt.execute(new RedisCallback<Object>() { @Override public Object doInRedis(RedisConnection redisConn) throws DataAccessException { // 配置文件中指定了這是一個String類型的連接 // 所以這里向下強制轉(zhuǎn)換一定是安全的 StringRedisConnection conn = (StringRedisConnection) redisConn; // 判斷hash名是否存在 // 如果不存在,創(chuàng)建該hash并設(shè)置過期時間 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; } });
總結(jié)
本文關(guān)于Spring AOP實現(xiàn)Redis緩存數(shù)據(jù)庫查詢源碼的介紹就到這里,希望對大家有所幫助。感興趣的朋友可以參閱本站其他相關(guān)專題,在此非常感謝大家對腳本之家的支持!
相關(guān)文章
springboot利用easypoi實現(xiàn)簡單導(dǎo)出功能
本文介紹了如何使用Spring Boot和EasyPoi庫實現(xiàn)Excel文件的導(dǎo)出功能,EasyPoi是一個簡化Excel和Word操作的工具,通過簡單的配置和代碼,可以輕松地將Java對象導(dǎo)出為Excel文件,并且支持圖片導(dǎo)出等功能,感興趣的朋友一起看看吧2024-12-12Java的StringBuilder在高性能場景下的正確用法
StringBuilder?對字符串的操作是直接改變字符串對象本身,而不是生成新的對象,所以新能開銷小.與StringBuffer相比StringBuilder的性能略高,StringBuilder則沒有保證線程的安全,從而性能略高于StringBuffer,需要的朋友可以參考下2023-05-05Java Fluent Mybatis實戰(zhàn)之構(gòu)建項目與代碼生成篇上
Java中常用的ORM框架主要是mybatis, hibernate, JPA等框架。國內(nèi)又以Mybatis用的多,基于mybatis上的增強框架,又有mybatis plus和TK mybatis等。今天我們介紹一個新的mybatis增強框架 fluent mybatis2021-10-10Java中的Gradle與Groovy的區(qū)別及存在的關(guān)系
這篇文章主要介紹了Java中的Gradle與Groovy的區(qū)別及存在的關(guān)系,Groovy是一種JVM語言,它可以編譯為與Java相同的字節(jié)碼,并且可以與Java類無縫地互操作,Gradle是Java項目中主要的構(gòu)建系統(tǒng)之一,下文關(guān)于兩者的詳細內(nèi)容,需要的小伙伴可以參考一下2022-02-02springboot讀取yml文件中的list列表、數(shù)組、map集合和對象方法實例
在平時的yml配置文件中,我們經(jīng)常使用到配置基本數(shù)據(jù)類型的字符串,下面這篇文章主要給大家介紹了關(guān)于springboot讀取yml文件中的list列表、數(shù)組、map集合和對象的相關(guān)資料,需要的朋友可以參考下2023-02-02MyBatis-Flex BaseMapper的接口基本用法小結(jié)
本文主要介紹了MyBatis-Flex BaseMapper的接口基本用法小結(jié),文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2025-02-02Mybatis foreach用法解析--對于list和array
這篇文章主要介紹了Mybatis foreach用法解析--對于list和array,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-03-03Intellij IDEA 與maven 版本不符 Unable to import maven project See
這篇文章主要介紹了Intellij IDEA 與maven 版本不符 Unable to import maven project See logs for details: No implementation for org.apache.maven.model.path.PathTranslator was bound,本文通過圖文給大家分享解決方案,需要的朋友可以參考下2020-08-08