企业级延迟任务方案之RabbitMQ死信队列

叁歲伎倆 2022-11-26 07:52 97阅读 0赞

> 延迟任务的应用场景比较广泛，比如订单超时关闭交易，支付结果延迟推送等，实现方案比较多，这期我们将介绍一下利用RabbitMQ死信队列实现延迟任务。

### 实现原理 ###

RabbitMQ的死信队列可以设置一个超时时间，超时之后之后消息可以回到绑定的队列中，此时回调用户给定的接口即可；原理简单但是需要保证消息的[可靠性][Link 1]

### 源码地址 ###

[https://github.com/WinterChenS/delay-server][https_github.com_WinterChenS_delay-server]

## 项目依赖 ##

*  jdk8
 *  maven
 *  springboot 2.3.0
 *  Redis
 *  RabbitMQ
 *  docker (可选）

## 实现功能 ##

*  可通用的延时任务服务
 *  可定制的超时时间以及重试次数，确保消息的可靠
 *  回调异常重试
 *  可拓展的失败消息存储策略

## 如何使用 ##

### 1.拉取代码 ###

git clone https://github.com/WinterChenS/delay-server.git

### 2.修改application.properties ###

### 3.编译 ###

> 以下方式选一即可

#### 3.1 普通编译 ####

cd delay-server &&
    mvn clean package

#### 3.2 docker编译 ####

cd delay-server &&
    mvn clean package docker:build

### 4.运行 ###

> 运行方式选一即可

#### 4.1 普通运行 ####

cd target &&
    nohup java -jar delay-server-0.0.1-SNAPSHOT.jar &

#### 4.2 docker运行 ####

docker run -p 8088:8088 -d  winterchen/delay-server

### 5.调用 ###

OkHttp

OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\n \"id\": \"0923840293429384023\",\n \"expireTime\": 3,\n \"message\": \"hello\",\n \"callbackPath\": \"http://127.0.0.1:8088/test/success\",\n \"currentTime\": 29387492384,\n \"retryCount\": 3\n}");
    Request request = new Request.Builder()
      .url("http://127.0.0.1:8088/api/v1/default/delay")
      .post(body)
      .addHeader("Content-Type", "application/json")
      .addHeader("cache-control", "no-cache")
      .build();
    
    Response response = client.newCall(request).execute();

接口参数描述：

<table> 
 <thead> 
  <tr> 
   <th>参数名</th> 
   <th>类型</th> 
   <th>解释</th> 
   <th>是否必须</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>String</td> 
   <td>请求唯一ID</td> 
   <td>是</td> 
   <td>982739492347932</td> 
  </tr> 
  <tr> 
   <td>expireTime</td> 
   <td>Long</td> 
   <td>过期时间(秒)</td> 
   <td>是</td> 
   <td>30</td> 
  </tr> 
  <tr> 
   <td>message</td> 
   <td>String</td> 
   <td>消息体（随意字符串)</td> 
   <td>是</td> 
   <td>{“name”:“ston”,“message”:“23424”}</td> 
  </tr> 
  <tr> 
   <td>callbackPath</td> 
   <td>String</td> 
   <td>过期回调地址</td> 
   <td>是</td> 
   <td>http://127.0.0.1:8088/test/success</td> 
  </tr> 
  <tr> 
   <td>currentTime</td> 
   <td>Long</td> 
   <td>当前系统时间</td> 
   <td>是</td> 
   <td>29387492384</td> 
  </tr> 
  <tr> 
   <td>retryCount</td> 
   <td>Integer</td> 
   <td>失败重试次数（默认无限重试）</td> 
   <td>否</td> 
   <td>0</td> 
  </tr> 
 </tbody> 
</table>

## docker镜像使用 ##

### docker ###

docker run -p 8088:8088 \
    -e SERVER_PORT=8088 \
    -e SPRING_RABBITMQ_HOST=127.0.0.1 \
    -e SPRING_RABBITMQ_PORT=5672 \
    -e SPRING_RABBITMQ_USERNAME=guest \
    -e SPRING_RABBITMQ_PASSWORD=guest \
    -e SPRING_REDIS_HOST=127.0.0.1 \
    -e SPRING_REDIS_PORT=6379 \
    -e SPRING_REDIS_PASSWORD=root \
    -e SPRING_REDIS_TIMEOUT=10000 \
    winterchen/delay-server

### docker-compose ###

version: '3'
    
    services:
      delay-server:
        container_name: delay-server
        image: winterchen/delay-server
        ports:
          - "8088:8088"
        volumes:
          - "./delay/log:/log"
        environment:
          SERVER_PORT: 8088
          SPRING_RABBITMQ_HOST: 127.0.0.1
          SPRING_RABBITMQ_PORT: 5672
          SPRING_RABBITMQ_USERNAME: guest
          SPRING_RABBITMQ_PASSWORD: guest
          SPRING_RABBITMQ_LISTENER_SIMPLE_ACKNOWLEDGE-MODE: manual
          SPRING_REDIS_HOST: 127.0.0.1
          SPRING_REDIS_PORT: 6379
          SPRING_REDIS_PASSWORD: root
          SPRING_REDIS_TIMEOUT: 10000
          SPRING_REDIS_DATABASE: 0
          SPRING_REDIS_LETTUCE_POOL_MAX_ACTIVE: 8
          SPRING_REDIS_LETTUCE_POOL_MAX_WAIT: -1
          SPRING_REDIS_LETTUCE_POOL_MAX_IDLE: 8
          SPRING_REDIS_LETTUCE_POOL_MIN_IDLE: 0
          COM_WINTERCHEN_FAIL_STORE_STRATEGY_CODE: REDIS

### 拓展 ###

该服务支持arrch64，点击即可获取详细使用方法  
[点击进入][Link 2]

## 使用注意事项 ##

*  该项目仅供学习，请勿在生产中使用
 *  使用该服务需要保证回调接口的幂等性

[Link 1]: https://juejin.im/post/6844903933182214151
[https_github.com_WinterChenS_delay-server]: https://github.com/WinterChenS/delay-server
[Link 2]: https://hub.docker.com/repository/docker/winterchen/delay-server-arrch64