mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-10-08 00:26:37 +08:00
解耦任务框架与业务任务
This commit is contained in:
@@ -12,10 +12,11 @@ description: "项目专用:当新增或修改 Asynq 异步任务、后台任
|
|||||||
新增或修改任务前,先快速查看这些文件,确认当前实现没有漂移:
|
新增或修改任务前,先快速查看这些文件,确认当前实现没有漂移:
|
||||||
|
|
||||||
- `internal/task/handler.go`: `TaskHandler`、`TaskResult`、可选 `PayloadValidator`。
|
- `internal/task/handler.go`: `TaskHandler`、`TaskResult`、可选 `PayloadValidator`。
|
||||||
- `internal/task/constants.go`: Asynq 任务类型常量、Admin 任务类型常量、`TaskMeta`、`TaskParam`、`DispatchableTasks`。
|
- `internal/task/constants.go`: 框架通用常量,如 `QueueDefault` 和 `DefaultMaxRetry`。
|
||||||
|
- `internal/task/meta.go`: 框架任务元数据结构体(TaskParam、TaskMeta)及全局动态注册与查询接口。
|
||||||
- `internal/task/executor.go`: `RegisterHandler`、`ValidateAndNormalizePayload`、`DispatchTask`、`RetryTask`、`ProcessTask`、`AppendLog`。
|
- `internal/task/executor.go`: `RegisterHandler`、`ValidateAndNormalizePayload`、`DispatchTask`、`RetryTask`、`ProcessTask`、`AppendLog`。
|
||||||
- `internal/task/handlers/register.go`: 内置 handler 的统一注册点,Admin API 和 Worker 都依赖它。
|
- `internal/task/handlers/register.go`: 内置 handler 和元数据的统一注册点,Admin API 和 Worker 都依赖它。
|
||||||
- `internal/task/worker/worker.go`: Asynq mux 路由和队列配置。
|
- `internal/task/worker/worker.go`: Asynq mux 动态路由分发和队列配置。
|
||||||
- `internal/task/scheduler/scheduler.go`: Cron 调度。
|
- `internal/task/scheduler/scheduler.go`: Cron 调度。
|
||||||
- `internal/apps/admin/task/routers.go`: Admin 下发、查询、详情、重试 API。
|
- `internal/apps/admin/task/routers.go`: Admin 下发、查询、详情、重试 API。
|
||||||
- 现有参考:`internal/apps/upload/tasks.go`(无参数任务)、`internal/apps/user/tasks.go`(带参数任务)。
|
- 现有参考:`internal/apps/upload/tasks.go`(无参数任务)、`internal/apps/user/tasks.go`(带参数任务)。
|
||||||
@@ -34,10 +35,9 @@ Admin dispatch -> ValidateAndNormalizePayload -> DispatchTask
|
|||||||
|
|
||||||
> 需要可复制的代码模板时,阅读 [references/CODE-EXAMPLES.md](references/CODE-EXAMPLES.md)。那里包含任务常量、无参数 handler、带参数 `PayloadValidator`、统一注册、Worker 路由、Cron 配置和测试示例。
|
> 需要可复制的代码模板时,阅读 [references/CODE-EXAMPLES.md](references/CODE-EXAMPLES.md)。那里包含任务常量、无参数 handler、带参数 `PayloadValidator`、统一注册、Worker 路由、Cron 配置和测试示例。
|
||||||
|
|
||||||
1. 定义任务元数据。
|
1. 定义任务元数据与常量。
|
||||||
- 在 `internal/task/constants.go` 添加 Asynq task type 常量,例如 `upload:cleanup_unused`。
|
- 业务包常量与元数据:在对应业务模块的 `internal/apps/<module>/tasks.go` 中定义 Asynq 任务类型常量(如 `CleanupUnusedUploadsTask = "upload:cleanup_unused"`)和 Admin 任务类型常量(如 `TaskTypeCleanupUploads = "cleanup_unused_uploads"`)。
|
||||||
- 添加 Admin 可下发 task type 常量,例如 `cleanup_unused_uploads`。
|
- 在同一 `tasks.go` 文件中定义该任务的 `TaskMeta` 元数据变量(如 `CleanupUnusedUploadsMeta = task.TaskMeta{...}`),配置 `Type`、`AsynqTask`、`Name`、`Description`、`MaxRetry`、`Queue`、`Retryable` 等字段。
|
||||||
- 在 `DispatchableTasks` 添加 `TaskMeta`,设置 `AsynqTask`、`Name`、`Description`、`MaxRetry`、`Queue`、`Retryable`。
|
|
||||||
- 有参数任务在 `Params` 中描述前端表单字段。`TaskParam.Name` 必须与 payload JSON tag 对齐。
|
- 有参数任务在 `Params` 中描述前端表单字段。`TaskParam.Name` 必须与 payload JSON tag 对齐。
|
||||||
|
|
||||||
2. 实现 handler。
|
2. 实现 handler。
|
||||||
@@ -48,19 +48,16 @@ Admin dispatch -> ValidateAndNormalizePayload -> DispatchTask
|
|||||||
- 不要在 handler 中写复杂 SQL;复杂查询放到 `internal/model/` 或 `internal/service/`。
|
- 不要在 handler 中写复杂 SQL;复杂查询放到 `internal/model/` 或 `internal/service/`。
|
||||||
- 新增 Go 文件后检查 license header;必要时运行 `make license`。
|
- 新增 Go 文件后检查 license header;必要时运行 `make license`。
|
||||||
|
|
||||||
3. 统一注册 handler。
|
3. 统一注册 handler 与元数据。
|
||||||
- 在 `internal/task/handlers/register.go` 导入业务模块并调用 `task.RegisterHandler(asynqTaskType, handler)`。
|
- 在 `internal/task/handlers/register.go` 导入业务模块,调用 `task.RegisterHandler(asynqTaskType, handler)` 注册处理器。
|
||||||
- 这里是 Admin payload 校验和 Worker 执行共同依赖的注册点。不要只在 worker 包里注册。
|
- 同时,在该文件中调用 `task.RegisterTaskMeta(meta)` 注册刚才在业务模块中定义的任务元数据。
|
||||||
|
- 这里是 Admin 校验、元数据获取和 Worker 执行共同依赖的注册点。
|
||||||
|
|
||||||
4. 注册 Worker 路由。
|
4. 如需 Cron 调度,系统默认定时任务必须通过 SQL 迁移(goose)初始化。
|
||||||
- 在 `internal/task/worker/worker.go` 的 Asynq mux 中添加 `mux.HandleFunc(task.YourAsynqTask, task.ProcessTask)`。
|
- 确保任务已正确注册并载入全局元数据池中。
|
||||||
- 所有业务任务都应交给 `task.ProcessTask`,由 executor 根据 task type 分发到 handler。
|
|
||||||
|
|
||||||
5. 如需 Cron 调度,系统默认定时任务必须通过 SQL 迁移(goose)初始化。
|
|
||||||
- 确保任务在 `DispatchableTasks` 中已正确配置 `TaskMeta`。
|
|
||||||
- 在 `internal/db/migrator/goose/postgres` 和 `sqlite` 下编写 migration 脚本,使用 `INSERT INTO schedules` 语句初始化任务,指定 `task_type` 和 `cron` 等字段。必须妥善处理冲突(如 `ON CONFLICT DO NOTHING`)以支持幂等。
|
- 在 `internal/db/migrator/goose/postgres` 和 `sqlite` 下编写 migration 脚本,使用 `INSERT INTO schedules` 语句初始化任务,指定 `task_type` 和 `cron` 等字段。必须妥善处理冲突(如 `ON CONFLICT DO NOTHING`)以支持幂等。
|
||||||
|
|
||||||
6. 如改动 Admin API。
|
5. 如改动 Admin API。
|
||||||
- handler 放在 `internal/apps/admin/<module>/` 或现有 Admin task 模块内。
|
- handler 放在 `internal/apps/admin/<module>/` 或现有 Admin task 模块内。
|
||||||
- 路由只在 `internal/router/router.go` 注册。
|
- 路由只在 `internal/router/router.go` 注册。
|
||||||
- 响应保持 `{ "error_msg": "", "data": ... }`,分页保持 `{ "total": 0, "results": [] }`。
|
- 响应保持 `{ "error_msg": "", "data": ... }`,分页保持 `{ "total": 0, "results": [] }`。
|
||||||
|
|||||||
@@ -2,28 +2,33 @@
|
|||||||
|
|
||||||
这些示例用于新增或修改 Wavelet Asynq 任务时快速套用。复制前先对照当前代码,因为任务框架可能随项目演进。
|
这些示例用于新增或修改 Wavelet Asynq 任务时快速套用。复制前先对照当前代码,因为任务框架可能随项目演进。
|
||||||
|
|
||||||
## 任务元数据
|
## 任务元数据与常量定义
|
||||||
|
|
||||||
在 `internal/task/constants.go` 添加 Asynq task type、Admin task type 和 `TaskMeta`。
|
在对应的业务包 `internal/apps/<module>/tasks.go` 中定义 Asynq task type、Admin task type 和 `TaskMeta`。
|
||||||
|
|
||||||
```go
|
```go
|
||||||
|
package upload
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/Rain-kl/Wavelet/internal/task"
|
||||||
|
)
|
||||||
|
|
||||||
// 异步任务类型标识。格式建议为 "{module}:{action}"。
|
// 异步任务类型标识。格式建议为 "{module}:{action}"。
|
||||||
const CleanupUnusedUploadsTask = "upload:cleanup_unused"
|
const CleanupUnusedUploadsTask = "upload:cleanup_unused"
|
||||||
|
|
||||||
// 管理员可下发的任务类型标识。用于 Admin API 的 task_type。
|
// 管理员可下发的任务类型标识。用于 Admin API 的 task_type。
|
||||||
const TaskTypeCleanupUploads = "cleanup_unused_uploads"
|
const TaskTypeCleanupUploads = "cleanup_unused_uploads"
|
||||||
|
|
||||||
var DispatchableTasks = []TaskMeta{
|
// CleanupUnusedUploadsMeta 任务元数据
|
||||||
{
|
var CleanupUnusedUploadsMeta = task.TaskMeta{
|
||||||
Type: TaskTypeCleanupUploads,
|
Type: TaskTypeCleanupUploads,
|
||||||
AsynqTask: CleanupUnusedUploadsTask,
|
AsynqTask: CleanupUnusedUploadsTask,
|
||||||
Name: "清理未使用上传",
|
Name: "清理未使用上传",
|
||||||
Description: "清理超过1小时未使用的上传文件",
|
Description: "清理超过1小时未使用的上传文件",
|
||||||
SupportsTime: false,
|
SupportsTime: false,
|
||||||
MaxRetry: defaultMaxRetry,
|
MaxRetry: task.DefaultMaxRetry,
|
||||||
Queue: QueueDefault,
|
Queue: task.QueueDefault,
|
||||||
Retryable: true,
|
Retryable: true,
|
||||||
},
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -175,28 +180,6 @@ func Register() {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Worker 路由
|
|
||||||
|
|
||||||
在 `internal/task/worker/worker.go` 的 mux 上添加任务类型。所有业务任务都指向 `task.ProcessTask`。
|
|
||||||
|
|
||||||
```go
|
|
||||||
func StartWorker() error {
|
|
||||||
asynqServer := asynq.NewServer(task.RedisOpt, asynq.Config{
|
|
||||||
Concurrency: config.Config.Worker.Concurrency,
|
|
||||||
ShutdownTimeout: workerShutdownTimeout,
|
|
||||||
Queues: buildQueuesFromConfig(),
|
|
||||||
StrictPriority: config.Config.Worker.StrictPriority,
|
|
||||||
})
|
|
||||||
|
|
||||||
mux := asynq.NewServeMux()
|
|
||||||
mux.Use(taskLoggingMiddleware)
|
|
||||||
mux.HandleFunc(task.CleanupUnusedUploadsTask, task.ProcessTask)
|
|
||||||
mux.HandleFunc(task.SendEmailTask, task.ProcessTask)
|
|
||||||
|
|
||||||
return asynqServer.Run(mux)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Cron 调度和配置
|
## Cron 调度和配置
|
||||||
|
|
||||||
系统默认的定时任务必须通过 Goose SQL 迁移初始化插入到 `schedules` 表。
|
系统默认的定时任务必须通过 Goose SQL 迁移初始化插入到 `schedules` 表。
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ func init() {
|
|||||||
// @Failure 403 {object} util.ResponseAny "无管理员权限"
|
// @Failure 403 {object} util.ResponseAny "无管理员权限"
|
||||||
// @Router /api/v1/admin/tasks/types [get]
|
// @Router /api/v1/admin/tasks/types [get]
|
||||||
func ListTaskTypes(c *gin.Context) {
|
func ListTaskTypes(c *gin.Context) {
|
||||||
c.JSON(http.StatusOK, util.OK(task.DispatchableTasks))
|
c.JSON(http.StatusOK, util.OK(task.GetDispatchableTasks()))
|
||||||
}
|
}
|
||||||
|
|
||||||
// DispatchTaskRequest 下发任务请求
|
// DispatchTaskRequest 下发任务请求
|
||||||
|
|||||||
@@ -15,6 +15,8 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/Rain-kl/Wavelet/internal/apps/oauth"
|
"github.com/Rain-kl/Wavelet/internal/apps/oauth"
|
||||||
|
"github.com/Rain-kl/Wavelet/internal/apps/upload"
|
||||||
|
"github.com/Rain-kl/Wavelet/internal/apps/user"
|
||||||
"github.com/Rain-kl/Wavelet/internal/model"
|
"github.com/Rain-kl/Wavelet/internal/model"
|
||||||
"github.com/Rain-kl/Wavelet/internal/task"
|
"github.com/Rain-kl/Wavelet/internal/task"
|
||||||
"github.com/Rain-kl/Wavelet/internal/testhelper"
|
"github.com/Rain-kl/Wavelet/internal/testhelper"
|
||||||
@@ -88,13 +90,13 @@ func TestListTaskTypes(t *testing.T) {
|
|||||||
|
|
||||||
foundCleanup := false
|
foundCleanup := false
|
||||||
for _, m := range taskMetas {
|
for _, m := range taskMetas {
|
||||||
if m.Type == task.TaskTypeCleanupUploads {
|
if m.Type == upload.TaskTypeCleanupUploads {
|
||||||
foundCleanup = true
|
foundCleanup = true
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if !foundCleanup {
|
if !foundCleanup {
|
||||||
t.Errorf("expected task type %s to be listed", task.TaskTypeCleanupUploads)
|
t.Errorf("expected task type %s to be listed", upload.TaskTypeCleanupUploads)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -107,7 +109,7 @@ func TestDispatchTask(t *testing.T) {
|
|||||||
|
|
||||||
t.Run("dispatch valid task successfully", func(t *testing.T) {
|
t.Run("dispatch valid task successfully", func(t *testing.T) {
|
||||||
payload := DispatchTaskRequest{
|
payload := DispatchTaskRequest{
|
||||||
TaskType: task.TaskTypeCleanupUploads,
|
TaskType: upload.TaskTypeCleanupUploads,
|
||||||
}
|
}
|
||||||
body, _ := json.Marshal(payload)
|
body, _ := json.Marshal(payload)
|
||||||
req, _ := http.NewRequest("POST", "/api/v1/admin/tasks/dispatch", bytes.NewBuffer(body))
|
req, _ := http.NewRequest("POST", "/api/v1/admin/tasks/dispatch", bytes.NewBuffer(body))
|
||||||
@@ -130,7 +132,7 @@ func TestDispatchTask(t *testing.T) {
|
|||||||
|
|
||||||
t.Run("dispatch send_email task successfully with valid payload", func(t *testing.T) {
|
t.Run("dispatch send_email task successfully with valid payload", func(t *testing.T) {
|
||||||
payload := DispatchTaskRequest{
|
payload := DispatchTaskRequest{
|
||||||
TaskType: task.TaskTypeSendEmail,
|
TaskType: user.TaskTypeSendEmail,
|
||||||
Payload: `{"to":"receiver@example.com","subject":"Test Subject","body":"Test Body"}`,
|
Payload: `{"to":"receiver@example.com","subject":"Test Subject","body":"Test Body"}`,
|
||||||
}
|
}
|
||||||
body, _ := json.Marshal(payload)
|
body, _ := json.Marshal(payload)
|
||||||
@@ -149,7 +151,7 @@ func TestDispatchTask(t *testing.T) {
|
|||||||
|
|
||||||
t.Run("dispatch send_email task failure with invalid payload json", func(t *testing.T) {
|
t.Run("dispatch send_email task failure with invalid payload json", func(t *testing.T) {
|
||||||
payload := DispatchTaskRequest{
|
payload := DispatchTaskRequest{
|
||||||
TaskType: task.TaskTypeSendEmail,
|
TaskType: user.TaskTypeSendEmail,
|
||||||
Payload: `{"to":`,
|
Payload: `{"to":`,
|
||||||
}
|
}
|
||||||
body, _ := json.Marshal(payload)
|
body, _ := json.Marshal(payload)
|
||||||
@@ -166,7 +168,7 @@ func TestDispatchTask(t *testing.T) {
|
|||||||
|
|
||||||
t.Run("dispatch send_email task failure with missing fields", func(t *testing.T) {
|
t.Run("dispatch send_email task failure with missing fields", func(t *testing.T) {
|
||||||
payload := DispatchTaskRequest{
|
payload := DispatchTaskRequest{
|
||||||
TaskType: task.TaskTypeSendEmail,
|
TaskType: user.TaskTypeSendEmail,
|
||||||
Payload: `{"to":"","subject":"Test","body":"Test"}`,
|
Payload: `{"to":"","subject":"Test","body":"Test"}`,
|
||||||
}
|
}
|
||||||
body, _ := json.Marshal(payload)
|
body, _ := json.Marshal(payload)
|
||||||
|
|||||||
@@ -16,6 +16,26 @@ import (
|
|||||||
"gorm.io/gorm"
|
"gorm.io/gorm"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// 异步任务名称与管理类型定义
|
||||||
|
const (
|
||||||
|
// CleanupUnusedUploadsTask 清理未使用上传任务标识
|
||||||
|
CleanupUnusedUploadsTask = "upload:cleanup_unused"
|
||||||
|
// TaskTypeCleanupUploads 清理未使用上传管理类型
|
||||||
|
TaskTypeCleanupUploads = "cleanup_unused_uploads"
|
||||||
|
)
|
||||||
|
|
||||||
|
// CleanupUnusedUploadsMeta represents the task metadata.
|
||||||
|
var CleanupUnusedUploadsMeta = task.TaskMeta{
|
||||||
|
Type: TaskTypeCleanupUploads,
|
||||||
|
AsynqTask: CleanupUnusedUploadsTask,
|
||||||
|
Name: "清理未使用上传",
|
||||||
|
Description: "清理超过1小时未使用的上传文件",
|
||||||
|
SupportsTime: false,
|
||||||
|
MaxRetry: task.DefaultMaxRetry,
|
||||||
|
Queue: task.QueueDefault,
|
||||||
|
Retryable: true,
|
||||||
|
}
|
||||||
|
|
||||||
// CleanupUnusedUploadsHandler 清理未使用上传文件的异步任务处理器
|
// CleanupUnusedUploadsHandler 清理未使用上传文件的异步任务处理器
|
||||||
type CleanupUnusedUploadsHandler struct{}
|
type CleanupUnusedUploadsHandler struct{}
|
||||||
|
|
||||||
|
|||||||
@@ -109,7 +109,7 @@ func sendEmailVerificationCode(ctx context.Context, email, scene, templateName s
|
|||||||
Body: emailBody,
|
Body: emailBody,
|
||||||
}
|
}
|
||||||
payloadBytes, _ := json.Marshal(payload)
|
payloadBytes, _ := json.Marshal(payload)
|
||||||
_, err = task.DispatchTask(ctx, task.TaskTypeSendEmail, payloadBytes, "system")
|
_, err = task.DispatchTask(ctx, TaskTypeSendEmail, payloadBytes, "system")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.New(errDispatchEmailTaskFailed)
|
return errors.New(errDispatchEmailTaskFailed)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
// Copyright 2025 linux.do
|
|
||||||
// Copyright 2026 Arctel.net
|
// Copyright 2026 Arctel.net
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
@@ -17,6 +16,52 @@ import (
|
|||||||
"github.com/Rain-kl/Wavelet/internal/util/mail"
|
"github.com/Rain-kl/Wavelet/internal/util/mail"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// 异步任务名称与管理类型定义
|
||||||
|
const (
|
||||||
|
// SendEmailTask 发送邮件任务标识
|
||||||
|
SendEmailTask = "mail:send"
|
||||||
|
// TaskTypeSendEmail 发送邮件管理类型
|
||||||
|
TaskTypeSendEmail = "send_email"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SendEmailMeta represents the task metadata.
|
||||||
|
var SendEmailMeta = task.TaskMeta{
|
||||||
|
Type: TaskTypeSendEmail,
|
||||||
|
AsynqTask: SendEmailTask,
|
||||||
|
Name: "发送邮件",
|
||||||
|
Description: "异步发送系统邮件",
|
||||||
|
SupportsTime: false,
|
||||||
|
MaxRetry: task.DefaultMaxRetry,
|
||||||
|
Queue: task.QueueDefault,
|
||||||
|
Retryable: true,
|
||||||
|
Params: []task.TaskParam{
|
||||||
|
{
|
||||||
|
Name: "to",
|
||||||
|
Label: "接收邮箱 (To)",
|
||||||
|
Type: "string",
|
||||||
|
Required: true,
|
||||||
|
Placeholder: "receiver@example.com",
|
||||||
|
Description: "接收邮件的目标邮箱地址",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Name: "subject",
|
||||||
|
Label: "邮件主题 (Subject)",
|
||||||
|
Type: "string",
|
||||||
|
Required: true,
|
||||||
|
Placeholder: "请输入邮件主题",
|
||||||
|
Description: "发送邮件的主题标题",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Name: "body",
|
||||||
|
Label: "邮件内容 (Body)",
|
||||||
|
Type: "text",
|
||||||
|
Required: true,
|
||||||
|
Placeholder: "请输入邮件内容(支持 HTML 格式)",
|
||||||
|
Description: "发送邮件的内容主体",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
// SendEmailPayload 邮件发送任务载荷
|
// SendEmailPayload 邮件发送任务载荷
|
||||||
type SendEmailPayload struct {
|
type SendEmailPayload struct {
|
||||||
To string `json:"to"`
|
To string `json:"to"`
|
||||||
|
|||||||
+2
-111
@@ -5,119 +5,10 @@
|
|||||||
// Package task 定义异步任务类型与调度常量
|
// Package task 定义异步任务类型与调度常量
|
||||||
package task
|
package task
|
||||||
|
|
||||||
// 异步任务类型标识
|
|
||||||
const (
|
|
||||||
CleanupUnusedUploadsTask = "upload:cleanup_unused"
|
|
||||||
SendEmailTask = "mail:send"
|
|
||||||
)
|
|
||||||
|
|
||||||
// 任务队列名称
|
// 任务队列名称
|
||||||
const (
|
const (
|
||||||
QueueDefault = "default"
|
QueueDefault = "default"
|
||||||
)
|
)
|
||||||
|
|
||||||
// 管理员可下发的任务类型标识
|
// DefaultMaxRetry 任务默认最大重试次数
|
||||||
const (
|
const DefaultMaxRetry = 3
|
||||||
TaskTypeCleanupUploads = "cleanup_unused_uploads"
|
|
||||||
TaskTypeSendEmail = "send_email"
|
|
||||||
)
|
|
||||||
|
|
||||||
// defaultMaxRetry 任务默认最大重试次数
|
|
||||||
const defaultMaxRetry = 3
|
|
||||||
|
|
||||||
// TaskParam 任务参数定义
|
|
||||||
//
|
|
||||||
//nolint:revive // TaskParam 保留完整名称以避免与通用 Param 混淆
|
|
||||||
type TaskParam struct {
|
|
||||||
Name string `json:"Name"` // 参数键名
|
|
||||||
Label string `json:"Label"` // 显示名称
|
|
||||||
Type string `json:"Type"` // 类型:string, text, number, boolean
|
|
||||||
Required bool `json:"Required"` // 是否必填
|
|
||||||
Placeholder string `json:"Placeholder"` // 占位符
|
|
||||||
Description string `json:"Description"` // 描述
|
|
||||||
}
|
|
||||||
|
|
||||||
// TaskMeta 任务元数据
|
|
||||||
//
|
|
||||||
//nolint:revive // TaskMeta 保留完整名称以避免与通用 Meta 混淆
|
|
||||||
type TaskMeta struct {
|
|
||||||
Type string
|
|
||||||
AsynqTask string
|
|
||||||
Name string
|
|
||||||
Description string
|
|
||||||
SupportsTime bool
|
|
||||||
MaxRetry int
|
|
||||||
Queue string
|
|
||||||
Retryable bool // 是否支持手动重试
|
|
||||||
Params []TaskParam
|
|
||||||
}
|
|
||||||
|
|
||||||
// DispatchableTasks 可下发的任务列表
|
|
||||||
var DispatchableTasks = []TaskMeta{
|
|
||||||
{
|
|
||||||
Type: TaskTypeCleanupUploads,
|
|
||||||
AsynqTask: CleanupUnusedUploadsTask,
|
|
||||||
Name: "清理未使用上传",
|
|
||||||
Description: "清理超过1小时未使用的上传文件",
|
|
||||||
SupportsTime: false,
|
|
||||||
MaxRetry: defaultMaxRetry,
|
|
||||||
Queue: QueueDefault,
|
|
||||||
Retryable: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Type: TaskTypeSendEmail,
|
|
||||||
AsynqTask: SendEmailTask,
|
|
||||||
Name: "发送邮件",
|
|
||||||
Description: "异步发送系统邮件",
|
|
||||||
SupportsTime: false,
|
|
||||||
MaxRetry: defaultMaxRetry,
|
|
||||||
Queue: QueueDefault,
|
|
||||||
Retryable: true,
|
|
||||||
Params: []TaskParam{
|
|
||||||
{
|
|
||||||
Name: "to",
|
|
||||||
Label: "接收邮箱 (To)",
|
|
||||||
Type: "string",
|
|
||||||
Required: true,
|
|
||||||
Placeholder: "receiver@example.com",
|
|
||||||
Description: "接收邮件的目标邮箱地址",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "subject",
|
|
||||||
Label: "邮件主题 (Subject)",
|
|
||||||
Type: "string",
|
|
||||||
Required: true,
|
|
||||||
Placeholder: "请输入邮件主题",
|
|
||||||
Description: "发送邮件的主题标题",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "body",
|
|
||||||
Label: "邮件内容 (Body)",
|
|
||||||
Type: "text",
|
|
||||||
Required: true,
|
|
||||||
Placeholder: "请输入邮件内容(支持 HTML 格式)",
|
|
||||||
Description: "发送邮件的内容主体",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetTaskMeta 根据任务类型获取元数据
|
|
||||||
func GetTaskMeta(taskType string) *TaskMeta {
|
|
||||||
for _, t := range DispatchableTasks {
|
|
||||||
if t.Type == taskType {
|
|
||||||
return &t
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetTaskMetaByAsynqTask 根据 Asynq 任务名称获取元数据
|
|
||||||
func GetTaskMetaByAsynqTask(asynqTask string) *TaskMeta {
|
|
||||||
for _, t := range DispatchableTasks {
|
|
||||||
if t.AsynqTask == asynqTask {
|
|
||||||
return &t
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -11,8 +11,13 @@ import (
|
|||||||
"github.com/Rain-kl/Wavelet/internal/task"
|
"github.com/Rain-kl/Wavelet/internal/task"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Register registers all built-in task handlers.
|
// Register registers all built-in task handlers and their metadata.
|
||||||
func Register() {
|
func Register() {
|
||||||
task.RegisterHandler(task.CleanupUnusedUploadsTask, &upload.CleanupUnusedUploadsHandler{})
|
// upload
|
||||||
task.RegisterHandler(task.SendEmailTask, &user.SendEmailHandler{})
|
task.RegisterHandler(upload.CleanupUnusedUploadsTask, &upload.CleanupUnusedUploadsHandler{})
|
||||||
|
task.RegisterTaskMeta(upload.CleanupUnusedUploadsMeta)
|
||||||
|
|
||||||
|
// user
|
||||||
|
task.RegisterHandler(user.SendEmailTask, &user.SendEmailHandler{})
|
||||||
|
task.RegisterTaskMeta(user.SendEmailMeta)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,92 @@
|
|||||||
|
// Copyright 2026 Arctel.net
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package task
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sync"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TaskParam 任务参数定义
|
||||||
|
//
|
||||||
|
//nolint:revive // TaskParam 保留完整名称以避免与通用 Param 混淆
|
||||||
|
type TaskParam struct {
|
||||||
|
Name string `json:"Name"` // 参数键名
|
||||||
|
Label string `json:"Label"` // 显示名称
|
||||||
|
Type string `json:"Type"` // 类型:string, text, number, boolean
|
||||||
|
Required bool `json:"Required"` // 是否必填
|
||||||
|
Placeholder string `json:"Placeholder"` // 占位符
|
||||||
|
Description string `json:"Description"` // 描述
|
||||||
|
}
|
||||||
|
|
||||||
|
// TaskMeta 任务元数据
|
||||||
|
//
|
||||||
|
//nolint:revive // TaskMeta 保留完整名称以避免与通用 Meta 混淆
|
||||||
|
type TaskMeta struct {
|
||||||
|
Type string
|
||||||
|
AsynqTask string
|
||||||
|
Name string
|
||||||
|
Description string
|
||||||
|
SupportsTime bool
|
||||||
|
MaxRetry int
|
||||||
|
Queue string
|
||||||
|
Retryable bool // 是否支持手动重试
|
||||||
|
Params []TaskParam
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
dispatchableTasksMutex sync.RWMutex
|
||||||
|
dispatchableTasks []TaskMeta
|
||||||
|
)
|
||||||
|
|
||||||
|
// RegisterTaskMeta 注册任务元数据到全局列表
|
||||||
|
func RegisterTaskMeta(meta TaskMeta) {
|
||||||
|
dispatchableTasksMutex.Lock()
|
||||||
|
defer dispatchableTasksMutex.Unlock()
|
||||||
|
dispatchableTasks = append(dispatchableTasks, meta)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetDispatchableTasks 获取所有已注册的元数据列表(返回副本以避免并发并发读写冲突)
|
||||||
|
func GetDispatchableTasks() []TaskMeta {
|
||||||
|
dispatchableTasksMutex.RLock()
|
||||||
|
defer dispatchableTasksMutex.RUnlock()
|
||||||
|
|
||||||
|
metas := make([]TaskMeta, len(dispatchableTasks))
|
||||||
|
copy(metas, dispatchableTasks)
|
||||||
|
return metas
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetTaskMeta 根据任务类型获取元数据
|
||||||
|
func GetTaskMeta(taskType string) *TaskMeta {
|
||||||
|
dispatchableTasksMutex.RLock()
|
||||||
|
defer dispatchableTasksMutex.RUnlock()
|
||||||
|
for _, t := range dispatchableTasks {
|
||||||
|
if t.Type == taskType {
|
||||||
|
copied := t
|
||||||
|
return &copied
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetTaskMetaByAsynqTask 根据 Asynq 任务名称获取元数据
|
||||||
|
func GetTaskMetaByAsynqTask(asynqTask string) *TaskMeta {
|
||||||
|
dispatchableTasksMutex.RLock()
|
||||||
|
defer dispatchableTasksMutex.RUnlock()
|
||||||
|
for _, t := range dispatchableTasks {
|
||||||
|
if t.AsynqTask == asynqTask {
|
||||||
|
copied := t
|
||||||
|
return &copied
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetRegisteredAsynqTasks 返回所有已注册的 Asynq 任务名称,以便动态注册路由
|
||||||
|
func GetRegisteredAsynqTasks() []string {
|
||||||
|
keys := make([]string, 0, len(handlerRegistry))
|
||||||
|
for k := range handlerRegistry {
|
||||||
|
keys = append(keys, k)
|
||||||
|
}
|
||||||
|
return keys
|
||||||
|
}
|
||||||
@@ -39,8 +39,10 @@ func StartWorker() error {
|
|||||||
|
|
||||||
// 统一使用 task.ProcessTask 处理所有任务类型
|
// 统一使用 task.ProcessTask 处理所有任务类型
|
||||||
// 框架内部自动分发到对应的 TaskHandler 实现
|
// 框架内部自动分发到对应的 TaskHandler 实现
|
||||||
mux.HandleFunc(task.CleanupUnusedUploadsTask, task.ProcessTask)
|
// 动态注册所有已注册的任务处理器路由,框架内部自动分发到对应的 TaskHandler 实现
|
||||||
mux.HandleFunc(task.SendEmailTask, task.ProcessTask)
|
for _, taskName := range task.GetRegisteredAsynqTasks() {
|
||||||
|
mux.HandleFunc(taskName, task.ProcessTask)
|
||||||
|
}
|
||||||
|
|
||||||
// 启动服务器
|
// 启动服务器
|
||||||
return asynqServer.Run(mux)
|
return asynqServer.Run(mux)
|
||||||
|
|||||||
Reference in New Issue
Block a user