在 Redis 上实现的分布式锁

  1 <?php
  2 
  3 require_once 'RedisFactory.php';
  4 
  5 /**
  6 * 在 Redis 上实现的分布式锁
  7 */
  8 class RedisLock {
  9     //单例模式
 10     private static $_instance = null;
 11     public static function instance() {
 12         if(self::$_instance == null) {
 13             self::$_instance = new RedisLock();
 14         }
 15         return self::$_instance;
 16     }
 17 
 18     //redis对象变量
 19     private $redis;
 20     //存放被锁的标志名的数组
 21     private $lockedNames = array();
 22 
 23     public function __construct() {
 24         //获取一个 RedisString 实例
 25         $this->redis = RedisFactory::instance()->getString();
 26     }
 27 
 28     /** 
 29     * 加锁
 30     *
 31     * @param string 锁的标识名
 32     * @param int 获取锁失败时的等待超时时间(秒), 在此时间之内会一直尝试获取锁直到超时. 为 0 表示失败后直接返回不等待
 33     * @param int 当前锁的最大生存时间(秒), 必须大于 0 . 如果超过生存时间后锁仍未被释放, 则系统会自动将其强制释放
 34     * @param int 获取锁失败后挂起再试的时间间隔(微秒)
 35     */
 36     public function lock($name, $timeout = 0, $expire = 15, $waitIntervalUs = 100000) {
 37         if(empty($name)) return false;
 38 
 39         $timeout = (int)$timeout;
 40         $expire = max((int)$expire, 5);
 41         $now = microtime(true);
 42         $timeoutAt = $now + $timeout;
 43         $expireAt = $now + $expire;
 44 
 45         $redisKey = "Lock:$name";
 46         while(true) {
 47             $result = $this->redis->setnx($redisKey, (string)$expireAt);
 48             if($result !== false) {
 49                 //对$redisKey设置生存时间
 50                 $this->redis->expire($redisKey, $expire);
 51                 //将最大生存时刻记录在一个数组里面
 52                 $this->lockedNames[$name] = $expireAt;
 53                 return true;
 54             }
 55 
 56             //以秒为单位，返回$redisKey 的剩余生存时间
 57             $ttl = $this->redis->ttl($redisKey);
 58             // TTL 小于 0 表示 key 上没有设置生存时间(key 不会不存在, 因为前面 setnx 会自动创建)
 59             // 如果出现这种情况, 那就是进程在某个实例 setnx 成功后 crash 导致紧跟着的 expire 没有被调用. 这时可以直接设置 expire 并把锁纳为己用
 60             if($ttl < 0) {
 61                 $this->redis->set($redisKey, (string)$expireAt, $expire);
 62                 $this->lockedNames[$name] = $expireAt;
 63                 return true;
 64             }
 65 
 66             // 设置了不等待或者已超时
 67             if($timeout <= 0 || microtime(true) > $timeoutAt) break;
 68 
 69             // 挂起一段时间再试
 70             usleep($waitIntervalUs);
 71         }
 72 
 73         return false;
 74     }
 75 
 76     /**
 77     * 给当前锁增加指定的生存时间(秒), 必须大于 0
 78     *
 79     * @param string 锁的标识名
 80     * @param int 生存时间(秒), 必须大于 0
 81     */
 82     public function expire($name, $expire) {
 83         if($this->isLocking($name)) {
 84             if($this->redis->expire("Lock:$name", max($expire, 1))) {
 85                 return true;
 86             }
 87         }
 88         return false;
 89     }
 90 
 91     /**
 92     * 判断当前是否拥有指定名称的锁
 93     *
 94     * @param mixed $name
 95     */
 96     public function isLocking($name) {
 97         if(isset($this->lockedNames[$name])) {
 98             return (string)$this->lockedNames[$name] == (string)$this->redis->get("Lock:$name");
 99         }
100         return false;
101     }
102 
103     /**
104     * 释放锁
105     *
106     * @param string 锁的标识名
107     */
108     public function unlock($name) {
109         if($this->isLocking($name)) {
110             if($this->redis->deleteKey("Lock:$name")) {
111                 unset($this->lockedNames[$name]);
112                 return true;
113             }
114         }
115         return false;
116     }
117 
118     /** 释放当前已经获取到的所有锁 */
119     public function unlockAll() {
120         $allSuccess = true;
121         foreach($this->lockedNames as $name => $item) {
122             if(false === $this->unlock($name)) {
123                 $allSuccess = false;
124             }
125         }
126         return $allSuccess;
127     }
128 }