4.4. 结构体

结构体是一种聚合的数据类型,是由零个或多个任意类型的值聚合成的实体。每个值称为结构体的成员。用结构体的经典案例是处理公司的员工信息,每个员工信息包含一个唯一的员工编号、员工的名字、家庭住址、出生日期、工作岗位、薪资、上级领导等等。所有的这些信息都需要绑定到一个实体中,可以作为一个整体单元被复制,作为函数的参数或返回值,或者是被存储到数组中,等等。

下面两个语句声明了一个叫Employee的命名的结构体类型,并且声明了一个Employee类型的变量dilbert:

  1. type Employee struct {
  2. ID int
  3. Name string
  4. Address string
  5. DoB time.Time
  6. Position string
  7. Salary int
  8. ManagerID int
  9. }
  10. var dilbert Employee

dilbert结构体变量的成员可以通过点操作符访问,比如dilbert.Name和dilbert.DoB。因为dilbert是一个变量,它所有的成员也同样是变量,我们可以直接对每个成员赋值:

  1. dilbert.Salary -= 5000 // demoted, for writing too few lines of code

或者是对成员取地址,然后通过指针访问:

  1. position := &dilbert.Position
  2. *position = "Senior " + *position // promoted, for outsourcing to Elbonia

点操作符也可以和指向结构体的指针一起工作:

  1. var employeeOfTheMonth *Employee = &dilbert
  2. employeeOfTheMonth.Position += " (proactive team player)"

相当于下面语句

  1. (*employeeOfTheMonth).Position += " (proactive team player)"

下面的EmployeeByID函数将根据给定的员工ID返回对应的员工信息结构体的指针。我们可以使用点操作符来访问它里面的成员:

  1. func EmployeeByID(id int) *Employee { /* ... */ }
  2. fmt.Println(EmployeeByID(dilbert.ManagerID).Position) // "Pointy-haired boss"
  3. id := dilbert.ID
  4. EmployeeByID(id).Salary = 0 // fired for... no real reason

后面的语句通过EmployeeByID返回的结构体指针更新了Employee结构体的成员。如果将EmployeeByID函数的返回值从*Employee指针类型改为Employee值类型,那么更新语句将不能编译通过,因为在赋值语句的左边并不确定是一个变量(译注:调用函数返回的是值,并不是一个可取地址的变量)。

通常一行对应一个结构体成员,成员的名字在前类型在后,不过如果相邻的成员类型如果相同的话可以被合并到一行,就像下面的Name和Address成员那样:

  1. type Employee struct {
  2. ID int
  3. Name, Address string
  4. DoB time.Time
  5. Position string
  6. Salary int
  7. ManagerID int
  8. }

结构体成员的输入顺序也有重要的意义。我们也可以将Position成员合并(因为也是字符串类型),或者是交换Name和Address出现的先后顺序,那样的话就是定义了不同的结构体类型。通常,我们只是将相关的成员写到一起。

如果结构体成员名字是以大写字母开头的,那么该成员就是导出的;这是Go语言导出规则决定的。一个结构体可能同时包含导出和未导出的成员。

结构体类型往往是冗长的,因为它的每个成员可能都会占一行。虽然我们每次都可以重写整个结构体成员,但是重复会令人厌烦。因此,完整的结构体写法通常只在类型声明语句的地方出现,就像Employee类型声明语句那样。

一个命名为S的结构体类型将不能再包含S类型的成员:因为一个聚合的值不能包含它自身。(该限制同样适用于数组。)但是S类型的结构体可以包含*S指针类型的成员,这可以让我们创建递归的数据结构,比如链表和树结构等。在下面的代码中,我们使用一个二叉树来实现一个插入排序:

gopl.io/ch4/treesort

  1. type tree struct {
  2. value int
  3. left, right *tree
  4. }
  5. // Sort sorts values in place.
  6. func Sort(values []int) {
  7. var root *tree
  8. for _, v := range values {
  9. root = add(root, v)
  10. }
  11. appendValues(values[:0], root)
  12. }
  13. // appendValues appends the elements of t to values in order
  14. // and returns the resulting slice.
  15. func appendValues(values []int, t *tree) []int {
  16. if t != nil {
  17. values = appendValues(values, t.left)
  18. values = append(values, t.value)
  19. values = appendValues(values, t.right)
  20. }
  21. return values
  22. }
  23. func add(t *tree, value int) *tree {
  24. if t == nil {
  25. // Equivalent to return &tree{value: value}.
  26. t = new(tree)
  27. t.value = value
  28. return t
  29. }
  30. if value < t.value {
  31. t.left = add(t.left, value)
  32. } else {
  33. t.right = add(t.right, value)
  34. }
  35. return t
  36. }

结构体类型的零值是每个成员都是零值。通常会将零值作为最合理的默认值。例如,对于bytes.Buffer类型,结构体初始值就是一个随时可用的空缓存,还有在第9章将会讲到的sync.Mutex的零值也是有效的未锁定状态。有时候这种零值可用的特性是自然获得的,但是也有些类型需要一些额外的工作。

