PHP實現Redis單據鎖以及防止併發重複寫入

1、前言：

在整個供應鏈系統中，會有不少種單據（採購單、入庫單、到貨單、運單等等），在涉及寫單據數據的接口時（增刪改操做），即便前端作了相關限制，仍是有可能由於網絡或異常操做產生併發重複調用的狀況，致使對相同單據作相同的處理；

爲了防止這種狀況對系統形成異常影響，咱們經過Redis實現了一個簡單的單據鎖，每一個請求需先獲取鎖才能執行業務邏輯，執行結束後纔會釋放鎖；保證了同一單據的併發重複操做請求只有一個請求能夠獲取到鎖（依賴Redis的單線程），是一種悲觀鎖的設計；

注：Redis鎖在咱們的系統中通常只用於解決併發重複請求的狀況，對於非併發的的重複請求通常會去數據庫或日誌校驗數據的狀態，兩種機制結合起來才能保證整個鏈路的可靠。

2、加鎖機制：

主要依賴Redis setnx指令實現：

但使用setnx有一個問題，即setnx指令不支持設置過時時間，須要使用expire指令另行爲key設置超時時間，這樣整個加鎖操做就不是一個原子性操做，有可能存在setnx加鎖成功，但因程序異常退出致使未成功設置超時時間，在不及時解鎖的狀況下，有可能會致使死鎖（即便業務場景中不會出現死鎖，無用的key一直常駐內存也不是很好的設計）；

這種狀況能夠使用Redis事務解決，把setnx與expire兩條指令做爲一個原子性操做執行，但這樣作相對而言會比較麻煩，好在Redis 2.6.12以後版本，Redis set指令支持了nx、ex模式，並支持原子化地設置過時時間：

3、加鎖實現（完整測試代碼會貼在最後）：

/**
 * 加單據鎖
 * @param int $intOrderId 單據ID
 * @param int $intExpireTime 鎖過時時間（秒）
 * @return bool|int 加鎖成功返回惟一鎖ID，加鎖失敗返回false
 */
public static function addLock($intOrderId, $intExpireTime = self::REDIS_LOCK_DEFAULT_EXPIRE_TIME)
{
 //參數校驗
 if (empty($intOrderId) || $intExpireTime <= 0) {
  return false;
 }

 //獲取Redis鏈接
 $objRedisConn = self::getRedisConn();

 //生成惟一鎖ID，解鎖需持有此ID
 $intUniqueLockId = self::generateUniqueLockId();

 //根據模板，結合單據ID，生成惟一Redis key（通常來講，單據ID在業務中系統中惟一的）
 $strKey = sprintf(self::REDIS_LOCK_KEY_TEMPLATE, $intOrderId);

 //加鎖（經過Redis setnx指令實現，從Redis 2.6.12開始，經過set指令可選參數也能夠實現setnx，同時可原子化地設置超時時間）
 $bolRes = $objRedisConn->set($strKey, $intUniqueLockId, ['nx', 'ex'=>$intExpireTime]);

 //加鎖成功返回鎖ID，加鎖失敗返回false
 return $bolRes ? $intUniqueLockId : $bolRes;
}

4、解鎖機制：

解鎖即比對加鎖時的惟一lock id，若是比對成功，則刪除key；須要注意的是，解鎖整個過程當中一樣須要保證原子性，這裏依賴redis的watch與事務實現；

WATCH命令能夠監控一個或多個鍵，一旦其中有一個鍵被修改（或刪除），以後的事務就不會執行。監控一直持續到EXEC命令（事務中的命令是在EXEC以後才執行的，因此在MULTI命令後能夠修改WATCH監控的鍵值）

5、解鎖實現（完整測試代碼會貼在最後）：

/**
  * 解單據鎖
  * @param int $intOrderId 單據ID
  * @param int $intLockId 鎖惟一ID
  * @return bool
  */
 public static function releaseLock($intOrderId, $intLockId)
 {
  //參數校驗
  if (empty($intOrderId) || empty($intLockId)) {
   return false;
  }

  //獲取Redis鏈接
  $objRedisConn = self::getRedisConn();

  //生成Redis key
  $strKey = sprintf(self::REDIS_LOCK_KEY_TEMPLATE, $intOrderId);

  //監聽Redis key防止在【比對lock id】與【解鎖事務執行過程當中】被修改或刪除，提交事務後會自動取消監控，其餘狀況需手動解除監控
  $objRedisConn->watch($strKey);
  if ($intLockId == $objRedisConn->get($strKey)) {
   $objRedisConn->multi()->del($strKey)->exec();
   return true;
  }
  $objRedisConn->unwatch();
  return false;
 }

