Spring Boot 基于注解的 Redis 缓存使用详解

2019-11-26 12:18:21

字体：大中小

来源：转载

供稿：网友

看文本之前，请先确定你看过上一篇文章《Spring Boot Redis 集成配置》并保证 Redis 集成后正常可用，因为本文是基于上文继续增加的代码。

一、创建 Caching 配置类

RedisKeys.Java

package com.shanhy.example.redis;import java.util.HashMap;import java.util.Map;import javax.annotation.PostConstruct;import org.springframework.stereotype.Component;/** * 方法缓存key常量 *  * @author SHANHY */@Componentpublic class RedisKeys {  // 测试 begin  public static final String _CACHE_TEST = "_cache_test";// 缓存key  public static final Long _CACHE_TEST_SECOND = 20L;// 缓存时间  // 测试 end  // 根据key设定具体的缓存时间  private Map<String, Long> expiresMap = null;  @PostConstruct  public void init(){    expiresMap = new HashMap<>();    expiresMap.put(_CACHE_TEST, _CACHE_TEST_SECOND);  }  public Map<String, Long> getExpiresMap(){    return this.expiresMap;  }}

CachingConfig.java

package com.shanhy.example.redis;import java.lang.reflect.Method;import java.util.ArrayList;import java.util.List;import org.springframework.cache.CacheManager;import org.springframework.cache.annotation.CachingConfigurerSupport;import org.springframework.cache.annotation.EnableCaching;import org.springframework.cache.interceptor.KeyGenerator;import org.springframework.cache.interceptor.SimpleKeyGenerator;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.data.redis.cache.RedisCacheManager;import org.springframework.data.redis.core.RedisTemplate;/** * 注解式环境管理 *  * @author 单红宇(CSDN catoop) * @create 2016年9月12日 */@Configuration@EnableCachingpublic class CachingConfig extends CachingConfigurerSupport {  /**   * 在使用@Cacheable时，如果不指定key，则使用找个默认的key生成器生成的key   *   * @return   *    * @author 单红宇(CSDN CATOOP)   * @create 2017年3月11日   */  @Override  public KeyGenerator keyGenerator() {    return new SimpleKeyGenerator() {      /**       * 对参数进行拼接后MD5       */      @Override      public Object generate(Object target, Method method, Object... params) {        StringBuilder sb = new StringBuilder();        sb.append(target.getClass().getName());        sb.append(".").append(method.getName());        StringBuilder paramsSb = new StringBuilder();        for (Object param : params) {          // 如果不指定，默认生成包含到键值中          if (param != null) {            paramsSb.append(param.toString());          }        }        if (paramsSb.length() > 0) {          sb.append("_").append(paramsSb);        }        return sb.toString();      }    };  }  /**   * 管理缓存   *   * @param redisTemplate   * @return   */  @Bean  public CacheManager cacheManager(RedisTemplate<String, Object> redisTemplate, RedisKeys redisKeys) {    RedisCacheManager rcm = new RedisCacheManager(redisTemplate);    // 设置缓存默认过期时间（全局的）    rcm.setDefaultExpiration(1800);// 30分钟    // 根据key设定具体的缓存时间，key统一放在常量类RedisKeys中    rcm.setExpires(redisKeys.getExpiresMap());    List<String> cacheNames = new ArrayList<String>(redisKeys.getExpiresMap().keySet());    rcm.setCacheNames(cacheNames);    return rcm;  }}

二、创建需要缓存数据的类

TestService.java

package com.shanhy.example.service;import org.apache.commons.lang3.RandomStringUtils;import org.springframework.cache.annotation.Cacheable;import org.springframework.stereotype.Service;import com.shanhy.example.redis.RedisKeys;@Servicepublic class TestService {  /**   * 固定key   *   * @return   * @author SHANHY   * @create 2017年4月9日   */  @Cacheable(value = RedisKeys._CACHE_TEST, key = "'" + RedisKeys._CACHE_TEST + "'")  public String testCache() {    return RandomStringUtils.randomNumeric(4);  }  /**   * 存储在Redis中的key自动生成，生成规则详见CachingConfig.keyGenerator()方法   *   * @param str1   * @param str2   * @return   * @author SHANHY   * @create 2017年4月9日   */  @Cacheable(value = RedisKeys._CACHE_TEST)  public String testCache2(String str1, String str2) {    return RandomStringUtils.randomNumeric(4);  }}

说明一下，其中 @Cacheable 中的 value 值是在 CachingConfig的cacheManager 中配置的，那里是为了配置我们的缓存有效时间。其中 methodKeyGenerator 为 CachingConfig 中声明的 KeyGenerator。

另外，Cache 相关的注解还有几个，大家可以了解下，不过我们常用的就是 @Cacheable，一般情况也可以满足我们的大部分需求了。还有 @Cacheable 也可以配置表达式根据我们传递的参数值判断是否需要缓存。

注： TestService 中 testCache 中的 mapper.get 大家不用关心，这里面我只是访问了一下数据库而已，你只需要在这里做自己的业务代码即可。

三、测试方法

下面代码，随便放一个 Controller 中

package com.shanhy.example.controller;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.data.redis.connection.jedis.RedisClient;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;import com.shanhy.example.service.TestService;/** * 测试Controller *  * @author 单红宇(365384722) * @create 2017年4月9日 */@RestController@RequestMapping("/test")public class TestController {  private static final Logger LOG = LoggerFactory.getLogger(TestController.class);  @Autowired  private RedisClient redisClient;  @Autowired  private TestService testService;  @GetMapping("/redisCache")  public String redisCache() {    redisClient.set("shanhy", "hello,shanhy", 100);    LOG.info("getRedisValue = {}", redisClient.get("shanhy"));    testService.testCache2("aaa", "bbb");    return testService.testCache();  }}

至此完毕！

最后说一下，这个 @Cacheable 基本是可以放在所有方法上的，Controller 的方法上也是可以的（这个我没有测试 ^_^）。

源码下载地址：http://git.oschina.net/catoop/springboot-cache-redis

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持武林网。

上一篇：详解Spring Boot 使用slf4j+logback记录日志配置

下一篇：Spring Boot Redis 集成配置详解