经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 程序设计 » PHP » 查看文章
Gin框架 - 数据绑定和验证 - it-world
来源:cnblogs  作者:it-world  时间:2019/11/15 9:00:42  对本文有异议

概述

上篇文章分享了 Gin 框架使用 Logrus 进行日志记录,这篇文章分享 Gin 框架的数据绑定与验证。

有读者咨询我一个问题,如何让框架的运行日志不输出控制台?

解决方案:

   

  1. engine := gin.Default() //修改成如下
  2. engine := gin.New()

 



我是怎么知道的?看框架代码。

  1. Default():
  2.  
  3. func Default() *Engine {
  4. debugPrintWARNINGDefault()
  5. engine := New()
  6. engine.Use(Logger(), Recovery())
  7. return engine
  8. }

 



New() 代码我就不贴了。

我们看到 Default() 使用了两个中间件 Logger(),Recovery(),如果不想使用,那就直接使用 New() 就可以了。

开始今天的文章。

比如,请求 v1/member/add 新增会员方法, name、 age 为必填,同时 name 不能等于 admin 字符串,10 <= age <= 120。

直接看代码吧。

首先,先定义一个结构体。

  1. entity/member.go
  2.  
  3. package entity
  4. // 定义 Member 结构体
  5. type Member struct {
  6. Name string `form:"name" json:"name" binding:"required,NameValid"`
  7. Age int `form:"age" json:"age" binding:"required,gt=10,lt=120"`
  8. }

 


binding 中 required,这个是框架自带的, NameValid,这个是自己定义的。

问题一:框架自带的 binding 参数还有哪些?

问题二:自定义验证方法,怎么写?

接下来要说的就是问题二,写一个验证方法。

  1. validator/member/member.go
  2.  
  3. package member
  4. import (
  5. "gopkg.in/go-playground/validator.v8"
  6. "reflect"
  7. )
  8. func NameValid(
  9. v *validator.Validate, topStruct reflect.Value, currentStructOrField reflect.Value,
  10. field reflect.Value, fieldType reflect.Type, fieldKind reflect.Kind, param string,
  11. ) bool {
  12. if s, ok := field.Interface().(string); ok {
  13. if s == "admin" {
  14. return false
  15. }
  16. }
  17. return true
  18. }

 



接下来,在路由中绑定:

  1. router/router.go
  2.  
  3. package router
  4. import (
  5. "ginDemo/middleware/logger"
  6. "ginDemo/middleware/sign"
  7. "ginDemo/router/v1"
  8. "ginDemo/router/v2"
  9. "ginDemo/validator/member"
  10. "github.com/gin-gonic/gin"
  11. "github.com/gin-gonic/gin/binding"
  12. "gopkg.in/go-playground/validator.v8"
  13. )
  14. func InitRouter(r *gin.Engine) {
  15. r.Use(logger.LoggerToFile())
  16. // v1 版本
  17. GroupV1 := r.Group("/v1")
  18. {
  19. GroupV1.Any("/product/add", v1.AddProduct)
  20. GroupV1.Any("/member/add", v1.AddMember)
  21. }
  22. // v2 版本
  23. GroupV2 := r.Group("/v2").Use(sign.Sign())
  24. {
  25. GroupV2.Any("/product/add", v2.AddProduct)
  26. GroupV2.Any("/member/add", v2.AddMember)
  27. }
  28. // 绑定验证器
  29. if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
  30. v.RegisterValidation("NameValid", member.NameValid)
  31. }
  32. }

 



最后,看一下调用的代码。

  1. router/v1/member.go
  2.  
  3. package v1
  4. import (
  5. "ginDemo/entity"
  6. "github.com/gin-gonic/gin"
  7. "net/http"
  8. )
  9. func AddMember(c *gin.Context) {
  10. res := entity.Result{}
  11. mem := entity.Member{}
  12. if err := c.ShouldBind(&mem); err != nil {
  13. res.SetCode(entity.CODE_ERROR)
  14. res.SetMessage(err.Error())
  15. c.JSON(http.StatusForbidden, res)
  16. c.Abort()
  17. return
  18. }
  19. // 处理业务(下次再分享)
  20. data := map[string]interface{}{
  21. "name" : mem.Name,
  22. "age" : mem.Age,
  23. }
  24. res.SetCode(entity.CODE_ERROR)
  25. res.SetData(data)
  26. c.JSON(http.StatusOK, res)
  27. }

 


