This commit is contained in:
杭州明婳科技
2026-04-30 23:26:14 +08:00
commit 2dfcbbbb22
76 changed files with 17478 additions and 0 deletions
+397
View File
@@ -0,0 +1,397 @@
package validation
import (
"fmt"
"reflect"
"strings"
"github.com/gin-gonic/gin"
"github.com/gin-gonic/gin/binding"
"github.com/go-playground/validator/v10"
)
// Validator 全局验证器实例
var Validator *validator.Validate
// ValidationError 验证错误
type ValidationError struct {
Field string `json:"field"` // 字段名(使用 label 或 json tag
Label string `json:"label"` // 字段中文名(用于显示)
Message string `json:"message"` // 错误消息
}
// ValidationErrors 验证错误列表
type ValidationErrors []ValidationError
// Error 实现 error 接口
func (ve ValidationErrors) Error() string {
var msgs []string
for _, e := range ve {
if e.Label != "" {
msgs = append(msgs, e.Label+": "+e.Message)
} else {
msgs = append(msgs, e.Field+": "+e.Message)
}
}
return strings.Join(msgs, "; ")
}
// ToMap 转换为 map
func (ve ValidationErrors) ToMap() map[string]string {
m := make(map[string]string)
for _, e := range ve {
m[e.Field] = e.Message
}
return m
}
// ToLabelMap 转换为带标签的 map
func (ve ValidationErrors) ToLabelMap() map[string]string {
m := make(map[string]string)
for _, e := range ve {
if e.Label != "" {
m[e.Label] = e.Message
} else {
m[e.Field] = e.Message
}
}
return m
}
// First 获取第一个错误
func (ve ValidationErrors) First() *ValidationError {
if len(ve) == 0 {
return nil
}
return &ve[0]
}
// FirstMessage 获取第一个错误消息
func (ve ValidationErrors) FirstMessage() string {
if len(ve) == 0 {
return ""
}
return ve[0].Message
}
// InitValidator 初始化验证器
func InitValidator() {
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
Validator = v
// 注册自定义标签名函数(优先使用 label,其次 json)
v.RegisterTagNameFunc(func(fld reflect.StructField) string {
// 优先使用 label tag 作为字段显示名
label := fld.Tag.Get("label")
if label != "" {
return label
}
// 其次使用 json tag
name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
if name == "-" {
return ""
}
return name
})
// 注册自定义验证规则
registerCustomValidations(v)
}
}
// registerCustomValidations 注册自定义验证规则
func registerCustomValidations(v *validator.Validate) {
// 密码强度验证
v.RegisterValidation("password", func(fl validator.FieldLevel) bool {
password := fl.Field().String()
valid, _ := ValidatePassword(password)
return valid
})
// 手机号验证(中国大陆)
v.RegisterValidation("phone", func(fl validator.FieldLevel) bool {
phone := fl.Field().String()
if len(phone) != 11 {
return false
}
return strings.HasPrefix(phone, "1")
})
// 用户名验证(字母开头,允许字母数字下划线)
v.RegisterValidation("username", func(fl validator.FieldLevel) bool {
username := fl.Field().String()
if len(username) < 3 || len(username) > 20 {
return false
}
if !isLetter(rune(username[0])) {
return false
}
for _, r := range username {
if !isLetter(r) && !isDigit(r) && r != '_' {
return false
}
}
return true
})
// 手机号严格验证(验证运营商号段)
v.RegisterValidation("phone_strict", func(fl validator.FieldLevel) bool {
phone := fl.Field().String()
if len(phone) != 11 {
return false
}
if !strings.HasPrefix(phone, "1") {
return false
}
// 检查号段
prefix := phone[:3]
validPrefixes := []string{
"130", "131", "132", "133", "134", "135", "136", "137", "138", "139",
"145", "146", "147", "148", "149",
"150", "151", "152", "153", "155", "156", "157", "158", "159",
"166", "167",
"170", "171", "172", "173", "174", "175", "176", "177", "178",
"180", "181", "182", "183", "184", "185", "186", "187", "188", "189",
"191", "198", "199",
}
for _, p := range validPrefixes {
if prefix == p {
return true
}
}
return false
})
// 身份证号验证(简化版)
v.RegisterValidation("idcard", func(fl validator.FieldLevel) bool {
id := fl.Field().String()
if len(id) != 18 && len(id) != 15 {
return false
}
// 简化验证:只检查长度和基本格式
for i, c := range id {
if i == len(id)-1 && len(id) == 18 {
// 最后一位可以是 X
if !isDigit(c) && c != 'X' && c != 'x' {
return false
}
} else {
if !isDigit(c) {
return false
}
}
}
return true
})
}
func isLetter(r rune) bool {
return (r >= 'a' && r <= 'z') || (r >= 'A' && r <= 'Z')
}
func isDigit(r rune) bool {
return r >= '0' && r <= '9'
}
// ValidateStruct 验证结构体
func ValidateStruct(s any) ValidationErrors {
if Validator == nil {
InitValidator()
}
err := Validator.Struct(s)
if err == nil {
return nil
}
return parseValidationErrors(err, s)
}
// parseValidationErrors 解析验证错误(支持自定义错误消息)
func parseValidationErrors(err error, s any) ValidationErrors {
var errors ValidationErrors
if validationErrors, ok := err.(validator.ValidationErrors); ok {
for _, e := range validationErrors {
fieldName := e.Field()
label := fieldName // Field() 返回的是 label 或 json tag
// 尝试获取原始字段名和自定义错误消息
if s != nil {
t := reflect.TypeOf(s)
if t.Kind() == reflect.Ptr {
t = t.Elem()
}
if t.Kind() == reflect.Struct {
// 获取原始字段名
originalField := getOriginalFieldName(t, e.StructField())
if originalField != "" {
fieldName = originalField
}
// 获取自定义错误消息
field, found := t.FieldByName(e.StructField())
if found {
customMsg := getCustomErrorMessage(field, e.Tag())
if customMsg != "" {
errors = append(errors, ValidationError{
Field: fieldName,
Label: label,
Message: customMsg,
})
continue
}
}
}
}
errors = append(errors, ValidationError{
Field: fieldName,
Label: label,
Message: getErrorMessage(e),
})
}
}
return errors
}
// getOriginalFieldName 获取原始字段名(从 json tag)
func getOriginalFieldName(t reflect.Type, structField string) string {
field, found := t.FieldByName(structField)
if !found {
return ""
}
jsonTag := field.Tag.Get("json")
if jsonTag == "" || jsonTag == "-" {
return structField
}
name := strings.SplitN(jsonTag, ",", 2)[0]
if name == "" {
return structField
}
return name
}
// getCustomErrorMessage 获取自定义错误消息
// 支持格式:
// - error:"自定义错误消息"
// - msg_required:"必填项" (针对特定验证规则)
// - msg_min:"最少5个字符"
func getCustomErrorMessage(field reflect.StructField, tag string) string {
// 优先查找特定规则的错误消息
specificTag := fmt.Sprintf("msg_%s", tag)
msg := field.Tag.Get(specificTag)
if msg != "" {
return msg
}
// 其次查找通用错误消息
msg = field.Tag.Get("error")
if msg != "" {
return msg
}
// 最后查找 msg tag
msg = field.Tag.Get("msg")
if msg != "" {
return msg
}
return ""
}
// getErrorMessage 获取默认验证错误消息
func getErrorMessage(e validator.FieldError) string {
switch e.Tag() {
case "required":
return "此字段为必填项"
case "email":
return "邮箱格式不正确"
case "min":
return fmt.Sprintf("长度不能少于 %s 个字符", e.Param())
case "max":
return fmt.Sprintf("长度不能超过 %s 个字符", e.Param())
case "len":
return fmt.Sprintf("长度必须为 %s 个字符", e.Param())
case "gte":
return fmt.Sprintf("必须大于或等于 %s", e.Param())
case "lte":
return fmt.Sprintf("必须小于或等于 %s", e.Param())
case "gt":
return fmt.Sprintf("必须大于 %s", e.Param())
case "lt":
return fmt.Sprintf("必须小于 %s", e.Param())
case "eq":
return fmt.Sprintf("必须等于 %s", e.Param())
case "ne":
return fmt.Sprintf("不能等于 %s", e.Param())
case "oneof":
return fmt.Sprintf("必须是以下值之一: %s", e.Param())
case "url":
return "URL 格式不正确"
case "uri":
return "URI 格式不正确"
case "uuid":
return "UUID 格式不正确"
case "alphanum":
return "只能包含字母和数字"
case "alpha":
return "只能包含字母"
case "numeric":
return "必须是数字"
case "password":
return "密码强度不足,需包含大小写字母和数字,至少8位"
case "phone":
return "手机号格式不正确"
case "phone_strict":
return "手机号无效,请输入正确的手机号"
case "username":
return "用户名必须以字母开头,只能包含字母、数字和下划线,长度3-20"
case "idcard":
return "身份证号格式不正确"
default:
return fmt.Sprintf("验证失败: %s", e.Tag())
}
}
// BindAndValidate 绑定并验证请求
func BindAndValidate(c *gin.Context, req any) ValidationErrors {
if err := c.ShouldBind(req); err != nil {
return parseValidationErrors(err, req)
}
return ValidateStruct(req)
}
// ShouldBindAndValidate 绑定并验证请求,返回是否成功
func ShouldBindAndValidate(c *gin.Context, req any) (ValidationErrors, bool) {
errors := BindAndValidate(c, req)
return errors, len(errors) == 0
}
// BindJSON 绑定 JSON 并验证
func BindJSON(c *gin.Context, req any) ValidationErrors {
if err := c.ShouldBindJSON(req); err != nil {
return parseValidationErrors(err, req)
}
return ValidateStruct(req)
}
// BindQuery 绑定 Query 并验证
func BindQuery(c *gin.Context, req any) ValidationErrors {
if err := c.ShouldBindQuery(req); err != nil {
return parseValidationErrors(err, req)
}
return ValidateStruct(req)
}
// BindForm 绑定 Form 并验证
func BindForm(c *gin.Context, req any) ValidationErrors {
if err := c.ShouldBind(req); err != nil {
return parseValidationErrors(err, req)
}
return ValidateStruct(req)
}