Spring框架接入单机Redis两种实现方式解析

下面我将详细讲解“Spring框架接入单机Redis两种实现方式解析”的完整攻略。

1. 简介

Redis是一个开源的内存数据结构存储系统，它支持多种数据结构，包括字符串、哈希、列表、集合、有序集合等。Redis具有高性能和可靠性，广泛用于缓存、消息队列、排行榜、计数器等场景。

Spring框架是一个流行的Java应用开发框架，提供了很多便利的特性，如依赖注入、切面编程、面向切面编程等，可以帮助我们快速地开发高质量的应用程序。

在Spring框架中，我们可以很方便地接入Redis，利用它的缓存特性提升应用性能。本文将介绍两种Spring框架接入单机Redis的实现方式，帮助你快速上手使用Redis。

2. 实现方式一：注解方式配置Redis

2.1 导入Redis依赖

首先，在Spring Boot项目的pom.xml文件中导入Redis相关依赖：

<dependencies>
    <!-- Redis依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>
</dependencies>

2.2 配置Redis连接信息

然后，在Spring Boot项目的application.properties（或application.yml）文件中配置Redis连接信息：

# Redis配置
spring.redis.host=localhost # Redis服务器地址
spring.redis.port=6379      # Redis服务器端口号
spring.redis.password=      # Redis服务器密码（如果有的话）

2.3 编写缓存代码

最后，在需要使用Redis的地方使用注解方式定义缓存的使用：

@Component
public class UserServiceImpl implements UserService {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    @Override
    @Cacheable(value = "user", key = "#id")
    public User getUserById(String id) {
        // 尝试从缓存中获取用户信息
        User user = (User)redisTemplate.opsForValue().get("user:" + id);
        if(user != null) {
            return user;
        }

        // 如果缓存不存在，则从数据库中获取用户信息
        user = userRepository.findById(id);
        if(user != null) {
            // 将用户信息写入缓存，有效期为1小时
            redisTemplate.opsForValue().set("user:" + id, user, 1, TimeUnit.HOURS);
        }

        return user;
    }

}

在上述代码中，我们使用了@Cacheable注解，启用了缓存，并定义了value属性为user，表示缓存的名称，key属性为#id，表示缓存的键。在方法执行时，首先尝试从缓存中获取用户信息（键为user:${id}），如果缓存不存在，则从数据库中获取用户信息，并将用户信息写入缓存中，设置有效期为1小时。

2.4 示例说明

请参考以下示例：

@RestController
@RequestMapping("/api/users")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public User getUserById(@PathVariable("id") String id) {
        return userService.getUserById(id);
    }

}

在上述代码中，我们使用@GetMapping注解定义了RESTful API的GET请求，路径为/api/users/{id}，使用@PathVariable注解映射请求路径中的{id}参数。在方法中，调用userService.getUserById方法获取指定ID的用户信息。

3. 实现方式二：配置类方式配置Redis

3.1 导入Redis依赖

首先，在Spring Boot项目的pom.xml文件中导入Redis相关依赖（同方式一），如下所示：

<dependencies>
    <!-- Redis依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>
</dependencies>

3.2 配置Redis连接信息

然后，在Spring Boot项目中，创建一个Redis配置类，用于配置Redis连接信息：

@Configuration
public class RedisConfig {

    @Autowired
    private Environment env;

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        LettuceConnectionFactory factory = new LettuceConnectionFactory();
        factory.setHostName(env.getProperty("spring.redis.host"));
        factory.setPort(Integer.parseInt(env.getProperty("spring.redis.port")));
        factory.setPassword(env.getProperty("spring.redis.password"));
        return factory;
    }

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(factory);
        template.setKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        return template;
    }

    @Bean
    public CacheManager cacheManager(RedisConnectionFactory factory) {
        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
            .entryTtl(Duration.ofHours(1));
        return RedisCacheManager.builder(factory)
            .cacheDefaults(config)
            .transactionAware()
            .build();
    }

}

在上述代码中，我们使用@Configuration注解标注了Redis配置类，并使用@Autowired注解注入了Spring Boot应用程序的配置属性。在配置类中，我们定义了以下三个@Bean方法：

redisConnectionFactory()方法：创建一个Lettuce连接工厂，用于连接Redis服务器。在该方法中，我们使用上述配置属性配置连接信息，并返回连接工厂对象。
redisTemplate()方法：创建一个RedisTemplate对象，用于与Redis进行交互。在该方法中，我们指定了键和值的序列化方式，并将连接工厂对象作为参数传入。
cacheManager()方法：创建一个RedisCacheManager对象，用于管理缓存。在该方法中，我们指定了缓存的默认有效期，并将连接工厂对象作为参数传入。

3.3 编写缓存代码

最后，在需要使用Redis的地方使用配置类方式定义缓存的使用：

@Component
public class UserServiceImpl implements UserService {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    @Autowired
    private UserRepository userRepository;

    @Override
    public User getUserById(String id) {
        // 尝试从缓存中获取用户信息
        User user = (User)redisTemplate.opsForValue().get("user:" + id);
        if(user != null) {
            return user;
        }

        // 如果缓存不存在，则从数据库中获取用户信息
        user = userRepository.findById(id);
        if(user != null) {
            // 将用户信息写入缓存，有效期为1小时
            redisTemplate.opsForValue().set("user:" + id, user, 1, TimeUnit.HOURS);
        }

        return user;
    }

}

在上述代码中，我们使用了RedisTemplate对象与Redis进行交互，并使用了跟方式一完全相同的缓存代码实现。

3.4 示例说明

请参考以下示例：

@RestController
@RequestMapping("/api/users")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public User getUserById(@PathVariable("id") String id) {
        return userService.getUserById(id);
    }

}