Spring Boot 集成 Redis 事件通知实现订单到期自动关闭

落日映苍穹つ 2023-02-25 08:47 9阅读 0赞

之前写过一篇文章 [RabbitMQ 延迟队列实现订单自动关闭][RabbitMQ]，今天介绍另外一种方式就是通过 Redis 的过期来实现订单自动关闭。

## 1、功能概述 ##

从 Redis 2.8.0 开始，健空间通知允许客户订阅 Pub/Sub 通道以接收影响Redis数据集的事件。可以接收到的事件的例子如下:

*  影响给定键的所有命令。
 *  接收LPUSH操作的所有键。
 *  所有键在数据库 0 中到期。

事件是使用正常的发布/订阅层的Redis，所以实现发布/订阅的客户端可以使用这个功能而不需要修改。

因为 Redis 发布/订阅是 fire and forget，目前没有办法使用这个功能，如果你的应用程序需要可靠的事件通知，也就是说，如果你的发布/订阅客户端断开连接，然后重新连接，所有在客户端断开连接期间发送的事件都丢失了。

未来有计划允许更可靠地交付事件，但这可能会在更广泛的层次上解决，或者提高发布/订阅本身的可靠性，或者允许Lua脚本拦截发布/订阅消息，以执行诸如将事件推入列表之类的操作。

## 2、事件类型 ##

键空间通知是通过为影响 Redis 数据空间的每个操作发送两种不同类型的事件来实现的。例如，针对数据库 0 中名为 mykey 的键的 DEL 操作将触发两个消息的传递，完全等同于以下两个发布命令:

PUBLISH __keyspace@0__:mykey del
    PUBLISH __keyevent@0__:del mykey

很容易看出，一个通道如何允许我们侦听所有针对键mykey的事件，而另一个通道如何允许获取有关del操作目标的所有键的信息。

通道中带有键空间前缀的第一种事件称为键空间通知，而带有键事件前缀的第二种事件称为键事件通知。

在上面的示例中，为密钥mykey生成了一个del事件。结果是:

*  键空间通道接收事件的名称作为消息。
 *  键事件通道将键的名称作为消息接收。

为了只交付我们感兴趣的事件子集，可以只启用一种通知。

## 3、配置 ##

默认情况下，键空间事件通知是禁用的，因为虽然这个特性使用了一些 CPU 能量，但它并不太明智。使用 redis.conf的 `notify-keyspace-events` 或通过配置集启用通知。

将该参数设置为空字符串将禁用通知。为了实现该特性，使用了一个由多个字符组成的非空字符串，其中每个字符都有特殊含义，如下表所示:

K     Keyspace events, published with __keyspace@<db>__ prefix.
    E     Keyevent events, published with __keyevent@<db>__ prefix.
    g     Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
    $     String commands
    l     List commands
    s     Set commands
    h     Hash commands
    z     Sorted set commands
    t     Stream commands
    x     Expired events (events generated every time a key expires)
    e     Evicted events (events generated when a key is evicted for maxmemory)
    m     Key miss events (events generated when a key that doesn't exist is accessed)
    A     Alias for "g$lshztxe", so that the "AKE" string means all the events except "m".

字符串中至少应该有K或E，否则无论字符串的其余部分如何，都不会传递事件。例如，要仅为列表启用键空间事件，配置参数必须设置为Kl，等等。字符串KEA可以用来启用每一个可能的事件。

这里我通过关注 Redis Key 的过期时间来定时关闭订单。需要配置 `redis.conf` 如下：

默认配置为：
    notify-keyspace-events ""
    
    修改为：
    notify-keyspace-events Ex

这里告诉一下我踩过的坑，我直接一直使用 `${REDIS_HOME}/src/redis-server &` 启动如果监听过期事件一直不成功。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI0MTA3MzM_size_16_color_FFFFFF_t_70]  
通过查看 redis 的启动日志才发现它默认不是使用 `${REDIS_HOME}/redis.conf` 启动的。后面把命令修改成：

src/redis-server redis.conf &

就可以了，所以查看日志是多么重要的一件事。

## 4、 Spring Boot 集成 Redis 订单过期 ##

### 4.1 maven 依赖 ###

Spring Boot 集成 Redis 订单过期所需要依赖的 Jar 包。

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.8.RELEASE</version>
            <relativePath/>
        </parent>
    
        <groupId>cn.carlzone.test</groupId>
        <artifactId>fintech-test</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-redis</artifactId>
            </dependency>
            <dependency>
                <groupId>com.google.guava</groupId>
                <artifactId>guava</artifactId>
                <version>20.0</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
        </dependencies>
    
        <build>
            <finalName>fintech-notice-client</finalName>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

### 4.2 订单实体类 ###

订单实例类，包含订单的基本信息。

@Data
    public class Order {
    
        /** 商户 ID */
        private String merchantId;
    
        /** 订单号 */
        private Long orderId;
    
        /** 用户名 */
        private String username;
    
        /** 金额 */
        private String amount;
    
        /** 产品名称 */
        private String productName;
    
    }

