com.biz.redis.utils.RedisZSetUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biz-all Show documentation

BizX 是一个灵活而高效的业务开发框架, 其中也有很多为业务开发所需要的工具类的提供。

The newest version!

package com.biz.redis.utils;

import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.data.redis.core.ZSetOperations;

import java.util.Set;

/**
 * Redis ZSet Utils 提供对Redis有序集合（ZSet）数据结构的常用操作方法。
 * 包括存储有序集合、获取指定范围的值、获取所有值以及获取集合大小等。
 *
 * 该类依赖于{@link ZSetOperations}和{@link RedisCommonUtils}。
 *
 *  * 示例：
 * RedisZSetUtils redisZSetUtils = new RedisZSetUtils(zSetOperations, redisCommonUtils);
 * redisZSetUtils.zSet("key", value, score);
 * 
 *
 * 注意：所有操作均假定键和值不为null，且对于可能出现的异常进行了日志记录。
 *
 * @see ZSetOperations
 * @see RedisCommonUtils
 * @see Redis ZSet Commands
 * @author francis
 * @version 1.4.11
 * @since 1.0.1
 */
@Slf4j
@RequiredArgsConstructor
public class RedisZSetUtils {

    private final ZSetOperations zSetOperations;
    private final RedisCommonUtils redisCommonUtils;

    /**
     * 存储有序集合中的一个值。
     *
     * @param key   集合的键，不能为空
     * @param value 集合中的值，不能为空
     * @param score 值的分数，用于排序
     * @see ZSetOperations#add(Object, Object, double)
     */
    public void addZSet(@NonNull String key, @NonNull Object value, double score) {
        zSetOperations.add(key, value, score);
    }

    /**
     * 存储有序集合中的多个值。
     *
     * @param key 集合的键，不能为空
     * @param set 集合中的多个值，不能为空
     * @see ZSetOperations#add(Object, Set)
     */
    public void addZSet(@NonNull String key, @NonNull Set> set) {
        zSetOperations.add(key, set);
    }

    /**
     * 获取有序集合中指定范围的值。
     *
     * @param key   集合的键，不能为空
     * @param start 开始位置
     * @param end   结束位置
     * @return 有序集合中的值
     * @see ZSetOperations#range(Object, long, long)
     */
    public Set