【Spring Boot】如何运用Spring Cache并设置缓存失效时间

news2024/9/29 23:26:48

简单描述

Spring Cache是一个框架，实现了基于注解的缓存功能，只需要简单地加一个注解，就能实现缓存功能。Spring Cache提供了一层抽象，底层可以切换不同的cache实现。具体就是通过CacheManager接口来统一不同的缓存技术。CacheManager是Spring提供的各种缓存技术抽象接口。

常用注解

注解	说明
@EnableCaching	开启缓存注解功能
@Cacheable	在方法执行前spring先查看缓存中是否有数据，如果有数据，则直接返回缓存数据；若没有数据，则调用方法并将方法返回值放到缓存中。常用于查询方法
@CachePut	将方法的返回值放到缓存中。常用于更新缓存
@CacheEvict	将一条或多条数据从缓存中删除。常用于失效缓存

在pom.xml文件中导入Spring Cache和Redis相关maven坐标

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-cache</artifactId>
        </dependency>

在启动类上加入@EnableCaching的缓存注解功能

package com.app.studypro;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;
import org.springframework.cache.annotation.EnableCaching;

/**
 * 启动类
 * 注解@EnableCaching：开启缓存注解功能
 *
 * @author Administrator
 */
@SpringBootApplication
@ServletComponentScan
@EnableCaching
public class StudyProApplication {

    public static void main(String[] args) {
        SpringApplication.run(StudyProApplication.class, args);
    }

}

若需要将数据存入缓存，则缓存对象一定要实现Serializable接口

package com.app.studypro.common;

import lombok.Data;

@Data
public class ResultBean<T> implements Serializable {

    private static final long serialVersionUID = -6759928086797729382L;


}

统一归类管理Redis的cacheName缓存失效时间，并设置相应的缓存序列化器

package com.app.studypro.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.StringRedisSerializer;

import java.time.Duration;
import java.util.HashMap;
import java.util.Map;

/**
 * Redis的配置信息
 *
 * @author Administrator
 */
@Configuration
@Slf4j
public class RedisConfig extends CachingConfigurerSupport {

    @Bean
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        RedisTemplate<Object, Object> redisTemplate = new RedisTemplate<>();
        log.info("Redis的KeySerializer设置为：{}", StringRedisSerializer.class);
        // 默认的Key序列化器为：JdkSerializationRedisSerializer
        // 将key的序列化器改为StringRedisSerializer，以便可以在Redis的key设置什么就显示什么，不进行转化
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setConnectionFactory(connectionFactory);
        return redisTemplate;
    }

    /**
     * 缓存管理
     *
     * @return 返回缓存管理信息
     */
    @Bean
    public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
        // 缓存配置
        RedisCacheConfiguration defaultCacheConfig = RedisCacheConfiguration.defaultCacheConfig()
                // 默认没有特殊指定的缓存，设置失效时间为1天
                .entryTtl(Duration.ofDays(1))
                // 在缓存名称前加上前缀
                .computePrefixWith(cacheName -> "default:" + cacheName);
        log.info("设置redis缓存的默认失效时间，失效时间默认为：{}天", defaultCacheConfig.getTtl().toDays());
        // 针对不同cacheName，设置不同的失效时间，map的key是缓存名称（注解设定的value/cacheNames），value是缓存的失效配置
        Map<String, RedisCacheConfiguration> initialCacheConfiguration = new HashMap<String, RedisCacheConfiguration>(8);
        // 设定失效时间为1小时
        initialCacheConfiguration.put("userCache", getDefaultSimpleConfiguration().entryTtl(Duration.ofHours(1)));
        // 设定失效时间为10分钟
        initialCacheConfiguration.put("userCache1", getDefaultSimpleConfiguration().entryTtl(Duration.ofMinutes(10)));
        // 设定失效时间为12小时
        initialCacheConfiguration.put("userCache2", getDefaultSimpleConfiguration().entryTtl(Duration.ofHours(12)));
        // ...如果有其他的不同cacheName需要控制失效时间，以此类推即可进行添加
        return RedisCacheManager.builder(redisConnectionFactory)
                // 设置缓存默认失效时间配置，也就是动态或者未指定的缓存将会使用当前配置
                .cacheDefaults(defaultCacheConfig)
                // 不同不同cacheName的个性化配置
                .withInitialCacheConfigurations(initialCacheConfiguration).build();
    }

    /**
     * 覆盖默认的构造key[默认拼接的时候是两个冒号（::）]，否则会多出一个冒号
     *
     * @return 返回缓存配置信息
     */
    private RedisCacheConfiguration getDefaultSimpleConfiguration() {
        return RedisCacheConfiguration.defaultCacheConfig().computePrefixWith(cacheName -> cacheName + ":");
    }

}

在控制器Controller的请求方法上添加相应的注解

    @CachePut(value = "userCache", key = "#result.data.id")
    @PostMapping
    public ResultBean<User> save(HttpServletRequest request, @RequestBody User user) {
  
        return ResultBean.success(user);
    }

    @CacheEvict(value = "userCache", allEntries = true)
    @PutMapping
    public ResultBean<String> update(HttpServletRequest request, @RequestBody User user) {

        return ResultBean.success("用户信息修改成功");
    }

    @Cacheable(value = "userCache3", key = "#id")
    @GetMapping("/{id}")
    public ResultBean<User> getById(@PathVariable Long id) {

    }

    @GetMapping("/page")
    @Cacheable(value = "userCache", key = "#page+'_'+#pageSize+'_'+#username", unless = "#result.data.total==0")
    public ResultBean<Page<User>> page(int page, int pageSize, String username) {

        return ResultBean.success(pageInfo);
    }