java 自定义validate_Golang-03 自定义validator,实现java注解功能-Go语言中文社区
0x00 About
接口開發中, 比較常用的操作就是對輸入的參數Bean進行字段屬性值校驗.
在Java中, 有Annotation(注解)可以讓我們方便的在的類上面添加校驗信息,
那么在Go中應該如何做到這一點呢?
0x01 structTag
StructType = "struct" "{" { FieldDecl ";" } "}" .
FieldDecl = (IdentifierList Type | EmbeddedField) [ Tag ] .
EmbeddedField = [ "*" ] TypeName .
Tag = string_lit .
也就是說, struct字段的后面, 可以添加一個字符串, 稱之為Tag
然后, 通過go語言中的reflect反射機制, 就可以讀取相應字段的Tag信息了.
接下來, 找一段代碼直觀感受一下:
type InParam struct {
StudentName string `json:"name" cc:"str,min=5,max=15"`
Score int `json:"score" cc:"num,min=0,max=100"`
}
package main
import (
"fmt"
"reflect"
)
func main() {
t := reflect.TypeOf(&InParam{"18", 25})
field := t.Elem().Field(0)
jsonName := field.Tag.Get("json")
cc := field.Tag.Get("cc")
fmt.Printf("%s(%s): %s", field.Name, jsonName, cc)
}
輸出結果:
StudentName(name): str,min=5,max=15
需要注意的地方: reflect.TypeOf 的參數只能接入對象.
0x02 Validator
那么接下來的工作, 就是根據Tag內容開發一個公共函數.
這里提供了兩種驗證器:string和number, 分別驗證其長度范圍和取值范圍.
package main
import (
"fmt"
"reflect"
"strings"
)
// 定義接口
type CCValid interface {
Validate(interface{}) (bool, error)
}
// 定義三個驗證器
type CCDefaultValid struct {
}
type CCNumberValid struct {
Min int
Max int
}
type CCStringValid struct {
Min int
Max int
}
// 三個驗證器實現接口方法
func (c CCNumberValid) Validate(obj interface{}) (bool, error) {
v := obj.(int)
if v < c.Min || v > c.Max {
return false, fmt.Errorf(":int value should in range (%d, %d)", c.Min, c.Max)
}
return true, nil
}
func (c CCStringValid) Validate(obj interface{}) (bool, error) {
l := len(obj.(string))
if l < c.Min || l > c.Max {
return false, fmt.Errorf(":string length should in range (%d, %d)", c.Min, c.Max)
}
return true, nil
}
func (c CCDefaultValid) Validate(obj interface{}) (bool, error) {
return true, nil
}
var tagName = "cc"
// 公共方法,對外提供檢驗處理
func CCValidate(s interface{}) []error {
var errs []error
v := reflect.ValueOf(s)
for i := 0; i < v.NumField(); i++ {
tag := v.Type().Field(i).Tag.Get(tagName)
if tag == "" || tag == "-" {
continue
}
validator := parseValidatorFromTag(tag)
valid, err := validator.Validate(v.Field(i).Interface())
if !valid && err != nil {
errs = append(errs, fmt.Errorf("%s%s", v.Type().Field(i).Name, err.Error()))
}
}
return errs
}
// 從Tag字符串里分析出使用哪個驗證器,并賦值
func parseValidatorFromTag(tag string) CCValid {
args := strings.Split(tag, ",")
switch args[0] {
case "num":
v := CCNumberValid{}
fmt.Sscanf(strings.Join(args[1:], ","), "min=%d,max=%d", &v.Min, &v.Max)
return v
case "str":
v := CCStringValid{}
fmt.Sscanf(strings.Join(args[1:], ","), "min=%d,max=%d", &v.Min, &v.Max)
return v
}
return CCDefaultValid{}
}
0x03 在gin中的使用
我們開發校驗器的目的, 當然, 是為了能在gin中使用啦
直接上代碼, 理解起來不難:
type Result struct {
code int
msg string
data interface{}
}
func OK(msg string) Result {
return Result{0, msg, nil}
}
func NG(msg string) Result {
return Result{1, msg, nil}
}
// 解析JSON請求
r.POST("/login", func(c *gin.Context) {
var header MyHeader
var param Login
// 解析Header
if c.BindHeader(&header) != nil {
c.JSON(200, NG("invalid header"))
return
}
// 解析JSON
if c.BindJSON(¶m) != nil {
c.JSON(200, NG("invalid json param"))
return
}
// 驗證
for _, firstErr := range CCValidate(param) {
c.JSON(200, NG(firstErr.Error()))
return
}
c.JSON(200, gin.H{"hello": param.Username, "world": param.Password, "from": header.From})
})
當驗證出錯時, 會向客戶端返回第一個發現的錯誤.
0x04 TODO
現在的代碼來看, 業務功能還沒開發呢, 已經寫了這么多行代碼了. 一點都不優雅.
接下來要考慮, 能不能利用中間件, 完成這些前置操作.
總結
以上是生活随笔為你收集整理的java 自定义validate_Golang-03 自定义validator,实现java注解功能-Go语言中文社区的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： java getresourceasst
- 下一篇： 抢椅子游戏java_游戏教案小班抢椅子