### 4.3 常量类 ###

定义一些基本常量类。

public class CommonConstant {
    
        public static final String ORDER_EXPIRE_KEY = "order_expire";
    
        public static final int ORDER_EXPIRE_KEY_LENGTH = 3;
    
        public static final String CACHE_KEY_SEPARATE = ":";
    
    }

### 4.4 订单控制器 ###

订单控制器，接收业务方的订单请求。

@RestController
    @RequestMapping("order")
    public class OrderController {
    
        @Resource(name = "orderService")
        private OrderService orderService;
    
        @RequestMapping("receipt")
        public String receipt(@RequestBody Order order) {
            return orderService.receipt(order);
        }
    
    }

### 4.5 订单服务类 ###

订单服务类它的主要逻辑是保存订单到数据库，然后设置包含商户 ID 和订单 ID 的订单的 10 秒过期的 Key 到 Redis 当中。

@Slf4j
    @Service("orderService")
    public class OrderService {
    
        @Resource(name = "stringRedisTemplate")
        private StringRedisTemplate redisTemplate;
    
        private static final AtomicLong ID_GEN = new AtomicLong();
    
        public String receipt(Order order) {
            // 模拟创建订单
            log.info("创建订单成功");
            order.setOrderId(ID_GEN.getAndIncrement());
    
            // 获取缓存 key
            String cacheKey = getCacheKey(order);
            log.info("OrderService.receipt cache key is {}", cacheKey);
    
            // 设置订单过期 cache
            redisTemplate.opsForValue().set(cacheKey, cacheKey, 10, TimeUnit.SECONDS);
    
            return "success";
        }
    
        private String getCacheKey(Order order){
           Joiner joiner = Joiner.on(CommonConstant.CACHE_KEY_SEPARATE);
           return joiner.join(CommonConstant.ORDER_EXPIRE_KEY, order.getMerchantId(), order.getOrderId());
        }
    
    }

### 4.6 Redis 过期键监听器 ###

实现实现提供的消息监听器 `MessageListener`，监听 Redis 的过期键事件。当这个 key 是 `order_expire` 开头就说明它是我们设置的订单过期关闭的 Key。

@Slf4j
    @Component
    public class TopicMessageListener implements MessageListener {
    
        @Override
        public void onMessage(Message message, byte[] pattern) {
            String expiredKey = message.toString();
            String[] str = expiredKey.split(CommonConstant.CACHE_KEY_SEPARATE);
            if(str.length == CommonConstant.ORDER_EXPIRE_KEY_LENGTH && CommonConstant.ORDER_EXPIRE_KEY.equals(str[0])){
                log.info("TopicMessageListener#onMessage order expire merchantId {}, orderId {}", str[1], str[2]);
            }
        }
    
    }

### 4.7 Redis 过期键监听配置 ###

配置 Redis 的过期键监听器 `TopicMessageListener` 到 Spring 提供的Redis 监听容器 `RedisMessageListenerContainer` 当中，这里没有配置 Redis。因为 `Spring Boot` 默认会自动配置 `redis` 的地址是 `localhost`，端口为 `6379` 和 `0` 数据库.

@Configuration
    public class RedisConfig {
    
        @Bean
        public RedisMessageListenerContainer redisMessageListenerContainer(RedisConnectionFactory factory, TopicMessageListener listener) {
            Topic keyEventExpiredTopic = new PatternTopic("__keyevent@0__:expired");
            RedisMessageListenerContainer container = new RedisMessageListenerContainer();
            Executor executor = new ThreadPoolExecutor(10, 20, 60, TimeUnit.SECONDS, new LinkedBlockingQueue<>());
            container.setTaskExecutor(executor);
            container.setConnectionFactory(factory);
            container.addMessageListener(listener, keyEventExpiredTopic);
            return container;
        }
    
    }

## 5、测试 ##

启动项目，然后使用 postman 向 `http://localhost:8080/order/receipt` 发送请求：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI0MTA3MzM_size_16_color_FFFFFF_t_70 1]  
服务打印的日志如下：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI0MTA3MzM_size_16_color_FFFFFF_t_70 2]  
可以看到订单的创建时间是 `20:04:51` ，而过期键监听器的消费时间创建订单的 10 秒后是 `20:05:01`。

*  [Redis Keyspace Notifications][]

[RabbitMQ]: https://blog.csdn.net/u012410733/article/details/87922920
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI0MTA3MzM_size_16_color_FFFFFF_t_70]: /images/20230209/79d4921fcddf4858b2d97a2808c7c21f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI0MTA3MzM_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200711200306725.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI0MTA3MzM=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI0MTA3MzM_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200711200542137.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI0MTA3MzM=,size_16,color_FFFFFF,t_70
[Redis Keyspace Notifications]: https://redis.io/topics/notifications