Spring AOP如何整合redis(注解方式)實(shí)現(xiàn)緩存統(tǒng)一管理詳解
前言
項(xiàng)目使用redis作為緩存數(shù)據(jù),但面臨著問題,比如,項(xiàng)目A,項(xiàng)目B都用到redis,而且用的redis都是一套集群,這樣會(huì)帶來一些問題。
問題:比如項(xiàng)目A的開發(fā)人員,要緩存一些熱門數(shù)據(jù),想到了redis,于是乎把數(shù)據(jù)放入到了redis,自定義一個(gè)緩存key:hot_data_key,數(shù)據(jù)格式是項(xiàng)目A自己的數(shù)據(jù)格式,項(xiàng)目B也遇到了同樣的問題,也要緩存熱門數(shù)據(jù),也是hot_data_key,數(shù)據(jù)格式是項(xiàng)目B是自己的數(shù)據(jù)格式,由于用的都是同一套redis集群,這樣key就是同一個(gè)key,有的數(shù)據(jù)格式適合項(xiàng)目A,有的數(shù)據(jù)格式適合項(xiàng)目B,會(huì)報(bào)錯(cuò)的,我們項(xiàng)目中就遇到這樣的一個(gè)錯(cuò)誤,找不到原因,結(jié)果就是兩個(gè)平臺(tái)用到了同一key,很懊惱。
解決方式:
1、弄一個(gè)常量類工程,所有的redis的key都放入到這個(gè)工程里,加上各自的平臺(tái)標(biāo)識(shí),這樣就不錯(cuò)錯(cuò)了
2、spring Aop結(jié)合redis,再相應(yīng)的service層,加上注解,key的規(guī)范是包名+key名,這樣就不錯(cuò)重復(fù)了
思路:
1、自定義注解,加在需要緩存數(shù)據(jù)的地方
2、spring aop 結(jié)合redis實(shí)現(xiàn)
3、SPEL解析注解參數(shù),用來得到響應(yīng)的注解信息
4、redis的key:包名+key 防止redis的key重復(fù)
實(shí)現(xiàn)如下:
項(xiàng)目準(zhǔn)備,由于是maven項(xiàng)目,需要引入相關(guān)的包
fastjson包 <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>${com.alibaba.fastjson}</version> </dependency> spring-data-redis <dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-redis</artifactId> <version>${spring.redis.version}</version> </dependency> <dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId> <version>${jedis.redis.clients.version}</version> </dependency>
還有一些必備的就是spring工程相關(guān)的包
1、自定義注解
import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; import java.util.concurrent.TimeUnit; /** * 緩存注解 * * @author shangdc * */ @Target({ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) public @interface RedisCache { /** * 緩存key的名稱 * @return */ String key(); /** * key是否轉(zhuǎn)換成md5值,有的key是整個(gè)參數(shù)對象,有的大內(nèi)容的,比如一個(gè)大文本,導(dǎo)致redis的key很長 * 需要轉(zhuǎn)換成md5值作為redis的key * @return */ boolean keyTransformMd5() default false; /** * key 過期日期 秒 * @return */ int expireTime() default 60; /** * 時(shí)間單位,默認(rèn)為秒 * @return */ TimeUnit dateUnit() default TimeUnit.SECONDS; }
2、定義切點(diǎn)Pointcut
/** * redis 緩存切面 * * @author shangdc * */ public class RedisCacheAspect { //由于每個(gè)人的環(huán)境,日志用的不一樣,怕報(bào)錯(cuò),就直接關(guān)掉了此日志輸出,如有需要可加上 //private Logger LOG = Logger.getLogger(RedisCacheAspect.class); /** * 這塊可配置,每個(gè)公司都要自己的緩存配置方式,到時(shí)候可配置自己公司所用的緩存框架和配置方式 */ @Resource(name = "redisTemplate") private ValueOperations<String, String> valueOperations; /** * 具體的方法 * @param jp * @return * @throws Throwable */ public Object cache(ProceedingJoinPoint jp, RedisCache cacheable) throws Throwable{ // result是方法的最終返回結(jié)果 Object result = null; // 得到類名、方法名和參數(shù) Object[] args = jp.getArgs(); //獲取實(shí)現(xiàn)類的方法 Method method = getMethod(jp); //注解信息 key String key = cacheable.key(); //是否轉(zhuǎn)換成md5值 boolean keyTransformMd5 = cacheable.keyTransformMd5(); //---------------------------------------------------------- // 用SpEL解釋key值 //---------------------------------------------------------- //解析EL表達(dá)式后的的redis的值 String keyVal = SpringExpressionUtils.parseKey(key, method, jp.getArgs(), keyTransformMd5); // 獲取目標(biāo)對象 Object target = jp.getTarget(); //這塊是全路徑包名+目標(biāo)對象名 ,默認(rèn)的前綴,防止有的開發(fā)人員亂使用key,亂定義key的名稱,導(dǎo)致重復(fù)key,這樣在這加上前綴了,就不會(huì)重復(fù)使用key String target_class_name = target.getClass().getName(); StringBuilder redis_key = new StringBuilder(target_class_name); redis_key.append(keyVal); //最終的redis的key String redis_final_key = redis_key.toString(); String value = valueOperations.get(redis_final_key); if (value == null) { //這塊是判空 // 緩存未命中,這塊沒用log輸出,可以自定義輸出 System.out.println(redis_final_key + "緩存未命中緩存"); // 如果redis沒有數(shù)據(jù)則執(zhí)行攔截的方法體 result = jp.proceed(args); //存入json格式字符串到redis里 String result_json_data = JSONObject.toJSONString(result); System.out.println(result_json_data); // 序列化結(jié)果放入緩存 valueOperations.set(redis_final_key, result_json_data, getExpireTimeSeconds(cacheable), TimeUnit.SECONDS); } else { // 緩存命中,這塊沒用log輸出,可以自定義輸出 System.out.println(redis_final_key + "命中緩存,得到數(shù)據(jù)"); // 得到被代理方法的返回值類型 Class<?> returnType = ((MethodSignature) jp.getSignature()).getReturnType(); //拿到數(shù)據(jù)格式 result = getData(value, returnType); } return result; } /** * 根據(jù)不同的class返回?cái)?shù)據(jù) * @param value * @param clazz * @return */ public <T> T getData(String value, Class<T> clazz){ T result = JSONObject.parseObject(value, clazz); return result; } /** * 獲取方法 * @param pjp * @return * @throws NoSuchMethodException */ public static Method getMethod(ProceedingJoinPoint pjp) throws NoSuchMethodException { // -------------------------------------------------------------------------- // 獲取參數(shù)的類型 // -------------------------------------------------------------------------- Object[] args = pjp.getArgs(); Class[] argTypes = new Class[pjp.getArgs().length]; for (int i = 0; i < args.length; i++) { argTypes[i] = args[i].getClass(); } String methodName = pjp.getSignature().getName(); Class<?> targetClass = pjp.getTarget().getClass(); Method[] methods = targetClass.getMethods(); // -------------------------------------------------------------------------- // 查找Class<?>里函數(shù)名稱、參數(shù)數(shù)量、參數(shù)類型(相同或子類)都和攔截的method相同的Method // -------------------------------------------------------------------------- Method method = null; for (int i = 0; i < methods.length; i++) { if (methods[i].getName() == methodName) { Class<?>[] parameterTypes = methods[i].getParameterTypes(); boolean isSameMethod = true; // 如果相比較的兩個(gè)method的參數(shù)長度不一樣,則結(jié)束本次循環(huán),與下一個(gè)method比較 if (args.length != parameterTypes.length) { continue; } // -------------------------------------------------------------------------- // 比較兩個(gè)method的每個(gè)參數(shù),是不是同一類型或者傳入對象的類型是形參的子類 // -------------------------------------------------------------------------- for (int j = 0; parameterTypes != null && j < parameterTypes.length; j++) { if (parameterTypes[j] != argTypes[j] && !parameterTypes[j].isAssignableFrom(argTypes[j])) { isSameMethod = false; break; } } if (isSameMethod) { method = methods[i]; break; } } } return method; } /** * 計(jì)算根據(jù)Cacheable注解的expire和DateUnit計(jì)算要緩存的秒數(shù) * @param cacheable * @return */ public int getExpireTimeSeconds(RedisCache redisCache) { int expire = redisCache.expireTime(); TimeUnit unit = redisCache.dateUnit(); if (expire <= 0) {//傳入非法值,默認(rèn)一分鐘,60秒 return 60; } if (unit == TimeUnit.MINUTES) { return expire * 60; } else if(unit == TimeUnit.HOURS) { return expire * 60 * 60; } else if(unit == TimeUnit.DAYS) { return expire * 60 * 60 * 24; }else {//什么都不是,默認(rèn)一分鐘,60秒 return 60; } } }
3、spring相關(guān)配置
由于是公司的項(xiàng)目,所有包就的路徑就去掉了
<!-- aop配置,切面類 .RedisCacheAspect類 bean--> <bean id="redisCacheAspect" class="包.RedisCacheAspect"> </bean> <!-- 攔截所有指定 包和指定類型下的 下所有的方法 ,你是想這個(gè)在哪些包下可以實(shí)現(xiàn)--> <aop:config proxy-target-class="true"> <aop:aspect ref="redisCacheAspect"> <aop:pointcut id="redisCacheAopPointcut" expression="(execution(* 包.business.web.service.*.*(..)) and @annotation(cacheable))"/> <!-- 環(huán)繞 ,命中緩存則直接放回緩存數(shù)據(jù),不會(huì)往下走,未命中直接放行,直接執(zhí)行對應(yīng)的方法--> <aop:around pointcut-ref="redisCacheAopPointcut" method="cache"/> </aop:aspect> </aop:config>
4、工具類 SPEL
/** * spring EL表達(dá)式 * * @author shangdc * */ public class SpringExpressionUtils { /** * 獲取緩存的key key 定義在注解上,支持SPEL表達(dá)式 注: method的參數(shù)支持Javabean和Map * method的基本類型要定義為對象,否則沒法讀取到名稱 * * example1: Phone phone = new Phone(); "#{phone.cpu}" 為對象的取值 、 * example2: Map apple = new HashMap(); apple.put("name","good apple"); "#{apple[name]}" 為map的取值 * example3: "#{phone.cpu}_#{apple[name]}" * * * @param key * @param method * @param args * @return */ public static String parseKey(String key, Method method, Object[] args, boolean keyTransformMd5) { // 獲取被攔截方法參數(shù)名列表(使用Spring支持類庫) LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer(); String[] paraNameArr = u.getParameterNames(method); // 使用SPEL進(jìn)行key的解析 ExpressionParser parser = new SpelExpressionParser(); // SPEL上下文 StandardEvaluationContext context = new StandardEvaluationContext(); // 把方法參數(shù)放入SPEL上下文中 for (int i = 0; i < paraNameArr.length; i++) { context.setVariable(paraNameArr[i], args[i]); } ParserContext parserContext = new TemplateParserContext(); // ---------------------------------------------------------- // 把 #{ 替換成 #{# ,以適配SpEl模板的格式 // ---------------------------------------------------------- //例如,@注解名稱(key="#{player.userName}",expire = 200) //#{phone[cpu]}_#{phone[ram]} //#{player.userName}_#{phone[cpu]}_#{phone[ram]}_#{pageNo}_#{pageSize} Object returnVal = parser.parseExpression(key.replace("#{", "#{#"), parserContext).getValue(context, Object.class); //這塊這么做,是為了Object和String都可以轉(zhuǎn)成String類型的,可以作為key String return_data_key = JSONObject.toJSONString(returnVal); //轉(zhuǎn)換成md5,是因?yàn)閞edis的key過長,并且這種大key的數(shù)量過多,就會(huì)占用內(nèi)存,影響性能 if(keyTransformMd5) { return_data_key = MD5Util.digest(return_data_key); } return returnVal == null ? null : return_data_key; } }
5、redis相關(guān)配置
重要的是自己的redis配置,可能跟我的不太一樣,用自己的就好
<!-- redisTemplate defination --> <bean id="redisTemplate" class="org.springframework.data.redis.core.StringRedisTemplate"> <property name="connectionFactory" ref="jedisConnectionFactory" /> </bean>
測試
public class RedisCacheTest { @Test public void test() { ApplicationContext context = new ClassPathXmlApplicationContext("classpath:spring/spring-applicationContext.xml"); RedisCacheAopService redisCacheAopService = (RedisCacheAopService) context.getBean("redisCacheAopService"); Api api = redisCacheAopService.getApi(1l); System.out.println(api.getClass()); System.out.println(JSONObject.toJSONString(api)); ApiParam param = new ApiParam(); param.setId(2l); param.setApiName("短信服務(wù)接口數(shù)據(jù)"); // System.out.println("toString:" + param.toString()); // System.out.println(MD5Util.digest(param.toString())); Api api_1 = redisCacheAopService.getApiByParam(param); System.out.println(api_1.getClass()); System.out.println(JSONObject.toJSONString(api_1)); } }
測試打印信息:
大體思路是這樣,需要自己動(dòng)手實(shí)踐,不要什么都是拿過來直接copy,使用,整個(gè)過程都不操作,也不知道具體的地方,該用什么,自己實(shí)際操作,可以得到很多信息。
輔助信息類:
public class Api implements Serializable { private static final long serialVersionUID = 1L; /** * * 自增主鍵id */ private Long id; /** * * api名稱 */ private String apiName; /** * * api描述 */ private String apiDescription; /** * * 有效時(shí)間 */ private Integer valid; /** * 處理類 */ private String handlerClass; /** * * */ private Date updateTime; /** * * */ private Date createTime; public Api() { } public String toString() { return "id:" + id + ", apiName:" + apiName + ", apiDescription:" + apiDescription + ", valid:" + valid + ", updateTime:" + updateTime + ", createTime:" + createTime; } public Long getId() { return this.id; } public void setId(Long id) { this.id = id; } public String getApiName() { return this.apiName; } public void setApiName(String apiName) { this.apiName = apiName; } public String getApiDescription() { return this.apiDescription; } public void setApiDescription(String apiDescription) { this.apiDescription = apiDescription; } public Integer getValid() { return this.valid; } public void setValid(Integer valid) { this.valid = valid; } public Date getUpdateTime() { return this.updateTime; } public void setUpdateTime(Date updateTime) { this.updateTime = updateTime; } public Date getCreateTime() { return this.createTime; } public void setCreateTime(Date createTime) { this.createTime = createTime; } public String getHandlerClass() { return handlerClass; } public void setHandlerClass(String handlerClass) { this.handlerClass = handlerClass; } }
參數(shù)類信息
public class ApiParam { /** * */ private static final long serialVersionUID = 1L; /** * api表主鍵id */ private Long id; /** * * api名稱 */ private String apiName; /** * * 有效OR無效 */ private Integer valid; public String getApiName() { return apiName; } public void setApiName(String apiName) { this.apiName = apiName; } public Integer getValid() { return valid; } public void setValid(Integer valid) { this.valid = valid; } public Long getId() { return id; } public void setId(Long id) { this.id = id; } /*@Override public String toString() { return "ApiParam [id=" + id + ", apiName=" + apiName + ", valid=" + valid + "]"; } */ }
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
相關(guān)文章
mybatis-plus返回map自動(dòng)轉(zhuǎn)駝峰配置操作
這篇文章主要介紹了mybatis-plus返回map自動(dòng)轉(zhuǎn)駝峰配置操作,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-11-11Java對zip,rar,7z文件帶密碼解壓實(shí)例詳解
在日常業(yè)務(wù)中,會(huì)遇到一些瑣碎文件需要打包到一個(gè)壓縮包中上傳,業(yè)務(wù)方在后臺(tái)接收到壓縮包后自行解壓,然后解析相應(yīng)文件。而且可能涉及安全保密,因此會(huì)在壓縮時(shí)帶上密碼,要求后臺(tái)業(yè)務(wù)可以指定密碼進(jìn)行解壓。本文將用Java解決這一問題,需要的可以參考一下2022-07-07關(guān)于jd-gui啟動(dòng)報(bào)This?program?requires?Java?1.8+的錯(cuò)誤問題及解決方法
最近,在Mac使用上JD-GUI啟動(dòng)時(shí)總是報(bào)錯(cuò),接下來通過本文給大家介紹關(guān)于jd-gui啟動(dòng)報(bào)this?program?requires?Java?1.8+的錯(cuò)誤問題及解決方法,需要的朋友可以參考下2022-05-05SpringBoot?將配置文件掛到?jar?包外面的操作方法
在 SpringBoot 中,可以將配置文件放在 jar 包外面,這樣可以方便地修改配置而不需要重新打包和部署,這篇文章主要介紹了SpringBoot?如何將配置文件掛到?jar?包外面,需要的朋友可以參考下2023-03-03Tomcat多war包部署實(shí)戰(zhàn)示例及注意事項(xiàng)
多服務(wù)部署在一個(gè)tomcat中,服務(wù)之間互相調(diào)用,下面這篇文章主要給大家介紹了關(guān)于Tomcat多war包部署實(shí)戰(zhàn)示例及注意事項(xiàng)的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-12-12SpringBoot配置文件中密碼屬性加密的實(shí)現(xiàn)
本文主要介紹了SpringBoot配置文件中密碼屬性加密的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-07-07