golang 中 json.Marshal 你不知道的转换规则

一、json.Marshal 原理分析

json.Marshal 源码分析参考
json.Marshal参考

// 将一个对象编码成JSON数据,接受一个interface{}对象,返回[]byte和error:
func Marshal(v interface{}) ([]byte, error)

// 将json []byte类型 解码到相应的数据结构
func Unmarshal(data []byte, v interface{}) error

结构体必须是大写字母开头的成员才会被JSON处理到,小写字母开头的成员不会有影响。

  1. Mashal时,结构体的成员变量名将会直接作为JSON Object的key打包成JSON;Unmashal时,会自动匹配对应的变量名进行赋值,大小写不敏感。

  2. Unmarshal时,如果JSON中有多余的字段,会被直接抛弃掉;如果JSON缺少某个字段,则直接忽略不对结构体中变量赋值,不会报错。

Marshal函数将会递归遍历整个对象,依次按成员类型对这个对象进行编码。
类型转换规则如下:

bool类型:转换为JSON的Boolean
整数、浮点数等数值类型: 转换为JSON的Number
string类型: 转换为JSON的字符串(带""引号)
struct类型:转换为JSON的Object,再根据各个成员的类型递归打包
数组或切片类型: 转换为JSON的Array
[]byte类型: 会先进行base64编码然后转换为JSON字符串
map类型:转换为JSON的Object,key必须是string
interface{}类型: 按照内部的实际类型进行转换
nil类型: 转为JSON的null
channel,func等类型: 会返回UnsupportedTypeError

  1. 从golang到json:
golang json
bool Boolean
int、float等数字 Number
string String
[]byte(base64编码) String
struct Object,再递归打包
array/slice Array
map Object
interface{} 按实际类型转换
nil null
channel,func UnsupportedTypeError
  1. 从json到golang:
json golang
Boolean bool
Number float64
String string
Array []interface{}
Object map[string]interface{}
null nil

go类型:
golang 中 json.Marshal 你不知道的转换规则_第1张图片

example:
如果希望手动配置结构体的成员和JSON字段的对应关系,可以在定义结构体的时候给成员打标签:

使用omitempty熟悉,如果该字段为nil或0值(数字0,字符串"",空数组[]等),则打包的JSON结果不会有这个字段。

type Message struct {  
    Name string `json:"msg_name"`       // 对应JSON的msg_name  
    Body string `json:"body,omitempty"` // 如果为空置则忽略字段  
    Time int64  `json:"-"`              // 直接忽略字段  
}  
var m = Message{  
    Name: "Alice",  
    Body: "",  
    Time: 1294706395881547000,  
}  
data, err := json.Marshal(m)  
if err != nil {  
    fmt.Printf(err.Error())  
    return  
}  
fmt.Println(string(data))  

Output:

{"msg_name":"Alice"}  

二、避坑

json.marshal使用不当,会存在base64编码问题
问题出现在:[]byte 在json.marshal时会进行base64 encoding处理

解决办法:使用json.RawMessage
json.RawMessage其实就是[]byte类型的重定义。可以进行强制类型转换。

现在有这么一种场景,结构体中的其中一个字段的格式是未知的:

type Command struct {  
    ID   int  
    Cmd  string  
    Args *json.RawMessage  
}  

使用json.RawMessage的话,Args字段在Unmarshal时不会被解析,直接将字节数据赋值给Args。我们可以能先解包第一层的JSON数据,然后根据Cmd的值,再确定Args的具体类型进行第二次Unmarshal。

注意:一定要使用指针类型*json.RawMessage,否则在Args会被认为是[]byte类型,在打包时会被打包成base64编码的字符串。

使用interface{}, interface{}类型在Unmarshal时,会自动将JSON转换为对应的数据类型:

JSON的boolean: 转换为bool
JSON的数值: 转换为float64
JSON的字符串: 转换为string
JSON的Array: 转换为[]interface{}
JSON的Object: 转换为map[string]interface{}
JSON的null: 转换为nil

需要注意的有两个:

  1. 一是所有的JSON数值自动转换为float64类型,使用时需要再手动转换为需要的int,int64等类型。
  2. 二是JSON的object自动转换为map[string]interface{}类型,访问时直接用JSON Object的字段名作为key进行访问。在不知道JSON数据的格式时,可以使用interface{}。

自定义类型:
如果希望自己定义对象的打包解包方式,可以实现以下的接口:

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

实现该接口的对象需要将自己的数据打包和解包。如果实现了该接口,json在打包解包时则会调用自定义的方法,不再对该对象进行其他处理。

你可能感兴趣的:(json,golang,开发语言)