go语言中json解析函数Unmarshaler和Marshaler的使用示例代码

go给我们提供了Unmarshaler和Marshaler接口来帮我们自定义序列化和反序列化的操作。

下面我们来看看如果使用这两个接口。

Unmarshaler接口

能够在json反序列化的时候，对字段进行自定义操作，如更改数据类型、验证或修改数据等。

下面我们来实现一个json解析时对用户手机号验证的例子：

先创建一个实现了Unmarshaler 接口的类型 Phone

在 UnmarshalJSON 中进行数据验证。

// Phone 实现Unmarshaler接口
type Phone string

// UnmarshalJSON 实现Unmarshaler接口
// 此处需要注意的是：如果要修改值，需要通过指针来实现接口
func (p *Phone) UnmarshalJSON(b []byte) error {
	var t string
	// 此处使用json.Unmarshal解析b
	// 为啥？
	// 因为如果字段为string类型，此处将会是一个带引号的字符串
	// 如果字段为object，则此处是一个可以解析的json
	// 这里我们指定类型为string
	err := json.Unmarshal(b, &t)
	if err != nil {
		return err
	}
	// 手机号正则验证
	matched, _ := regexp.MatchString(`^(13[0-9]|14[01456879]|15[0-35-9]|16[2567]|17[0-8]|18[0-9]|19[0-35-9])\d{8}$`, t)
	if matched {
		return nil
	}

	return errors.New("invalid phone number")
}

// User 定义一个结构体
type User struct {
	ID    int    `json:"id"`
	Name  string `json:"name"`
	Phone Phone  `json:"phone"`
}

func main() {
	j := `{"id":1,"name":"张三","phone":"18500000000"}`
	var u User
	err := json.Unmarshal([]byte(j), &u)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(u)
}

//{1 张三 18500000000}
// 如果修改错误的手机号，就会打印出err信息

至此，我们实现了一个简单（但是没用）的手机号验证功能，

在这里同样能够进行数据类型修改，比如将string类型的日期转换为time.Time。

Marshaler接口

可以用来自定义序列化时候的操作，比如在对time.Time 进行序列化时，生成指定的格式。

使用上面的User结构体，在用户序列化的时候，给手机号加上国家代码。

// Phone 实现Marshaler接口
type Phone string

// MarshalJSON 实现Marshaler接口
// 接口实现的时候要与使用到的数据类型保持一致，否则代码在判断接口实现的时候，会是false
func (p Phone) MarshalJSON() ([]byte, error) {
	// 由于Marshal之后，phone为字符串，因此要加上双引号
	// 如果不加引号则会导致序列化失败。
	b := []byte("\"+86 ") // 开头加上引号
	b = append(b, []byte(p)...)
	b = append(b, '"') // 末尾机上引号
	return b, nil
}

func main() {
	phone := Phone("18500000000")
	u := User{
		ID:    1,
		Name:  "张三",
		Phone: phone,
	}
	b, err := json.Marshal(u)

	if err != nil {
		fmt.Println(err)
		return
	}

	fmt.Println(string(b))
}

输出结果：

// 运行结果：
// {"id":1,"name":"张三","phone":"+86 18500000000"}

至此，利用Unmarshaler 接口成功对手机号进行了国家代码处理。

总结

在json序列化中，通过实现Unmarshaler 和Marshaler 能够对序列化和反序列化进行自定义。

一些值得注意的点：

a . 一般在实现Marshaler 接口时，采用值类型来时间，如 time.Timer 的实现：

// MarshalJSON implements the json.Marshaler interface.
// The time is a quoted string in RFC 3339 format, with sub-second precision added if present.
func (t Time) MarshalJSON() ([]byte, error) {
	if y := t.Year(); y < 0 || y >= 10000 {
		// RFC 3339 is clear that years are 4 digits exactly.
		// See golang.org/issue/4556#c15 for more discussion.
		return nil, errors.New("Time.MarshalJSON: year outside of range [0,9999]")
	}

	b := make([]byte, 0, len(RFC3339Nano)+2)
	b = append(b, '"')
	b = t.AppendFormat(b, RFC3339Nano)
	b = append(b, '"')
	return b, nil
}

如果此处用指针来实现，则序列化的数据类型也必须使用指针，使用值类型来实现的时候，序列化数据类型可以为值也可以为指针。

b . 实现 Unmarshaler 接口时，需要采用指针来实现该接口，这样修改数据的时候才能起作用。反之，如果使用值类型来实现，则不能实现修改数据的效果。

c . UnmarshalJSON 传入的[]byte 数据，如果是字符串，则是带引号的；如果是null，则是一个字符串的null。

d . MarshalJSON 需要将输入null 时，不是返回nil, 而是返回[]byte("null")