method

函数的另一种形态,带有接收者的函数,称为method

method

现在假设有这么一个场景,定义了一个struct叫做长方形,现在想要计算他的面积,那么按照一般的思路应该会用下面的方式来实现

  1. package main
  2. import "fmt"
  3. type Rectangle struct {
  4. width, height float64
  5. }
  6. func area(r Rectangle) float64 {
  7. return r.width*r.height
  8. }
  9. func main() {
  10. r1 := Rectangle{12, 2}
  11. r2 := Rectangle{9, 4}
  12. fmt.Println("Area of r1 is: ", area(r1))
  13. fmt.Println("Area of r2 is: ", area(r2))
  14. }

这段代码可以计算出来长方形的面积,但是area()不是作为Rectangle的方法实现的(类似面向对象里面的方法),而是将Rectangle的对象(如r1,r2)作为参数传入函数计算面积的。

这样实现当然没有问题,但是当需要增加圆形、正方形、五边形甚至其它多边形的时候,想计算他们的面积的时候怎么办?那就只能增加新的函数,但是函数名就必须要跟着换了,变成area_rectangle, area_circle, area_triangle...

椭圆代表函数, 而这些函数并不从属于struct(或者以面向对象的术语来说,并不属于class),他们是单独存在于struct外围,而非在概念上属于某个struct的。

很显然,这样的实现并不优雅,并且从概念上来说”面积”是”形状”的一个属性,它是属于这个特定的形状的,就像长方形的长和宽一样。

基于上面的原因所以就有了method的概念,method是附属在一个给定的类型上的,他的语法和函数的声明语法几乎一样,只是在func后面增加了一个receiver(也就是method所依从的主体)。

用上面提到的形状的例子来说,method area() 是依赖于某个形状(比如说Rectangle)来发生作用的。Rectangle.area()的发出者是Rectangle, area()是属于Rectangle的方法,而非一个外围函数。

更具体地说,Rectangle存在字段 height 和 width, 同时存在方法area(), 这些字段和方法都属于Rectangle。

用Rob Pike的话来说就是:

“A method is a function with an implicit first argument, called a receiver.”

method的语法如下:

  1. func (r ReceiverType) funcName(parameters) (results)

下面用最开始的例子用method来实现:

  1. package main
  2. import (
  3. "fmt"
  4. "math"
  5. )
  6. type Rectangle struct {
  7. width, height float64
  8. }
  9. type Circle struct {
  10. radius float64
  11. }
  12. func (r Rectangle) area() float64 {
  13. return r.width*r.height
  14. }
  15. func (c Circle) area() float64 {
  16. return c.radius * c.radius * math.Pi
  17. }
  18. func main() {
  19. r1 := Rectangle{12, 2}
  20. r2 := Rectangle{9, 4}
  21. c1 := Circle{10}
  22. c2 := Circle{25}
  23. fmt.Println("Area of r1 is: ", r1.area())
  24. fmt.Println("Area of r2 is: ", r2.area())
  25. fmt.Println("Area of c1 is: ", c1.area())
  26. fmt.Println("Area of c2 is: ", c2.area())
  27. }

在使用method的时候重要注意几点

  • 虽然method的名字一模一样,但是如果接收者不一样,那么method就不一样
  • method里面可以访问接收者的字段

  • 调用method通过.访问,就像struct里面访问字段一样

在上例,method area() 分别属于Rectangle和Circle, 于是他们的 Receiver 就变成了Rectangle 和 Circle, 或者说,这个area()方法 是由 Rectangle/Circle 发出的。

值得说明的一点是,图示中method用虚线标出,意思是此处方法的Receiver是以值传递,而非引用传递,是的,Receiver还可以是指针, 两者的差别在于, 指针作为Receiver会对实例对象的内容发生操作,而普通类型作为Receiver仅仅是以副本作为操作对象,并不对原实例对象发生操作。后文对此会有详细论述。

那是不是method只能作用在struct上面呢?当然不是,他可以定义在任何自定义的类型、内置类型、struct等各种类型上面。什么叫自定义类型,自定义类型不就是struct,其实不是这样的,struct只是自定义类型里面一种比较特殊的类型而已,还有其他自定义类型申明,可以通过如下这样的申明来实现。

  1. type typeName typeLiteral

请看下面这个申明自定义类型的代码

  1. type ages int
  2. type money float32
  3. type months map[string]int
  4. m := months {
  5. "January":31,
  6. "February":28,
  7. ...
  8. "December":31,
  9. }

这样就可以在自己的代码里面定义有意义的类型了,实际上只是一个定义了一个别名,有点类似于c中的typedef,例如上面ages替代了int,回到method 可以在任何的自定义类型中定义任意多的method,接下来让看一个复杂一点的例子

  1. package main
  2. import "fmt"
  3. const(
  4. WHITE = iota
  5. BLACK
  6. BLUE
  7. RED
  8. YELLOW
  9. )
  10. type Color byte
  11. type Box struct {
  12. width, height, depth float64
  13. color Color
  14. }
  15. type BoxList []Box //a slice of boxes
  16. func (b Box) Volume() float64 {
  17. return b.width * b.height * b.depth
  18. }
  19. func (b *Box) SetColor(c Color) {
  20. b.color = c
  21. }
  22. func (bl BoxList) BiggestColor() Color {
  23. v := 0.00
  24. k := Color(WHITE)
  25. for _, b := range bl {
  26. if bv := b.Volume(); bv > v {
  27. v = bv
  28. k = b.color
  29. }
  30. }
  31. return k
  32. }
  33. func (bl BoxList) PaintItBlack() {
  34. for i := range bl {
  35. bl[i].SetColor(BLACK)
  36. }
  37. }
  38. func (c Color) String() string {
  39. strings := []string {"WHITE", "BLACK", "BLUE", "RED", "YELLOW"}
  40. return strings[c]
  41. }
  42. func main() {
  43. boxes := BoxList {
  44. Box{4, 4, 4, RED},
  45. Box{10, 10, 1, YELLOW},
  46. Box{1, 1, 20, BLACK},
  47. Box{10, 10, 1, BLUE},
  48. Box{10, 30, 1, WHITE},
  49. Box{20, 20, 20, YELLOW},
  50. }
  51. fmt.Printf("We have %d boxes in our set\n", len(boxes))
  52. fmt.Println("The volume of the first one is", boxes[0].Volume(), "cm³")
  53. fmt.Println("The color of the last one is",boxes[len(boxes)-1].color.String())
  54. fmt.Println("The biggest one is", boxes.BiggestColor().String())
  55. fmt.Println("Let's paint them all black")
  56. boxes.PaintItBlack()
  57. fmt.Println("The color of the second one is", boxes[1].color.String())
  58. fmt.Println("Obviously, now, the biggest one is", boxes.BiggestColor().String())
  59. }

