Go语言之反射（三）

结构体转JSON

JSON格式是一种用途广泛的对象文本格式。在Go语言中，结构体可以通过系统提供的json.Marshal()函数进行序列化。为了演示怎么样通过反射获取结构体成员以及各种值的过程，下面使用反射将结构体序列化为文本数据。

1.数据结构及入口函数

将结构体序列化为JSON的步骤如下：

1. 准备数据结构体。
2. 准备要序列化的结构体数据。
3. 调用序列化函数

参见下面的代码。序列化JSON主流程：

func main() {

	// 声明技能结构
	type Skill struct {
		Name  string
		Level int
	}

	// 声明角色结构
	type Actor struct {
		Name string
		Age  int

		Skills []Skill
	}

	// 填充基本角色数据
	a := Actor{
		Name: "cow boy",
		Age:  37,

		Skills: []Skill{
			{Name: "Roll and roll", Level: 1},
			{Name: "Flash your dog eye", Level: 2},
			{Name: "Time to have Lunch", Level: 3},
		},
	}

	if result, err := MarshalJson(a); err == nil {
		fmt.Println(result)
	} else {
		fmt.Println(err)
	}
}

　　

• 第4~15行声明了一些结构体，用于描述一个角色的信息。
• 第18~27行，实例化了Actor结构体，并且填充了一些基本的角色数据。
• 第29行，调用自己实现的MarshalJson()函数，将Actor实例化的数据转换为JSON字符串。
• 第30行，如果操作成功将打印出数据。
• 第32行，如果操作有错误将打印错误。

完成代码输出如下：

{"Name":"cow boy","Age":37,"Skills":[{"Name":"Roll and roll","Level":1},{"Name":"Flash your dog eye","Level":2},{"Name":"Time to have Lunch","Level":3}]}

　　

2.序列化主函数

MarshalJson()是序列化过程的主要函数入口，通过这个函数会调用不同类型的子序列化函数。MarshalJson()函数传入一个interface{}的数据，并将这个数据转换为JSON字符串返回，如果发生错误，则返回错误信息。

序列化JSON主函数：

// 给外部使用序列化值为JSON的接口
func MarshalJson(v interface{}) (string, error) {
	// 准备一个缓冲
	var b bytes.Buffer

	// 将任意值转换为json并输出到缓冲
	if err := writeAny(&b, reflect.ValueOf(v)); err == nil {
		return b.String(), nil
	} else {
		return "", err
	}
}

　　

代码说明如下：

• 第4行，使用bytes.Buffer构建一个缓冲，这个对象类似于其他语言中的StringBuilder，在大量字符串连接时，推荐使用这个结构。
• 第7行，调用writeAny函数，将bytes.Buffer以指针的方式传入，以方便将各种类型的数据都写入这个bytes.Buffer中。同时，将v转换为反射值对象并传入。
• 第8行，如果没有错误发生时，将bytes.Buffer的内容转换为字符串并返回。
• 第10行，发生错误时，返回空字符串结果和错误。

MarshalJson()这个函数其实是对writeAny()函数的一个封装，将外部的interface{}类型转换为内部的reflect.Value类型，同时构建输出缓冲，将一些复杂的操作简化，方便外部使用。

3.任意值序列化

writeAny()函数传入一个字节缓冲和反射值对象，将反射值对象转换为JSON格式并写入字节缓冲中。参见下面的代码：

任意值序列化：

// 将任意值转换为json并输出到缓冲
func writeAny(buff *bytes.Buffer, value reflect.Value) error {

	switch value.Kind() {
	case reflect.String:
		// 写入带有双引号括起来的字符串
		buff.WriteString(strconv.Quote(value.String()))
	case reflect.Int:
		// 将整形转换为字符串并写入缓冲
		buff.WriteString(strconv.FormatInt(value.Int(), 10))
	case reflect.Slice:
		return writeSlice(buff, value)
	case reflect.Struct:
		return writeStruct(buff, value)
	default:
		// 遇到不认识的种类，返回错误
		return errors.New("unsupport kind: " + value.Kind().String())
	}

	return nil
}

　　

代码说明如下：

• 第4行，根据传入反射值对象的种类进行判断，如字符串、整型、切片及结构体。
• 第7行，当传入值为字符串种类时，使用reflect.Value的String函数将传入值转换为字符串，再将字符串用双引号括起来，strconv.Quote()函数提供了比较正规的封装。最终使用bytes.Buffer的WriteString()函数，将前面输出的字符串写入缓冲中。
• 第10行，当传入值为整型时，使用reflect.Value的Int()函数，将传入值转换为整型，再将整型以十进制格式使用strconv.FormatInt()函数格式化为字符串，最后写入缓冲。
• 第11行，使用writeSlice()函数把切片序列化为JSON操作。
• 第14行，使用writeStruct()函数把切片序列化为JSON操作。
• 第17行，遇到不能识别的类型，函数返回错误。

