開發接口的時候需要多前端提交的參數進行參數校驗，如果提交的參數只有一個兩個，這樣我們可以簡單寫個if判斷，但是如果提交的參數比較多，通過if判斷就比較繁瑣了，在Go中有一個validator包可以通過反射結構體struct的tag進行參數校驗。
1.實踐
go get github.com/go-playground/validator/v10
定義結體：
type UserInfo struct {
ID int `validate:"gt=0"`
Age int `validate:"gt=0"`
Name string `validate:"required"`
Sex string `validate:"required"`
}
初始化結構體并做參數校驗：
func InitUserInfo(id,age int,name,sex string) *UserInfo {
// new一個校驗器
valid := validator.New()
// 初始化UserInfo
userInfo := &UserInfo{
ID: id,
Age: age,
Name:name,
Sex:sex,
}
if err := valid.Struct(userInfo);err != nil {
fmt.Println("參數校驗不通過",err)
}
return userInfo
}
效果：
InitUserInfo(1,2,"kevin","男")// 參數校驗通過 InitUserInfo(0,2,"kevin","男")// 參數校驗不通過 Key: 'UserInfo.ID' Error:Field validation for 'ID' failed on the 'gt' tag InitUserInfo(1,2,"kevin","")// 參數校驗不通過 Key: 'UserInfo.Sex' Error:Field validation for 'Sex' failed on the 'required' tag
如參數校驗不通過，err中會包含不通過字段信息
1.1校驗標簽
-：跳過該字段，不測驗；
|：應用多個束縛，只須要滿足其中一個，例如rgb|rgba；
required：字段必須設置，不能為默認值；
omitempty：如果字段未設置，則疏忽它
1.2字符串約束
- excludesall：不包含參數中任意的 UNICODE 字符，例如excludesall=ab；
- excludesrune：不包含參數表示的 rune 字符，excludesrune=asong ；
- startswith：以參數子串為前綴，例如startswith=hi；
- endswith：以參數子串為后綴，例如endswith=bye 。
- contains= ：包含參數子串，例如contains=email；
- containsany：包含參數中任意的 UNICODE 字符，例如containsany=ab；
- containsrune：包含參數表示的 rune 字符，例如`containsrune=asong；
- excludes：不包含參數子串，例如excludes=email；
1.3自定義校驗器
在Gin中支持實現自定義校驗標簽
定義校驗邏輯：
// sum不能大于10
func VerifySum(level validator.FieldLevel) bool {
if sum,ok := level.Field().Interface().(int);ok{
fmt.Println(sum)
if sum > 10 {
return false
}
return true
}
return false
}
注冊標簽：
// 注冊
if v,ok := binding.Validator.Engine().(*validator.Validate); ok {
if err := v.RegisterValidation("sum",VerifySum);err != nil{
fmt.Println("參數校驗標簽注冊失敗")
}
fmt.Println("參數校驗標簽注冊成功")
}
應用標簽到結構體上:
type TestSum struct {
Sum int `binding:"sum"`
}
測試：
func getSum(c *gin.Context) {
var b TestSum
b.Sum = cast.ToInt(c.Request.URL.Query().Get("sum"))
// 數據模型綁定查詢字符串驗證
if err := c.ShouldBindWith(&b, binding.Query); err == nil {
c.JSON(http.StatusOK, gin.H{"message": "prams are valid!"})
} else {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
}
}
func main() {
route := gin.Default()
// 注冊
if v,ok := binding.Validator.Engine().(*validator.Validate); ok {
if err := v.RegisterValidation("sum",VerifySum);err != nil{
fmt.Println("參數校驗標簽注冊失敗")
}
fmt.Println("參數校驗標簽注冊成功")
}
route.GET("/getSum", getSum)
route.Run(":8080")
}
附加：
Go中獲取標簽值是通過反射進行獲取的：
type TestSum struct {
Sum int `binding:"sum"`
}
// 獲取標簽值：
var b TestSum
b_type := reflect.TypeOf(b)
fmt.Println(b_type.Field(0).Tag.Get("binding"))
到此這篇關于golang參數校驗Validator的文章就介紹到這了,更多相關go參數校驗Validator內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家！
原文鏈接：https://blog.csdn.net/weixin_41922289/article/details/121432884
