go语言的`encoding/json`包原生不支持通过tag标记json字段为“必填”。本文将探讨如何在go中实现json反序列化时的必填字段校验，主要通过利用指针类型在反序列化后进行检查，从而区分字段缺失、值为`null`或零值的情况。这种方法提供了一种简洁有效的机制来确保所需字段的存在，避免因数据不完整导致的应用逻辑错误。
在Go语言中处理JSON数据时，encoding/json标准库提供了强大的序列化（Marshal）和反序列化（Unmarshal）功能。然而，该库并没有内置机制来直接标记结构体字段为“必填”（required），这意味着如果JSON输入中缺少某个字段，Unmarshal操作通常会将其对应结构体字段初始化为该类型的零值，而不会抛出错误。这在需要严格验证输入数据完整性的场景下，可能会导致业务逻辑错误。
必填字段校验的策略
为了解决这一问题，Go开发者通常采用两种主要策略：
- 自定义 UnmarshalJSON() 方法： 为结构体实现 json.Unmarshaler 接口，在 UnmarshalJSON() 方法中手动解析JSON数据并进行字段存在性检查。这种方法提供了最大的灵活性，但实现起来相对复杂。
- 反序列化后使用指针进行检查： 这是更常用且相对简单的策略。通过将结构体字段定义为指针类型，encoding/json 包在反序列化时会根据字段是否存在来决定是否为指针分配内存并赋值。如果字段缺失，指针将保持为 nil，从而可以进行后续检查。
本文将重点介绍第二种方法，因为它对于大多数必填字段校验场景来说，既简单又高效。
使用指针进行必填字段校验
当结构体字段被定义为指针类型时，例如 *string 或 *float64，json.Unmarshal 的行为会发生变化：
立即学习“go语言免费学习笔记（深入）”；
- 如果JSON输入中存在该字段且其值为非null，Unmarshal 会为指针分配内存，并将值存储在指向的内存地址中。
- 如果JSON输入中存在该字段但其值为null（例如 "field": null），Unmarshal 会将指针设置为 nil。
- 如果JSON输入中完全缺失该字段，Unmarshal 也会将指针设置为 nil。
利用这一特性，我们可以在 Unmarshal 操作完成后，通过检查指针是否为 nil 来判断字段是否缺失或为 null。
示例代码
考虑一个场景，我们期望JSON输入中必须包含 String 和 Number 两个字段。我们可以将结构体定义如下：
package main
import (
"encoding/json"
"fmt"
)
// JsonStruct 定义了用于JSON反序列化的结构体
// 字段使用指针类型，以便区分缺失、null和零值
type JsonStruct struct {
String *string `json:"string"`
Number *float64 `json:"number"`
}
func main() {
// 示例1: 缺少 Number 字段的JSON
rawJsonMissingNumber := []byte(`{
"string":"这是一个字符串"
}`)
fmt.Println("--- 示例1: 缺少 'number' 字段 ---")
var s1 JsonStruct
err := json.Unmarshal(rawJsonMissingNumber, &s1)
if err != nil {
fmt.Printf("反序列化错误: %v\n", err)
return
}
// 检查必填字段
if s1.String == nil {
fmt.Println("错误: 'string' 字段缺失或为null!")
} else {
fmt.Printf("String: %s\n", *s1.String)
}
if s1.Number == nil {
fmt.Println("错误: 'number' 字段缺失或为null!")
// 实际应用中，这里可以抛出错误或返回校验失败
} else {
fmt.Printf("Number: %f\n", *s1.Number)
}
fmt.Println("\n--- 示例2: 所有字段都存在的JSON ---")
// 示例2: 所有字段都存在的JSON
rawJsonComplete := []byte(`{
"string":"另一个字符串",
"number":123.45
}`)
var s2 JsonStruct
err = json.Unmarshal(rawJsonComplete, &s2)
if err != nil {
fmt.Printf("反序列化错误: %v\n", err)
return
}
// 检查必填字段
if s2.String == nil {
fmt.Println("错误: 'string' 字段缺失或为null!")
} else {
fmt.Printf("String: %s\n", *s2.String)
}
if s2.Number == nil {
fmt.Println("错误: 'number' 字段缺失或为null!")
} else {
fmt.Printf("Number: %f\n", *s2.Number)
}
fmt.Println("\n--- 示例3: 字段值为 null 的JSON ---")
// 示例3: 字段值为 null 的JSON
rawJsonNullField := []byte(`{
"string": null,
"number": 99.99
}`)
var s3 JsonStruct
err = json.Unmarshal(rawJsonNullField, &s3)
if err != nil {
fmt.Printf("反序列化错误: %v\n", err)
return
}
if s3.String == nil {
fmt.Println("错误: 'string' 字段缺失或为null!") // 这里会触发
} else {
fmt.Printf("String: %s\n", *s3.String)
}
if s3.Number == nil {
fmt.Println("错误: 'number' 字段缺失或为null!")
} else {
fmt.Printf("Number: %f\n", *s3.Number)
}
}代码解析：
- 结构体定义： JsonStruct 中的 String 和 Number 字段都被定义为指针类型 (*string, *float64)。
- 反序列化： json.Unmarshal(rawJson, &s) 尝试将JSON字节切片反序列化到 s 结构体实例中。
- 后置校验： 在反序列化成功后，通过 if s.String == nil 和 if s.Number == nil 来检查对应的字段是否为 nil。如果为 nil，则说明该字段在原始JSON中缺失或其值为 null，此时可以根据业务需求抛出错误或执行其他逻辑。
- 值访问： 如果指针不为 nil，则可以通过解引用 (*s.String, *s.Number) 来获取实际的值。
注意事项与进阶
- 区分缺失与 null： 使用指针的方法无法直接区分字段缺失和字段值为 null 的情况，因为两者都会导致指针为 nil。对于大多数必填校验场景，这种区分并不重要，因为 null 值通常也不被接受为有效数据。如果确实需要区分，则必须使用自定义的 UnmarshalJSON 方法，通过 json.RawMessage 配合 json.Decoder 来逐个字段检查。
- 性能考量： 对于非常大的JSON数据和频繁的反序列化操作，使用大量指针可能会带来轻微的内存开销和GC压力。但对于常规应用，这种影响通常可以忽略不计。
- 嵌套结构体： 这种方法同样适用于嵌套结构体。如果一个嵌套结构体本身是必填的，也可以将其定义为指针类型（例如 *NestedStruct），然后检查其是否为 nil。
- 错误处理： 在实际应用中，遇到必填字段缺失或为 null 的情况，应该返回一个明确的错误信息，而不是简单地 panic，以便上层调用者能够优雅地处理。
总结
尽管Go的 encoding/json 包没有直接的“必填”字段tag，但通过巧妙地利用指针类型，我们可以在反序列化后轻松实现对必填字段的校验。这种方法简洁、易于理解和实现，是Go语言中处理JSON数据完整性校验的常用且推荐实践。对于更复杂的校验逻辑或对性能有极致要求的场景，可以考虑实现自定义的 UnmarshalJSON 方法。
