Spring Boot 整合 Redis 全面教程：從配置到使用

Redis 是一種高性能的鍵值存儲數據庫，而 Spring Boot 是一個簡化了開發過程的 Java 框架。將兩者結合，可以輕鬆地在 Spring Boot 項目中使用 Redis 來實現數據緩存、會話管理和分佈式鎖等功能。

一、添加 Redis 依賴

在 pom.xml 文件中添加 Redis 相關依賴

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

二、配置 Redis 連接信息

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

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

根據自己 Redis 服務器配置，修改主機和端口信息

三、使用 RedisTemplate 進行操作

1. 創建 RedisTemplate Bean

在配置類中創建 RedisTemplate Bean，用於進行 Redis 操作

@Configuration
public class RedisConfig {

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

上述示例中使用了 JSON 序列化器來對值進行序列化和反序列化，你也可以根據需要選擇其他序列化器。

2. 注入 RedisTemplate

在服務類或控制器中注入 RedisTemplate

@Autowired
private RedisTemplate<String, Object> redisTemplate;

3. 執行 Redis 操作

使用注入的 RedisTemplate 來進行 Redis 操作，設置鍵值對、獲取值等

// 設置鍵值對
redisTemplate.opsForValue().set("key", "value");

// 獲取值
String value = (String) redisTemplate.opsForValue().get("key");

四、使用 Spring Cache 簡化緩存操作

1. 添加 Spring Cache 依賴

在 pom.xml 文件中添加 Spring Cache 相關依賴

<dependencies>
  <!-- Spring Data Redis -->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
  </dependency>
  
  <!-- Spring Cache -->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
  </dependency>
</dependencies>

2. 啓用緩存支持

在啓動類上添加 @EnableCaching 註解，啓用緩存支持

@SpringBootApplication
@EnableCaching
public class Application {
  // ...
}

3. 使用緩存註解

在服務類或方法上使用 Spring Cache 提供的緩存註解，如 @Cacheable、@CachePut、@CacheEvict

@Service
public class demoService {

  @Cacheable(value = "cacheName", key = "#id")
  public Object getData(String id) {
    // 從數據庫或其他數據源獲取數據
    return data;
  }

  @CachePut(value = "cacheName", key = "#id")
  public Object updateData(String id, Object newData) {
    // 更新數據庫或其他數據源的數據
    return newData;
  }

  @CacheEvict(value = "cacheName", key = "#id")
  public void deleteData(String id) {
    // 刪除數據庫或其他數據源的數據
  }
}

五、使用 Redisson 實現分佈式鎖

1. 添加 Redisson 依賴

在 pom.xml 文件中添加 Redisson 相關依賴

<dependencies>
  <!-- Spring Data Redis -->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
  </dependency>
  
  <!-- Redisson -->
  <dependency>
    <groupId>org.redisson</groupId>
    <artifactId>redisson-spring-boot-starter</artifactId>
    <version>3.16.3</version>
  </dependency>
</dependencies>

2. 配置 Redisson

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

# 單節點 Redisson 配置
spring.redis.redisson.config=classpath:redisson-single-node.yml

在 redisson-single-node.yml 配置文件中配置 Redisson 的連接信息

3. 使用 Redisson 獲取鎖：

在你的代碼中使用 Redisson 獲取分佈式鎖：

@Autowired
private RedissonClient redissonClient;

public void doSomething() {
  RLock lock = redissonClient.getLock("lockName");
  try {
    lock.lock();
    // 執行需要加鎖的操作
  } finally {
    lock.unlock();
  }
}

六、完善 Redis 的其他配置

除了基本配置，還可以根據實際需求完善 Redis 的其他配置，例如連接池配置、超時設置等。

一、連接池配置

Redis 使用連接池來管理和複用與 Redis 服務器的連接，以提高連接的效率和性能。

1. 在 配置文件中配置連接池相關參數

打開 Redis 配置文件 redis.conf，找到以下配置項並進行修改

# 最大連接數
maxclients 10000

# TCP 連接的隊列長度
tcp-backlog 511

# 連接池中的最大空閒連接數
maxidle 100

# 連接池中的最小空閒連接數
minidle 10

# 連接超時時間（毫秒）
timeout 3000

# 是否開啓 TCP 連接的保活機制
tcp-keepalive 0

2. 通過客戶端連接池配置對象進行配置

在 Spring Boot 項目中，可以通過 Redis 連接池配置對象 JedisPoolConfig 進行配置

@Configuration
public class RedisConfig {

  @Bean
  public JedisPoolConfig jedisPoolConfig() {
    JedisPoolConfig poolConfig = new JedisPoolConfig();
    poolConfig.setMaxTotal(10000);
    poolConfig.setMaxIdle(100);
    poolConfig.setMinIdle(10);
    poolConfig.setMaxWaitMillis(3000);
    // 其他配置項設置
    return poolConfig;
  }

  @Bean
  public JedisConnectionFactory jedisConnectionFactory(JedisPoolConfig poolConfig) {
    RedisStandaloneConfiguration config = new RedisStandaloneConfiguration();
    config.setHostName("127.0.0.1");
    config.setPort(6379);
    // 其他 Redis 配置項設置

    JedisClientConfiguration clientConfig = JedisClientConfiguration.builder()
        .usePooling().poolConfig(poolConfig)
        .build();

    return new JedisConnectionFactory(config, clientConfig);
  }

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

二、超時設置

超時設置用於控制 Redis 操作的超時時間，以防止長時間的阻塞或無響應操作

1. 配置 Redis 連接超時時間

在 Redis 配置文件中設置 timeout 參數，單位爲毫秒，如下設置連接超時時間爲 5000 毫秒

timeout 5000

2. 通過 Redis 客戶端配置對象進行配置

通過 JedisClientConfiguration 進行配置，將讀取操作的超時時間設置爲 5秒

@Bean
public JedisClientConfiguration jedisClientConfiguration() {
  Duration timeout = Duration.ofSeconds(5);

  return JedisClientConfiguration.builder()
      .readTimeout(timeout)
      .build();
}

@Bean
public JedisConnectionFactory jedisConnectionFactory(JedisClientConfiguration clientConfig) {
  // 其他配置項設置
  return new JedisConnectionFactory(config, clientConfig);
}