eredis

package module
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 12, 2022 License: MIT Imports: 26 Imported by: 8

README

eredis 组件使用指南

简介

对 go-redis 进行了轻量封装，并提供了以下功能：

  • 规范了标准配置格式，提供了统一的 Load().Build() 方法。
  • 支持自定义拦截器
  • 提供了默认的 Debug 拦截器，开启 Debug 后可输出 Request、Response 至终端。
  • 提供了默认的 Metric 拦截器，开启后可采集 Prometheus 指标数据
  • 提供了redis的分布式锁
  • 提供了redis的分布式锁的定时任务

快速上手

使用样例可参考 examples 使用样例可参考 examples

Documentation

Index

Constants

View Source 
const (
	// ClusterMode using clusterClient
	ClusterMode string = "cluster"
	// StubMode using stubClient
	StubMode string = "stub"
	// SentinelMode using Failover sentinel client
	SentinelMode string = "sentinel"
)
View Source 
const (
	// ErrInvalidParams  is returned when parameters is invalid.
	ErrInvalidParams = Err("invalid params")

	// ErrNotObtained is returned when a Lock cannot be obtained.
	ErrNotObtained = Err("redislock: not obtained")

	// ErrLockNotHeld is returned when trying to release an inactive Lock.
	ErrLockNotHeld = Err("redislock: lock not held")

	//Nil reply returned by Redis when key does not exist.
	Nil = redis.Nil
)
View Source 
const PackageName = "component.eredis"

Variables

This section is empty.

Functions

func DefaultConfig 

func DefaultConfig() *config

DefaultConfig default config ...

Types

type Component 

type Component struct {
	// contains filtered or unexported fields
}

Component client (cmdable and config)

func (*Component) Client 

func (r *Component) Client() redis.Cmdable

Client returns a universal redis client(ClusterClient, StubClient or SentinelClient), it depends on you config.

func (*Component) Close 

func (r *Component) Close() (err error)

Close closes the cluster client, releasing any open resources.

It is rare to Close a ClusterClient, as the ClusterClient is meant to be long-lived and shared between many goroutines.

func (*Component) Cluster 

func (r *Component) Cluster() *redis.ClusterClient

Cluster try to get a redis.ClusterClient

func (*Component) Decr 

func (r *Component) Decr(ctx context.Context, key string) (int64, error)

Decr redis自减

func (*Component) DecrBy added in v0.2.2 

func (r *Component) DecrBy(ctx context.Context, key string, decrement int64) (int64, error)

Decr redis自减特定的值

func (*Component) Del 

func (r *Component) Del(ctx context.Context, key string) (int64, error)

Del redis删除

func (*Component) Exists 

func (r *Component) Exists(ctx context.Context, key string) (bool, error)

Exists 键是否存在

func (*Component) Expire 

func (r *Component) Expire(ctx context.Context, key string, expiration time.Duration) (bool, error)

Expire 设置过期时间

func (*Component) GeoAdd 

func (r *Component) GeoAdd(ctx context.Context, key string, location *redis.GeoLocation) (int64, error)

GeoAdd 写入地理位置

func (*Component) GeoRadius 

func (r *Component) GeoRadius(ctx context.Context, key string, longitude, latitude float64, query *redis.GeoRadiusQuery) ([]redis.GeoLocation, error)

GeoRadius 根据经纬度查询列表

func (*Component) Get added in v0.2.0 

func (r *Component) Get(ctx context.Context, key string) (string, error)

Get

func (*Component) GetBytes 

func (r *Component) GetBytes(ctx context.Context, key string) ([]byte, error)

GetBytes

func (*Component) GetEx added in v0.2.3 

func (r *Component) GetEx(ctx context.Context, key string, expire time.Duration) (string, error)

GETEX

func (*Component) HDel 

func (r *Component) HDel(ctx context.Context, key string, field ...string) error

HDel ...

func (*Component) HGet 

func (r *Component) HGet(ctx context.Context, key string, fields string) (string, error)

HGet 从redis获取hash单个值

func (*Component) HGetAll 

