Sherlock：具有后端选择的分布式锁

概述

Sherlock是一个提供易于使用的分布式进程间锁定，能够为事先的锁定选择后端同步。当使用由多个服务或分布式服务，通常需要某种锁定机制使一次访问某些资源成为可能。分布式锁或互斥锁可以帮助您实现这一点。Sherlock提供这种方法，通过提供了一个易于使用的api方便进程间的锁定，类似于标准库的threading.lock语义。除此之外，Sherlock在管理锁的选择时候还提供了使用后端的灵活性。Sherlock同时还更加简单地扩展对于某些不支持的后端。

功能

• 似于标准库的threading.lock。
• 支持WITH语句，以干净地获取和释放锁。
• 后端多样：支持Redis、Memcached和Etcd作为选项 后端。
• 可扩展性：可以很容易地扩展到并与通过扩展基锁类进行选择。读取extending。

支持的后端和客户端库

每个支持的后端都支持以下客户端库：

• redis:redis-py
• memcached:pylibmc
• etcd:python-etcd
  截至目前，仅支持上述库。尽管 Sherlock接受自定义客户端对象，以便您可以轻松地提供要用于后端存储的设置，但即使api是同样的，Sherlock检查提供的客户端对象是否是受支持客户端的实例，并接受通过此检查的客户端对象。

安装与使用

安装很简单。

pip install sherlock

注意
Sherlock将安装所有支持后端。

基本用法

sherlock在api和语义层使用起来很简单，它符合标准库的threading.Lockapi。

import sherlock
from sherlock import Lock

# Configure Sherlock's locks to use Redis as the backend,
# never expire locks and retry acquiring an acquired lock after an
# interval of 0.1 second.
sherlock.configure(backend=sherlock.backends.REDIS,
                   expire=None,
                   retry_interval=0.1)

# Note: configuring sherlock to use a backend does not limit you
# another backend at the same time. You can import backend specific locks
# like RedisLock, MCLock and EtcdLock and use them just the same way you
# use a generic lock (see below). In fact, the generic Lock provided by
# sherlock is just a proxy that uses these specific locks under the hood.

# 获取一个my_lock
lock = Lock('my_lock')

# 获取锁
lock.acquire()

# 检查锁状态
lock.locked() == True

# 释放所
lock.release()

支持with语句

# using with statement
with Lock('my_lock'):
    # do something constructive with your locked resource here
    pass

阻塞和非阻塞api

# 获取非阻塞锁
lock1 = Lock('my_lock')
lock2 = Lock('my_lock')

# 成功获取 lock1
lock1.acquire()

# 尝试以非阻塞方式获取锁
lock2.acquire(False) == True # returns False

# 尝试以阻塞方式获取锁
lock2.acquire() # 阻塞直到获得超时锁定 

同时使用两个后端

将Sherlock配置为使用后端并不会限制您同时使用另一个后端。您可以导入后端特定的锁（如RedisLock，MCLock和EtcdLock），并以与使用普通锁相同的方式使用它们（请参见下文）。实际上，Sherlock提供的通用锁只是在后台使用这些特定锁的代理。

import sherlock
from sherlock import Lock

# Configure Sherlock's locks to use Redis as the backend
sherlock.configure(backend=sherlock.backends.REDIS)

# Acquire a lock called my_lock, this lock uses Redis
lock = Lock('my_lock')

# Now acquire locks in Memcached
from sherlock import MCLock
mclock = MCLock('my_mc_lock')
mclock.acquire()

测试

要运行所有测试（包括集成），必须确保所有数据库都在运行。确保所	有服务都在运行：

# memcached
memcached

# redis-server
redis-server

# etcd (etcd is probably not available as package, here is the simplest way
# to run it).
wget https://github.com/coreos/etcd/releases/download/<version>/etcd-<version>-<platform>.tar.gz
tar -zxvf etcd-<version>-<platform>.gz
./etcd-<version>-<platform>/etcd

像这样运行测试：

python setup.py test

文档

具体文档可以参考：

参考文档地址
国内地址：https://gitee.com/mirrors/sherlock
国外地址：https://github.com/vaidik/sherlock