iris请求数据验证

目录结构

主目录readJsonStructValidation

  1.     —— main.go

代码示例

main.go

  1. //包main显示验证器（最新版本9）与Iris的集成。
  2. //您可以在以下网址找到更多这样的示例：https//github.com/go-playground/validator/blob/v9/_examples
  3. package main
  5. import (
  6.     "fmt"
  7.     "github.com/kataras/iris"
  8.     // $ go get gopkg.in/go-playground/validator.v9
  9.     "gopkg.in/go-playground/validator.v9"
  10.     //"gopkg.in/go-playground/validator.v8"
  11. )
  12. //用户包含用户信息。
  13. type User struct {
  14.     FirstName      string     `json:"fname"`
  15.     LastName       string     `json:"lname"`
  16.     Age            uint8      `json:"age" validate:"gte=0,lte=130"`
  17.     Email          string     `json:"email" validate:"required,email"`
  18.     FavouriteColor string     `json:"favColor" validate:"hexcolor|rgb|rgba"`
  19.     Addresses      []*Address `json:"addresses" validate:"required,dive,required"`
  20. }
  21. //地址包含用户地址信息
  22. type Address struct {
  23.     Street string `json:"street" validate:"required"`
  24.     City   string `json:"city" validate:"required"`
  25.     Planet string `json:"planet" validate:"required"`
  26.     Phone  string `json:"phone" validate:"required"`
  27. }
  29. // Use a single instance of Validate, it caches struct info.
  30. //使用Validate的单个实例，它缓存struct info。
  31. var validate *validator.Validate
  33. func main() {
  34.     validate = validator.New()
  35.     //为'用户'注册验证
  36.     //注意：只需要为'User'，validator注册一个非指针类型
  37.     //在类型检查期间内部取消引用。
  38.     validate.RegisterStructValidation(UserStructLevelValidation, User{})
  39.     app := iris.New()
  40.     app.Get("/user", func(ctx iris.Context) {
  41.         fmt.Println("test")
  42.         var user User
  43.         if err := ctx.ReadJSON(&user); err != nil {
  44.             // 处理错误
  45.             fmt.Println(err)
  46.         }
  47.         //为错误的验证输入返回InvalidValidationError，nil或ValidationErrors（[] FieldError）
  48.         err := validate.Struct(user)
  49.         if err != nil {
  50.             //只有在您的代码可以生成时才需要进行此检查
  51.             //验证的无效值，例如与nil的接口
  52.             //大多数包括我自己的值通常不会有这样的代码。
  53.             if _, ok := err.(*validator.InvalidValidationError); ok {
  54.                 ctx.StatusCode(iris.StatusInternalServerError)
  55.                 ctx.WriteString(err.Error())
  56.                 return
  57.             }
  58.             ctx.StatusCode(iris.StatusBadRequest)
  59.             for _, err := range err.(validator.ValidationErrors) {
  60.                 fmt.Println()
  61.                 fmt.Println(err.Namespace())
  62.                 fmt.Println(err.Field())
  63.                 fmt.Println(err.StructNamespace()) //注册自定义TagNameFunc时可能会有所不同
  64.                 fmt.Println(err.StructField()) //通过将alt名称传递给ReportError，如下所示
  65.                 fmt.Println(err.Tag())
  66.                 fmt.Println(err.ActualTag())
  67.                 fmt.Println(err.Kind())
  68.                 fmt.Println(err.Type())
  69.                 fmt.Println(err.Value())
  70.                 fmt.Println(err.Param())
  71.                 fmt.Println()
  72.                 //或者将它们收集为json对象
  73.                 //并通过ctx.JSON将收集的错误发送回客户端
  74.                 // {
  75.                 //     "namespace":        err.Namespace(),
  76.                 //     "field":            err.Field(),
  77.                 //     "struct_namespace": err.StructNamespace(),
  78.                 //     "struct_field":     err.StructField(),
  79.                 //     "tag":              err.Tag(),
  80.                 //     "actual_tag":       err.ActualTag(),
  81.                 //     "kind":             err.Kind().String(),
  82.                 //     "type":             err.Type().String(),
  83.                 //     "value":            fmt.Sprintf("%v", err.Value()),
  84.                 //     "param":            err.Param(),
  85.                 // }
  86.             }
  87.             ctx.WriteString("testasdd")
  88.             //从这里你可以用你想要的任何语言创建自己的错误信息。
  89.             return
  90.         }
  91.         //将用户保存到数据库
  92.     })
  93.     //使用Postman或其他什么来做POST请求
  94.     //使用RAW BODY的http//localhost:8080/user
  95.     /*
  96.         {
  97.             "fname": "",
  98.             "lname": "",
  99.             "age": 45,
  100.             "email": "mail@example.com",
  101.             "favColor": "#000",
  102.             "addresses": [{
  103.                 "street": "Eavesdown Docks",
  104.                 "planet": "Persphone",
  105.                 "phone": "none",
  106.                 "city": "Unknown"
  107.             }]
  108.         }
  109.     */
  110.     //Content-Type to application/json（可选，如果选择更好）。
  111.     //由于空的`User.FirstName`（json中的fname），此请求将失败
  112.     //和`User.LastName`（json中的lname）。
  113.     //检查iris应用程序终端输出
  114.     app.Run(iris.Addr(":8080"), iris.WithoutServerError(iris.ErrServerClosed))
  115. }
  116. // UserStructLevelValidation包含并非总是的自定义结构级别验证
  117. //在字段验证级别有同样有意义。例如，此函数验证了这一点
  118. //存在FirstName或LastName; 可以通过自定义字段验证完成，但随后
  119. //必须将它添加到复制逻辑+开销的两个字段中，这样就可以了,仅验证一次。
  120. //
  121. //注意：您可能会问为什么我不能在验证器之外执行此操作，因为这样做
  122. //挂钩到验证器，你可以与验证标签结合，但仍然有常见错误输出格式。
  123. func UserStructLevelValidation(sl validator.StructLevel) {
  124.     user := sl.Current().Interface().(User)
  125.     if len(user.FirstName) == 0 && len(user.LastName) == 0 {
  126.         sl.ReportError(user.FirstName, "FirstName", "fname", "fnameorlname", "")
  127.         sl.ReportError(user.LastName, "LastName", "lname", "fnameorlname", "")
  128.     }
  129.     //加上可以更多，甚至使用不同于“fnameorlname”的标签。
  130. }