# 1. 介绍
Asynq 是一个 Go 库，用于对任务进行排队并与工作人员异步处理它们。
它的工作原理：
客户端将任务放入队列
服务器从队列中拉出任务并为每个任务启动一个工作 goroutine
多个工作人员同时处理任务
仓库链接：https://github.com/hibiken/asynq)
# 2. 快速开始
2.1 准备工作
确保已安装并运行了redis
redis-server
安装asynq软件包
go get -u github.com/hibiken/asynq
创建项目asynq_task，目录结构：
2.2 Redis连接项
Asynq 使用 Redis 作为消息代理。
client.go 和 main.go 都需要连接到 Redis 进行写入和读取。
我们将使用 RedisClientOpt 指定如何连接到本地 Redis 实例。
asynq.RedisClientOpt{
Addr: "127.0.0.1:6379",
Password: "",
DB: 2,
}
2.3 Task任务
type Task struct {
// 一个简单的字符串值，表示要执行的任务的类型.
typename string
// 有效载荷保存执行任务所需的数据，有效负载值必须是可序列化的.
payload []byte
// 保存任务的选项.
opts []Option
// 任务的结果编写器.
w *ResultWriter
}
2.4 编写程序
test_delivery.go : 一个封装任务创建和任务处理的包
package test_delivery
import (
"context"
"encoding/json"
"fmt"
"github.com/hibiken/asynq"
"log"
)
const (
TypeEmailDelivery = "email:deliver"
)
type EmailDeliveryPayload struct {
UserID int
TemplateID string
}
func NewEmailDeliveryTask(userID int, tmplID string) (*asynq.Task, error) {
payload, err := json.Marshal(EmailDeliveryPayload{UserID: userID, TemplateID: tmplID})
if err != nil {
fmt.Println(err)
return nil, err
}
return asynq.NewTask(TypeEmailDelivery, payload), nil
}
func HandleEmailDeliveryTask(ctx context.Context, t *asynq.Task) error {
var p EmailDeliveryPayload
if err := json.Unmarshal(t.Payload(), &p); err != nil {
return fmt.Errorf("json.Unmarshal failed: %v: %w", err, asynq.SkipRetry)
}
//逻辑处理start...
log.Printf("Sending Email to User: user_id=%d, template_id=%s", p.UserID, p.TemplateID)
return nil
}
client.go: 在应用程序代码中，导入上述包并用于Client将任务放入队列中。
package client
import (
"asynq_task/test_delivery"
"github.com/hibiken/asynq"
"log"
)
func EmailDeliveryTaskAdd() {
client := asynq.NewClient(asynq.RedisClientOpt{
Addr: "127.0.0.1:6379",
Password: "",
DB: 2,
})
defer client.Close()
task, err := test_delivery.NewEmailDeliveryTask(42, "some:template:id")
if err != nil {
log.Fatalf("could not create task: %v", err)
}
info, err := client.Enqueue(task)
if err != nil {
log.Fatalf("could not enqueue task: %v", err)
}
log.Printf("enqueued task: id=%s queue=%s", info.ID, info.Queue)
}
main.go: 异步任务服务入口文件
接下来，启动一个工作服务器以在后台处理这些任务。要启动后台工作人员，使用Server并提供您Handler来处理任务。可以选择使用ServeMux来创建处理程序，就像使用net/httpHandler 一样。
package main
import (
"asynq_task/test_delivery"
"github.com/hibiken/asynq"
"log"
)
func main() {
srv := asynq.NewServer(
asynq.RedisClientOpt{
Addr: "127.0.0.1:6379",
Password: "",
DB: 2,
},
asynq.Config{
// 每个进程并发执行的worker数量
Concurrency: 5,
// Optionally specify multiple queues with different priority.
Queues: map[string]int{
"critical": 6,
"default": 3,
"low": 1,
},
// See the godoc for other configuration options
},
)
mux := asynq.NewServeMux()
mux.HandleFunc(test_delivery.TypeEmailDelivery, test_delivery.HandleEmailDeliveryTask)
if err := srv.Run(mux); err != nil {
log.Fatalf("could not run server: %v", err)
}
}
Asynq 是一个 Go 库(https://github.com/hibiken/asynq)，用于对任务进行排队并与工作人员异步处理它们。用来分发异步任务
package main
import (
"asynq_task/test_delivery/client"
"time"
)
func main() {
for i := 0; i < 3; i++ {
client.EmailDeliveryTaskAdd()
time.Sleep(time.Second * 3)
}
}
5. 运行查看结果
首先，我们要先把异步任务启动起来准备好接收，也就是启动cmd/main.go
启动test.go文件向异步任务服务添加任务队列
结果如下：
go run main.go
# 3. 细节
3.1 关于asynq的优雅退出
如果异步服务突然被暂停，正在执行的异步任务会push到队列中，下次启动的时候自动执行。
我们可以将一个异步任务中途sleep几秒，发送一个异步任务，任务没执行完中途停掉任务测试出结果：
再次启动异步任务服务，发现这个任务被重新执行。
3.2 client中 client.Enqueue 的使用
1) 立即处理任务
client.Enqueue(t1, time.Now())
2）延时处理任务， 两小时后处理
client.Enqueue(t2, asynq.ProcessIn(time.Now().Add(2 * time.Hour)))
3) 任务重试，最大重试次数为25次。
client.Enqueue(task, asynq.MaxRetry(5))
4）确保任务的唯一性
4-1：使用TaskID选项：自行生成唯一的任务 ID
_, err := client.Enqueue(task, asynq.TaskID("mytaskid"))
// Second task will fail, err is ErrTaskIDConflict (assuming that the first task didn't get processed yet)
_, err = client.Enqueue(task, asynq.TaskID("mytaskid"))
4-2：使用Unique选项：让 Asynq 为任务创建唯一性锁
err := c.Enqueue(t1, asynq.Unique(time.Hour))
另外，asynq异步任务提供了命令行工具和Asynqmon用于监控和管理Asynq异步任务和队列。WebUI可以通过传递两个标志来启用与 Prometheus 的集成。
来源：https://huaweicloud.csdn.net/637ef508df016f70ae4ca586.html?
