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

 更新时间:2017年05月13日 17:13:28   作者:catoop  
本篇文章主要介绍了Spring Boot 基于注解的 Redis 缓存使用详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

看文本之前,请先确定你看过上一篇文章《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
 */
@Component
public 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
@EnableCaching
public 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;

@Service
public 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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • 精通Java泛型的使用与原理

    精通Java泛型的使用与原理

    针对利用继承来实现通用程序设计所产生的问题,泛型提供了更好的解决方案,本文详细的介绍了Java泛型的使用与原理,感兴趣的可以了解一下
    2022-03-03
  • 详解Java String字符串获取每一个字符及常用方法

    详解Java String字符串获取每一个字符及常用方法

    这篇文章主要介绍了详解Java String字符串获取每一个字符及常用方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-09-09
  • java后台接受到图片后保存方法

    java后台接受到图片后保存方法

    在本篇文章里小编给大家整理了关于java后台接受到图片后怎么保存的相关知识点,需要的朋友们参考学习下。
    2019-06-06
  • HttpClient的KeepAlive接口方法源码解析

    HttpClient的KeepAlive接口方法源码解析

    这篇文章主要为大家介绍了HttpClient的KeepAlive接口方法源码解析,
    有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-10-10
  • Spring Cloud Gateway自定义异常处理Exception Handler的方法小结

    Spring Cloud Gateway自定义异常处理Exception Handler的方法小结

    这篇文章主要介绍了Spring Cloud Gateway自定义异常处理Exception Handler的方法,本文通过两种方法结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-08-08
  • Java实现的权重算法(按权重展现广告)

    Java实现的权重算法(按权重展现广告)

    这篇文章主要介绍了Java实现的权重算法(按权重展现广告),本文讲解了算法实现原理和实现代码,需要的朋友可以参考下
    2015-04-04
  • SpringBoot开启异步调用方法

    SpringBoot开启异步调用方法

    这篇文章主要为大家详细介绍了SpringBoot开启异步调用方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-09-09
  • Java组件FileUpload上传文件实现代码

    Java组件FileUpload上传文件实现代码

    这篇文章主要为大家详细介绍了Java组件FileUpload上传文件实现代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-06-06
  • Spring实战之FileSystemResource加载资源文件示例

    Spring实战之FileSystemResource加载资源文件示例

    这篇文章主要介绍了Spring实战之FileSystemResource加载资源文件,结合实例形式分析了spring FileSystemResource加载xml资源文件的具体实现步骤与相关操作技巧,需要的朋友可以参考下
    2019-12-12
  • 一文带你搞懂Java8的LocalDateTime

    一文带你搞懂Java8的LocalDateTime

    LocalDateTime 是Java8中新加入的日期时间类,现在都 Java20 了,不会还有人没用过 LocalDateTime 吧?今天给大家演示一下 LocalDateTime 的常用方法
    2023-04-04

最新评论