使用php实现redis分布式锁

redis来实现分布式锁的原理就是将程序中一个唯一的key写入redis中，当有其他分布式应用要访问时候此key时，就去redis中读取，读取到了则说明此数据正在被处理，读取不到则说明可以进行处理；

但是，想将分布式锁处理的妥当，还真不是一件轻松地事情，继续往后看。

在redis实现的分布式锁中，我们需要强调以下几点，只有保证了以下几点，才可说是确保了锁的实现：

(1)互斥，在任何时刻，对于同一条数据，只有一台应用可以获取到分布式锁；

(2)不能发生死锁，一台服务器挂了，程序没有执行完，但是redis中的锁却永久存在了，那么已加锁未执行完的数据，就永远得不到处理了，直到人工发现，或者监控发现；

(3)高可用性，可以保证程序的正常加锁，正常解锁；

(4) 加锁解锁必须由同一台服务器进行，不能出现你加的锁，别人给你解锁了。

多数实现使用的是setnx()方法和expire()方法实现，而在redis最新版本中使用的是set()方法；

在分布式系统环境下，val的值可以设置成该机器的唯一标识，例如时间+请求号。为什么这么说，当一个服务器向redis加锁时候，我们需要确定这个key是来自于哪台服务器，在解锁时需要校验是不是解锁的请求来自于同一个服务器；

SET(key value [EX seconds] [PX milliseconds] [NX|XX]) 方法：

(1)key，我们使用key来当锁，key是唯一的。 (2)value，我们传的是“时间+请求号”，通过给value赋值我们在解锁的时候就会传递同样的数据进行解锁。不至于出现不同的服务器对key进行解锁。为什么说，不允许出现不同的服务器对一个key进行解锁？我们后面讲解。 (3)nxxx，NX意思为SET IF NOT EXIST，即当key不存在时，我们进行set操作；若key已经存在，则不做任何操作； (4)expx，PX意思是给这个key加一个过期设置，具体时间由第五个参数决定。 (5)time，代表key的过期时间，单位毫秒。

$redis = new \Redis();
$rt = $redis->connect('127.0.0.1', 6379, 0.01);
$redis->set('test','hello word',['NX', 'PX' => 10]);

说完了上锁，接下来说说解锁：

解锁，就是将key删除，你可能会觉得调用redis删除方法就行了呗，事实并不是如此；

$redis->del($key);

我们前面说了，在分布式环境中，哪台服务器加的锁，在解锁时候，还让那台服务器来解锁。不能出现A服务器加锁，而B服务器解锁的情况；而上面的代码就会出现这种情况。

当A服务器将一个key设置超时时间为5秒钟，获取到锁执行业务逻辑，但是呢，5秒钟没有执行完，此时key由于到了过期时间而被删除了。正好B服务器进行了获取锁操作，发现key没有上锁，进而加锁开始执行业务逻辑。过了1秒后，A服务器执行完毕，执行释放所操作，del(key)，将B服务器上的锁给删除了。A、B服务器对同一个可以执行了一样的操作；

由于判断和del()操作不是原子性的，那么就会存在判断后，让其他服务器删除的情况；

例如：A服务器加锁，执行业务逻辑，很快执行完毕，进行解锁操作，解锁判断，OK，准备进行del()操作，此时CPU切换到执行别的操作了，或者JVM虚拟机进行垃圾回收操作。这时候，key到了过期时间，B服务器执行获取到锁，执行业务逻辑，还没执行完成，A服务器复活，执行del()操作，删除key；此时，A服务器上的锁，超时而被删除，B服务器加锁，A服务器将其删除；

终极大招，lua脚本实现：

$luaScript = "if redis.call('get',KEYS[1]) == ARGV[1] then return redis.call('del',KEYS[1]) else return 0 end";

eval($luaScript,$key,$value);

通过lua脚本，解决了 解铃还须系铃人 的问题。

PHP代码实现

<?php
class RedLock
{
    private $retryDelay;
    private $retryCount;
    private $clockDriftFactor = 0.01;
    private $quorum;
    private $servers = array();
    private $instances = array();
    function __construct(array $servers, $retryDelay = 200, $retryCount = 3)
    {
        $this->servers = $servers;
        $this->retryDelay = $retryDelay;
        $this->retryCount = $retryCount;
        $this->quorum  = min(count($servers), (count($servers) / 2 + 1));
    }
    public function lock($resource, $ttl)
    {
        $this->initInstances();
        $token = uniqid();
        $retry = $this->retryCount;
        do {
            $n = 0;
            $startTime = microtime(true) * 1000;
            foreach ($this->instances as $instance) {
                if ($this->lockInstance($instance, $resource, $token, $ttl)) {
                    $n++;
                }
            }
            # Add 2 milliseconds to the drift to account for Redis expires
            # precision, which is 1 millisecond, plus 1 millisecond min drift
            # for small TTLs.
            $drift = ($ttl * $this->clockDriftFactor) + 2;
            $validityTime = $ttl - (microtime(true) * 1000 - $startTime) - $drift;
            if ($n >= $this->quorum && $validityTime > 0) {
                return [
                    'validity' => $validityTime,
                    'resource' => $resource,
                    'token'    => $token,
                ];
            } else {
                foreach ($this->instances as $instance) {
                    $this->unlockInstance($instance, $resource, $token);
                }
            }
            // Wait a random delay before to retry
            $delay = mt_rand(floor($this->retryDelay / 2), $this->retryDelay);
            usleep($delay * 1000);
            $retry--;
        } while ($retry > 0);
        return false;
    }
    public function unlock(array $lock)
    {
        $this->initInstances();
        $resource = $lock['resource'];
        $token    = $lock['token'];
        foreach ($this->instances as $instance) {
            $this->unlockInstance($instance, $resource, $token);
        }
    }
    private function initInstances()
    {
        if (empty($this->instances)) {
            foreach ($this->servers as $server) {
                list($host, $port, $timeout) = $server;
                $redis = new \Redis();
                $redis->connect($host, $port, $timeout);
                $this->instances[] = $redis;
            }
        }
    }
    private function lockInstance($instance, $resource, $token, $ttl)
    {
        return $instance->set($resource, $token, ['NX', 'PX' => $ttl]);
    }
    private function unlockInstance($instance, $resource, $token)
    {
        $script = '
            if redis.call("GET", KEYS[1]) == ARGV[1] then
                return redis.call("DEL", KEYS[1])
            else
                return 0
            end
        ';
        return $instance->eval($script, [$resource, $token], 1);
    }
}
?>

实例

<?php
require_once __DIR__ . '/src/RedLock.php';
$servers = [
    ['127.0.0.1', 6379, 0.01],
    ['127.0.0.1', 6389, 0.01],
    ['127.0.0.1', 6399, 0.01],
];
$redLock = new RedLock($servers);
while (true) {
    $lock = $redLock->lock('test', 10000);
    if ($lock) {
        print_r($lock);
    } else {
        print "Lock not acquired\n";
    }
}

谢谢,ALL !