上面的代码通过const定义了一些常量,然后定义了一些自定义类型

  • Color作为byte的别名
  • 定义了一个struct:Box,含有三个长宽高字段和一个颜色属性

  • 定义了一个slice:BoxList,含有Box

然后以上面的自定义类型为接收者定义了一些method

  • Volume()定义了接收者为Box,返回Box的容量
  • SetColor(c Color),把Box的颜色改为c

  • BiggestColor()定在在BoxList上面,返回list里面容量最大的颜色

  • PaintItBlack()把BoxList里面所有Box的颜色全部变成黑色

  • String()定义在Color上面,返回Color的具体颜色(字符串格式)

上面的代码通过文字描述出来之后是不是很简单?一般解决问题都是通过问题的描述,去写相应的代码实现。

指针作为receiver

现在让回过头来看看SetColor这个method,它的receiver是一个指向Box的指针,可以使用*Box。

定义SetColor的真正目的是想改变这个Box的颜色,如果不传Box的指针,那么SetColor接受的其实是Box的一个copy,也就是说method内对于颜色值的修改,其实只作用于Box的copy,而不是真正的Box。所以需要传入指针。

这里可以把receiver当作method的第一个参数来看,然后结合前面函数讲解的传值和传引用就不难理解

这里也许会问SetColor函数里面应该这样定义*b.Color=c,而不是b.Color=c,需要读取到指针相应的值。

其实Go里面这两种方式都是正确的,当用指针去访问相应的字段时(虽然指针没有任何的字段),Go知道要通过指针去获取这个值。PaintItBlack里面调用SetColor的时候是不是应该写成(&bl[i]).SetColor(BLACK),因为SetColor的receiver是*Box,而不是Box。这两种方式都可以,因为Go知道receiver是指针,他自动转了。

也就是说:

如果一个method的receiver是*T,可以在一个T类型的实例变量V上面调用这个method,而不需要&V去调用这个method

类似的

如果一个method的receiver是T,可以在一个T类型的变量P上面调用这个method,而不需要 P去调用这个method

所以不用担心是调用的指针的method还是不是指针的method,Go知道要做的一切,这对于有多年C/C++编程经验的同学来说,真是解决了一个很大的痛苦。

method继承

通过字段的继承的学习,发现Go的一个神奇之处,method也是可以继承的。如果匿名字段实现了一个method,那么包含这个匿名字段的struct也能调用该method。来看下面这个例子

  1. package main
  2. import "fmt"
  3. type Human struct {
  4. name string
  5. age int
  6. phone string
  7. }
  8. type Student struct {
  9. Human //匿名字段
  10. school string
  11. }
  12. type Employee struct {
  13. Human //匿名字段
  14. company string
  15. }
  16. //在human上面定义了一个method
  17. func (h *Human) SayHi() {
  18. fmt.Printf("Hi, I am %s you can call me on %s\n", h.name, h.phone)
  19. }
  20. func main() {
  21. mark := Student{Human{"Mark", 25, "222-222-YYYY"}, "MIT"}
  22. sam := Employee{Human{"Sam", 45, "111-888-XXXX"}, "Golang Inc"}
  23. mark.SayHi()
  24. sam.SayHi()
  25. }

method重写

上面的例子中,如果Employee想要实现自己的SayHi,怎么办?简单,和匿名字段冲突一样的道理,可以在Employee上面定义一个method,重写了匿名字段的方法。请看下面的例子

  1. package main
  2. import "fmt"
  3. type Human struct {
  4. name string
  5. age int
  6. phone string
  7. }
  8. type Student struct {
  9. Human //匿名字段
  10. school string
  11. }
  12. type Employee struct {
  13. Human //匿名字段
  14. company string
  15. }
  16. //Human定义method
  17. func (h *Human) SayHi() {
  18. fmt.Printf("Hi, I am %s you can call me on %s\n", h.name, h.phone)
  19. }
  20. //Employee的method重写Human的method
  21. func (e *Employee) SayHi() {
  22. fmt.Printf("Hi, I am %s, I work at %s. Call me on %s\n", e.name,
  23. e.company, e.phone) //Yes you can split into 2 lines here.
  24. }
  25. func main() {
  26. mark := Student{Human{"Mark", 25, "222-222-YYYY"}, "MIT"}
  27. sam := Employee{Human{"Sam", 45, "111-888-XXXX"}, "Golang Inc"}
  28. mark.SayHi()
  29. sam.SayHi()
  30. }

通过这些内容,可以设计出基本的面向对象的程序了,但是Go里面的面向对象是如此的简单,没有任何的私有、公有关键字,通过大小写来实现(大写开头的为公有,小写开头的为私有),方法也同样适用这个原则。