Files
junhong_cmp_fiber/internal/service/email/service.go
huang 409a68d60b
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m45s
feat: OpenAPI 契约对齐与框架优化
主要变更:
1. OpenAPI 文档契约对齐
   - 统一错误响应字段名为 msg(非 message)
   - 规范 envelope 响应结构(code, msg, data, timestamp)
   - 个人客户路由纳入文档体系(使用 Register 机制)
   - 新增 BuildDocHandlers() 统一管理 handler 构造
   - 确保文档生成的幂等性

2. Service 层错误处理统一
   - 全面替换 fmt.Errorf 为 errors.New/Wrap
   - 统一错误码使用规范
   - Handler 层参数校验不泄露底层细节
   - 新增错误码验证集成测试

3. 代码质量提升
   - 删除未使用的 Task handler 和路由
   - 新增代码规范检查脚本(check-service-errors.sh)
   - 新增注释路径一致性检查(check-comment-paths.sh)
   - 更新 API 文档生成指南

4. OpenSpec 归档
   - 归档 openapi-contract-alignment 变更(63 tasks)
   - 归档 service-error-unify-core 变更
   - 归档 service-error-unify-support 变更
   - 归档 code-cleanup-docs-update 变更
   - 归档 handler-validation-security 变更
   - 同步 delta specs 到主规范文件

影响范围:
- pkg/openapi: 新增 handlers.go,优化 generator.go
- internal/service/*: 48 个 service 文件错误处理统一
- internal/handler/admin: 优化参数校验错误提示
- internal/routes: 个人客户路由改造,删除 task 路由
- scripts: 新增 3 个代码检查脚本
- docs: 更新 OpenAPI 文档(15750+ 行)
- openspec/specs: 同步 3 个主规范文件

破坏性变更:无
向后兼容:是
2026-01-30 11:40:36 +08:00

160 lines
4.5 KiB
Go

// Package email 提供邮件发送的业务逻辑服务
// 包含邮件发送、邮件模板管理等功能
package email
import (
"context"
"fmt"
"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/bytedance/sonic"
"github.com/hibiken/asynq"
"go.uber.org/zap"
)
// Service 邮件服务
type Service struct {
queueClient *queue.Client
logger *zap.Logger
}
// NewService 创建邮件服务实例
func NewService(queueClient *queue.Client, logger *zap.Logger) *Service {
return &Service{
queueClient: queueClient,
logger: logger,
}
}
// SendWelcomeEmail 发送欢迎邮件(异步)
func (s *Service) SendWelcomeEmail(ctx context.Context, userID uint, email string) error {
// 构造任务载荷
payload := &task.EmailPayload{
RequestID: fmt.Sprintf("welcome-%d", userID),
To: email,
Subject: "欢迎加入君鸿卡管系统",
Body: "感谢您注册我们的服务!我们很高兴为您提供服务。",
}
payloadBytes, err := sonic.Marshal(payload)
if err != nil {
s.logger.Error("序列化邮件任务载荷失败",
zap.Uint("user_id", userID),
zap.String("email", email),
zap.Error(err))
return errors.Wrap(errors.CodeInternalError, err, "序列化邮件任务载荷失败")
}
// 提交任务到队列
err = s.queueClient.EnqueueTask(
ctx,
constants.TaskTypeEmailSend,
payloadBytes,
asynq.Queue(constants.QueueDefault),
asynq.MaxRetry(constants.DefaultRetryMax),
)
if err != nil {
s.logger.Error("提交欢迎邮件任务失败",
zap.Uint("user_id", userID),
zap.String("email", email),
zap.Error(err))
return errors.Wrap(errors.CodeInternalError, err, "提交欢迎邮件任务失败")
}
s.logger.Info("欢迎邮件任务已提交",
zap.Uint("user_id", userID),
zap.String("email", email))
return nil
}
// SendPasswordResetEmail 发送密码重置邮件(异步)
func (s *Service) SendPasswordResetEmail(ctx context.Context, email string, resetToken string) error {
// 构造任务载荷
payload := &task.EmailPayload{
RequestID: fmt.Sprintf("reset-%s-%s", email, resetToken),
To: email,
Subject: "密码重置请求",
Body: fmt.Sprintf("您的密码重置令牌是: %s\n此令牌将在 1 小时后过期。", resetToken),
}
payloadBytes, err := sonic.Marshal(payload)
if err != nil {
s.logger.Error("序列化密码重置邮件任务载荷失败",
zap.String("email", email),
zap.Error(err))
return errors.Wrap(errors.CodeInternalError, err, "序列化密码重置邮件任务载荷失败")
}
// 提交任务到队列(高优先级)
err = s.queueClient.EnqueueTask(
ctx,
constants.TaskTypeEmailSend,
payloadBytes,
asynq.Queue(constants.QueueCritical), // 密码重置使用高优先级队列
asynq.MaxRetry(constants.DefaultRetryMax),
)
if err != nil {
s.logger.Error("提交密码重置邮件任务失败",
zap.String("email", email),
zap.Error(err))
return errors.Wrap(errors.CodeInternalError, err, "提交密码重置邮件任务失败")
}
s.logger.Info("密码重置邮件任务已提交",
zap.String("email", email))
return nil
}
// SendNotificationEmail 发送通知邮件(异步)
func (s *Service) SendNotificationEmail(ctx context.Context, to string, subject string, body string) error {
// 构造任务载荷
payload := &task.EmailPayload{
RequestID: fmt.Sprintf("notify-%s-%d", to, getCurrentTimestamp()),
To: to,
Subject: subject,
Body: body,
}
payloadBytes, err := sonic.Marshal(payload)
if err != nil {
s.logger.Error("序列化通知邮件任务载荷失败",
zap.String("to", to),
zap.Error(err))
return errors.Wrap(errors.CodeInternalError, err, "序列化通知邮件任务载荷失败")
}
// 提交任务到队列(低优先级)
err = s.queueClient.EnqueueTask(
ctx,
constants.TaskTypeEmailSend,
payloadBytes,
asynq.Queue(constants.QueueLow), // 通知邮件使用低优先级队列
asynq.MaxRetry(constants.DefaultRetryMax),
)
if err != nil {
s.logger.Error("提交通知邮件任务失败",
zap.String("to", to),
zap.Error(err))
return errors.Wrap(errors.CodeInternalError, err, "提交通知邮件任务失败")
}
s.logger.Info("通知邮件任务已提交",
zap.String("to", to),
zap.String("subject", subject))
return nil
}
// getCurrentTimestamp 获取当前时间戳(毫秒)
func getCurrentTimestamp() int64 {
return 0 // 实际实现应返回真实时间戳
}