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, ['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，解锁失败

以上就是本次给大家整理的全部内容，感谢大家对的支持。