func (r *Component) HGetAll(ctx context.Context, key string) (map[string]string, error)

HGetAll 从redis获取hash的所有键值对

func (*Component) HIncrBy 

func (r *Component) HIncrBy(ctx context.Context, key string, field string, incr int) (int64, error)

HIncrBy 哈希field自增

func (*Component) HKeys 

func (r *Component) HKeys(ctx context.Context, key string) ([]string, error)

HKeys 获取hash的所有域

func (*Component) HLen 

func (r *Component) HLen(ctx context.Context, key string) (int64, error)

HLen 获取hash的长度

func (*Component) HMGet added in v0.2.0 

func (r *Component) HMGet(ctx context.Context, key string, fileds []string) ([]interface{}, error)

func (*Component) HMGetMap 

func (r *Component) HMGetMap(ctx context.Context, key string, fields []string) (map[string]string, error)

HMGetMap 批量获取hash值，返回map

func (*Component) HMGetString 

func (r *Component) HMGetString(ctx context.Context, key string, fileds []string) ([]string, error)

HMGet 批量获取hash值

func (*Component) HMSet 

func (r *Component) HMSet(ctx context.Context, key string, hash map[string]interface{}, expire time.Duration) error

HMSet 设置redis的hash

func (*Component) HSet 

func (r *Component) HSet(ctx context.Context, key string, field string, value interface{}) error

HSet hset

func (*Component) Incr 

func (r *Component) Incr(ctx context.Context, key string) (int64, error)

Incr redis自增

func (*Component) IncrBy 

func (r *Component) IncrBy(ctx context.Context, key string, increment int64) (int64, error)

IncrBy 将 key 所储存的值加上增量 increment 。

func (*Component) LIndex 

func (r *Component) LIndex(ctx context.Context, key string, idx int64) (string, error)

LIndex ...

func (*Component) LLen 

func (r *Component) LLen(ctx context.Context, key string) (int64, error)

LLen ...

func (*Component) LPush 

func (r *Component) LPush(ctx context.Context, key string, values ...interface{}) (int64, error)

LPush 将一个或多个值 value 插入到列表 key 的表头

func (*Component) LRange 

func (r *Component) LRange(ctx context.Context, key string, start, stop int64) ([]string, error)

LRange 获取列表指定范围内的元素

func (*Component) LRem 

func (r *Component) LRem(ctx context.Context, key string, count int64, value interface{}) (int64, error)

LRem ...

func (*Component) LTrim 

func (r *Component) LTrim(ctx context.Context, key string, start, stop int64) (string, error)

LTrim ...

func (*Component) LockClient added in v0.2.1 

func (r *Component) LockClient() *lockClient

LockClient gets default distributed Lock client

func (*Component) MGet added in v0.2.0 

func (r *Component) MGet(ctx context.Context, keys []string) ([]interface{}, error)

MGets ...

func (*Component) MGetString 

func (r *Component) MGetString(ctx context.Context, keys ...string) ([]string, error)

MGet ...

func (*Component) Ping added in v0.2.0 

func (r *Component) Ping(ctx context.Context) (string, error)

Ping

func (*Component) RPop 

func (r *Component) RPop(ctx context.Context, key string) (string, error)

RPop 移除并返回列表 key 的尾元素。

func (*Component) RPush 

func (r *Component) RPush(ctx context.Context, key string, values ...interface{}) (int64, error)

RPush 将一个或多个值 value 插入到列表 key 的表尾(最右边)。

func (*Component) SAdd 

func (r *Component) SAdd(ctx context.Context, key string, member ...interface{}) (int64, error)

SAdd 向set中添加成员

func (*Component) SIsMember 

func (r *Component) SIsMember(ctx context.Context, key string, member interface{}) (bool, error)

SIsMember ...

func (*Component) SMembers 

func (r *Component) SMembers(ctx context.Context, key string) ([]string, error)

SMembers 返回set的全部成员

func (*Component) SRem added in v0.2.3 

func (r *Component) SRem(ctx context.Context, key string, member interface{}) (int64, error)

