Spring Boot 整合 Redis 全面教程：从配置到利用

Redis 是一种高性能的键值存储数据库，而 Spring Boot 是一个简化了开发过程的 Java 框架。将两者团结，可以轻松地在 Spring Boot 项目中利用 Redis 来实现数据缓存、会话管理和分布式锁等功能。
一、添加 Redis 依赖

在 pom.xml 文件中添加 Redis 相关依赖

1. <dependencies>
2.   <!-- Spring Data Redis -->
3.   <dependency>
4.     <groupId>org.springframework.boot</groupId>
5.     <artifactId>spring-boot-starter-data-redis</artifactId>
6.   </dependency>
7. </dependencies>

复制代码

二、配置 Redis 毗连信息

在 application.properties 或 application.yml 配置文件中添加 Redis 毗连信息

1. spring.redis.host=127.0.0.1
2. spring.redis.port=6379

复制代码

根据自己 Redis 服务器配置，修改主机和端口信息
三、利用 RedisTemplate 进行操作

1. 创建 RedisTemplate Bean

在配置类中创建 RedisTemplate Bean，用于进行 Redis 操作

1. @Configuration
2. public class RedisConfig {
4.   @Bean
5.   public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
6.     RedisTemplate<String, Object> template = new RedisTemplate<>();
7.     template.setConnectionFactory(connectionFactory);
8.     template.setKeySerializer(new StringRedisSerializer());
9.     template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
10.     return template;
11.   }
12. }

复制代码

上述示例中利用了 JSON 序列化器来对值进行序列化和反序列化，你也可以根据须要选择其他序列化器。
2. 注入 RedisTemplate

在服务类或控制器中注入 RedisTemplate

1. @Autowired
2. private RedisTemplate<String, Object> redisTemplate;

复制代码

3. 实行 Redis 操作

利用注入的 RedisTemplate 来进行 Redis 操作，设置键值对、获取值等

1. // 设置键值对
2. redisTemplate.opsForValue().set("key", "value");
4. // 获取值
5. String value = (String) redisTemplate.opsForValue().get("key");

复制代码

四、利用 Spring Cache 简化缓存操作

1. 添加 Spring Cache 依赖

在 pom.xml 文件中添加 Spring Cache 相关依赖

1. <dependencies>
2.   <!-- Spring Data Redis -->
3.   <dependency>
4.     <groupId>org.springframework.boot</groupId>
5.     <artifactId>spring-boot-starter-data-redis</artifactId>
6.   </dependency>
7.   
8.   <!-- Spring Cache -->
9.   <dependency>
10.     <groupId>org.springframework.boot</groupId>
11.     <artifactId>spring-boot-starter-cache</artifactId>
12.   </dependency>
13. </dependencies>

复制代码

2. 启用缓存支持

在启动类上添加 @EnableCaching 注解，启用缓存支持

1. @SpringBootApplication
2. @EnableCaching
3. public class Application {
4.   // ...
5. }

复制代码

3. 利用缓存注解

在服务类或方法上利用 Spring Cache 提供的缓存注解，如 @Cacheable、@CachePut、@CacheEvict

1. @Service
2. public class demoService {
4.   @Cacheable(value = "cacheName", key = "#id")
5.   public Object getData(String id) {
6.     // 从数据库或其他数据源获取数据
7.     return data;
8.   }
10.   @CachePut(value = "cacheName", key = "#id")
11.   public Object updateData(String id, Object newData) {
12.     // 更新数据库或其他数据源的数据
13.     return newData;
14.   }
16.   @CacheEvict(value = "cacheName", key = "#id")
17.   public void deleteData(String id) {
18.     // 删除数据库或其他数据源的数据
19.   }
20. }

复制代码

五、利用 Redisson 实现分布式锁

1. 添加 Redisson 依赖

在 pom.xml 文件中添加 Redisson 相关依赖

1. <dependencies>
2.   <!-- Spring Data Redis -->
3.   <dependency>
4.     <groupId>org.springframework.boot</groupId>
5.     <artifactId>spring-boot-starter-data-redis</artifactId>
6.   </dependency>
7.   
8.   <!-- Redisson -->
9.   <dependency>
10.     <groupId>org.redisson</groupId>
11.     <artifactId>redisson-spring-boot-starter</artifactId>
12.     <version>3.16.3</version>
13.   </dependency>
14. </dependencies>

