PHP用Redis单据锁，防止并发重复写入数据

用redis 的 setnx 命令实现

• 只在键 key 不存在的情况下， 将键 key 的值设置为 value 。

• 若键 key 已经存在， 则 SETNX 命令不做任何动作。

• SETNX 是『SET if Not eXists』(如果不存在，则 SET)的简写。

namespace app\model;

use think\facade\Cache;

/**
 * Class Lock_Service 单据锁服务
 */
class Lock
{
    /**
     * 单据锁redis key模板
     */
    private const REDIS_LOCK_KEY_TEMPLATE = 'order_lock_%s';

    /**
     * 单据锁默认超时时间（秒）
     */
    private const REDIS_LOCK_DEFAULT_EXPIRE_TIME = 3600;
    private $objRedis;

    public function __construct()
    {
        $this->objRedis = Cache::store('redis')->handler();
    }
    /**
     * 加单据锁
     * @param int $intOrderId 单据ID
     * @param int $intExpireTime 锁过期时间（秒）
     * @return bool|int 加锁成功返回唯一锁ID，加锁失败返回false
     */
    public function addLock(int $intOrderId, int $intExpireTime = self::REDIS_LOCK_DEFAULT_EXPIRE_TIME)
    {
        //参数校验
        if (empty($intOrderId) || $intExpireTime <= 0) {
            return false;
        }

        //生成唯一锁ID，解锁需持有此ID
        $intUniqueLockId = $this->generateUniqueLockId();

        //根据模板，结合单据ID，生成唯一Redis key（一般来说，单据ID在业务中系统中唯一的）
        $strKey = sprintf(self::REDIS_LOCK_KEY_TEMPLATE, $intOrderId);

        //加锁（通过Redis setnx指令实现，从Redis 2.6.12开始，通过set指令可选参数也可以实现setnx，同时可原子化地设置超时时间）
        $bolRes = $this->objRedis->set($strKey, $intUniqueLockId, ['nx', 'ex' => $intExpireTime]);

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

    /**
     * 解单据锁
     * @param int $intOrderId 单据ID
     * @param int $intLockId 锁唯一ID
     * @return bool
     */
    public function releaseLock(int $intOrderId, int $intLockId): bool
    {
        //参数校验
        if (empty($intOrderId) || empty($intLockId)) {
            return false;
        }

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

        //监听Redis key防止在【比对lock id】与【解锁事务执行过程中】被修改或删除，提交事务后会自动取消监控，其他情况需手动解除监控
        $this->objRedis->watch($strKey);
        if ($intLockId === (int)$this->objRedis->get($strKey)) {
            $this->objRedis->multi()->del($strKey)->exec();
            return true;
        }
        $this->objRedis->unwatch();
        return false;
    }

    /**
     * 用于生成唯一的锁ID的redis key
     */
    private const REDIS_LOCK_UNIQUE_ID_KEY = 'lock_unique_id';

    /**
     * 生成锁唯一ID（通过Redis incr指令实现简易版本，可结合日期、时间戳、取余、字符串填充、随机数等函数，生成指定位数唯一ID）
     * @return mixed
     */
    public function generateUniqueLockId()
    {
        return $this->objRedis->incr(self::REDIS_LOCK_UNIQUE_ID_KEY);
    }
}

$lock = new Lock();
$orderId = '888888';
// 加锁成功
$intLockId = $lock->addLock($orderId);
dump($intLockId);
// 加锁失败
dump($lock->addLock($orderId));
// 解锁成功
dump($lock->releaseLock($orderId,$intLockId));