问题引入

当某个struct存在某个字段为string或者[]byte类型但是实际上保存的内容是json格式的数据时，对其进行json序列化，比如

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
type Message struct {
	From string     `json:"from"`
	To   string     `json:"to"`
	Data string `json:"data"`
}

func main() {
	msg := Message{
		From: "XiaoMing",
		To:   "LiGang",
		Data: `{"title":"test","body":"something"}`,
	}
	jsonData, err := json.Marshal(msg)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(jsonData))
}

在上面的例子中，Data字段是string类型，但是保存的内容是json格式的数据，这个时候，程序输出：

1
{"from":"XiaoMing","to":"LiGang","data":"{\"title\":\"test\",\"body\":\"something\"}"}

可以看到，序列化之后的data是一个字符串。
如果Message对应的是数据库中的一张表，而data字段在数据库中是json类型，当我们需要一个接口，查询Message表中的记录返回给客户端。如果直接执行序列化，那么客户端获取到的Data实际上是一个字符串，客户端还需要自行对这个字符串进行json反序列化。

这时候我们就会想，有没有什么办法能够在服务端序列化Message时，将data字段序列化成json对象而不是字符串呢？

自定义序列化

因为data字段的值本身就是json类型，为什么不能在序列化时直接使用呢？
查看json包的官方文档，我们可以发现关于 自定义序列化的例子
当执行json序列化时，如果对应的类型实现了Marshaler接口：

1
2
3
type Marshaler interface {
	MarshalJSON() ([]byte, error)
}

那么就会执行其MarshalJSON方法，并将返回的字节数组作为该值的序列化值。
那么回到上面的例子，我们就很容易实现目标：

1
2
3
4
5
6
7
8
9
10
11
12
type JsonString string

func (j JsonString) MarshalJSON() ([]byte, error) {
	fmt.Println("marshal...")
	return []byte(j), nil
}

type Message struct {
	From string     `json:"from"`
	To   string     `json:"to"`
	Data JsonString `json:"data"`
}

在上面的代码中基于string类型声明了JsonString，代表json格式的字符串，并实现了Marshaler接口。因为JsonString代表的就是json字符串，直接将其转换成字节数组返回。
然后将Message中的Data字段换成JsonString类型。
再次执行程序，可以看到：

1
{"from":"XiaoMing","to":"LiGang","data":{"title":"test","body":"something"}}

Perfect!