为 Spring Boot 应用添加 Redis Caching

中大型应用开发中,缓存的重要性不言而喻,早期常用的进程式类的缓存,像 EhCache 或者是 ConcurrentHashMap 这样的容器,发展到如今,更流行的是那些分布式的独立缓存服务,如:Redis、Memcached。

对于 Java 应用开发者来说,Spring 提供了完善的缓存抽象机制,结合 Spring Boot 的使用,可以做到非常轻松的完成缓存实现和切换。下面通过简单的示例,展示下如何快速为你的 Spring Boot 应用添加 Redis Caching。

  1. 相关依赖
<dependencies>
        <!-- 添加该依赖后,将自动使用 Redis 作为 Cache Provider -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
  1. 补充配置
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&zeroDateTimeBehavior=convertToNull&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8&tinyInt1isBit=false
    username: root
    password: root
  jpa:
    database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
    hibernate:
      ddl-auto: create
    # 开启 SQL 输出,方便查看结果是否走了缓存
    show-sql: true
    open-in-view: false
  redis:
    host: localhost
  cache:
    # 非必须,但如果配置了需补充相应的依赖,否则会出错
    #type: redis
    redis:
      # 过期时间5秒,默认单位:毫秒,等同于设置成 5s、5S
      time-to-live: 5000
      key-prefix: cn.mariojd.cache.
      cache-null-values: false
  1. 添加实体,实现 Serializable 接口
@Data
@Entity
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class User implements Serializable {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    private String name;

}

定义 Repository 接口:

public interface UserRepository extends JpaRepository<User, Integer> {
}
  1. 编写 Service,进行缓存规则配置,核心注解有:@CacheConfig@Cacheable(缓存新增)、@CachePut(缓存更新)、@CacheEvict(缓存删除)
@Slf4j
@Service
@CacheConfig(cacheNames = "user")
public class UserService {

    @Resource
    private UserRepository userRepository;

    /**
     * Key name: key-prefix.classSimpleName.methodName?pn=xxx&ps=xxx&sort=xxx
     */
    @Cacheable(key = "#root.targetClass.simpleName+'.'+#root.methodName+'?pn='+#pageable.pageNumber+'&ps='+#pageable.pageSize+'&sort='+#pageable.sort.toString()")
    public Page<User> page(Pageable pageable) {
        return userRepository.findAll(pageable);
    }

    @Cacheable(key = "'user.'+#userId", unless = "#result == null")
    public Optional<User> get(int userId) {
        return userRepository.findById(userId);
    }

    @Transactional
    public User add(String name) {
        User user = User.builder().name(name).build();
        return userRepository.save(user);
    }

    @CachePut(key = "'user.'+#userId", unless = "#result == null")
    @Transactional
    public Optional<User> update(int userId, String name) {
        Optional<User> userOptional = userRepository.findById(userId);
        userOptional.ifPresent(user -> {
            user.setName(name);
            userRepository.save(user);
        });
        return userOptional;
    }

    @CacheEvict(key = "'user.'+#userId")
    @Transactional
    public void delete(int userId) {
        userRepository.findById(userId).ifPresent(user -> userRepository.delete(user));
    }

}
  1. 缓存测试,为启动类添加:@EnableCaching
@Slf4j
@EnableCaching
@SpringBootApplication
public class SpringBootCacheApplication implements ApplicationRunner {

    public static void main(String[] args) {
        new SpringApplicationBuilder()
                .sources(SpringBootCacheApplication.class)
                .bannerMode(Banner.Mode.OFF)
                .web(WebApplicationType.NONE)
                .run(args);
        log.info("\n");
    }

    @Resource
    private UserRepository userRepository;

    @PostConstruct
    public void init() {
        // 初始化数据
        for (int i = 0; i < 10; i++) {
            User user = User.builder().name("ZS" + i).build();
            userRepository.save(user);
        }
    }

    @Resource
    private UserService userService;

    @Resource
    private Environment environment;

    @Override
    public void run(ApplicationArguments args) throws InterruptedException {
        // 测试缓存,观察是否有SQL输出

        PageRequest pageable = PageRequest.of(0, 5);
        userService.page(pageable);
        for (int i = 0; i < 5; i++) {
            userService.page(pageable);
            log.info("Reading page cache...");
        }
        // 由于配置是5秒中后缓存失效,这里休眠后重新读取
        TimeUnit.MILLISECONDS.sleep(Integer.parseInt(environment.getProperty("spring.cache.redis.time-to-live", "5000")));
        log.warn("Page Cache expired : " + userService.page(pageable).getTotalElements());

        log.info("\n");

        // Test CRUD Cache![enter description here](http://image.mariojd.cn/happyjared/201949/20190409101855.png)
        User user = userService.add("李四");
        int userId = user.getId();
        userService.get(userId);
        log.info("Reading user cache..." + userService.get(userId));

        userService.update(userId, "王五");
        log.info("Reading new user cache..." + userService.get(userId));

        userService.delete(userId);
        log.warn("User Cache delete : " + userService.get(userId));
    }
    
}

从图中的红框部分输出可以看到,这些查询走了缓存,如果需要在 redis 中查看缓存内容,可以将配置中的 TTL 时间调大:

测试输出

扩展操作

Spring 允许开发者们通过自定义 KeyGenerator 来覆盖繁琐的 Key 定义(非必须),同时也允许我们配置自定义的 CacheManager,下面来看看如何编写 KeyGenerator:

@CacheConfig
@Slf4j
public class CustomKeyGenerator implements KeyGenerator {

    @Override
    public Object generate(Object target, Method method, Object... params) {
        // 类名.方法名.参数值
        String keySuffix = target.getClass().getSimpleName() + "." + method.getName() + "." + Arrays.toString(params);
        log.info("Cache key suffix : {}", keySuffix);
        return keySuffix;
    }

}

接着配置注册为 Bean:

@Configuration
public class CustomConfig {

    @Bean
    public CustomKeyGenerator customKeyGenerator() {
        return new CustomKeyGenerator();
    }

}

编写 Service 用于测试,具体的测试代码这里就不再贴出来了,有兴趣的可以自行尝试。

@Slf4j
@Service
@CacheConfig(cacheNames = "user")
public class UserSupportService {

    @Resource
    private UserRepository userRepository;

    /**
     * 使用了自定义的KeyGenerator
     * 缓存生效需满足:存在不为空的入参i、且返回值非空
     */
    @Cacheable(keyGenerator = "customKeyGenerator", condition = "#i!=null", unless = "#result.isEmpty()")
    public List<User> list(Integer i) {
        return userRepository.findAll();
    }

}

参考阅读

Spring-Boot-Caching

示例源码
欢迎关注我的个人公众号:超级码里奥
如果这对您有帮助,欢迎点赞和分享,转载请注明出处

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容