Golang中的自定义json序列化

后端开发人员跟前端对接接口的时候，或多或少都会面临一些沟通问题，比如说枚举字符的定义，比如有整形状态字段： state

创新互联成都网站建设按需开发，是成都网站开发公司,为石雕提供网站建设服务,有成熟的网站定制合作流程，提供网站定制设计服务：原型图制作、网站创意设计、前端HTML5制作、后台程序开发等。成都网站营销推广热线：13518219792

通常给前端的时候，前段要做的是将1，2，3以及对应的中文释义存储为key/value的形式，key与value单看都无法知道对方的语义，

比如我只知道状态值为“1”， 是无法将其与“成功”对应起来的（当然这套状态的设计者肯定是知道的），后端通常给到前端的restful api

接口定义也是key/value的形式，这乍一看其实也没啥毛病，只要有key/value也没问题，后端定义通常会是

但数字的表现形式终归是不不太明确的，如果对状态的定义换成以下形式：

基本可以理解为中英文互译了，理解起来也会更清晰一些不是，如果这么做的话，后端给到前端的响应字段状态的类型就需要修改成字符器格式

后端还是要做一层字符串到整型的转换，从目的来讲，我们只是想返给前端的 state 字段是字符串而已，也就是在做json序列化的时候将整型与字符串做一层转换，有更优雅的做法如下所示

只需要做两件事，自定义类型 MyState ，实现 MarshalJSON 方法

只要类型实现了 MarshalJSON 方法，在json序列化时就会调用此方法，如此一来，我们就轻松实现了自定义json序列化，反序列化同样如此

实现起来也很简单

需要注意的是， UnmarshalJSON 方法操作过程需要给 receiver 也就是 u 赋值，所以必须是指针类型，同样的，在实现

MarshalJSON 方法， receiver 的类型需要与结构体定义中的类型保持一致，否则自定义序列化会失败

参考：

golang反射自定义tag

维基百科中反射的定义：在计算机科学中，反射是指计算机程序在运行时（Run time）可以访问、检测和修改它本身状态或行为的一种能力。用比喻来说，反射就是程序在运行的时候能够“观察”并且修改自己的行为。

golang reflect包实现了反射。动态的获得程序运行时对象的结构和信息。

reflect 包中提供了两个基础的关于反射的函数来获取上述的接口和结构体：

func TypeOf(i interface{}) Type

func ValueOf(i interface{}) Value

大体上可以这样理解，TypeOf获取对象的类型信息，ValueOf获取对象中存储的值。

golang tag

golang中可以为结构体的字段添加tag。golang本身的encoding/json包解析json使用了tag，一些开源的orm框架如gorm，也使用了tag。tag可以方便的为结构体的字段添加一些信息，用reflect可以读取到，加以利用。

这是一个用tag标记列名以实现结构体自动生成xlsx的例子：

```

type Employee struct{

ID int `xlsx:”工号”`

Name string `xlsx:”姓名”`

Email string `xlsx:”邮箱”`

}

func Outputxlsx(es []*Employee) ([]byte, error) {

xt := reflect.TypeOf(es[0])

xv := reflect.ValueOf(es[0])

rows := [][]interface{}{}

headers := []interface{}{}

for i := 0; i xt.Elem().NumField(); i++ {

head, ok := xt.Elem().Field(i).Tag.Lookup("xlsx")

if ok {

headers = append(headers, head)

}

}

for _, e := range es {

cells := []interface{}{}

xv := reflect.ValueOf(e)

for i := 0; i xv.Elem().NumField(); i++ {

_, ok := xt.Elem().Field(i).Tag.Lookup("xlsx")

if ok {

cells = append(cells, xv.Elem().Field(i).Interface())

}

}

rows = append(rows, cells)

}

file := xlsx.NewFile()

sheet, _ := file.AddSheet("sheet1")

row := sheet.AddRow()

for _, header := range headers {

row.AddCell().Value = fmt.Sprintf("%v", header)

}

for _, v := range rows {

row := sheet.AddRow()

for _, vv := range v {

row.AddCell().Value = fmt.Sprintf("%v", vv)

}

}

var buffer bytes.Buffer

if err := file.Write(buffer); err != nil {

return nil, err

}

return buffer.Bytes(), nil

}

```

