Spring Boot 集成 Redis 实战案例解析

随着微服务架构的流行，Spring Boot 成为了构建微服务应用的一个重要工具。而在微服务架构中，Redis 作为一个高性能的键值存储数据库，被广泛应用于缓存、会话管理、消息队列等场景。本文将详细介绍如何在 Spring Boot 应用中集成 Redis，并通过一个简单的实战案例来演示其使用方法。

1. 引入依赖

首先，在你的 Spring Boot 项目中引入 Redis 相关的依赖。如果你使用的是 Maven，可以在 pom.xml 文件中添加以下依赖：

xml

深色版本

1<dependency>
2    <groupId>org.springframework.boot</groupId>
3    <artifactId>spring-boot-starter-data-redis</artifactId>
4</dependency>
5
6<!-- 如果你需要使用 Redis 的连接池 -->
7<dependency>
8    <groupId>org.springframework.boot</groupId>
9    <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
10</dependency>
11
12<!-- Redis 客户端选择 -->
13<dependency>
14    <groupId>redis.clients</groupId>
15    <artifactId>jedis</artifactId>
16</dependency>

2. 配置 Redis

接下来，需要在 application.properties 或者 application.yml 中配置 Redis 连接信息。这里以 application.yml 为例：

yaml

深色版本

1spring:
2  redis:
3    host: localhost
4    port: 6379
5    password: 
6    database: 0
7    timeout: 5000ms
8    jedis:
9      pool:
10        max-active: 8
11        max-wait: -1ms
12        max-idle: 8
13        min-idle: 0

3. 创建 Redis 配置类

为了让 Spring Boot 自动装配 RedisTemplate，我们需要创建一个配置类：

java

深色版本

1@Configuration
2public class RedisConfig {
3
4    @Bean
5    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
6        RedisTemplate<String, Object> template = new RedisTemplate<>();
7        template.setConnectionFactory(factory);
8        
9        // 使用Jackson2JsonRedisSerializer序列化和反序列化redis的value值
10        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
11        ObjectMapper om = new ObjectMapper();
12        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
13        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
14        jackson2JsonRedisSerializer.setObjectMapper(om);
15        template.setValueSerializer(jackson2JsonRedisSerializer);
16        
17        // 使用StringRedisSerializer来序列化和反序列化redis的key值
18        template.setKeySerializer(new StringRedisSerializer());
19        template.afterPropertiesSet();
20        return template;
21    }
22}

4. 编写服务层

接下来我们编写一个简单的服务层，用于与 Redis 进行交互：

java

深色版本

1@Service
2public class CacheService {
3
4    @Autowired
5    private RedisTemplate<String, Object> redisTemplate;
6
7    public void setCache(String key, Object value) {
8        redisTemplate.opsForValue().set(key, value);
9    }
10
11    public Object getCache(String key) {
12        return redisTemplate.opsForValue().get(key);
13    }
14}

5. 实战案例

假设我们要缓存用户的登录状态，当用户成功登录后，我们可以将其信息保存到 Redis 中，当其他模块需要验证用户是否登录时，直接从 Redis 中获取数据即可。

用户登录接口

java

深色版本

1@RestController
2@RequestMapping("/api/auth")
3public class AuthController {
4
5    @Autowired
6    private CacheService cacheService;
7
8    @PostMapping("/login")
9    public ResponseEntity<?> login(@RequestBody User user) {
10        // 假设这里已经验证了用户的登录信息
11        cacheService.setCache(user.getUsername(), user);
12        return ResponseEntity.ok("登录成功！");
13    }
14}

用户信息获取接口

java

深色版本

1@RestController
2@RequestMapping("/api/user")
3public class UserController {
4
5    @Autowired
6    private CacheService cacheService;
7
8    @GetMapping("/{username}")
9    public ResponseEntity<User> getUserInfo(@PathVariable String username) {
10        Object userInfo = cacheService.getCache(username);
11        if (userInfo != null) {
12            return ResponseEntity.ok((User) userInfo);
13        } else {
14            return ResponseEntity.notFound().build();
15        }
16    }
17}

6. 总结

通过上述步骤，我们成功地在 Spring Boot 应用中集成了 Redis，并实现了一个简单的用户登录状态缓存功能。这个例子展示了如何使用 Spring Boot 的自动配置来简化 Redis 的集成过程，并且通过 RedisTemplate 进行基本的操作。希望这篇文章能够帮助你更好地理解如何在实际开发中运用 Spring Boot 和 Redis。