redis分布式锁

一个简单的Redis分布式锁
首先借助于redis的setnx命令来操作,setnx本身针对key赋值的时候会判断redis中是否存在这个key,如果有返回-1, 如果没有的化,他会直接set键值。那他跟直接set键值有啥区别? setnx是原子操作,而set不能保证原子性。

为了防止锁被长久锁定,或者防止客户端崩掉了没有删掉锁,可以用expire加入过期时间。 但这过期时间也不解决那种客户端异常退出,又没删除锁的情况。

增加了查询锁的剩余时间,以及修改(更新)过期时间。

package lock


import (
    "errors"
    "github.com/garyburd/redigo/redis"
    "time"
)

type RedisLock interface {
    Lock(timeout int) ( err error)
    Unlock() (err error)
    ExpirationTime() (ttl int, err error)
    UpdateExpirationTime(second int) (err error)
}

type redisLock struct {
    conn    redis.Conn
    lockKey string
    value   int64
}

func NewRedisLock(lockKey string, conn redis.Conn) RedisLock {
    return &redisLock{
        conn:    conn,
        lockKey: lockKey,
        value:   time.Now().Unix(),
    }
}

//保证原子性(redis是单线程),避免del删除了,其他client获得的lock
var delScript = redis.NewScript(1, `
if redis.call("get", KEYS[1]) == ARGV[1] then
    return redis.call("del", KEYS[1])
else
    return -1
end`)

// 锁
func (this *redisLock) Lock(timeout int) (err error) {
    var lockReply interface{}
    lockReply, err = redis.String(this.conn.Do("SET", this.lockKey, this.value, "ex", timeout, "nx"))
    if err!=nil {
        return
    }
    if lockReply != "OK" {
        err = errors.New("lock err")
    }
    return
}

// 解锁
func (this *redisLock) Unlock() (err error) {
    var val interface{}
    val, err = redis.Int(delScript.Do(this.conn, this.lockKey, this.value))
    // val==1 删除成功, val==0之前的锁已过期锁已经被其他拿走。
    if err != nil {
        return
    }
    switch val {
    case -1:
        err = errors.New("the lock has bean locked")
    case 0:
        err = errors.New("unlock is fail")
    }
    return
}

// 提交数据前判断锁是否还在自己的手上返回 过期时间
func (this *redisLock) ExpirationTime() (ttl int, err error) {
    //当 key 不存在时,返回 -2 。 当 key 存在但没有设置剩余生存时间时,返回 -1 。 否则,以秒为单位,返回 key 的剩余生存时间。
    ttl, err = redis.Int(this.conn.Do("TTL", this.lockKey))
    if err != nil {
        return
    }
    switch ttl {
    case -2:
        err = errors.New("the key is not exist")
    case  -1:
        err = errors.New("the key is not have expiration time")
    }
    return
}

// 修改锁的过期时间
func (this *redisLock) UpdateExpirationTime(second int) (err error) {
    var val interface{}
    val, err =  redis.Int(this.conn.Do("EXPIRE", this.lockKey, second))
    if err != nil {
        return
    }
    if val != 1 {
        err = errors.New("update fail")
    }
    return
}

你可能感兴趣的:(redis分布式锁)