如何在Gin-Gonic中验证请求头和请求体？

huangapple
go评论106阅读模式
英文:

How to validate headers and body in Gin-Gonic?

问题

我有一个Gin程序。当有请求到来时，我希望变量data（类型为ProductCreate）的所有字段都有值：UserId（来自请求头）以及Name、Price（来自JSON请求体）。我使用了下面的代码，它可以工作：

  1. package main
  3. import (
  4. 	"fmt"
  5. 	"github.com/gin-gonic/gin"
  6. )
  8. type ProductCreate struct {
  9. 	UserId int    `header:"user-id"`
  10. 	Name   string `json:"name"`
  11. 	Price  int    `json:"price"`
  12. }
  14. func main() {
  15. 	r := gin.Default()
  17. 	r.POST("/product", func(c *gin.Context) {
  18. 		var data ProductCreate
  20. 		// 将请求头绑定到data
  21. 		if err := c.ShouldBindHeader(&data); err != nil {
  22. 			c.JSON(400, err.Error())
  23. 			return
  24. 		}
  26. 		// 将请求体绑定到data
  27. 		if err := c.ShouldBindJSON(&data); err != nil {
  28. 			c.JSON(400, err.Error())
  29. 			return
  30. 		}
  32. 		c.JSON(200, data)
  33. 	})
  35. 	r.Run(":8080")
  36. }

之后，我想确保这些字段必须提供，所以我将ProductCreate结构体修改为：

  1. type ProductCreate struct {
  2. 	UserId int    `header:"user-id" binding:"required"`
  3. 	Name   string `json:"name" binding:"required"`
  4. 	Price  int    `json:"price" binding:"required"`
  5. }

然后，当我再次测试时，出现了意外的错误：

Key: 'ProductCreate.Name' Error:Field validation for 'Name' failed on the 'required' tag\nKey: 'ProductCreate.Price' Error:Field validation for 'Price' failed on the 'required' tag

我意识到错误发生在这里：

  1. // 将请求头绑定到data
  2. if err := c.ShouldBindHeader(&data); err != nil {
  3.    c.JSON(400, err.Error())
  4.    return
  5. }

有没有解决这个问题的方法？

英文:

I have a Gin program. When a request comes, I want all of the fields of the variable data (type ProductCreate) to have values: UserId (from headers) and Name, Price (from JSON body). I used the below code and it works:

  1. package main
  3. import (
  4. 	"fmt"
  5. 	"github.com/gin-gonic/gin"
  6. )
  8. type ProductCreate struct {
  9. 	UserId int    `header:"user-id"`
  10. 	Name   string `json:"name"`
  11. 	Price  int    `json:"price"`
  12. }
  14. func main() {
  15. 	r := gin.Default()
  17. 	r.POST("/product", func(c *gin.Context) {
  18. 		var data ProductCreate
  20. 		// bind the headers to data
  21. 		if err := c.ShouldBindHeader(&data); err != nil {
  22. 			c.JSON(400, err.Error())
  23.             return
  24. 		}
  26. 		// bind the body to data
  27. 		if err := c.ShouldBindJSON(&data); err != nil {
  28. 			c.JSON(400, err.Error())
  29.             return
  30. 		}
  32. 		c.JSON(200, data)
  33. 	})
  35. 	r.Run(":8080")
  36. }

After that, I wanted to make sure that fields must be provided so I edited the ProductCreate struct like this:

  1. type ProductCreate struct {
  2. 	UserId int    `header:"user-id" binding:"required"`
  3. 	Name   string `json:"name" binding:"required"`
  4. 	Price  int    `json:"price" binding:"required"`
  5. }

Then it raised an unexpected error when I tested it again:

Key: 'ProductCreate.Name' Error:Field validation for 'Name' failed on the 'required' tag\nKey: 'ProductCreate.Price' Error:Field validation for 'Price' failed on the 'required' tag

I realized the error happened at this:

  1. // bind the headers to data
  2. if err := c.ShouldBindHeader(&data); err != nil {
  3.    c.JSON(400, err.Error())
  4.    return
  5. }

Is there any solution to resolve my problem?

答案1

得分: 2

你好！以下是翻译好的内容：

你能试试这个吗？

  1. curl --location --request POST 'http://localhost:8080/product' \
  2. --header 'user-id: 20' \
  3. --data-raw '{
  4.     "name": "sr"   
  5. }'

我尝试了你的代码，它完美地工作了。

  1. {
  2.     "UserId": 20,
  3.     "name": "sr",
  4.     "price": 0
  5. }

Gin版本：github.com/gin-gonic/gin v1.8.1 // indirect

解决方案：

  1. package main
  3. import (
  4. 	"github.com/gin-gonic/gin"
  5. )
  7. type ProductCreate struct {
  8. 	Name  *string `json:"name" binding:"required"`
  9. 	Price *int    `json:"price" binding:"required"`
  10. }
  12. type Header struct {
  13. 	UserId *int `header:"user-id" binding:"required"`
  14. }
  16. func main() {
  17. 	r := gin.Default()
  19. 	r.POST("/product", func(c *gin.Context) {
  20. 		data := &ProductCreate{}
  21. 		header := &Header{}
  23. 		// 将头部绑定到数据
  24. 		if err := c.ShouldBindHeader(header); err != nil {
  25. 			c.JSON(400, err.Error())
  26. 			return
  27. 		}
  29. 		// 将请求体绑定到数据
  30. 		if err := c.ShouldBindJSON(data); err != nil {
  31. 			c.JSON(400, err.Error())
  32. 			return
  33. 		}
  35. 		c.JSON(200, data)
  36. 	})
  38. 	r.Run(":8080")
  39. }
英文:

Can you try this?

  1. curl --location --request POST 'http://localhost:8080/product' \
  2. --header 'user-id: 20' \
  3. --data-raw '{
  4.     "name": "sr"   
  5. }'

I tried your code and it works perfectly.

  1. {
  2.     "UserId": 20,
  3.     "name": "sr",
  4.     "price": 0
  5. }

Gin version: github.com/gin-gonic/gin v1.8.1 // indirect

Soln:

  1. package main
  3. import (
  4. 	"github.com/gin-gonic/gin"
  5. )
  7. type ProductCreate struct {
  8. 	Name  *string `json:"name" binding:"required"`
  9. 	Price *int    `json:"price" binding:"required"`
  10. }
  12. type Header struct {
  13. 	UserId *int `header:"user-id" binding:"required"`
  14. }
  16. func main() {
  17. 	r := gin.Default()
  19. 	r.POST("/product", func(c *gin.Context) {
  20. 		data := &ProductCreate{}
  21. 		header := &Header{}
  23. 		// bind the headers to data
  24. 		if err := c.ShouldBindHeader(header); err != nil {
  25. 			c.JSON(400, err.Error())
  26. 			return
  27. 		}
  29. 		// bind the body to data
  30. 		if err := c.ShouldBindJSON(data); err != nil {
  31. 			c.JSON(400, err.Error())
  32. 			return
  33. 		}
  35. 		c.JSON(200, data)
  36. 	})
  38. 	r.Run(":8080")
  39. }

huangapple
  • 本文由 发表于 2022年7月22日 15:13:33
  • 转载请务必保留本文链接：https://go.coder-hub.com/73076450.html
  • go
  • go-gin
  • http
  • validation
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定