PHP實作簡單Redis單據鎖並防止並發重複調用

在整個供應鏈系統中，會有很多種單據（採購單、入庫單、到貨單、運單等等），在涉及寫單據資料的介面時（增刪改操作），即使前端做了相關限制，還是有可能因為網路或異常操作產生並發重複呼叫的情況，導致對相同單據做相同的處理；

為了防止這種情況對系統造成異常影響，我們透過Redis實作了一個簡單的單據鎖，每個請求需先取得鎖才能執行業務邏輯，執行結束後才會釋放鎖；保證了同一單據的並發重複操作請求只有一個請求可以取得到鎖（依賴Redis的單執行緒），是一種悲觀鎖的設計；

註：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, [&#39;nx&#39;, &#39;ex&#39;=>$intExpireTime]);        
        
        //加锁成功返回锁ID，加锁失败返回false
        return $bolRes ? $intUniqueLockId : $bolRes;
    }

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

WATCH指令可以監控一個或多個鍵，一旦其中有一個鍵被修改（或刪除），之後的交易就不會執行。監控一直持續到EXEC指令（交易中的指令是在EXEC之後才執行的，所以在MULTI指令後可以修改WATCH監控的鍵值）
Redis watch與事務可參考簡書文章：https://www.jianshu.com/p/361cb9cd13d5

五、解鎖實作（完整測試程式碼會貼在最後）：

/**
     * 解单据锁
     * @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 = &#39;order_lock_%s&#39;;    
    
    /**
     * 单据锁默认超时时间（秒）
     */
    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, [&#39;nx&#39;, &#39;ex&#39;=>$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 = &#39;127.0.0.1&#39;;    
    
     /**
     * 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 = &#39;lock_unique_id&#39;;    /**
     * 生成锁唯一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(&#39;666666&#39;);
var_dump($res1);//返回lock id，加锁成功$res2 = Lock_Service::addLock(&#39;666666&#39;);
var_dump($res2);//false，加锁失败$res3 = Lock_Service::releaseLock(&#39;666666&#39;, $res1);
var_dump($res3);//true，解锁成功$res4 = Lock_Service::releaseLock(&#39;666666&#39;, $res1);
var_dump($res4);//false，解锁失败

以上是PHP實作簡單Redis單據鎖並防止並發重複調用的詳細內容。更多資訊請關注PHP中文網其他相關文章！