访问看看效果吧。

  1. 访问:http://localhost:8080/v1/member/add
  2.  
  3. {
  4. "code": -1,
  5. "msg": "Key: 'Member.Name' Error:Field validation for 'Name' failed on the 'required' tag\nKey: 'Member.Age' Error:Field validation for 'Age' failed on the 'required' tag",
  6. "data": null
  7. }
  8.  
  9. 访问:http://localhost:8080/v1/member/add?name=1
  10.  
  11. {
  12. "code": -1,
  13. "msg": "Key: 'Member.Age' Error:Field validation for 'Age' failed on the 'required' tag",
  14. "data": null
  15. }
  16.  
  17. 访问:http://localhost:8080/v1/member/add?age=1
  18.  
  19. {
  20. "code": -1,
  21. "msg": "Key: 'Member.Age' Error:Field validation for 'Age' failed on the 'required' tag",
  22. "data": null
  23. }
  24.  
  25. 访问:http://localhost:8080/v1/member/add?name=admin&age=1
  26.  
  27. {
  28. "code": -1,
  29. "msg": "Key: 'Member.Name' Error:Field validation for 'Name' failed on the 'NameValid' tag",
  30. "data": null
  31. }
  32.  
  33. 访问:http://localhost:8080/v1/member/add?name=1&age=1
  34.  
  35. {
  36. "code": -1,
  37. "msg": "Key: 'Member.Age' Error:Field validation for 'Age' failed on the 'gt' tag",
  38. "data": null
  39. }
  40.  
  41. 访问:http://localhost:8080/v1/member/add?name=1&age=121
  42.  
  43. {
  44. "code": -1,
  45. "msg": "Key: 'Member.Age' Error:Field validation for 'Age' failed on the 'lt' tag",
  46. "data": null
  47. }
  48.  
  49. 访问:http://localhost:8080/v1/member/add?name=Tom&age=30
  50.  
  51. {
  52. "code": 1,
  53. "msg": "",
  54. "data": {
  55. "age": 30,
  56. "name": "Tom"
  57. }
  58. }

 


   
为避免返回信息过多,错误提示咱们也可以统一。

   

  1. if err := c.ShouldBind(&mem); err != nil {
  2. res.SetCode(entity.CODE_ERROR)
  3. res.SetMessage("参数验证错误")
  4. c.JSON(http.StatusForbidden, res)
  5. c.Abort()
  6. return
  7. }

 



这一次目录结构调整了一些,在这里说一下:

    ├─ ginDemo    
    │  ├─ common        //公共方法    
    │     ├── common.go    
    │  ├─ config        //配置文件    
    │     ├── config.go    
    │  ├─ entity        //实体    
    │     ├── ...    
    │  ├─ middleware    //中间件    
    │     ├── logger    
    │         ├── ...    
    │     ├── sign    
    │         ├── ...    
    │  ├─ router        //路由    
    │     ├── ...    
    │  ├─ validator     //验证器    
    │     ├── ...    
    │  ├─ vendor        //扩展包    
    │     ├── github.com    
    │         ├── ...    
    │     ├── golang.org    
    │         ├── ...    
    │     ├── gopkg.in    
    │         ├── ...    
    │  ├─ Gopkg.toml    
    │  ├─ Gopkg.lock    
    │  ├─ main.go

将 sign 和 logger 调整为中间件,并放到 middleware 中间件 目录。

新增了 common 公共方法目录。

新增了 validator 验证器目录。

新增了 entity 实体目录。

具体代码我会放到 GitHub,有感兴趣的可以去看:https://github.com/xinliangnote/Go。

上面还遗漏了 问题一 没解决,框架自带的 binding 参数还有哪些?


原文链接:http://www.cnblogs.com/it-3327/p/11863070.html

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号