gin自定义验证器转化中文

本文介绍了如何在Gin Web框架中实现参数验证的错误信息中文本地化,并展示了如何自定义验证器以检查日期是否可预订。通过创建一个翻译器并注册到验证器中,可以将英文错误信息转换为中文,提高用户体验。同时,自定义验证函数`bookableDate`用于确保入住日期早于当前日期且退房日期晚于入住日期,确保了预订的有效性。
摘要由CSDN通过智能技术生成

在这里插入图片描述

使用gin 自带 绑定验证参数返回的是乱的英文,对于国人来说看起来不是特别友好

{
  "message": "Key: 'Booking.CheckIn' Error:Field validation for 'CheckIn' failed on the 'required' tag\nKey: 'Booking.CheckOut' Error:Field validation for 'CheckOut' failed on the 'required' tag"
}

validator 翻译成中文

新建文件 validator

package validator

//gin > 1.4.0

//将验证器错误翻译成中文

import (
	"github.com/gin-gonic/gin/binding"
	"github.com/go-playground/locales/zh"
	ut "github.com/go-playground/universal-translator"
	"github.com/go-playground/validator/v10"
	zh_translations "github.com/go-playground/validator/v10/translations/zh"
)

var (
	uni      *ut.UniversalTranslator
	validate *validator.Validate
	trans ut.Translator
)

func Init() {
	//注册翻译器
	zh := zh.New()
	uni = ut.New(zh, zh)

	trans, _ = uni.GetTranslator("zh")

	//获取gin的校验器
	validate := binding.Validator.Engine().(*validator.Validate)
	//注册翻译器
	zh_translations.RegisterDefaultTranslations(validate, trans)
}

//Translate 翻译错误信息
func Translate(err error) map[string][]string {

	var result = make(map[string][]string)

	errors := err.(validator.ValidationErrors)

	for _, err := range errors{
		result[err.Field()] = append(result[err.Field()], err.Translate(trans))
	}
	return result
}

在main 中初始化

	validator.Init()

控制器中:

package api

import (
	"github.com/gin-gonic/gin"
	"yibage-api/validator"
)



type Booking struct {
	CheckIn  string `form:"check_in"  binding:"required"`
	CheckOut string`form:"check_out"  binding:"required"`
}

func Test(c *gin.Context) {

	var b Booking
	err := c.BindQuery(&b);
	if err == nil {
		c.JSON(200, gin.H{"message": "Success"})
		return;
	} else {
		c.JSON(200, gin.H{"message": validator.Translate(err)})
		return;
	}
}


上面用到了 在validator 中 的翻译 validator.Translate(err)

效果:

{
  "message": {
    "CheckIn": [
      "CheckIn为必填字段"
    ],
    "CheckOut": [
      "CheckOut为必填字段"
    ]
  }
}

自定义参数验证器

package main

import (
	"net/http"
	"reflect"
	"time"

	"github.com/gin-gonic/gin"
	"github.com/gin-gonic/gin/binding"
	"gopkg.in/go-playground/validator.v8"
)

// Booking contains binded and validated data.
type Booking struct {
	CheckIn  time.Time `form:"check_in" binding:"required,bookabledate" time_format:"2006-01-02"`
	CheckOut time.Time `form:"check_out" binding:"required,gtfield=CheckIn" time_format:"2006-01-02"`
}

func bookableDate(
	v *validator.Validate, topStruct reflect.Value, currentStructOrField reflect.Value,
	field reflect.Value, fieldType reflect.Type, fieldKind reflect.Kind, param string,
) bool {
	if date, ok := field.Interface().(time.Time); ok {
		today := time.Now()
		if today.Year() > date.Year() || today.YearDay() > date.YearDay() {
			return false
		}
	}
	return true
}

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

	if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
		v.RegisterValidation("bookabledate", bookableDate)
	}

	route.GET("/bookable", getBookable)
	route.Run(":8085")
}

func getBookable(c *gin.Context) {
	var b Booking
	if err := c.ShouldBindWith(&b, binding.Query); err == nil {
		c.JSON(http.StatusOK, gin.H{"message": "Booking dates are valid!"})
	} else {
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
	}
}

参考:https://www.kancloud.cn/shuangdeyu/gin_book/949427

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

廖圣平

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值