writeAny()函数是整个序列化中非常重要的环节，可以通过扩充switch中的种类扩充序列化能识别的类型。

4.切片序列化

writeAny()函数中会调用writeSlice()函数将切片类型转换为JSON格式的字符串并将数据写入缓冲中。参见下面的代码。

切片序列化：

// 将切片转换为json并输出到缓冲
func writeSlice(buff *bytes.Buffer, value reflect.Value) error {

	// 写入切片开始标记
	buff.WriteString("[")

	// 遍历每个切片元素
	for s := 0; s < value.Len(); s++ {
		sliceValue := value.Index(s)

		// 写入每个切片元素
		writeAny(buff, sliceValue)

		// 写入每个元素尾部逗号，最后一个字段不添加
		if s < value.Len()-1 {
			buff.WriteString(",")
		}
	}

	// 写入切片结束标记
	buff.WriteString("]")

	return nil
}

　　

代码说明如下：

• 第5行和第21行分别写入JSON数组的开始标识“[”和结束标识“]”。
• 第8行和第9行，使用reflect.Value的Len()方法和Index()方法遍历切片的所有元素。Len()方法返回切片的长度，Index()方法根据给定的索引找到对应的索引。
• 第12行，通过reflect.Value类型的Index方法获得reflect.Value类型的sliceValue，再将sliceValue传入writeAny()函数并继续对这个值进行递归序列化。
• 第15~17行，JSON格式规定：每个数组成员由逗号分隔且最后一个元素后不加号，这里就是遵守这个规定。

由于writeAny的功能较为完善，因此序列化切片只需要添加头尾标识符及元素分隔符就可以了。

5.结构体序列化

在JSON格式中，切片是一系列值的序列，以方括号开头和结尾；结构体由键值对组成，以大括号开始和结束。两种结构的元素均以逗号分隔。序列化结构体的过程参见下面的代码。

结构体序列化：

// 将结构体序列化为json并输出到缓冲
func writeStruct(buff *bytes.Buffer, value reflect.Value) error {

	// 取值的类型对象
	valueType := value.Type()

	// 写入结构体左大括号
	buff.WriteString("{")

	// 遍历结构体的所有值
	for i := 0; i < value.NumField(); i++ {

		// 获取每个字段的字段值(reflect.Value)
		fieldValue := value.Field(i)

		// 获取每个字段的类型(reflect.StructField)
		fieldType := valueType.Field(i)

		// 写入字段名左双引号
		buff.WriteString("\"")

		// 写入字段名
		buff.WriteString(fieldType.Name)

		// 写入字段名右双引号和冒号
		buff.WriteString("\":")

		// 写入每个字段值
		writeAny(buff, fieldValue)

		// 写入每个字段尾部逗号，最后一个字段不添加
		if i < value.NumField()-1 {
			buff.WriteString(",")
		}
	}

	// 写入结构体右大括号
	buff.WriteString("}")

	return nil
}

　　

代码说明如下：

• 第5行，遍历结构体获取值时，习惯性取出反射类型对象。
• 第8行和第38行，分别写入结构体开头和结尾的标识符。
• 第11行，根据reflect.Value的NumField()方法遍历结构体的成员值。
• 第14行，获取每一个结构体成员的反射值对象。
• 第17行，获取每一个结构体成员的反射类型对象，类型信息必须从类型对象中获取， 反射值对象无法提供字段的类型信息，如果尝试从fieldValue.Type()中获得类型对象那么取到的是值本身的类型对象，而不是结构体成员类型信息。
• 第20行，写入字段左边的双引号，双引号本身需要使用“\”进行转义，从这里开始写入键值对。
• 第23行，根据结构体成员类型信息写入字段名。
• 第26行，写入字段名右边的双引号和冒号。
• 第29行，递归调用任意值序列化函数writeAny(),将fieldValue继续序列化。
• 第32行，和切片一样，多个结构体字段间也是以逗号分隔，最后一个字段后面不接逗号。

6.总结
上面例子只支持整型、字符串、切片和结构体类型序列化为JSON格式。如果需要扩充类型，可以在writeAny()函数中添加。程序功能和结构上还有一些不足，例如：

• 没有处理各种异常情况，切片或结构体为空时应该提前判断，否则会触发宕机。
• 可以支持结构体标签（StructTag），方便自定义JSON的键名及忽略某些字段的序列化过程，避免这些字段被序列化到JSON中。
• 支持缩进且可以自定义缩进字符，将JSON序列化后的内容格式化，方便查看。
• 默认应该序列化为[]byte字节数组，外部自己转换为字符串。在大部分的使用中，JSON—般以字节数组方式解析、存储、传输，很少以字符串方式解析，因此避免字节数组和字符串的转换可以提高一些性能。