理解net.IP的默认JSON序列化行为
在go语言中，encoding/json包提供了方便的json序列化（marshal）和反序列化（unmarshal）功能。然而，对于某些标准库类型，如net.ip，其默认的序列化行为可能不符合预期。net.ip本质上是一个[]byte切片，当直接对其进行json序列化时，json.marshal会将其处理为字节数组的json表示，例如[127,0,0,1]，而非我们通常期望的ip地址字符串"127.0.0.1"。
例如，考虑以下结构体：
package main
import (
"encoding/json"
"fmt"
"net"
)
type IPFilePair struct {
IP net.IP
FileName string
}
func main() {
pair := IPFilePair{IP: net.ParseIP("127.0.0.1"), FileName: "example.txt"}
b, _ := json.Marshal(pair)
fmt.Println(string(b))
}其输出会是：
{"IP":[127,0,0,1],"FileName":"example.txt"}这显然不是我们希望的{"IP":"127.0.0.1","FileName":"example.txt"}。为了解决这个问题，我们需要自定义net.IP类型的JSON序列化行为。
自定义net.IP的JSON序列化
Go语言提供了json.Marshaler接口，允许我们为自定义类型（或类型别名）实现MarshalJSON方法，从而精确控制该类型在JSON序列化时的输出格式。
立即学习“go语言免费学习笔记（深入）”；
json.Marshaler接口定义如下：
type Marshaler interface {
MarshalJSON() ([]byte, error)
}要将net.IP序列化为字符串，我们可以创建一个net.IP的类型别名，并为这个别名实现MarshalJSON方法。
步骤一：定义net.IP的类型别名
首先，创建一个net.IP的类型别名。这样做是为了避免与net.IP的原始方法冲突，并允许我们为这个别名添加自定义方法。
type netIP net.IP
步骤二：实现MarshalJSON方法
为netIP类型别名实现MarshalJSON方法。在这个方法中，我们将netIP转换为其底层的net.IP类型，然后调用其String()方法获取IP地址的字符串表示，最后使用json.Marshal将这个字符串序列化为JSON字节数组。
func (ip netIP) MarshalJSON() ([]byte, error) {
// 将类型别名转换回 net.IP，然后调用其 String() 方法获取字符串表示
// 接着使用 json.Marshal 将这个字符串序列化
return json.Marshal(net.IP(ip).String())
}步骤三：在结构体中使用类型别名
在需要使用net.IP的结构体中，将字段类型从net.IP更改为我们定义的netIP类型别名。
type IPFilePair struct {
IP netIP // 使用自定义的 netIP 类型
FileName string
}
type IPFilePairs []*IPFilePair // 如果需要序列化结构体切片完整示例代码
将上述步骤整合，一个完整的解决方案如下：
package main
import (
"encoding/json"
"fmt"
"net"
)
// 定义 net.IP 的类型别名
type netIP net.IP
// 为 netIP 实现 MarshalJSON 方法
func (ip netIP) MarshalJSON() ([]byte, error) {
// 将 netIP 转换回 net.IP 类型，调用其 String() 方法获取字符串
// 然后将该字符串序列化为 JSON 字节数组
return json.Marshal(net.IP(ip).String())
}
// 包含 netIP 字段的结构体
type IPFilePair struct {
IP netIP
FileName string
}
// 结构体切片类型
type IPFilePairs []*IPFilePair
func main() {
// 创建 IPFilePair 实例，注意 IP 字段需要转换为 netIP 类型
pair1 := IPFilePair{IP: netIP(net.ParseIP("127.0.0.1")), FileName: "file1.txt"}
pair2 := IPFilePair{IP: netIP(net.ParseIP("192.168.1.100")), FileName: "file2.log"}
// 将多个 IPFilePair 实例放入切片中
sampleIPFilePairs := IPFilePairs{&pair1, &pair2}
// 序列化结构体切片
b, err := json.Marshal(sampleIPFilePairs)
if err != nil {
fmt.Println("Error marshaling:", err)
return
}
fmt.Println(string(b))
// 序列化单个结构体
bSingle, err := json.Marshal(pair1)
if err != nil {
fmt.Println("Error marshaling single:", err)
return
}
fmt.Println(string(bSingle))
}运行上述代码，将得到期望的JSON输出：
[{"IP":"127.0.0.1","FileName":"file1.txt"},{"IP":"192.168.1.100","FileName":"file2.log"}]
{"IP":"127.0.0.1","FileName":"file1.txt"}反序列化（UnmarshalJSON）的考虑
如果将来需要将上述JSON数据反序列化回Go结构体，同样需要为netIP类型实现json.Unmarshaler接口，即UnmarshalJSON方法。
json.Unmarshaler接口定义如下：
type Unmarshaler interface {
UnmarshalJSON([]byte) error
}为netIP实现UnmarshalJSON方法，通常会解析输入的JSON字符串，然后使用net.ParseIP将其转换为net.IP类型。
// 为 netIP 实现 UnmarshalJSON 方法
func (ip *netIP) UnmarshalJSON(b []byte) error {
var s string
if err := json.Unmarshal(b, &s); err != nil {
return err
}
parsedIP := net.ParseIP(s)
if parsedIP == nil {
return fmt.Errorf("invalid IP address string: %s", s)
}
*ip = netIP(parsedIP) // 将解析后的 IP 赋值给 *ip
return nil
}通过同时实现MarshalJSON和UnmarshalJSON，可以确保net.IP类型在JSON序列化和反序列化过程中都保持一致且符合预期的字符串格式。
总结
通过为net.IP类型创建别名并实现json.Marshaler接口的MarshalJSON方法，我们可以灵活地控制net.IP在JSON输出中的格式，将其从默认的字节数组表示转换为标准的IP地址字符串。这不仅提高了JSON数据的可读性，也增强了与其他系统交互时的兼容性。同时，为了实现完整的双向转换，建议也实现json.Unmarshaler接口的UnmarshalJSON方法。这种模式在处理Go标准库中那些默认JSON行为不符合业务需求的类型时非常有用。
