- 作者：老汪软件技巧
- 发表时间：2024-09-01 04:01
- 浏览量：
最近在做 Spring Boot 项目，借此机会，我使用了 Spring Boot 3 和 JDK 17 的组合，整理了一下 Redis 的配置方式，并通过实践实现了常用的 Redis 工具类。我这里主要是整理一下如何在 Spring Boot 3 中使用 Redis，以及如何自定义工具类实现常见的 Redis 操作。
Spring Boot 3.x 和 JDK 17 兼容，特别是在 Spring Boot 3 中引入了 Jakarta EE 9 的命名空间（如包名从 javax 改为 jakarta），因此在使用一些依赖时需要注意兼容性问题。
1、引入依赖
首先，我们要确保项目中已经引入了 Redis 相关的依赖。spring-boot-starter-data-redis 是使用 Redis 的核心依赖，它包含了 RedisTemplate 等必要的类。
在 pom.xml 文件中（如果使用 Maven），确保包含以下依赖：
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-data-redisartifactId>
dependency>
如果使用 Gradle，确保 build.gradle 中有以下依赖：
implementation 'org.springframework.boot:spring-boot-starter-data-redis'
2、application的配置
在 application.yml 文件中添加 Redis 相关的配置，这里有一点需要注意。Springboot2 中的配置是spring.redis，Springboot3 中的配置是spring.data.redis。
参考配置如下所示：
spring:
data:
redis:
host: 127.0.0.1
port: 6379
database: 0
timeout: 1800s # 使用时间格式化
password:
lettuce:
pool:
max-active: 20 # 最大连接数
max-wait: -1 # 最大阻塞等待时间(负数表示没限制)
max-idle: 5 # 最大空闲
min-idle: 0 # 最小空闲
关键参数说明：3、自定义某些配置
为了定制化 Redis 的使用方式，我们可以创建一个 RedisConfig 配置类，自定义 RedisTemplate 和 RedisCacheManager，以便对 Redis 的键值进行序列化和缓存管理。这里定义对象序列化的方式，可以直接往Reids中存放对象，它实现自动转换。
@Configuration
@EnableCaching
public class RedisConfig {
// 配置 RedisTemplate，用于操作 Redis 数据库
@Bean
public RedisTemplate redisTemplate(RedisConnectionFactory factory) {
// 创建 RedisTemplate 对象，用于执行 Redis 操作
RedisTemplate redisTemplate = new RedisTemplate<>();
// 设置连接工厂，用于与 Redis 建立连接
redisTemplate.setConnectionFactory(factory);
// 设置 key 的序列化器，使用 StringRedisSerializer 将 key 序列化为字符串
redisTemplate.setKeySerializer(new StringRedisSerializer());
// 设置 value 的序列化器，使用 GenericJackson2JsonRedisSerializer 将对象序列化为 JSON
redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
// 设置 hash key 的序列化器，使用 StringRedisSerializer 序列化 hash 的 key
redisTemplate.setHashKeySerializer(new StringRedisSerializer());
// 设置 hash value 的序列化器，使用 Jackson2JsonRedisSerializer 将 hash 值序列化为 JSON
redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer 4、自定义工具类
为了简化 Redis 的常用操作（如增删改查），我们可以创建一个 RedisUtil 工具类，便于在项目中使用。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import java.util.Arrays;
import java.util.concurrent.TimeUnit;
/**
* Redis工具类
*
* @author luoxiaodou
*/
@Component
public class RedisUtil {
private static final Logger logger = LoggerFactory.getLogger(RedisUtil.class);
private final RedisTemplate redisTemplate;
/**
* 在 Spring Boot 中，RedisTemplate 是由 Spring 自动配置的。
* Spring Boot 的 spring-boot-starter-data-redis 会自动根据 application.yml
* 或 application.properties 中的 Redis 配置生成
* RedisTemplate 实例，并将其作为一个 Bean 注入到 Spring 容器中。
*
* 从 Spring Framework 4.3 开始，如果类只有一个构造函数，Spring 会自动推断并使用这个构造函数进行依赖注入，无需显式地使用 @Autowired 注解。
* 由于 RedisUtil 类中只有一个构造函数，因此 Spring 自动会将 RedisTemplate 注入到 RedisUtil 中。
*
* @param redisTemplate
*/
@Autowired
public RedisUtil(RedisTemplate redisTemplate) {
this.redisTemplate = redisTemplate;
}
/**
* 设置缓存失效时间
*
* @param key 键
* @param time 时间(秒)
*/
public boolean expire(String key, long time) {
if (time > 0) {
return Boolean.TRUE.equals(redisTemplate.expire(key, time, TimeUnit.SECONDS));
}
return false;
}
/**
* 根据key 获取过期时间
*
* @param key 键 不能为null
* @return 时间(秒) 返回0代表为永久有效
*/
public long getExpire(String key) {
return redisTemplate.getExpire(key, TimeUnit.SECONDS);
}
/**
* 判断key是否存在
*
* @param key 键
* @return true 存在 false不存在
*/
public boolean hasKey(String key) {
return Boolean.TRUE.equals(redisTemplate.hasKey(key));
}
/**
* 删除缓存
*
* @param key 可以传一个值 或多个
*/
public void delete(String... key) {
if (key != null && key.length > 0) {
if (key.length == 1) {
redisTemplate.delete(key[0]);
} else {
redisTemplate.delete(Arrays.asList(key));
}
}
}
/**
* 获取普通缓存
*
* @param key 键
* @return 值
*/
public Object get(String key) {
return key == null ? null : redisTemplate.opsForValue()
.get(key);
}
/**
* 泛型方法 get： 使得 get 方法可以返回不同类型的对象，clazz 参数是对象的类型信息，传入后可以将存储的值反序列化为相应类型。
* Redis 中的数据必须是通过 GenericJackson2JsonRedisSerializer 或类似的 JSON 序列化器存储的，确保可以成功反序列化。
*
* @param key
* @param clazz
* @param
* @return
*/
public T get(String key, Class clazz) {
try {
Object value = redisTemplate.opsForValue()
.get(key);
if (value != null) {
// 自动转换成指定类型
return clazz.cast(value);
}
} catch (Exception e) {
logger.error(e.getMessage(), e);
}
return null;
}
/**
* 普通缓存放入
*
* @param key 键
* @param value 值
* @return true成功 false失败
*/
public boolean set(String key, Object value) {
try {
redisTemplate.opsForValue()
.set(key, value);
return true;
} catch (Exception e) {
logger.error(e.getMessage(), e);
return false;
}
}
/**
* 普通缓存放入并设置时间
*
* @param key 键
* @param value 值
* @param time 时间(秒) time要大于0 如果time小于等于0 将设置无限期
* @return true成功 false 失败
*/
public boolean set(String key, Object value, long time) {
try {
if (time > 0) {
redisTemplate.opsForValue()
.set(key, value, time, TimeUnit.SECONDS);
} else {
set(key, value);
}
return true;
} catch (Exception e) {
logger.error(e.getMessage(), e);
return false;
}
}
}
关键方法说明：
