简化控制器层重复代码
This commit is contained in:
294
internal/app/controller/management/controller_helpers.go
Normal file
294
internal/app/controller/management/controller_helpers.go
Normal file
@@ -0,0 +1,294 @@
|
||||
package management
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strconv"
|
||||
|
||||
"git.huangwc.com/pig/pig-farm-controller/internal/app/controller"
|
||||
"git.huangwc.com/pig/pig-farm-controller/internal/app/service"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
// mapAndSendError 统一映射服务层错误并发送响应。
|
||||
// 这个函数将服务层返回的错误转换为控制器层应返回的HTTP状态码和审计信息。
|
||||
func mapAndSendError(c *PigBatchController, ctx *gin.Context, action string, err error, id uint) {
|
||||
if errors.Is(err, service.ErrPigBatchNotFound) ||
|
||||
errors.Is(err, service.ErrPenNotFound) ||
|
||||
errors.Is(err, service.ErrPenNotAssociatedWithBatch) {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeNotFound, err.Error(), action, err.Error(), id)
|
||||
} else if errors.Is(err, service.ErrInvalidOperation) ||
|
||||
errors.Is(err, service.ErrPigBatchActive) ||
|
||||
errors.Is(err, service.ErrPigBatchNotActive) ||
|
||||
errors.Is(err, service.ErrPenOccupiedByOtherBatch) ||
|
||||
errors.Is(err, service.ErrPenStatusInvalidForAllocation) ||
|
||||
errors.Is(err, service.ErrPenNotEmpty) {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeConflict, err.Error(), action, err.Error(), id)
|
||||
} else {
|
||||
c.logger.Errorf("操作[%s]业务逻辑失败: %v", action, err)
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeInternalError, "操作失败", action, err.Error(), id)
|
||||
}
|
||||
}
|
||||
|
||||
// idExtractorFunc 定义了一个函数类型，用于从gin.Context中提取主ID。
|
||||
type idExtractorFunc func(ctx *gin.Context) (uint, error)
|
||||
|
||||
// handleAPIRequest 封装了控制器中处理带有请求体和路径参数的API请求的通用逻辑。
|
||||
// 它负责请求体绑定、操作员ID获取、服务层调用、错误映射和响应发送。
|
||||
//
|
||||
// 参数:
|
||||
//
|
||||
// c: *PigBatchController - 控制器实例，用于访问其服务和日志。
|
||||
// ctx: *gin.Context - Gin上下文。
|
||||
// action: string - 当前操作的描述，用于日志和审计。
|
||||
// reqDTO: Req - 请求数据传输对象。
|
||||
// serviceExecutor: func(ctx *gin.Context, operatorID uint, primaryID uint, req Req) error - 实际执行服务层逻辑的回调函数。
|
||||
// 这个回调函数负责从ctx中解析所有必要的路径参数（除了primaryID，如果idExtractorFunc提供了），
|
||||
// 获取operatorID，并调用具体的服务方法。
|
||||
// successMsg: string - 操作成功时返回给客户端的消息。
|
||||
// idExtractor: idExtractorFunc - 可选函数，用于从ctx中提取主ID。如果为nil，则尝试从":id"路径参数中提取。
|
||||
func handleAPIRequest[Req any]( // 使用泛型Req
|
||||
c *PigBatchController,
|
||||
ctx *gin.Context,
|
||||
action string,
|
||||
reqDTO Req,
|
||||
serviceExecutor func(ctx *gin.Context, operatorID uint, primaryID uint, req Req) error,
|
||||
successMsg string,
|
||||
idExtractor idExtractorFunc,
|
||||
) {
|
||||
var primaryID uint // 用于审计和日志的主ID
|
||||
|
||||
// 1. 绑定请求体
|
||||
if err := ctx.ShouldBindJSON(&reqDTO); err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的请求体", action, "请求体绑定失败", reqDTO)
|
||||
return
|
||||
}
|
||||
|
||||
// 2. 获取操作员ID
|
||||
operatorID, err := controller.GetOperatorIDFromContext(ctx)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeUnauthorized, "未授权", action, "无法获取操作员ID", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 3. 提取主ID
|
||||
if idExtractor != nil {
|
||||
primaryID, err = idExtractor(ctx)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的ID格式", action, "ID格式错误", err.Error())
|
||||
return
|
||||
}
|
||||
} else { // 默认从 ":id" 路径参数提取
|
||||
idParam := ctx.Param("id")
|
||||
if idParam == "" { // 有些端点可能没有 "id" 参数，例如列表或创建操作
|
||||
// 如果没有ID参数且没有自定义提取器，primaryID保持为0，这对于某些操作是可接受的
|
||||
} else {
|
||||
parsedID, err := strconv.ParseUint(idParam, 10, 32)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的ID格式", action, "ID格式错误", idParam)
|
||||
return
|
||||
}
|
||||
primaryID = uint(parsedID)
|
||||
}
|
||||
}
|
||||
|
||||
// 4. 执行服务层逻辑
|
||||
err = serviceExecutor(ctx, operatorID, primaryID, reqDTO)
|
||||
if err != nil {
|
||||
mapAndSendError(c, ctx, action, err, primaryID)
|
||||
return
|
||||
}
|
||||
|
||||
// 5. 发送成功响应
|
||||
controller.SendSuccessWithAudit(ctx, controller.CodeSuccess, successMsg, nil, action, successMsg, primaryID)
|
||||
}
|
||||
|
||||
// handleNoBodyAPIRequest 封装了处理不带请求体，但有路径参数和操作员ID的API请求的通用逻辑。
|
||||
func handleNoBodyAPIRequest(
|
||||
c *PigBatchController,
|
||||
ctx *gin.Context,
|
||||
action string,
|
||||
serviceExecutor func(ctx *gin.Context, operatorID uint, primaryID uint) error,
|
||||
successMsg string,
|
||||
idExtractor idExtractorFunc,
|
||||
) {
|
||||
var primaryID uint // 用于审计和日志的主ID
|
||||
|
||||
// 1. 获取操作员ID
|
||||
operatorID, err := controller.GetOperatorIDFromContext(ctx)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeUnauthorized, "未授权", action, "无法获取操作员ID", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 2. 提取主ID
|
||||
if idExtractor != nil {
|
||||
primaryID, err = idExtractor(ctx)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的ID格式", action, "ID格式错误", err.Error())
|
||||
return
|
||||
}
|
||||
} else { // 默认从 ":id" 路径参数提取
|
||||
idParam := ctx.Param("id")
|
||||
if idParam == "" {
|
||||
// 如果没有ID参数且没有自定义提取器，primaryID保持为0
|
||||
} else {
|
||||
parsedID, err := strconv.ParseUint(idParam, 10, 32)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的ID格式", action, "ID格式错误", idParam)
|
||||
return
|
||||
}
|
||||
primaryID = uint(parsedID)
|
||||
}
|
||||
}
|
||||
|
||||
// 3. 执行服务层逻辑
|
||||
err = serviceExecutor(ctx, operatorID, primaryID)
|
||||
if err != nil {
|
||||
mapAndSendError(c, ctx, action, err, primaryID)
|
||||
return
|
||||
}
|
||||
|
||||
// 4. 发送成功响应
|
||||
controller.SendSuccessWithAudit(ctx, controller.CodeSuccess, successMsg, nil, action, successMsg, primaryID)
|
||||
}
|
||||
|
||||
// handleAPIRequestWithResponse 封装了控制器中处理带有请求体、路径参数并返回响应DTO的API请求的通用逻辑。
|
||||
func handleAPIRequestWithResponse[Req any, Resp any](
|
||||
c *PigBatchController,
|
||||
ctx *gin.Context,
|
||||
action string,
|
||||
reqDTO Req,
|
||||
serviceExecutor func(ctx *gin.Context, operatorID uint, primaryID uint, req Req) (Resp, error), // serviceExecutor现在返回Resp
|
||||
successMsg string,
|
||||
idExtractor idExtractorFunc,
|
||||
) {
|
||||
var primaryID uint // 用于审计和日志的主ID
|
||||
|
||||
// 1. 绑定请求体
|
||||
if err := ctx.ShouldBindJSON(&reqDTO); err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的请求体", action, "请求体绑定失败", reqDTO)
|
||||
return
|
||||
}
|
||||
|
||||
// 2. 获取操作员ID
|
||||
operatorID, err := controller.GetOperatorIDFromContext(ctx)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeUnauthorized, "未授权", action, "无法获取操作员ID", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 3. 提取主ID
|
||||
if idExtractor != nil {
|
||||
primaryID, err = idExtractor(ctx)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的ID格式", action, "ID格式错误", err.Error())
|
||||
return
|
||||
}
|
||||
} else { // 默认从 ":id" 路径参数提取
|
||||
idParam := ctx.Param("id")
|
||||
if idParam == "" { // 有些端点可能没有 "id" 参数，例如列表或创建操作
|
||||
// 如果没有ID参数且没有自定义提取器，primaryID保持为0，这对于某些操作是可接受的
|
||||
} else {
|
||||
parsedID, err := strconv.ParseUint(idParam, 10, 32)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的ID格式", action, "ID格式错误", idParam)
|
||||
return
|
||||
}
|
||||
primaryID = uint(parsedID)
|
||||
}
|
||||
}
|
||||
|
||||
// 4. 执行服务层逻辑
|
||||
respDTO, err := serviceExecutor(ctx, operatorID, primaryID, reqDTO)
|
||||
if err != nil {
|
||||
mapAndSendError(c, ctx, action, err, primaryID)
|
||||
return
|
||||
}
|
||||
|
||||
// 5. 发送成功响应
|
||||
controller.SendSuccessWithAudit(ctx, controller.CodeSuccess, successMsg, respDTO, action, successMsg, primaryID)
|
||||
}
|
||||
|
||||
// handleNoBodyAPIRequestWithResponse 封装了处理不带请求体，但有路径参数和操作员ID，并返回响应DTO的API请求的通用逻辑。
|
||||
func handleNoBodyAPIRequestWithResponse[Resp any](
|
||||
c *PigBatchController,
|
||||
ctx *gin.Context,
|
||||
action string,
|
||||
serviceExecutor func(ctx *gin.Context, operatorID uint, primaryID uint) (Resp, error), // serviceExecutor现在返回Resp
|
||||
successMsg string,
|
||||
idExtractor idExtractorFunc,
|
||||
) {
|
||||
var primaryID uint // 用于审计和日志的主ID
|
||||
|
||||
// 1. 获取操作员ID
|
||||
operatorID, err := controller.GetOperatorIDFromContext(ctx)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeUnauthorized, "未授权", action, "无法获取操作员ID", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 2. 提取主ID
|
||||
if idExtractor != nil {
|
||||
primaryID, err = idExtractor(ctx)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的ID格式", action, "ID格式错误", err.Error())
|
||||
return
|
||||
}
|
||||
} else { // 默认从 ":id" 路径参数提取
|
||||
idParam := ctx.Param("id")
|
||||
if idParam == "" {
|
||||
// 如果没有ID参数且没有自定义提取器，primaryID保持为0
|
||||
} else {
|
||||
parsedID, err := strconv.ParseUint(idParam, 10, 32)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的ID格式", action, "ID格式错误", idParam)
|
||||
return
|
||||
}
|
||||
primaryID = uint(parsedID)
|
||||
}
|
||||
}
|
||||
|
||||
// 3. 执行服务层逻辑
|
||||
respDTO, err := serviceExecutor(ctx, operatorID, primaryID)
|
||||
if err != nil {
|
||||
mapAndSendError(c, ctx, action, err, primaryID)
|
||||
return
|
||||
}
|
||||
|
||||
// 4. 发送成功响应
|
||||
controller.SendSuccessWithAudit(ctx, controller.CodeSuccess, successMsg, respDTO, action, successMsg, primaryID)
|
||||
}
|
||||
|
||||
// handleQueryAPIRequestWithResponse 封装了处理带有查询参数并返回响应DTO的API请求的通用逻辑。
|
||||
func handleQueryAPIRequestWithResponse[Query any, Resp any](
|
||||
c *PigBatchController,
|
||||
ctx *gin.Context,
|
||||
action string,
|
||||
queryDTO Query,
|
||||
serviceExecutor func(ctx *gin.Context, operatorID uint, query Query) (Resp, error), // serviceExecutor现在接收queryDTO
|
||||
successMsg string,
|
||||
) {
|
||||
// 1. 绑定查询参数
|
||||
if err := ctx.ShouldBindQuery(&queryDTO); err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeBadRequest, "无效的查询参数", action, "查询参数绑定失败", queryDTO)
|
||||
return
|
||||
}
|
||||
|
||||
// 2. 获取操作员ID
|
||||
operatorID, err := controller.GetOperatorIDFromContext(ctx)
|
||||
if err != nil {
|
||||
controller.SendErrorWithAudit(ctx, controller.CodeUnauthorized, "未授权", action, "无法获取操作员ID", nil)
|
||||
return
|
||||
}
|
||||
|
||||
// 3. 执行服务层逻辑
|
||||
respDTO, err := serviceExecutor(ctx, operatorID, queryDTO)
|
||||
if err != nil {
|
||||
// 对于列表查询，通常没有primaryID，所以传递0
|
||||
mapAndSendError(c, ctx, action, err, 0)
|
||||
return
|
||||
}
|
||||
|
||||
// 4. 发送成功响应
|
||||
controller.SendSuccessWithAudit(ctx, controller.CodeSuccess, successMsg, respDTO, action, successMsg, nil)
|
||||
}
|
||||
Reference in New Issue
Block a user