redis

README

单元测试可以使用 https://github.com/alicebob/miniredis, 可以开启一个本地的模拟redis

• 在单元测试中模拟Redis

Documentation

Index

• Constants
• Variables
• func Init() *redis.Client
• func InitTestRedis()
• type IdAlloc
  • func (ia *IdAlloc) GetCurrentID() (int64, error)
  • func (ia *IdAlloc) GetKey() string
  • func (ia *IdAlloc) GetNewID(step int64) (int64, error)
• type Lock
  • func New(conn *redis.Client, key string, defaultTimeout time.Duration) *Lock
  • func NewLock(conn *redis.Client, key string, defaultTimeout time.Duration) *Lock
  • func (l *Lock) GenToken() string
  • func (l *Lock) GetKey() string
  • func (l *Lock) Lock(token string) (bool, error)
  • func (l *Lock) Unlock(token string) error

Constants

const Nil = redis.Nil

Nil redis 返回为空

Variables

var RedisClient *redis.Client

RedisClient redis 客户端

Functions

func Init

func Init() *redis.Client

Init 实例化一个redis client

func InitTestRedis

func InitTestRedis()

InitTestRedis 实例化一个可以用于单元测试的redis

Types

type IdAlloc

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

IdAlloc id生成器

func (*IdAlloc) GetCurrentID

func (ia *IdAlloc) GetCurrentID() (int64, error)

GetCurrentID 获取当前id

func (*IdAlloc) GetKey

func (ia *IdAlloc) GetKey() string

GetKey 获取key, 由业务前缀+功能前缀+具体场景id组成

func (*IdAlloc) GetNewID

func (ia *IdAlloc) GetNewID(step int64) (int64, error)

GetNewID 生成id

type Lock

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

Lock 定义lock结构体

func New

func New(conn *redis.Client, key string, defaultTimeout time.Duration) *Lock

New 实例化

func NewLock

func NewLock(conn *redis.Client, key string, defaultTimeout time.Duration) *Lock

NewLock 实例化lock

func (*Lock) GenToken

func (l *Lock) GenToken() string

GenToken 生成token

func (*Lock) GetKey

func (l *Lock) GetKey() string

GetKey 获取key

func (*Lock) Lock

func (l *Lock) Lock(token string) (bool, error)

Lock 加锁

func (*Lock) Unlock

func (l *Lock) Unlock(token string) error

Unlock 解锁 token 一致才会执行删除，避免误删，这里用了lua脚本进行事务处理