golang 遇到导入自定义包导入不进去的问题解决

当尝试了网上所有方法，仍然发现在主文件.go中或者在其他地方引用自定义包时，自动删除导入的包的情况解决如下：

如你存放地址的包在src/xxx点抗 中时请通过命令行进入这个文件夹的位置

然后执行go mod init xxx点抗 /m/v1回车

上述的.../m/v1随便，这个是按照官方的建议这么写的方便维护版本吧？！

再次尝试引入自定义包，引用方式如下：

xxx点抗 /m/v1

|_test

| |_test.go

|_main.go

import (

"fmt"

"xxx点抗 /m/v1/test"

)

献给被折磨许久的小伙伴们。。。

没有类，C语言有结构体，那么Go的结构体有什么特别之处？

Go语言中没有“类”的概念，也不支持“类”的继承等面向对象的概念。Go语言中通过结构体的内嵌再配合接口比面向对象具有更高的扩展性和灵活性。

自定义类型

在Go语言中有一些基本的数据类型，如string、整型、浮点型、布尔等数据类型， Go语言中可以使用type关键字来定义自定义类型。

自定义类型是定义了一个全新的类型。我们可以基于内置的基本类型定义，也可以通过struct定义。例如：

通过Type关键字的定义，MyInt就是一种新的类型，它具有int的特性。

类型别名

类型别名是Go1.9版本添加的新功能。

类型别名规定：TypeAlias只是Type的别名，本质上TypeAlias与Type是同一个类型。就像一个孩子小时候有小名、乳名，上学后用学名，英语老师又会给他起英文名，但这些名字都指的是他本人。

type TypeAlias = Type

我们之前见过的rune和byte就是类型别名，他们的定义如下：

类型定义和类型别名的区别

类型别名与类型定义表面上看只有一个等号的差异，我们通过下面的这段代码来理解它们之间的区别。

结果显示a的类型是main.NewInt，表示main包下定义的NewInt类型。b的类型是int。MyInt类型只会在代码中存在，编译完成时并不会有MyInt类型。

Go语言中的基础数据类型可以表示一些事物的基本属性，但是当我们想表达一个事物的全部或部分属性时，这时候再用单一的基本数据类型明显就无法满足需求了，Go语言提供了一种自定义数据类型，可以封装多个基本数据类型，这种数据类型叫结构体，英文名称struct。 也就是我们可以通过struct来定义自己的类型了。

Go语言中通过struct来实现面向对象。

结构体的定义

使用type和struct关键字来定义结构体，具体代码格式如下：

其中：

举个例子，我们定义一个Person（人）结构体，代码如下：

同样类型的字段也可以写在一行，

这样我们就拥有了一个person的自定义类型，它有name、city、age三个字段，分别表示姓名、城市和年龄。这样我们使用这个person结构体就能够很方便的在程序中表示和存储人信息了。

语言内置的基础数据类型是用来描述一个值的，而结构体是用来描述一组值的。比如一个人有名字、年龄和居住城市等，本质上是一种聚合型的数据类型

结构体实例化

只有当结构体实例化时，才会真正地分配内存。也就是必须实例化后才能使用结构体的字段。

基本实例化

举个例子：

我们通过.来访问结构体的字段（成员变量）,例如p1.name和p1.age等。

匿名结构体

在定义一些临时数据结构等场景下还可以使用匿名结构体。

创建指针类型结构体

我们还可以通过使用new关键字对结构体进行实例化，得到的是结构体的地址。 格式如下：

从打印的结果中我们可以看出p2是一个结构体指针。

需要注意的是在Go语言中支持对结构体指针直接使用.来访问结构体的成员。

取结构体的地址实例化

使用对结构体进行取地址操作相当于对该结构体类型进行了一次new实例化操作。

p3.name = "七米"其实在底层是(*p3).name = "七米"，这是Go语言帮我们实现的语法糖。

结构体初始化

没有初始化的结构体，其成员变量都是对应其类型的零值。

使用键值对初始化