复制代码

2. 配置 Redisson

在配置文件中添加 Redisson 配置，例如 application.properties

1. # 单节点 Redisson 配置
2. spring.redis.redisson.config=classpath:redisson-single-node.yml

复制代码

在 redisson-single-node.yml 配置文件中配置 Redisson 的毗连信息
3. 利用 Redisson 获取锁：

在你的代码中利用 Redisson 获取分布式锁：

1. @Autowired
2. private RedissonClient redissonClient;
4. public void doSomething() {
5.   RLock lock = redissonClient.getLock("lockName");
6.   try {
7.     lock.lock();
8.     // 执行需要加锁的操作
9.   } finally {
10.     lock.unlock();
11.   }
12. }

复制代码

六、完满 Redis 的其他配置

除了根本配置，还可以根据现实需求完满 Redis 的其他配置，例如毗连池配置、超时设置等。
一、毗连池配置

Redis 利用毗连池来管理和复用与 Redis 服务器的毗连，以提高毗连的效率和性能。
1. 在 配置文件中配置毗连池相关参数

打开 Redis 配置文件 redis.conf，找到以下配置项并进行修改

1. # 最大连接数
2. maxclients 10000
4. # TCP 连接的队列长度
5. tcp-backlog 511
7. # 连接池中的最大空闲连接数
8. maxidle 100
10. # 连接池中的最小空闲连接数
11. minidle 10
13. # 连接超时时间（毫秒）
14. timeout 3000
16. # 是否开启 TCP 连接的保活机制
17. tcp-keepalive 0

复制代码

2. 通过客户端毗连池配置对象进行配置

在 Spring Boot 项目中，可以通过 Redis 毗连池配置对象 JedisPoolConfig 进行配置

1. @Configuration
2. public class RedisConfig {
4.   @Bean
5.   public JedisPoolConfig jedisPoolConfig() {
6.     JedisPoolConfig poolConfig = new JedisPoolConfig();
7.     poolConfig.setMaxTotal(10000);
8.     poolConfig.setMaxIdle(100);
9.     poolConfig.setMinIdle(10);
10.     poolConfig.setMaxWaitMillis(3000);
11.     // 其他配置项设置
12.     return poolConfig;
13.   }
15.   @Bean
16.   public JedisConnectionFactory jedisConnectionFactory(JedisPoolConfig poolConfig) {
17.     RedisStandaloneConfiguration config = new RedisStandaloneConfiguration();
18.     config.setHostName("127.0.0.1");
19.     config.setPort(6379);
20.     // 其他 Redis 配置项设置
22.     JedisClientConfiguration clientConfig = JedisClientConfiguration.builder()
23.         .usePooling().poolConfig(poolConfig)
24.         .build();
26.     return new JedisConnectionFactory(config, clientConfig);
27.   }
29.   @Bean
30.   public RedisTemplate<String, Object> redisTemplate(JedisConnectionFactory connectionFactory) {
31.     RedisTemplate<String, Object> template = new RedisTemplate<>();
32.     template.setConnectionFactory(connectionFactory);
33.     template.setKeySerializer(new StringRedisSerializer());
34.     template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
35.     return template;
36.   }
37. }

复制代码

二、超时设置

超时设置用于控制 Redis 操作的超时时间，以防止长时间的阻塞或无响应操作
1. 配置 Redis 毗连超时时间

在 Redis 配置文件中设置 timeout 参数，单位为毫秒，如下设置毗连超时时间为 5000 毫秒

1. timeout 5000

复制代码

2. 通过 Redis 客户端配置对象进行配置

通过 JedisClientConfiguration 进行配置，将读取操作的超时时间设置为 5秒

1. @Bean
2. public JedisClientConfiguration jedisClientConfiguration() {
3.   Duration timeout = Duration.ofSeconds(5);
5.   return JedisClientConfiguration.builder()
6.       .readTimeout(timeout)
7.       .build();
8. }
10. @Bean
11. public JedisConnectionFactory jedisConnectionFactory(JedisClientConfiguration clientConfig) {
12.   // 其他配置项设置
13.   return new JedisConnectionFactory(config, clientConfig);
14. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。