docs: 添加部分注释
Some checks failed
CI / Backend (push) Has been cancelled
CI / Frontend (push) Has been cancelled

This commit is contained in:
hhs
2026-07-01 19:34:13 +08:00
parent 1b74c82ed4
commit e3c68dd6d3
4 changed files with 18 additions and 8 deletions

View File

@@ -8,6 +8,8 @@ import (
redis "github.com/redis/go-redis/v9"
)
// ZincrBy 将有序集合 key 中 member 的分数增加 score。
// 如果 member 不存在,则将其添加并设置初始分数为 score。
func (c *Client) ZincrBy(ctx context.Context, key string, member string, score float64) error {
if c == nil || c.rdb == nil {
return nil
@@ -15,6 +17,7 @@ func (c *Client) ZincrBy(ctx context.Context, key string, member string, score f
return c.rdb.ZIncrBy(ctx, key, score, member).Err()
}
// ZAdd 向有序集合 key 中添加一个或多个带分数的成员。
func (c *Client) ZAdd(ctx context.Context, key string, members ...redis.Z) error {
if c == nil || c.rdb == nil {
return nil
@@ -22,6 +25,7 @@ func (c *Client) ZAdd(ctx context.Context, key string, members ...redis.Z) error
return c.rdb.ZAdd(ctx, key, members...).Err()
}
// ZRemRangeByRank 移除有序集合 key 中排名在 [start, stop] 范围内的所有成员。
func (c *Client) ZRemRangeByRank(ctx context.Context, key string, start int64, stop int64) error {
if c == nil || c.rdb == nil {
return nil
@@ -29,6 +33,7 @@ func (c *Client) ZRemRangeByRank(ctx context.Context, key string, start int64, s
return c.rdb.ZRemRangeByRank(ctx, key, start, stop).Err()
}
// ZRangeWithScores 返回有序集合 key 中排名在指定范围内的成员及其分数。
func (c *Client) ZRangeWithScores(ctx context.Context, key string, start int64, stop int64) ([]redis.Z, error) {
if c == nil || c.rdb == nil {
return nil, errors.New("redis client not initialized")
@@ -36,6 +41,7 @@ func (c *Client) ZRangeWithScores(ctx context.Context, key string, start int64,
return c.rdb.ZRangeWithScores(ctx, key, start, stop).Result()
}
// Expire 为 key 设置过期时间TTL 过后 key 会被自动删除。
func (c *Client) Expire(ctx context.Context, key string, ttl time.Duration) error {
if c == nil || c.rdb == nil {
return nil
@@ -43,6 +49,8 @@ func (c *Client) Expire(ctx context.Context, key string, ttl time.Duration) erro
return c.rdb.Expire(ctx, key, ttl).Err()
}
// ZUnionStore 计算 keys 指定的多个有序集合的并集,将结果存入 dst。
// aggregate 控制分数聚合方式,可选 "SUM"、"MIN" 或 "MAX"。
func (c *Client) ZUnionStore(ctx context.Context, dst string, keys []string, aggregate string) error {
if c == nil || c.rdb == nil {
return nil
@@ -53,6 +61,7 @@ func (c *Client) ZUnionStore(ctx context.Context, dst string, keys []string, agg
}).Err()
}
// Exists 判断 key 是否存在于 Redis 中。
func (c *Client) Exists(ctx context.Context, key string) (bool, error) {
if c == nil || c.rdb == nil {
return false, nil
@@ -61,6 +70,7 @@ func (c *Client) Exists(ctx context.Context, key string) (bool, error) {
return n > 0, err
}
// ZRevRange 返回有序集合 key 中排名在 [start, stop] 范围内的成员,按分数从高到低排序。
func (c *Client) ZRevRange(ctx context.Context, key string, start, stop int64) ([]string, error) {
if c == nil || c.rdb == nil {
return nil, nil
@@ -68,6 +78,8 @@ func (c *Client) ZRevRange(ctx context.Context, key string, start, stop int64) (
return c.rdb.ZRevRange(ctx, key, start, stop).Result()
}
// ZRevRangeByScore 返回有序集合 key 中分数在 [min, max] 范围内的成员,按分数从高到低排序。
// offset 和 count 用于分页控制。
func (c *Client) ZRevRangeByScore(ctx context.Context, key string, max, min string, offset, count int64) ([]string, error) {
if c == nil || c.rdb == nil {
return nil, nil