Redis key过期事件监听实现 - 30分钟自动取消未支付订单

一、前言

前段时间一个朋友问：让实现一个30分钟如果订单未支付，系统自动取消订单的功能需求，当时巴拉巴拉给他说了几种方案；

那么，今天着重挑选一种通用、效率高的方案给大家讲解一下；

Demo源码地址详见：《Alipay_demo》 下载即可使用

好文章 记得收藏+点赞+关注额 ！！！

---- Nick.Peng

二、实现方案分析

• 方案1：统一的定时任务，每隔1分钟轮询执行，来处理订单

  缺点： 一听到轮询，肯定是不建议大家使用的，每隔一分钟处理一次，过于频繁的请求，增加服务器的负担。并且会有1分钟的误差，因为定时任务设置每隔1分钟执行一次。
  优点： 实现简单

• 方案2：利用mq的延迟发送特性处理 + 定时任务

  下单后，发送一条消息给mq，并设置mq，30分钟后再处理发送消息动作
  优点： 时间准确性相对高，一个单子只执行一次，并发高。
  缺点：
          1、当大量消息堆积的时候，同样存在延迟的问题。同时还可能存在消息丢失风险。（rocketmq号称0丢失）
          2、基本上mq，都是默认不开启延迟发送的，需要开启mq延迟发送功能，且会增加mq的一部分性能负担。

• 方案3：利用redis的过期key特性处理

  优点： 时间准确性相对高，一个单子只执行一次，过期key到期自动消失。
  缺点：
          1、消息只发送一次，不管有没有处理成功。
          2、当很多key同时过期时，存在延迟问题。
          3、redis默认是不开启这个功能的，需要开启redis过期key的监听订阅，会增加redis的一部分性能负担。

• 方案4：写一套30分钟后处理的定时任务

  当下单后，新建一个30分钟后处理的定时任务
  优点： 时间准确性高，一个单子只执行一次。（可以使用Apscheduler定时框架+redis）
  缺点： 需要频繁新建定时任务，并且需要删除处理过无用的定时任务。

• 方案5：在订单列表视图中实现一套30分钟取消订单的逻辑
  
  

三、Redis key过期事件方案实现步骤

Re：
        Redis 自2.8.0之后版本提供了 Keyspace Notifications 功能，允许客户订阅 Pub / Sub 频道，以便以某种方式接收影响 Redis 数据集的事件。

3.1 Redis 安装步骤详见

• 《Linux 安装 Redis 5.0 最新版》或《Docker 安装 Redis 步骤以及设置密码》

3.2 修改 Redis 配置

• 找到 redis.conf 配置文件，一般在/etc/redis/redis.conf，可以通过以下方式查看：
  
• 修改 Redis 配置文件，找到notify-keyspace-events Ex，默认是被注释的，打开注释，并将下面的 notify-keyspace-events ""加上注释即可
  

  # ====== 配置参数说明 ======
  # K    键空间通知，以__keyspace@<db>__为前缀
  # E    键事件通知，以__keysevent@<db>__为前缀
  # g    del , expipre , rename 等类型无关的通用命令的通知, ...
  # $    String命令
  # l    List命令
  # s    Set命令
  # h    Hash命令
  # z    有序集合命令
  # x    过期事件（每次key过期时生成）
  # e    驱逐事件（当key在内存满了被清除时生成）
  # A    g$lshzxe的别名，因此”AKE”意味着所有的事件
  

• 重启 redis; 输入命令：sudo service redis-server restart

3.3 在获取支付链接视图中设置key过期事件

• 在 payment views.py 视图集中的获取支付链接视图中增加以下代码

  
  # 设置redis key空间过期事件，实现key过期自动取消订单，这里过期时间模拟设为10秒
  prefix = 'nick_'
  key_name = f"{prefix}{out_trade_no}"  # 拼接key：自定义前缀'nick_' + '订单编号'
  seconds = 30 * 60  # 30分钟订单自动取消
  redis.setex(key_name, 10 if settings.DEBUG else seconds, "use_cancel_order")  # key, seconds, value
  
  

3.4 编写取消订单视图

• 在 payment views.py 视图集中新增 cancel_order 视图

  @csrf_exempt
  @atomic()
  def cancel_order(request):
      if request.method == "POST":
          post = json.loads(request.body, strict=False)
          order_id = post.get("order_id", 0)
          if not order_id:
              return JsonResponse(dict(message="参数错误"))
          # 取消订单业务逻辑实现
          # 校验订单，查询订单是否存在
          # 存在即更新订单状态
          return JsonResponse(dict(message="取消订单成功"))
  
      return JsonResponse(dict(message="请求方法错误，取消订单失败"))
  

3.5 编写订单监听脚本

• 在 script 里新建 order_monitor.py

  # -*- coding: utf-8 -*-
  # @Author      : Nick
  # @File        : order_monitor.py  v1.0
  # @CreateTime  : 2020-08-09 14:30:11
  # Copyright (C) 2020 Nick Ltd. All rights reserved.
  import json
  import time
  
  import requests
  from utils.common import Redis
  
  # 创建Redis对象并连接redis数据库
  redis = Redis().connection()
  # 创建pub_sub对象，该对象订阅一个频道并侦听新消息：
  pub_sub = redis.pubsub()
  
  
  # 定义触发事件
  def event_handler(msg):
      # msg：{'type': 'pmessage', 'pattern': '__keyevent@0__:expired', 'channel': '__keyevent@0__:expired', 'data': 'nick_1'}
      print('捕获到订阅消息：', msg)
      data = msg.get('data')  # 获取键，创建订单设置SETEX key seconds value
      data_list = data.split('_')
      if data_list[0] == 'nick':  # 在创建订单，写入redis key时加上prefix前缀：nick_
          order_id = data_list[-1]
          print(f'过期的订单id：{order_id}')
          url = 'http://192.168.0.106:8008/payment/cancel_order/'  # 这里改成你对应域名/IP地址
          result = requests.post(url=url, json=dict(order_id=order_id))
          data = json.loads(result.content.decode("UTF-8"))
          print("事件执行返回状态：", data)
  
  
  # 订阅redis键空间通知，__keyevent@0__:expired 的 0 表示数据库index，表示只触发本数据库的过期事件
  pub_sub.psubscribe(**{'__keyevent@0__:expired': event_handler})
  
  
  def main():
      # 主方法，循环接收订阅的通知
      while True:
          message = pub_sub.get_message()
          if message:
              # message：{'type': 'psubscribe', 'pattern': None, 'channel': '__keyevent@0__:expired', 'data': 1}
              print(f"订阅的消息: {message}")
              print('正在监听过期订单。。。。。。')
              time.sleep(0.5)
          else:
              time.sleep(0.5)
  
  
  if __name__ == '__main__':
      main()
  
  

四、项目运行并监听订单

• 运行 django 项目和 order_monitor 脚本