6、附總體測試代碼（此代碼僅爲簡易版本）

<?php

/**
 * Class Lock_Service 單據鎖服務
 */
class Lock_Service
{
 /**
  * 單據鎖redis key模板
  */
 const REDIS_LOCK_KEY_TEMPLATE = 'order_lock_%s';

 /**
  * 單據鎖默認超時時間（秒）
  */
 const REDIS_LOCK_DEFAULT_EXPIRE_TIME = 86400;

 /**
  * 加單據鎖
  * @param int $intOrderId 單據ID
  * @param int $intExpireTime 鎖過時時間（秒）
  * @return bool|int 加鎖成功返回惟一鎖ID，加鎖失敗返回false
  */
 public static function addLock($intOrderId, $intExpireTime = self::REDIS_LOCK_DEFAULT_EXPIRE_TIME)
 {
  //參數校驗
  if (empty($intOrderId) || $intExpireTime <= 0) {
   return false;
  }

  //獲取Redis鏈接
  $objRedisConn = self::getRedisConn();

  //生成惟一鎖ID，解鎖需持有此ID
  $intUniqueLockId = self::generateUniqueLockId();

  //根據模板，結合單據ID，生成惟一Redis key（通常來講，單據ID在業務中系統中惟一的）
  $strKey = sprintf(self::REDIS_LOCK_KEY_TEMPLATE, $intOrderId);

  //加鎖（經過Redis setnx指令實現，從Redis 2.6.12開始，經過set指令可選參數也能夠實現setnx，同時可原子化地設置超時時間）
  $bolRes = $objRedisConn->set($strKey, $intUniqueLockId, ['nx', 'ex'=>$intExpireTime]);

  //加鎖成功返回鎖ID，加鎖失敗返回false
  return $bolRes ? $intUniqueLockId : $bolRes;
 }

 /**
  * 解單據鎖
  * @param int $intOrderId 單據ID
  * @param int $intLockId 鎖惟一ID
  * @return bool
  */
 public static function releaseLock($intOrderId, $intLockId)
 {
  //參數校驗
  if (empty($intOrderId) || empty($intLockId)) {
   return false;
  }

  //獲取Redis鏈接
  $objRedisConn = self::getRedisConn();

  //生成Redis key
  $strKey = sprintf(self::REDIS_LOCK_KEY_TEMPLATE, $intOrderId);

  //監聽Redis key防止在【比對lock id】與【解鎖事務執行過程當中】被修改或刪除，提交事務後會自動取消監控，其餘狀況需手動解除監控
  $objRedisConn->watch($strKey);
  if ($intLockId == $objRedisConn->get($strKey)) {
   $objRedisConn->multi()->del($strKey)->exec();
   return true;
  }
  $objRedisConn->unwatch();
  return false;
 }

 /**
  * Redis配置：IP
  */
 const REDIS_CONFIG_HOST = '127.0.0.1';

 /**
  * Redis配置：端口
  */
 const REDIS_CONFIG_PORT = 6379;

 /**
  * 獲取Redis鏈接（簡易版本，可用單例實現）
  * @param string $strIp IP
  * @param int $intPort 端口
  * @return object Redis鏈接
  */
 public static function getRedisConn($strIp = self::REDIS_CONFIG_HOST, $intPort = self::REDIS_CONFIG_PORT)
 {
  $objRedis = new Redis();
  $objRedis->connect($strIp, $intPort);
  return $objRedis;
 }

 /**
  * 用於生成惟一的鎖ID的redis key
  */
 const REDIS_LOCK_UNIQUE_ID_KEY = 'lock_unique_id';

 /**
  * 生成鎖惟一ID（經過Redis incr指令實現簡易版本，可結合日期、時間戳、取餘、字符串填充、隨機數等函數，生成指定位數惟一ID）
  * @return mixed
  */
 public static function generateUniqueLockId()
 {
  return self::getRedisConn()->incr(self::REDIS_LOCK_UNIQUE_ID_KEY);
 }
}

//test
$res1 = Lock_Service::addLock('666666');
var_dump($res1);//返回lock id，加鎖成功
$res2 = Lock_Service::addLock('666666');
var_dump($res2);//false，加鎖失敗
$res3 = Lock_Service::releaseLock('666666', $res1);
var_dump($res3);//true，解鎖成功
$res4 = Lock_Service::releaseLock('666666', $res1);
var_dump($res4);//false，解鎖失敗