如何在PHP項目中實現一個Redis單據鎖

如何在PHP項目中實現一個Redis單據鎖？相信很多沒有經驗的人對此束手無策，為此本文總結了問題出現的原因和解決方法，通過這篇文章希望你能解決這個問題。

主要依賴Redis setnx指令實現：

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

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

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

 /**
  * 加單據鎖
  * @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;
 }

四、解鎖機制：

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

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

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

/**
  * 解單據鎖
  * @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;
 }

六、附整體測試代碼（此代碼僅為簡易版本）

<?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，解鎖失敗

看完上述內容，你們掌握如何在PHP項目中實現一個Redis單據鎖的方法了嗎？如果還想學到更多技能或想了解更多相關內容，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！