docs(constitution): 新增数据库设计原则(v2.4.0)

在项目宪章中新增第九条原则"数据库设计原则",明确禁止使用数据库外键约束和ORM关联标签。

主要变更:
- 新增原则IX:数据库设计原则(Database Design Principles)
- 强制要求:数据库表不得使用外键约束
- 强制要求:GORM模型不得使用ORM关联标签(foreignKey、hasMany等)
- 强制要求:表关系必须通过ID字段手动维护
- 强制要求:关联数据查询必须显式编写,避免ORM魔法
- 强制要求:时间字段由GORM处理,不使用数据库触发器

设计理念:
- 提升业务逻辑灵活性(无数据库约束限制)
- 优化高并发性能(无外键检查开销)
- 增强代码可读性(显式查询,无隐式预加载)
- 简化数据库架构和迁移流程
- 支持分布式和微服务场景

版本升级:2.3.0 → 2.4.0(MINOR)
This commit is contained in:
2025-11-13 13:40:19 +08:00
parent ea0c6a8b16
commit 984ccccc63
63 changed files with 12099 additions and 83 deletions

213
internal/handler/task.go Normal file
View File

@@ -0,0 +1,213 @@
package handler
import (
"fmt"
"time"
"github.com/gofiber/fiber/v2"
"github.com/google/uuid"
"github.com/hibiken/asynq"
"go.uber.org/zap"
"github.com/break/junhong_cmp_fiber/internal/task"
"github.com/break/junhong_cmp_fiber/pkg/constants"
"github.com/break/junhong_cmp_fiber/pkg/errors"
"github.com/break/junhong_cmp_fiber/pkg/queue"
"github.com/break/junhong_cmp_fiber/pkg/response"
)
// TaskHandler 任务处理器
type TaskHandler struct {
queueClient *queue.Client
logger *zap.Logger
}
// NewTaskHandler 创建任务处理器实例
func NewTaskHandler(queueClient *queue.Client, logger *zap.Logger) *TaskHandler {
return &TaskHandler{
queueClient: queueClient,
logger: logger,
}
}
// SubmitEmailTaskRequest 提交邮件任务请求
type SubmitEmailTaskRequest struct {
To string `json:"to" validate:"required,email"`
Subject string `json:"subject" validate:"required,min=1,max=200"`
Body string `json:"body" validate:"required,min=1"`
CC []string `json:"cc,omitempty" validate:"omitempty,dive,email"`
Attachments []string `json:"attachments,omitempty"`
RequestID string `json:"request_id,omitempty"`
}
// SubmitSyncTaskRequest 提交数据同步任务请求
type SubmitSyncTaskRequest struct {
SyncType string `json:"sync_type" validate:"required,oneof=sim_status flow_usage real_name"`
StartDate string `json:"start_date" validate:"required"`
EndDate string `json:"end_date" validate:"required"`
BatchSize int `json:"batch_size,omitempty" validate:"omitempty,min=1,max=1000"`
RequestID string `json:"request_id,omitempty"`
Priority string `json:"priority,omitempty" validate:"omitempty,oneof=critical default low"`
}
// TaskResponse 任务响应
type TaskResponse struct {
TaskID string `json:"task_id"`
Queue string `json:"queue"`
Status string `json:"status"`
}
// SubmitEmailTask 提交邮件发送任务
// @Summary 提交邮件发送任务
// @Description 异步发送邮件
// @Tags 任务
// @Accept json
// @Produce json
// @Param request body SubmitEmailTaskRequest true "邮件任务参数"
// @Success 200 {object} response.Response{data=TaskResponse}
// @Failure 400 {object} response.Response
// @Router /api/v1/tasks/email [post]
func (h *TaskHandler) SubmitEmailTask(c *fiber.Ctx) error {
var req SubmitEmailTaskRequest
if err := c.BodyParser(&req); err != nil {
h.logger.Warn("解析邮件任务请求失败",
zap.Error(err))
return response.Error(c, fiber.StatusBadRequest, errors.CodeBadRequest, "请求参数格式错误")
}
// 验证参数
if err := validate.Struct(&req); err != nil {
h.logger.Warn("邮件任务参数验证失败",
zap.Error(err))
return response.Error(c, fiber.StatusBadRequest, errors.CodeBadRequest, err.Error())
}
// 生成 RequestID如果未提供
if req.RequestID == "" {
req.RequestID = generateRequestID("email")
}
// 构造任务载荷
payload := &task.EmailPayload{
RequestID: req.RequestID,
To: req.To,
Subject: req.Subject,
Body: req.Body,
CC: req.CC,
Attachments: req.Attachments,
}
// 提交任务到队列
err := h.queueClient.EnqueueTask(
c.Context(),
constants.TaskTypeEmailSend,
payload,
asynq.Queue(constants.QueueDefault),
asynq.MaxRetry(constants.DefaultRetryMax),
asynq.Timeout(constants.DefaultTimeout),
)
if err != nil {
h.logger.Error("提交邮件任务失败",
zap.String("to", req.To),
zap.String("request_id", req.RequestID),
zap.Error(err))
return response.Error(c, fiber.StatusInternalServerError, errors.CodeInternalError, "任务提交失败")
}
h.logger.Info("邮件任务提交成功",
zap.String("queue", constants.QueueDefault),
zap.String("to", req.To),
zap.String("request_id", req.RequestID))
return response.SuccessWithMessage(c, TaskResponse{
TaskID: req.RequestID,
Queue: constants.QueueDefault,
Status: "queued",
}, "邮件任务已提交")
}
// SubmitSyncTask 提交数据同步任务
// @Summary 提交数据同步任务
// @Description 异步执行数据同步
// @Tags 任务
// @Accept json
// @Produce json
// @Param request body SubmitSyncTaskRequest true "同步任务参数"
// @Success 200 {object} response.Response{data=TaskResponse}
// @Failure 400 {object} response.Response
// @Router /api/v1/tasks/sync [post]
func (h *TaskHandler) SubmitSyncTask(c *fiber.Ctx) error {
var req SubmitSyncTaskRequest
if err := c.BodyParser(&req); err != nil {
h.logger.Warn("解析同步任务请求失败",
zap.Error(err))
return response.Error(c, fiber.StatusBadRequest, errors.CodeBadRequest, "请求参数格式错误")
}
// 验证参数
if err := validate.Struct(&req); err != nil {
h.logger.Warn("同步任务参数验证失败",
zap.Error(err))
return response.Error(c, fiber.StatusBadRequest, errors.CodeBadRequest, err.Error())
}
// 生成 RequestID如果未提供
if req.RequestID == "" {
req.RequestID = generateRequestID("sync")
}
// 设置默认批量大小
if req.BatchSize == 0 {
req.BatchSize = 100
}
// 确定队列优先级
queueName := constants.QueueDefault
if req.Priority == "critical" {
queueName = constants.QueueCritical
} else if req.Priority == "low" {
queueName = constants.QueueLow
}
// 构造任务载荷
payload := &task.DataSyncPayload{
RequestID: req.RequestID,
SyncType: req.SyncType,
StartDate: req.StartDate,
EndDate: req.EndDate,
BatchSize: req.BatchSize,
}
// 提交任务到队列
err := h.queueClient.EnqueueTask(
c.Context(),
constants.TaskTypeDataSync,
payload,
asynq.Queue(queueName),
asynq.MaxRetry(constants.DefaultRetryMax),
asynq.Timeout(constants.DefaultTimeout),
)
if err != nil {
h.logger.Error("提交同步任务失败",
zap.String("sync_type", req.SyncType),
zap.String("request_id", req.RequestID),
zap.Error(err))
return response.Error(c, fiber.StatusInternalServerError, errors.CodeInternalError, "任务提交失败")
}
h.logger.Info("同步任务提交成功",
zap.String("queue", queueName),
zap.String("sync_type", req.SyncType),
zap.String("request_id", req.RequestID))
return response.SuccessWithMessage(c, TaskResponse{
TaskID: req.RequestID,
Queue: queueName,
Status: "queued",
}, "同步任务已提交")
}
// generateRequestID 生成请求 ID
func generateRequestID(prefix string) string {
return fmt.Sprintf("%s-%s-%d", prefix, uuid.New().String(), time.Now().UnixNano())
}