如果结构体没有任何成员的话就是空结构体,写作struct{}。它的大小为0,也不包含任何信息,但是有时候依然是有价值的。有些Go语言程序员用map来模拟set数据结构时,用它来代替map中布尔类型的value,只是强调key的重要性,但是因为节约的空间有限,而且语法比较复杂,所以我们通常会避免这样的用法。

  1. seen := make(map[string]struct{}) // set of strings
  2. // ...
  3. if _, ok := seen[s]; !ok {
  4. seen[s] = struct{}{}
  5. // ...first time seeing s...
  6. }

4.4.1. 结构体字面值

结构体值也可以用结构体字面值表示,结构体字面值可以指定每个成员的值。

  1. type Point struct{ X, Y int }
  2. p := Point{1, 2}

这里有两种形式的结构体字面值语法,上面的是第一种写法,要求以结构体成员定义的顺序为每个结构体成员指定一个字面值。它要求写代码和读代码的人要记住结构体的每个成员的类型和顺序,不过结构体成员有细微的调整就可能导致上述代码不能编译。因此,上述的语法一般只在定义结构体的包内部使用,或者是在较小的结构体中使用,这些结构体的成员排列比较规则,比如image.Point{x, y}或color.RGBA{red, green, blue, alpha}。

其实更常用的是第二种写法,以成员名字和相应的值来初始化,可以包含部分或全部的成员,如1.4节的Lissajous程序的写法:

  1. anim := gif.GIF{LoopCount: nframes}

在这种形式的结构体字面值写法中,如果成员被忽略的话将默认用零值。因为提供了成员的名字,所以成员出现的顺序并不重要。

两种不同形式的写法不能混合使用。而且,你不能企图在外部包中用第一种顺序赋值的技巧来偷偷地初始化结构体中未导出的成员。

  1. package p
  2. type T struct{ a, b int } // a and b are not exported
  3. package q
  4. import "p"
  5. var _ = p.T{a: 1, b: 2} // compile error: can't reference a, b
  6. var _ = p.T{1, 2} // compile error: can't reference a, b

虽然上面最后一行代码的编译错误信息中并没有显式提到未导出的成员,但是这样企图隐式使用未导出成员的行为也是不允许的。

结构体可以作为函数的参数和返回值。例如,这个Scale函数将Point类型的值缩放后返回:

  1. func Scale(p Point, factor int) Point {
  2. return Point{p.X * factor, p.Y * factor}
  3. }
  4. fmt.Println(Scale(Point{1, 2}, 5)) // "{5 10}"

如果考虑效率的话,较大的结构体通常会用指针的方式传入和返回,

  1. func Bonus(e *Employee, percent int) int {
  2. return e.Salary * percent / 100
  3. }

如果要在函数内部修改结构体成员的话,用指针传入是必须的;因为在Go语言中,所有的函数参数都是值拷贝传入的,函数参数将不再是函数调用时的原始变量。

  1. func AwardAnnualRaise(e *Employee) {
  2. e.Salary = e.Salary * 105 / 100
  3. }

因为结构体通常通过指针处理,可以用下面的写法来创建并初始化一个结构体变量,并返回结构体的地址:

  1. pp := &Point{1, 2}

它和下面的语句是等价的

  1. pp := new(Point)
  2. *pp = Point{1, 2}

不过&Point{1, 2}写法可以直接在表达式中使用,比如一个函数调用。

4.4.2. 结构体比较

如果结构体的全部成员都是可以比较的,那么结构体也是可以比较的,那样的话两个结构体将可以使用==或!=运算符进行比较。相等比较运算符==将比较两个结构体的每个成员,因此下面两个比较的表达式是等价的:

  1. type Point struct{ X, Y int }
  2. p := Point{1, 2}
  3. q := Point{2, 1}
  4. fmt.Println(p.X == q.X && p.Y == q.Y) // "false"
  5. fmt.Println(p == q) // "false"

可比较的结构体类型和其他可比较的类型一样,可以用于map的key类型。

  1. type address struct {
  2. hostname string
  3. port int
  4. }
  5. hits := make(map[address]int)
  6. hits[address{"golang.org", 443}]++

4.4.3. 结构体嵌入和匿名成员

在本节中,我们将看到如何使用Go语言提供的不同寻常的结构体嵌入机制让一个命名的结构体包含另一个结构体类型的匿名成员,这样就可以通过简单的点运算符x.f来访问匿名成员链中嵌套的x.d.e.f成员。

考虑一个二维的绘图程序,提供了一个各种图形的库,例如矩形、椭圆形、星形和轮形等几何形状。这里是其中两个的定义:

  1. type Circle struct {
  2. X, Y, Radius int
  3. }
  4. type Wheel struct {
  5. X, Y, Radius, Spokes int
  6. }

