springboot集成哨兵RedissonClient-CFANZ编程社区

Spring Boot 集成哨兵 RedissonClient

在微服务架构中，Redis 被广泛用于缓存和分布式锁等场景。Redisson 是一个对 Redis 客户端的封装，其支持了多种高级特性。本文将介绍如何在 Spring Boot 项目中集成 RedissonClient，并结合哨兵模式实现高可用的 Redis 服务。

什么是 Redisson？

Redisson 是一个 Java 的 Redis 客户端，与标准的 Jedis 和 Lettuce 相比，Redisson 提供了更高层次的封装，支持分布式锁、分布式对象、异步 API 等功能。Redisson 通过基于 Spring 的集合类型，方便地将 Redis 的数据结构映射成Java对象。

哨兵模式

Redis Sentinel 是 Redis 自带的高可用解决方案。通过哨兵，可以监控 Redis 主从配置，并在主节点发生故障时自动切换。Redisson 可以轻松地与哨兵模式结合使用。

环境准备

Maven 依赖

您需要为 Maven 项目添加以下依赖：

<dependency>
    <groupId>org.redisson</groupId>
    <artifactId>redisson-spring-boot-starter</artifactId>
    <version>3.16.1</version>
</dependency>

配置文件

在 application.yml 中添加 Redis Sentinel 配置信息，例如：

spring:
  redis:
    sentinel:
      master: your-master
      nodes:
        - host1:26379
        - host2:26379
        - host3:26379
  redisson:
    singleServerConfig:
      address: "redis://your-sentinel-host:6379"
      password: your-redis-password

创建 RedissonClient Bean

在 Spring Boot 应用中，您需要创建一个 Bean 来配置 RedissonClient。可以在您的主应用程序类或者一个配置类中完成：

import org.redisson Redisson;
import org.redisson.config.Config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class RedissonConfig {

    @Bean
    public RedissonClient redissonClient() {
        Config config = new Config();
        config.useSentinelServers()
                .setMasterName("your-master")
                .addSentinelAddress("redis://host1:26379", "redis://host2:26379", "redis://host3:26379")
                .setPassword("your-redis-password");
        return Redisson.create(config);
    }
}

使用 RedissonClient

RedissonClient 的用法非常直观，下面是一些常用的功能示例。

1. 使用 RMap 存储数据

import org.redisson.api.RedissonClient;
import org.redisson.api.RMap;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class RedisService {

    @Autowired
    private RedissonClient redissonClient;

    public void saveData(String key, String value) {
        RMap<String, String> map = redissonClient.getMap("myMap");
        map.put(key, value);
    }

    public String getData(String key) {
        RMap<String, String> map = redissonClient.getMap("myMap");
        return map.get(key);
    }
}

2. 使用分布式锁

import org.redisson.api.RLock;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class LockService {

    @Autowired
    private RedissonClient redissonClient;

    public void performLockedTask() {
        RLock lock = redissonClient.getLock("myLock");
        lock.lock();
        try {
            // 执行需要被锁定的业务逻辑
        } finally {
            lock.unlock();
        }
    }
}

序列图

在这个部分，我们将展示 RedissonClient 如何与 Redis 服务进行交互的简单序列图。

sequenceDiagram
    participant APP as 应用程序
    participant REDISS as RedissonClient
    participant S1 as 哨兵节点1
    participant S2 as 哨兵节点2
    participant S3 as 哨兵节点3
    participant MASTER as 主节点

    APP->>REDISS: 初始化请求
    REDISS->>S1: 获取master节点信息
    S1-->>REDISS: 返回master节点 (MASTER)
    REDISS->>MASTER: 发送数据操作请求
    MASTER-->>REDISS: 操作成功
    REDISS-->>APP: 返回结果