go json序列化时指定必须存在的字段

目的

使用encoding/json包的json.Unmarshal方法的时候，指定不能为空的字段，若字段为空，Unmarshal报错。

具体使用场景

通过Unmarshal方法进行字段必须赋值的过滤，达到统一一处进行判断的效果，之后改起来方便。

前言

我们在使用encoding/json包的时候，会指定tag标签，如下：

type A struct {
	Name string `json:",omitempty"` // 若为空值，则字符串中不会包含它
	Value string `xorm:"unique" json:"required"`
}

这时，我想要设置某个字段必须赋值，不赋值的时候，json.Unmarshal报错怎么搞（required）？但是官方标准库貌似没有提供类似的tag标签。我通过实现Unmarshaler接口来进行一层封装，以达到报错的目的。

Unmarshaler接口仅提供了一个方法，实现其即可。

type Unmarshaler interface {
	UnmarshalJSON([]byte) error
}

package main

import (
	"encoding/json"
	"errors"
	"log"
	"fmt"
)

type A struct {
	Name string `json:",omitempty"` 
	Value string `xorm:"unique" json:"required"`
}
type A_Wrapper struct {
	Name string  
	Value string `xorm:"unique" json:"required"`
}
func (a *A) UnmarshalJSON(data []byte) error {
	w := new(A_Wrapper)
	if err := json.Unmarshal(data, w); err != nil {
		return err
	}
	// Name不能为空
	if w.Name == "" {
		return errors.New("Name is nil")
	}
	a.Name = w.Name
	a.Value = w.Value
	return nil
}
func main() {
	jsonStr := `{"Value":"Name is nil"}`
	a := new(A)
	err := json.Unmarshal([]byte(jsonStr), a)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%#v\n", a)
}

结语

这边简单的通过包装一层Unmarshal来实现了目的，感觉不是很好。小伙伴们若有其他好的实现方式，欢迎留言交流一下。

其他

GitHub上的validator库，有兴趣的可以了解一下 https://github.com/go-playground/validator