Spring boot詳解緩存redis實現(xiàn)定時過期方法

更新時間：2022年07月12日 09:33:59 作者：鄭小白

本篇文章分享的就是spring boot中的一個輪子，spring cache注解的方式實現(xiàn)接口數(shù)據(jù)緩存。默認的配置想非常簡單，但是有一個弊端是緩存數(shù)據(jù)為永久緩存，本次將介紹如何設置接口緩存數(shù)據(jù)的過期時間

前言

使用redis進行緩存數(shù)據(jù)，是目前比較常用的緩存解決方案。常用的緩存形式有一下幾種：

1.純原生代碼進行redis的增刪改查，手工編寫緩存工具類，由開發(fā)者在代碼中進行調(diào)用。

優(yōu)勢：代碼由實際使用的開發(fā)者進行維護，便于定制化的改造。

2.使用市場上已有的緩存工具，也就是大家常說的大佬的輪子

優(yōu)勢：方便快捷，提升開發(fā)效率

添加依賴

修改pom文件引入如下配置

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.7.0</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.test</groupId>
	<artifactId>common-project</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>common-project</name>
	<description></description>
	<properties>
		<java.version>1.8</java.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-redis</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.24</version>
		</dependency>
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>2.0.7</version>
		</dependency>
	</dependencies>
</project>

添加配置

application.yml中增加redisd 配置信息

spring:
redis:
host: localhost
port: 6379
database: 0
password: *****
timeout: 10000
server:
port: 8082

常規(guī)緩存

在spring 3.1版本以后，注意是spring的版本，不是spring boot的版本。在spring-context包中合并進去了spring Cache的內(nèi)容?？梢允褂米⒔夥绞竭M行緩存設定。

開啟緩存

開啟緩存只需要在入口函數(shù)上增加@EnableCaching注解

@SpringBootApplication
@EnableCaching //開啟緩存
public class CommonApplication {
    public static void main(String[] args) {
        SpringApplication.run(CommonApplication.class,args);
    }
}

設置緩存空間

設置緩存空間可能大家不好理解，換一個通俗的說法就是設置要緩存的類，把這個類下面要緩存的數(shù)據(jù)的key加上一個統(tǒng)一的前綴，也是一個注解：@CacheConfig這里可以設置具體的值如下

@RestController
@RequestMapping("/test")
@CacheConfig(cacheNames = "test-controller")
public class TestController {
    @Autowired
    TestService testService;
    @RequestMapping("/testCache")
    @Cacheable(key = "'testCache'",unless = "#result==null")
    public Object testCache(){
        return testService.getUserInfoList();
    }
}

這里的cacheNames就是我上面說的緩存空間，也許這樣還是沒辦法理解，請看在redis中的緩存情況：

就是說如果我在TestController類下設置的接口緩存數(shù)據(jù)都會緩存到test-controller這個緩存空間里。

設置緩存

這里就是指具體要緩存的接口數(shù)據(jù)，使用注解：@Cacheable，具體代碼參見上面的代碼塊。

截止到這里，就可以啟動服務，調(diào)用接口，會發(fā)現(xiàn)數(shù)據(jù)已經(jīng)可以緩存到redis中了。但是，這里有一個問題，就是緩存下來的數(shù)據(jù)，是永久緩存，一旦接口實際的數(shù)據(jù)有更新，只能通過再設置更新方法來更新緩存，或者刪除緩存，我們都知道redis本身是支持設置key的過期時間的，這一特性，讓緩存變得更加優(yōu)雅，所以我們的程序也要有?。?！

增加設置緩存過期時間

想要設置緩存過期時間，也并不是很麻煩，只是需要單獨增加一個redis的配置類，自定義修改一下緩存管理器就可以了

@Configuration
public class RedisCacheManagerConfig {
    /**
     * redis模板配置以及序列化配置
     *
     * @param factory 工廠
     * @return {@link RedisTemplate}<{@link String}, {@link Object}>
     */
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(factory);
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
        //key 采用的String 的序列化方式
        template.setKeySerializer(stringRedisSerializer);
        //hashde key 也采用String的序列化方式
        template.setHashKeySerializer(stringRedisSerializer);
        //value 序列化方式采用jackson
        template.setValueSerializer(jackson2JsonRedisSerializer);
        //hash 的 value序列化方式采用jackson
        template.setHashKeySerializer(jackson2JsonRedisSerializer);
        template.afterPropertiesSet();
        template.afterPropertiesSet();
        return template;
    }
    @Bean
    RedisCacheWriter writer(RedisTemplate<String, Object> redisTemplate) {
        return RedisCacheWriter.nonLockingRedisCacheWriter(Objects.requireNonNull(redisTemplate.getConnectionFactory()));
    }
    @Bean
    CacheManager cacheManager(RedisCacheWriter writer) {
        RedisSerializer<String> redisSerializer = new StringRedisSerializer();
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        Map<String, RedisCacheConfiguration> configurationMap = new HashMap<>();
        // 配置序列化（解決亂碼的問題）
        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
                .entryTtl(Duration.ofHours(1))//time
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer))
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer))
                .disableCachingNullValues();
        //此處可以自定義緩存空間的緩存的過期時間，可以根據(jù)自己實際情況進行設置，也可以不設置，用統(tǒng)一過期時間
        configurationMap.put("test-controller", config.entryTtl(Duration.ofSeconds(200)));
        //解決查詢緩存轉換異常的問題
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        return RedisCacheManager.builder(writer)
                .initialCacheNames(configurationMap.keySet())
                .withInitialCacheConfigurations(configurationMap)
                //其他緩存空間緩存過期時間為500S
                .cacheDefaults(config.entryTtl(Duration.ofSeconds(500)))
                .build();
    }
}

增加了此配置類之后，之前的代碼均不需要更改，直接啟動程序，測試驗證，可以看到redis中的數(shù)據(jù)是被設置了過期時間的