目录
Asynq 实现 Go 异步任务处理
一、概述
今天为大家介绍一个Go处理异步任务的解决方案:Asynq。
Asynq 是一个 Go 库,用于异步任务处理的库。它由Redis提供支持,旨在实现可扩展且易于上手
- Asynq 工作原理的高级概述:
- 客户端将任务放入队列
- 服务器从队列中拉出任务并为每个任务启动一个工作 goroutine
- 多个工作人员同时处理任务
- git库地址:
二、快速开始
1. 准备工作
- 确保已安装并运行了redis
redis 版本大于5.0
redis-server
目录结构
.
├── conf
│ └── redis.conf
└── docker-compose.yml
docker-compose.yml
version: '3.8'
services:
myredis:
container_name: myredis
image: redis:6.2.5 #6.0.6
restart: always
ports:
- 6379:6379
privileged: true
environment:
# 时区上海
TZ: Asia/Shanghai
command: redis-server /etc/redis/redis.conf --appendonly yes
volumes:
- $PWD/data:/data
- $PWD/conf/redis.conf:/etc/redis/redis.conf
# networks:
# - myweb
#networks:
# myweb:
# driver: bridge
conf/redis.conf
#开启保护
protected-mode yes
#开启远程连接
#bind 127.0.0.1
#自定义密码
requirepass 123456
port 6379
timeout 0
# 900s内至少一次写操作则执行bgsave进行RDB持久化
save 900 1
save 300 10
save 60 10000
# rdbcompression ;默认值是yes。对于存储到磁盘中的快照,可以设置是否进行压缩存储。如果是的话,redis会采用LZF算法进行压缩。如果你不想消耗CPU来进行压缩的话,可以设置为关闭此功能,但是存储在磁盘上的快照会比较大。
rdbcompression yes
# dbfilename :设置快照的文件名,默认是 dump.rdb
dbfilename dump.rdb
# dir:设置快照文件的存放路径,这个配置项一定是个目录,而不能是文件名。使用上面的 dbfilename 作为保存的文件名。
dir /data
# 默认redis使用的是rdb方式持久化,这种方式在许多应用中已经足够用了。但是redis如果中途宕机,会导致可能有几分钟的数据丢失,根据save来策略进行持久化,Append Only File是另一种持久化方式, 可以提供更好的持久化特性。Redis会把每次写入的数据在接收后都写入appendonly.aof文件,每次启动时Redis都会先把这个文件的数据读入内存里,先忽略RDB文件。默认值为no。
appendonly yes
# appendfilename :aof文件名,默认是"appendonly.aof"
# appendfsync:aof持久化策略的配置;no表示不执行fsync,由操作系统保证数据同步到磁盘,速度最快;always表示每次写入都执行fsync,以保证数据同步到磁盘;everysec表示每秒执行一次fsync,可能会导致丢失这1s数据
appendfsync everysec
启动 redis
服务
docker-compose up -d
2. 安装asynq软件包
go get -u github.com/hibiken/asynq
3. 创建项目asynq_task
目录结构:
.
|-- README.md
|-- cmd
| `-- main.go # 启动消费者监听
|-- go.mod
|-- go.sum
|-- test.go # 生产者 发送测试数据
`-- test_delivery
|-- client
| `-- client.go # 生产者 具体发送测试数据的逻辑
`-- test_delivery.go # 消费者,执行任务具体处理逻辑
2. Redis连接项
Asynq
使用 Redis
作为消息代理。
client.go
和 main.go
都需要连接到 Redis
进行写入和读取。
我们将使用 asynq.RedisClientOpt
指定如何连接到本地 Redis
实例。
asynq.RedisClientOpt{
Addr: "127.0.0.1:6379",
Password: "",
DB: 2,
}
4. Task任务
*asynq.Task
type Task struct {
// 一个简单的字符串值,表示要执行的任务的类型.
typename string
// 有效载荷保存执行任务所需的数据,有效负载值必须是可序列化的.
payload []byte
// 保存任务的选项.
opts []Option
// 任务的结果编写器.
w *ResultWriter
}
5. 编写程序
1)test_delivery.go
一个封装任务创建和任务处理的包
package test_delivery
import (
"context"
"encoding/json"
"fmt"
"github.com/hibiken/asynq"
"log"
)
const (
TypeEmailDelivery = "email:deliver"
)
// EmailDeliveryPayload 异步任务需要传递的数据结构
type EmailDeliveryPayload struct {
UserID int
TemplateID string
DataStr string
}
// NewEmailDeliveryTask 异步任务需要传递的数据
func NewEmailDeliveryTask(userID int, tmplID, dataStr string) (*asynq.Task, error) {
payload, err := json.Marshal(EmailDeliveryPayload{UserID: userID, TemplateID: tmplID, DataStr: dataStr})
if err != nil {
fmt.Println(err)
re