Golang，Gin框架使用ShouldBindJSON时出现EOF报错

前言

做毕设ing，使用的是Gin框架做的一个简单的管理系统。但偶尔也会碰到一些稀奇古怪的Bug，因此记录一下。

问题描述

api是这样写的

func UserRegisterHandler(c *gin.Context, user *usecase.UserOperate) {

	if err := c.ShouldBindJSON(&UserRegisterRequest); err != nil {
		log.Error("eeeeeeeeeee", err)
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

	userID, err := user.Register(c, UserRegisterRequest.Username, UserRegisterRequest.Password, UserRegisterRequest.Phone)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

	c.JSON(http.StatusOK, gin.H{"userID": userID})
}

其中结构体定义为

var UserRegisterRequest struct {
	Username string `json:"username"`
	Password string `json:"password"`
	Phone    string `json:"phone"`
}

Postman请求会报错EOF，确定是在ShouldBindJSON的地方出现了错误。

问题解决

先是发现自己忘记了加required标签…
修改后：

type UserRegisterRequest struct {
	Username string `json:"username" binding:"required"`
	Password string `json:"password" binding:"required"`
	Phone    string `json:"phone" binding:"required"`
}

同时换成了更简单的ShouldBind。发现报错改为：

Key: 'UserRegisterRequest.Password' Error:Field validation for 'Password' failed on the 'required' tag

遂搜索，参考https://blog.youkuaiyun.com/default7/article/details/114920194

发现是自己忘记了定义form…
修改后最终为：

type UserRegisterRequest struct {
	Username string ` form:"username" json:"username" binding:"required"`
	Password string `form:"password" json:"password" binding:"required"`
	Phone    string `form:"phone" json:"phone" binding:"required"`
}

func UserRegisterHandler(c *gin.Context, user *usecase.UserOperate) {
	var userRegisterRequest UserRegisterRequest

	if err := c.ShouldBind(&userRegisterRequest); err == nil {
		c.JSON(http.StatusOK, gin.H{
			"user":     userRegisterRequest.Username,
			"password": userRegisterRequest.Password,
			"phone":    userRegisterRequest.Phone,
		})
	} else {
		log.Error("绑定JSON错误", err)
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

	userID, err := user.Register(c, userRegisterRequest.Username, userRegisterRequest.Password, userRegisterRequest.Phone)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

	c.JSON(http.StatusOK, gin.H{"userID": userID})
}

成功！

总结反思

定义时候注意细节…Go的反引号标签要用好。