一个Circle代表的圆形类型包含了标准圆心的X和Y坐标信息,和一个Radius表示的半径信息。一个Wheel轮形除了包含Circle类型所有的全部成员外,还增加了Spokes表示径向辐条的数量。我们可以这样创建一个wheel变量:

  1. var w Wheel
  2. w.X = 8
  3. w.Y = 8
  4. w.Radius = 5
  5. w.Spokes = 20

随着库中几何形状数量的增多,我们一定会注意到它们之间的相似和重复之处,所以我们可能为了便于维护而将相同的属性独立出来:

  1. type Point struct {
  2. X, Y int
  3. }
  4. type Circle struct {
  5. Center Point
  6. Radius int
  7. }
  8. type Wheel struct {
  9. Circle Circle
  10. Spokes int
  11. }

这样改动之后结构体类型变的清晰了,但是这种修改同时也导致了访问每个成员变得繁琐:

  1. var w Wheel
  2. w.Circle.Center.X = 8
  3. w.Circle.Center.Y = 8
  4. w.Circle.Radius = 5
  5. w.Spokes = 20

Go语言有一个特性让我们只声明一个成员对应的数据类型而不指名成员的名字;这类成员就叫匿名成员。匿名成员的数据类型必须是命名的类型或指向一个命名的类型的指针。下面的代码中,Circle和Wheel各自都有一个匿名成员。我们可以说Point类型被嵌入到了Circle结构体,同时Circle类型被嵌入到了Wheel结构体。

  1. type Circle struct {
  2. Point
  3. Radius int
  4. }
  5. type Wheel struct {
  6. Circle
  7. Spokes int
  8. }

得益于匿名嵌入的特性,我们可以直接访问叶子属性而不需要给出完整的路径:

  1. var w Wheel
  2. w.X = 8 // equivalent to w.Circle.Point.X = 8
  3. w.Y = 8 // equivalent to w.Circle.Point.Y = 8
  4. w.Radius = 5 // equivalent to w.Circle.Radius = 5
  5. w.Spokes = 20

在右边的注释中给出的显式形式访问这些叶子成员的语法依然有效,因此匿名成员并不是真的无法访问了。其中匿名成员Circle和Point都有自己的名字——就是命名的类型名字——但是这些名字在点操作符中是可选的。我们在访问子成员的时候可以忽略任何匿名成员部分。

不幸的是,结构体字面值并没有简短表示匿名成员的语法, 因此下面的语句都不能编译通过:

  1. w = Wheel{8, 8, 5, 20} // compile error: unknown fields
  2. w = Wheel{X: 8, Y: 8, Radius: 5, Spokes: 20} // compile error: unknown fields

结构体字面值必须遵循形状类型声明时的结构,所以我们只能用下面的两种语法,它们彼此是等价的:

gopl.io/ch4/embed

  1. w = Wheel{Circle{Point{8, 8}, 5}, 20}
  2. w = Wheel{
  3. Circle: Circle{
  4. Point: Point{X: 8, Y: 8},
  5. Radius: 5,
  6. },
  7. Spokes: 20, // NOTE: trailing comma necessary here (and at Radius)
  8. }
  9. fmt.Printf("%#v\n", w)
  10. // Output:
  11. // Wheel{Circle:Circle{Point:Point{X:8, Y:8}, Radius:5}, Spokes:20}
  12. w.X = 42
  13. fmt.Printf("%#v\n", w)
  14. // Output:
  15. // Wheel{Circle:Circle{Point:Point{X:42, Y:8}, Radius:5}, Spokes:20}

需要注意的是Printf函数中%v参数包含的#副词,它表示用和Go语言类似的语法打印值。对于结构体类型来说,将包含每个成员的名字。

因为匿名成员也有一个隐式的名字,因此不能同时包含两个类型相同的匿名成员,这会导致名字冲突。同时,因为成员的名字是由其类型隐式地决定的,所以匿名成员也有可见性的规则约束。在上面的例子中,Point和Circle匿名成员都是导出的。即使它们不导出(比如改成小写字母开头的point和circle),我们依然可以用简短形式访问匿名成员嵌套的成员

  1. w.X = 8 // equivalent to w.circle.point.X = 8

但是在包外部,因为circle和point没有导出,不能访问它们的成员,因此简短的匿名成员访问语法也是禁止的。

到目前为止,我们看到匿名成员特性只是对访问嵌套成员的点运算符提供了简短的语法糖。稍后,我们将会看到匿名成员并不要求是结构体类型;其实任何命名的类型都可以作为结构体的匿名成员。但是为什么要嵌入一个没有任何子成员类型的匿名成员类型呢?

答案是匿名类型的方法集。简短的点运算符语法可以用于选择匿名成员嵌套的成员,也可以用于访问它们的方法。实际上,外层的结构体不仅仅是获得了匿名成员类型的所有成员,而且也获得了该类型导出的全部的方法。这个机制可以用于将一些有简单行为的对象组合成有复杂行为的对象。组合是Go语言中面向对象编程的核心,我们将在6.3节中专门讨论。