详解一种用django_cache实现分布式锁的方式

问题背景

在项目开发过程中，我遇到一个需求：对于某条记录，一个用户对它进行操作时会持续比较久，希望在一个用户的操作期间，不允许有另一个用户操作它，否容易会出现混乱。

在与同事们讨论后，想通过加锁的方式，起初想用redis锁，但这样会为项目增加别的依赖，因此转而使用django-cache的缓存数据库，来实现该功能。

资料查找

基于缓存实现分布式锁，在网络上查找了实现方式，大概可以总结为以下3种：

第一种锁命令INCR

这种加锁的思路是， key 不存在，那么 key 的值会先被初始化为 0 ，然后再执行 INCR 操作进行加一。 然后其它用户在执行 INCR 操作进行加一时，如果返回的数大于 1 ，说明这个锁正在被使用当中。

第二种锁命令SETNX

这种加锁的思路是，如果 key 不存在，将 key 设置为 value 如果 key 已存在，则 SETNX 不做任何动作

第三种锁命令SET

上面两种方法都有一个问题，会发现，都需要设置 key 过期。那么为什么要设置key过期呢？如果请求执行因为某些原因意外退出了，导致创建了锁但是没有删除锁，那么这个锁将一直存在，以至于以后缓存再也得不到更新。于是乎我们需要给锁加一个过期时间以防不测。

在实际编写中，我综合了第二种和第三种方式，即用键名来设置锁，同时设置了过期时间，以防长时间占用。

另外，关于如何使用django-cache去使用数据库缓存，相关的API整理如下：

from django.core.cache import caches
# 设置锁和超时时间
cache.set('my_key', 'Initial value', 60)
# 获取锁
cache.get('my_key')
# 更新锁
cache.add('add_key', 'New value')

代码编写

在经过多次的迭代，并且对比了网上的各路写法后，我结合django-cache的特性，最终总结了一套较为简洁的写法。

首先是一个CacheLock的类，初始化方法里可以传执行超时时间，和拿锁等待的时间。CacheLock类的主要方法有两个，一个是拿锁的方法，一个是释放锁的方法。

拿锁的方法中，键名根据操作的具体对象来定，键值为uuid值，超时时间默认为60s。一旦发现能拿到锁，则返回uuid值。

释放锁的方法中，首先比较键值和uuid值是否一致，一致则释放，避免因超时情况导致把其他的正在操作的锁给释放掉。

class CacheLock(object):
def __init__(self, expires=60, wait_timeout=0):
self.cache = cache
self.expires = expires # 函数执行超时时间
self.wait_timeout = wait_timeout # 拿锁等待超时时间

def get_lock(self, lock_key):
# 获取cache锁
wait_timeout = self.wait_timeout
identifier = uuid.uuid4()
while wait_timeout >= 0:
 if self.cache.add(lock_key, identifier, self.expires):
 return identifier
 wait_timeout -= 1
 time.sleep(1)
raise LockTimeout({'msg': '当前有其他用户正在编辑该采集配置，请稍后重试'})

def release_lock(self, lock_key, identifier):
# 释放cache锁
lock_value = self.cache.get(lock_key)
if lock_value == identifier:
 self.cache.delete(lock_key)

另外，将缓存锁写成一个装饰器，对需要加锁的地方，添加上该装饰器，则可以很轻松地实现锁功能。

def lock(cache_lock):
def my_decorator(func):
def wrapper(*args, **kwargs):
 lock_key = 'bk_monitor:lock:xxx' # 具体的lock_key要根据调用时传的参数而定
 identifier = cache_lock.get_lock(lock_key)
 try:
 return func(*args, **kwargs)
 finally:
 cache_lock.release_lock(lock_key, identifier)
return wrapper
return my_decorator

再举一个实际调用中的例子：

@lock(CacheLock())
def f():
pass

另外，我在设置缓存的key名的时候，会根据函数的具体操作对象，从而给装饰器传递相应的参数，这里就不再举例了。

优化改进

当然，实现以上功能需求一定还有别的更好的方式，关于锁的实现，网络上有很多别的方式，比如基于zookeeper实现分布式锁、基于数据库实现分布式锁等等，它们在可靠性或性能方面都各有长短，要根据具体场景进行取舍，所以还有非常多值得研究的地方。

我这里也只是抛砖引玉，欢迎拍砖~

来源：https://juejin.im/post/5d69e7136fb9a06acc009c1c