SRem ...

func (*Component) Sentinel added in v0.2.0 

func (r *Component) Sentinel() *redis.Client

Sentinel try to get a redis Failover Sentinel client

func (*Component) Set 

func (r *Component) Set(ctx context.Context, key string, value interface{}, expire time.Duration) error

Set 设置redis的string

func (*Component) SetEX added in v0.2.0 

func (r *Component) SetEX(ctx context.Context, key string, value interface{}, expire time.Duration) error

SetEX ...

func (*Component) SetNX added in v0.2.0 

func (r *Component) SetNX(ctx context.Context, key string, value interface{}, expire time.Duration) error

SetNX ...

func (*Component) SetNx 

func (r *Component) SetNx(ctx context.Context, key string, value interface{}, expiration time.Duration) (bool, error)

SetNx 设置redis的string 如果键已存在

func (*Component) Stub 

func (r *Component) Stub() *redis.Client

Stub try to get a redis.client

func (*Component) TTL 

func (r *Component) TTL(ctx context.Context, key string) (time.Duration, error)

TTL 查询过期时间

func (*Component) Type 

func (r *Component) Type(ctx context.Context, key string) (string, error)

Type ...

func (*Component) ZAdd 

func (r *Component) ZAdd(ctx context.Context, key string, members ...*redis.Z) (int64, error)

ZAdd 将一个或多个 member 元素及其 score 值加入到有序集 key 当中

func (*Component) ZCard 

func (r *Component) ZCard(ctx context.Context, key string) (int64, error)

ZCard 获取有序集合的基数

func (*Component) ZCount 

func (r *Component) ZCount(ctx context.Context, key string, min, max string) (int64, error)

ZCount 返回有序集 key 中， score 值在 min 和 max 之间(默认包括 score 值等于 min 或 max )的成员的数量。

func (*Component) ZRange 

func (r *Component) ZRange(ctx context.Context, key string, start, stop int64) ([]string, error)

ZRange ...

func (*Component) ZRangeByScore added in v0.3.0 

func (r *Component) ZRangeByScore(ctx context.Context, key string, opt *redis.ZRangeBy) ([]string, error)

ZRangeByScore ...

func (*Component) ZRangeByScoreWithScores added in v0.2.3 

func (r *Component) ZRangeByScoreWithScores(ctx context.Context, key string, opt *redis.ZRangeBy) ([]redis.Z, error)

ZRangeByScoreWithScores ...

func (*Component) ZRangeWithScores added in v0.2.3 

func (r *Component) ZRangeWithScores(ctx context.Context, key string, start, stop int64) ([]redis.Z, error)

ZRangeWithScores ...

func (*Component) ZRem 

func (r *Component) ZRem(ctx context.Context, key string, members ...interface{}) (int64, error)

ZRem 从zset中移除变量

func (*Component) ZRemRangeByRank 

func (r *Component) ZRemRangeByRank(ctx context.Context, key string, start, stop int64) (int64, error)

ZRemRangeByRank 移除有序集合中给定的排名区间的所有成员

func (*Component) ZRevRange 

func (r *Component) ZRevRange(ctx context.Context, key string, start, stop int64) ([]string, error)

ZRevRange 倒序获取有序集合的部分数据

func (*Component) ZRevRangeByScore 

func (r *Component) ZRevRangeByScore(ctx context.Context, key string, opt *redis.ZRangeBy) ([]string, error)

ZRevRangeByScore ...

func (*Component) ZRevRangeByScoreWithScores 

func (r *Component) ZRevRangeByScoreWithScores(ctx context.Context, key string, opt *redis.ZRangeBy) ([]redis.Z, error)

ZRevRangeByScoreWithScores ...

func (*Component) ZRevRangeWithScores 

func (r *Component) ZRevRangeWithScores(ctx context.Context, key string, start, stop int64) ([]redis.Z, error)

ZRevRangeWithScores ...

func (*Component) ZRevRank 

func (r *Component) ZRevRank(ctx context.Context, key string, member string) (int64, error)

