在Go语言开发中,将JSON数据反序列化为结构体是常见操作。但标准库encoding/json在解析时,如果JSON里缺少某个字段,对应结构体字段只会保持零值,不会报错。这就导致我们无法区分字段是故意传了零值,还是根本没有传。为了实现字段必填校验,需要在解析过程中显式判断字段是否存在。
为什么默认反序列化无法校验必填
Go的json.Unmarshal会按照字段名匹配JSON键,缺失的键不会触发任何错误。例如下面的结构体,Name字段即使不传,也只会是空字符串:
type User struct {
Name string
Age int
}
如果业务要求Name必须存在且非空,仅靠上述定义无法在反序列化时发现请求漏传了Name。
使用指针类型配合二次检查
把字段定义为指针类型,缺失时指针为nil,从而和零值区分开。解析后再统一检查:
package main
import (
"encoding/json"
"errors"
"fmt"
)
type User struct {
Name *string
Age *int
}
func (u *User) Validate() error {
if u.Name == nil || *u.Name == "" {
return errors.New("Name为必填字段")
}
if u.Age == nil {
return errors.New("Age为必填字段")
}
return nil
}
func main() {
data := []byte(`{"Age":20}`)
var u User
if err := json.Unmarshal(data, &u); err != nil {
fmt.Println("解析失败:", err)
return
}
if err := u.Validate(); err != nil {
fmt.Println("校验失败:", err)
return
}
fmt.Println("通过校验")
}
自定义UnmarshalJSON方法
也可以在结构体上实现UnmarshalJSON,在解析时直接校验必填字段:
package main
import (
"encoding/json"
"errors"
"fmt"
)
type User struct {
Name string
Age int
}
func (u *User) UnmarshalJSON(b []byte) error {
type tmp User
aux := &struct {
Name *string `json:"Name"`
Age *int `json:"Age"`
*tmp
}{
tmp: (*tmp)(u),
}
if err := json.Unmarshal(b, &aux); err != nil {
return err
}
if aux.Name == nil || *aux.Name == "" {
return errors.New("Name为必填字段")
}
if aux.Age == nil {
return errors.New("Age为必填字段")
}
return nil
}
func main() {
data := []byte(`{"Name":"Tom"}`)
var u User
if err := json.Unmarshal(data, &u); err != nil {
fmt.Println("错误:", err)
return
}
fmt.Println("用户:", u)
}
使用第三方校验库
如果项目里有很多结构体需要校验,可以使用如go-playground/validator这类库,通过标签声明必填规则:
package main
import (
"fmt"
"github.com/go-playground/validator/v10"
)
type User struct {
Name string `json:"Name" validate:"required"`
Age int `json:"Age" validate:"required"`
}
func main() {
v := validator.New()
u := User{Name: ""}
if err := v.Struct(u); err != nil {
fmt.Println("校验错误:", err)
return
}
fmt.Println("通过")
}
总结对比
| 方式 | 优点 | 缺点 |
|---|---|---|
| 指针加检查 | 不依赖外部库,逻辑直观 | 每个结构体要写检查代码 |
| 自定义UnmarshalJSON | 解析即校验,集中处理 | 代码稍复杂,需小心循环调用 |
| 第三方库 | 规则声明简单,功能丰富 | 引入额外依赖 |
根据实际项目规模和团队习惯,选择合适的字段必填校验方案,可以让Go语言的JSON反序列化更可靠。