Redis 安装与 Spring Boot 集成指南

news2025/1/11 23:33:46

安装 Redis 和将其与 Spring Boot 应用集成是构建高效缓存解决方案的常见步骤。以下是详细的指南，帮助你在本地环境中安装 Redis，并在 Spring Boot 项目中配置和使用它。

1. 安装 Redis

Windows 环境

Redis 官方并不直接支持 Windows，但你可以通过以下几种方式在 Windows 上运行 Redis：

Chocolatey：如果已经安装了 Chocolatey 包管理器，可以通过命令行安装 Redis。
```
choco install redis-64
```
Docker：推荐使用 Docker 来运行 Redis 容器，这样可以避免兼容性问题。
```
docker pull redis
docker run --name myredis -p 6379:6379 -d redis
```
MS Open Tech 版本：也可以从 MSOpenTech GitHub 下载适用于 Windows 的 Redis 版本。

macOS 环境

macOS 用户可以通过 Homebrew 安装 Redis：

brew install redis

启动 Redis 服务：

brew services start redis

Linux 环境

大多数 Linux 发行版自带 Redis 包，可以直接通过包管理器安装：

sudo apt-get update
sudo apt-get install redis-server

启动 Redis 服务：

sudo systemctl start redis.service

确保 Redis 正常运行后，可以通过 redis-cli 命令行工具测试连接：

redis-cli ping

如果返回 PONG，则表示 Redis 已经正确安装并正在运行。

2. 在 Spring Boot 中配置 Redis

添加依赖项

首先，在你的 build.gradle 或 pom.xml 文件中添加必要的依赖项以启用对 Redis 的支持。

Gradle

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-redis'
    // 如果你打算使用 Lettuce 连接池
    implementation 'io.lettuce:lettuce-core'
}

Maven

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- 如果你打算使用 Lettuce 连接池 -->
<dependency>
    <groupId>io.lettuce</groupId>
    <artifactId>lettuce-core</artifactId>
</dependency>

配置 application.properties 或 application.yml

接下来，编辑 application.properties 或 application.yml 文件来配置 Redis 连接信息。

application.properties

# Redis server address (default is localhost)
spring.redis.host=localhost
# Redis server port (default is 6379)
spring.redis.port=6379
# Redis password if any
# spring.redis.password=
# Database index used by the connection factory
# spring.redis.database=0
# Connection pool settings
spring.redis.lettuce.pool.max-active=8
spring.redis.lettuce.pool.max-idle=8
spring.redis.lettuce.pool.min-idle=0

application.yml

spring:
  redis:
    host: localhost
    port: 6379
    # password: your_password_here
    database: 0
    lettuce:
      pool:
        max-active: 8
        max-idle: 8
        min-idle: 0

编写 Redis 操作代码

最后，编写一些简单的 Java 类来进行 Redis 操作。Spring Data Redis 提供了 RedisTemplate 和 StringRedisTemplate，它们简化了与 Redis 的交互。

示例：RedisConfig.java

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.StringRedisSerializer;

@Configuration
public class RedisConfig {

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

示例：RedisService.java

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;

@Service
public class RedisService {

    private final RedisTemplate<String, Object> redisTemplate;

    @Autowired
    public RedisService(RedisTemplate<String, Object> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    public void set(String key, Object value) {
        redisTemplate.opsForValue().set(key, value);
    }

    public Object get(String key) {
        return redisTemplate.opsForValue().get(key);
    }

    public void delete(String key) {
        redisTemplate.delete(key);
    }
}

3. 测试 Redis 功能

创建一个简单的控制器或单元测试来验证 Redis 是否正常工作。

示例：RedisController.java

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api/redis")
public class RedisController {

    private final RedisService redisService;

    @Autowired
    public RedisController(RedisService redisService) {
        this.redisService = redisService;
    }

    @PostMapping("/set/{key}/{value}")
    public String set(@PathVariable String key, @PathVariable String value) {
        redisService.set(key, value);
        return "Set key " + key + " with value " + value;
    }

    @GetMapping("/get/{key}")
    public Object get(@PathVariable String key) {
        return redisService.get(key);
    }

    @DeleteMapping("/delete/{key}")
    public String delete(@PathVariable String key) {
        redisService.delete(key);
        return "Deleted key " + key;
    }
}