Gin 框架中实现请求绑定和验证的通用方法

package main

import (
	"errors"
	"fmt"
	"net/http"
	"strings"

	"github.com/gin-gonic/gin"
	"github.com/go-playground/validator/v10"
)

// TranslateError 将验证错误翻译成更友好的中文提示
func TranslateError(err validator.ValidationErrors) map[string]string {
	errs := make(map[string]string)
	for _, e := range err {
		// 可以根据 e.Tag() 为不同验证规则自定义更友好的翻译
		errs[e.Field()] = fmt.Sprintf("字段 '%s' 未通过 '%s' 验证", e.Field(), e.Tag())
	}
	return errs
}

// BindAndValidate 是一个通用的绑定和验证函数
// 它接收一个 gin.Context 和一个指向目标 struct 的指针
// 成功时，返回该 struct 的指针；失败时，返回错误信息并中止后续处理
func BindAndValidate(c *gin.Context, obj interface{}) (interface{}, bool) {
	if err := c.ShouldBindJSON(obj); err != nil {
		var validationErrs validator.ValidationErrors
		// 检查错误是否为验证错误
		if errors.As(err, &validationErrs) {
			// 将验证错误翻译成更友好的格式
			c.JSON(http.StatusBadRequest, gin.H{
				"error":   "请求参数无效",
				"details": TranslateError(validationErrs),
			})
		} else {
			// 处理其他类型的绑定错误，例如 JSON 格式错误
			c.JSON(http.StatusBadRequest, gin.H{
				"error": "请求体格式错误",
				"details": err.Error(),
			})
		}
		return nil, false
	}
	return obj, true
}

func main() {
	r := gin.Default()

	// 示例：创建一个需要验证的用户结构体
	type CreateUserInput struct {
		Username string `json:"username" binding:"required,min=4,max=20"`
		Password string `json:"password" binding:"required,min=8"`
		Email    string `json:"email"    binding:"required,email"`
		Age      int    `json:"age"      binding:"omitempty,gte=18,lte=120"` // omitempty 表示可选
	}

	// 创建用户的 API 路由
	r.POST("/users", func(c *gin.Context) {
		var input CreateUserInput

		// 调用通用函数进行绑定和验证
		validatedData, ok := BindAndValidate(c, &input)
		if !ok {
			return // 如果验证失败，直接返回
		}

		// 类型断言，获取验证后的数据指针
		validatedUser, _ := validatedData.(*CreateUserInput)

		// --- 验证成功，执行后续的业务逻辑 ---
		fmt.Printf("验证成功，接收到用户数据: %+v\n", validatedUser)

		c.JSON(http.StatusOK, gin.H{
			"message": "用户创建成功",
			"user":    validatedUser,
		})
	})

	r.Run(":8080")
}

package main

import (
	"errors"
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
	"github.com/go-playground/validator/v10"
)

// ValidationError 是一个自定义错误类型，用于封装验证失败的详细信息
type ValidationError struct {
	Details map[string]string
}

// Error 实现 error 接口
func (ve *ValidationError) Error() string {
	var errs []string
	for field, msg := range ve.Details {
		errs = append(errs, fmt.Sprintf("field '%s': %s", field, msg))
	}
	return "validation failed: " + strings.Join(errs, ", ")
}


// TranslateError 将 validator.ValidationErrors 转换为我们自定义的 map[string]string
func TranslateError(errs validator.ValidationErrors) map[string]string {
	details := make(map[string]string)
	for _, err := range errs {
		// 这里可以根据 err.Tag() 提供更友好的中文翻译
		details[err.Field()] = fmt.Sprintf("不满足 '%s' 校验规则", err.Tag())
	}
	return details
}

// BindAndValidate 是一个通用的、类型安全的绑定和验证函数
// 它使用泛型来接收任意 struct 类型
// 成功时，返回一个指向该类型实例的指针和 nil error
// 失败时，返回 nil 指针和一个具体的 error
func BindAndValidate[T any](c *gin.Context) (*T, error) {
	// 1. 创建一个 T 类型的实例指针
	var obj T = *new(T)

	// 2. 绑定 JSON 并进行验证
	if err := c.ShouldBindJSON(&obj); err != nil {
		var validationErrs validator.ValidationErrors
		// 检查是否是 validator 的验证错误
		if errors.As(err, &validationErrs) {
			// 将其封装到我们的自定义错误类型中
			return nil, &ValidationError{
				Details: TranslateError(validationErrs),
			}
		}
		// 其他绑定错误（如JSON格式错误）直接返回
		return nil, err
	}

	// 3. 成功，返回填充好数据的对象指针
	return &obj, nil
}

// 示例：创建一个需要验证的用户结构体
type CreateUserInput struct {
	Username string `json:"username" binding:"required,min=4,max=20"`
	Password string `json:"password" binding:"required,min=8"`
	Email    string `json:"email"    binding:"required,email"`
	Age      int    `json:"age"      binding:"omitempty,gte=18,lte=120"`
}

func main() {
	r := gin.Default()

	// 创建用户的 API 路由
	r.POST("/users", func(c *gin.Context) {
		// 调用通用函数，直接在尖括号中指定你的 struct 类型
		input, err := BindAndValidate[CreateUserInput](c)
		if err != nil {
			var ve *ValidationError
			// 判断是否是我们的自定义验证错误
			if errors.As(err, &ve) {
				c.JSON(http.StatusBadRequest, gin.H{
					"error":   "请求参数无效",
					"details": ve.Details,
				})
			} else {
				// 其他类型的错误
				c.JSON(http.StatusBadRequest, gin.H{
					"error":   "请求体绑定失败",
					"details": err.Error(),
				})
			}
			return
		}

		// --- 无需类型断言，直接使用 input ---
		// input 的类型已经是 *CreateUserInput
		fmt.Printf("验证成功，接收到用户数据: %+v\n", input)

		c.JSON(http.StatusOK, gin.H{
			"message": "用户创建成功",
			"user":    input,
		})
	})

	r.Run(":8080")
}