ZRevRank ...

func (*Component) ZScore 

func (r *Component) ZScore(ctx context.Context, key string, member string) (float64, error)

ZScore 获取有序集合成员 member 的 score 值

type Container 

type Container struct {
	// contains filtered or unexported fields
}

func DefaultContainer 

func DefaultContainer() *Container

DefaultContainer 定义了默认Container配置

func Load 

func Load(key string) *Container

Load 载入配置，初始化Container

func (*Container) Build 

func (c *Container) Build(options ...Option) *Component

Build 构建Component

func (*Container) Printf added in v0.3.0 

func (c *Container) Printf(ctx context.Context, format string, v ...interface{})

type Err added in v0.2.0 

type Err string

func (Err) Error added in v0.2.0 

func (e Err) Error() string

type Lock added in v0.2.1 

type Lock struct {
	// contains filtered or unexported fields
}

Lock represents an obtained, distributed Lock.

func (*Lock) Key added in v0.2.1 

func (l *Lock) Key() string

Key returns the redis key used by the Lock.

func (*Lock) Metadata added in v0.2.1 

func (l *Lock) Metadata() string

Metadata returns the metadata of the Lock.

func (*Lock) Refresh added in v0.2.1 

func (l *Lock) Refresh(ctx context.Context, ttl time.Duration, opts ...LockOption) error

Refresh extends the Lock with a new TTL. May return ErrNotObtained if refresh is unsuccessful.

func (*Lock) Release added in v0.2.1 

func (l *Lock) Release(ctx context.Context) error

Release manually releases the Lock. May return ErrLockNotHeld.

func (*Lock) TTL added in v0.2.1 

func (l *Lock) TTL(ctx context.Context) (time.Duration, error)

TTL returns the remaining time-to-live. Returns 0 if the Lock has expired.

func (*Lock) Token added in v0.2.1 

func (l *Lock) Token() string

Token returns the token value set by the Lock.

type LockOption added in v0.2.0 

type LockOption func(c *lockOption)

func WithLockOptionMetadata added in v0.2.1 

func WithLockOptionMetadata(md string) LockOption

func WithLockOptionRetryStrategy added in v0.2.1 

func WithLockOptionRetryStrategy(retryStrategy RetryStrategy) LockOption

type Option 

type Option func(c *Container)

func WithAddr added in v0.2.3 

func WithAddr(addr string) Option

WithAddr set address

func WithAddrs added in v0.2.3 

func WithAddrs(addrs []string) Option

WithAddrs set addresses

func WithCluster 

func WithCluster() Option

WithStub set mode to "cluster"

func WithPassword added in v0.2.3 

func WithPassword(password string) Option

WithPassword set password

func WithSentinel added in v0.2.0 

func WithSentinel() Option

WithStub set mode to "sentinel"

func WithStub 

func WithStub() Option

WithStub set mode to "stub"

type RetryStrategy added in v0.2.0 

type RetryStrategy interface {
	// NextBackoff returns the next backoff duration.
	NextBackoff() time.Duration
}

RetryStrategy allows to customise the Lock retry strategy.

func ExponentialBackoffRetry added in v0.2.0 

func ExponentialBackoffRetry(min, max time.Duration) RetryStrategy

ExponentialBackoffRetry strategy is an optimization strategy with a retry time of 2**n milliseconds (n means number of times). You can set a minimum and maximum value, the recommended minimum value is not less than 16ms.

func LimitRetry added in v0.2.0 

func LimitRetry(s RetryStrategy, max int) RetryStrategy

LimitRetry limits the number of retries to max attempts.

func LinearBackoffRetry added in v0.2.0 

func LinearBackoffRetry(backoff time.Duration) RetryStrategy

LinearBackoffRetry allows retries regularly with customized intervals

func NoRetry added in v0.2.0 

func NoRetry() RetryStrategy

--------------------------------No Retry----------------------------------- NoRetry acquire the Lock only once.

Source Files

View all Source files

Directories

Path Synopsis
examples
redis
redislockcron
redistrace

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.