RedissonClient：ZSet（有序集合）上手教程

介绍：

RedissonClient 是 Redisson 提供的 Java 客户端，用于操作 Redis 数据。ZSet（有序集合）是 Redis 中的一种数据结构，它存储一组唯一的元素，并为每个元素分配一个分数（score），元素根据分数排序。以下是 RedissonClient 操作 ZSet 的详细教程。

使用步骤

1. 添加依赖

首先，确保项目中引入了 Redisson 的依赖。如果使用 Maven，可以在 pom.xml 中添加以下依赖：

<dependency><groupId>org.redisson</groupId><artifactId>redisson</artifactId><version>3.20.0</version> <!-- 请使用最新版本 -->
</dependency>

2. 初始化 RedissonClient

在 Spring Boot 项目中，可以通过配置文件或代码初始化 RedissonClient。

2.1 配置文件方式

在 application.yml 中配置 Redis 连接：

spring:redis:host: localhostport: 6379password: your-password

然后在代码中注入 RedissonClient：

    @Resourceprivate RedissonClient redisson;

2.2 代码方式（不建议）

直接通过代码初始化 RedissonClient：

import org.redisson.Redisson;
import org.redisson.api.RedissonClient;
import org.redisson.config.Config;public class RedissonExample {public static void main(String[] args) {Config config = new Config();config.useSingleServer().setAddress("redis://localhost:6379").setPassword("your-password");RedissonClient redisson = Redisson.create(config);// 使用 redisson 操作 ZSet}
}

3. 操作 ZSet

RedissonClient 提供了 RScoredSortedSet 接口来操作 ZSet。

3.1 添加元素

有分数

import org.redisson.api.RScoredSortedSet;
import org.redisson.api.RedissonClient;
import org.springframework.stereotype.Component;import javax.annotation.Resource;@Component
public class ZSetService {@Resourceprivate RedissonClient redisson;/*** 添加元素到 ZSet** @param key    ZSet 的键* @param value  元素值* @param score  分数（用于排序）*/public void addToZSet(String key, String value, double score) {RScoredSortedSet<String> zSet = redisson.getScoredSortedSet(key);zSet.add(score, value);}
}

无分数，使用当前时间戳作为分数

    /*** 向 ZSet 中添加元素* 使用当前时间戳作为分数** @param key   ZSet 的键名* @param value 元素的值*/public void addToZSet(String key, String value) {// 获取当前时间戳作为分数，时间越新，时间戳越大。double score = new Date().getTime();RScoredSortedSet<String> zSet = redisson.getScoredSortedSet(key);zSet.add(score, value);}

3.2 获取元素

获取所有元素

    /*** 获取指定键的 ZSet 中的所有元素* @param key ZSet 的键名* @return 包含 ZSet 所有元素的集合*/public Collection<String> getAllZSetElements(String key) {RScoredSortedSet<String> zSet = redisson.getScoredSortedSet(key);return zSet.readAll();}

按分数范围获取元素：

/*** 按分数范围获取元素** @param key  ZSet 的键* @param minScore 最小分数* @param maxScore 最大分数* @return 元素集合*/
public Collection<String> getElementsByScoreRange(String key, double minScore, double maxScore) {RScoredSortedSet<String> zSet = redisson.getScoredSortedSet(key);return zSet.valueRange(minScore, true, maxScore, true);
}

按排名范围获取元素

/*** 按排名范围获取元素** @param key  ZSet 的键* @param startRank 起始排名（从 0 开始）* @param endRank   结束排名* @return 元素集合*/
public Collection<String> getElementsByRankRange(String key, int startRank, int endRank) {RScoredSortedSet<String> zSet = redisson.getScoredSortedSet(key);return zSet.valueRange(startRank, endRank);
}

3.3 删除元素

删除指定元素：

/*** 删除指定元素** @param key   ZSet 的键* @param value 元素值* @return 是否删除成功*/
public boolean removeElement(String key, String value) {RScoredSortedSet<String> zSet = redisson.getScoredSortedSet(key);return zSet.remove(value);
}

按分数范围删除元素：

/*** 按分数范围删除元素** @param key       ZSet 的键* @param minScore  最小分数* @param maxScore  最大分数* @return 删除的元素数量*/
public int removeElementsByScoreRange(String key, double minScore, double maxScore) {RScoredSortedSet<String> zSet = redisson.getScoredSortedSet(key);return zSet.removeRangeByScore(minScore, true, maxScore, true);
}

清空元素

public int removeElementsByScoreRange(String key) {RScoredSortedSet<String> zSet = redisson.getScoredSortedSet(key);return zSet.clear();
}

3.4 获取 ZSet 大小

/*** 获取 ZSet 的大小** @param key ZSet 的键* @return ZSet 的大小*/
public int getZSetSize(String key) {RScoredSortedSet<String> zSet = redisson.getScoredSortedSet(key);return zSet.size();
}

3.5 获取元素的分数

/*** 获取元素的分数** @param key   ZSet 的键* @param value 元素值* @return 元素的分数*/
public Double getElementScore(String key, String value) {RScoredSortedSet<String> zSet = redisson.getScoredSortedSet(key);return zSet.getScore(value);
}