使用键值对对结构体进行初始化时，键对应结构体的字段，值对应该字段的初始值。

也可以对结构体指针进行键值对初始化，例如：

当某些字段没有初始值的时候，该字段可以不写。此时，没有指定初始值的字段的值就是该字段类型的零值。

使用值的列表初始化

初始化结构体的时候可以简写，也就是初始化的时候不写键，直接写值：

使用这种格式初始化时，需要注意：

结构体内存布局

结构体占用一块连续的内存。

输出：

【进阶知识点】关于Go语言中的内存对齐推荐阅读:在 Go 中恰到好处的内存对齐

面试题

请问下面代码的执行结果是什么？

构造函数

Go语言的结构体没有构造函数，我们可以自己实现。 例如，下方的代码就实现了一个person的构造函数。 因为struct是值类型，如果结构体比较复杂的话，值拷贝性能开销会比较大，所以该构造函数返回的是结构体指针类型。

调用构造函数

方法和接收者

Go语言中的方法（Method）是一种作用于特定类型变量的函数。这种特定类型变量叫做接收者（Receiver）。接收者的概念就类似于其他语言中的this或者 self。

方法的定义格式如下：

其中，

举个例子：

方法与函数的区别是，函数不属于任何类型，方法属于特定的类型。

指针类型的接收者

指针类型的接收者由一个结构体的指针组成，由于指针的特性，调用方法时修改接收者指针的任意成员变量，在方法结束后，修改都是有效的。这种方式就十分接近于其他语言中面向对象中的this或者self。 例如我们为Person添加一个SetAge方法，来修改实例变量的年龄。

调用该方法：

值类型的接收者

当方法作用于值类型接收者时，Go语言会在代码运行时将接收者的值复制一份。在值类型接收者的方法中可以获取接收者的成员值，但修改操作只是针对副本，无法修改接收者变量本身。

什么时候应该使用指针类型接收者

任意类型添加方法

在Go语言中，接收者的类型可以是任何类型，不仅仅是结构体，任何类型都可以拥有方法。 举个例子，我们基于内置的int类型使用type关键字可以定义新的自定义类型，然后为我们的自定义类型添加方法。

注意事项： 非本地类型不能定义方法，也就是说我们不能给别的包的类型定义方法。

结构体的匿名字段

匿名字段默认采用类型名作为字段名，结构体要求字段名称必须唯一，因此一个结构体中同种类型的匿名字段只能有一个。

嵌套结构体

一个结构体中可以嵌套包含另一个结构体或结构体指针。

嵌套匿名结构体

当访问结构体成员时会先在结构体中查找该字段，找不到再去匿名结构体中查找。

嵌套结构体的字段名冲突

嵌套结构体内部可能存在相同的字段名。这个时候为了避免歧义需要指定具体的内嵌结构体的字段。

结构体的“继承”

Go语言中使用结构体也可以实现其他编程语言中面向对象的继承。

结构体字段的可见性

结构体中字段大写开头表示可公开访问，小写表示私有（仅在定义当前结构体的包中可访问）。

结构体与JSON序列化

JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。JSON键值对是用来保存JS对象的一种方式，键/值对组合中的键名写在前面并用双引号""包裹，使用冒号:分隔，然后紧接着值；多个键值之间使用英文,分隔。

结构体标签（Tag）

Tag是结构体的元信息，可以在运行的时候通过反射的机制读取出来。 Tag在结构体字段的后方定义，由一对反引号包裹起来，具体的格式如下：

`key1:"value1" key2:"value2"`

结构体标签由一个或多个键值对组成。键与值使用冒号分隔，值用双引号括起来。键值对之间使用一个空格分隔。 注意事项： 为结构体编写Tag时，必须严格遵守键值对的规则。结构体标签的解析代码的容错能力很差，一旦格式写错，编译和运行时都不会提示任何错误，通过反射也无法正确取值。例如不要在key和value之间添加空格。

例如我们为Student结构体的每个字段定义json序列化时使用的Tag：

网站栏目：go语言自定义的方法 go语言导入自定义包
文章分享：http://myzitong.com/article/ddjcgji.html