We talked about functions and structs in the last two sections, but did you ever consider using functions as fields of a struct? In this section, I will introduce you to another form of function that has a receiver, which is called a method.
Suppose you define a "rectangle" struct and you want to calculate its area. We'd typically use the following code to achieve this goal.
package main
import "fmt"
type Rectangle struct {
width, height float64
}
func area(r Rectangle) float64 {
return r.width * r.height
}
func main() {
r1 := Rectangle{12, 2}
r2 := Rectangle{9, 4}
fmt.Println("Area of r1 is: ", area(r1))
fmt.Println("Area of r2 is: ", area(r2))
}The above example can calculate a rectangle's area. We use the function called area, but it's not a method of the rectangle struct (like class methods in classic object-oriented languages). The function and struct are two independent things as you may notice.
It's not a problem so far. However, if you also have to calculate the area of a circle, square, pentagon, or any other kind of shape, you are going to need to add additional functions with very similar names.
Figure 2.8 Relationship between function and struct
Obviously that's not cool. Also, the area should really be the property of a circle or rectangle.
This is where a method comes to play. The method is a function affiliated with a type. It has similar syntax as function except, after the func keyword has a parameter called the receiver, which is the main body of that method.
Using the same example, Rectangle.Area() belongs directly to rectangle, instead of as a peripheral function. More specifically, length, width and Area() all belong to rectangle.
As Rob Pike said.
"A method is a function with an implicit first argument, called a receiver."Syntax of method.
func (r ReceiverType) funcName(parameters) (results)Let's change our example using method instead.
package main
import (
"fmt"
"math"
)
type Circle struct {
radius float64
}
type Rectangle struct {
width, height float64
}
// method
func (c Circle) Area() float64 {
return c.radius * c.radius * math.Pi
}
// method
func (r Rectangle) Area() float64 {
return r.width * r.height
}
func main() {
c1 := Circle{10}
c2 := Circle{25}
r1 := Rectangle{9, 4}
r2 := Rectangle{12, 2}
fmt.Println("Area of c1 is: ", c1.Area())
fmt.Println("Area of c2 is: ", c2.Area())
fmt.Println("Area of r1 is: ", r1.Area())
fmt.Println("Area of r2 is: ", r2.Area())
}Notes for using methods.
- If the name of methods are the same but they don't share the same receivers, they are not the same.
- Methods are able to access fields within receivers.
- Use
.to call a method in the struct, the same way fields are called.
Figure 2.9 Methods are different in different structs
In the example above, the Area() methods belong to both Rectangle and Circle respectively, so the receivers are Rectangle and Circle.
One thing that's worth noting is that the method with a dotted line means the receiver is passed by value, not by reference. The difference between them is that a method can change its receiver's values when the receiver is passed by reference, and it gets a copy of the receiver when the receiver is passed by value.
Can the receiver only be a struct? Of course not. Any type can be the receiver of a method. You may be confused about customized types. Struct is a special kind of customized type -there are more customized types.
Use the following format to define a customized type.
type typeName typeLiteralExamples of customized types:
type age int
type money float32
type months map[string]int
m := months {
"January":31,
"February":28,
...
"December":31,
}I hope that you know how to use customized types now. Similar to typedef in C, we use ages to substitute int in the above example.
Let's get back to talking about method.
You can use as many methods in custom types as you want.
package main
import "fmt"
const (
WHITE = iota
BLACK
BLUE
RED
YELLOW
)
type Box struct {
width, height, depth float64
color Color
}
type Color byte
type BoxList []Box //a slice of boxes
// method
func (b Box) Volume() float64 {
return b.width * b.height * b.depth
}
// method with a pointer receiver
func (b *Box) SetColor(c Color) {
b.color = c
}
// method
func (bl BoxList) BiggestsColor() Color {
v := 0.00
k := Color(WHITE)
for _, b := range bl {
if b.Volume() > v {
v = b.Volume()
k = b.color
}
}
return k
}
// method
func (bl BoxList) PaintItBlack() {
for i, _ := range bl {
bl[i].SetColor(BLACK)
}
}
// method
func (c Color) String() string {
strings := []string{"WHITE", "BLACK", "BLUE", "RED", "YELLOW"}
return strings[c]
}
func main() {
boxes := BoxList{
Box{4, 4, 4, RED},
Box{10, 10, 1, YELLOW},
Box{1, 1, 20, BLACK},
Box{10, 10, 1, BLUE},
Box{10, 30, 1, WHITE},
Box{20, 20, 20, YELLOW},
}
fmt.Printf("We have %d boxes in our set\n", len(boxes))
fmt.Println("The volume of the first one is", boxes[0].Volume(), "cm³")
fmt.Println("The color of the last one is", boxes[len(boxes)-1].color.String())
fmt.Println("The biggest one is", boxes.BiggestsColor().String())
// Let's paint them all black
boxes.PaintItBlack()
fmt.Println("The color of the second one is", boxes[1].color.String())
fmt.Println("Obviously, now, the biggest one is", boxes.BiggestsColor().String())
}We define some constants and customized types.
- Use
Coloras alias ofbyte. - Define a struct
Boxwhich has fields height, width, length and color. - Define a struct
BoxListwhich hasBoxas its field.
Then we defined some methods for our customized types.
Volume()uses Box as its receiver and returns the volume of Box.SetColor(c Color)changes Box's color.BiggestsColor()returns the color which has the biggest volume.PaintItBlack()sets color for all Box in BoxList to black.String()use Color as its receiver, returns the string format of color name.
Is it much clearer when we use words to describe our requirements? We often write our requirements before we start coding.
Let's take a look at SetColor method. Its receiver is a pointer of Box. Yes, you can use *Box as a receiver. Why do we use a pointer here? Because we want to change Box's color in this method. Thus, if we don't use a pointer, it will only change the value inside a copy of Box.
If we see that a receiver is the first argument of a method, it's not hard to understand how it works.
You might be asking why we aren't using (*b).Color=c instead of b.Color=c in the SetColor() method. Either one is OK here because Go knows how to interpret the assignment. Do you think Go is more fascinating now?
You may also be asking whether we should use (&bl[i]).SetColor(BLACK) in PaintItBlack because we pass a pointer to SetColor. Again, either one is OK because Go knows how to interpret it!
We learned about inheritance of fields in the last section. Similarly, we also have method inheritance in Go. If an anonymous field has methods, then the struct that contains the field will have all the methods from it as well.
package main
import "fmt"
type Human struct {
name string
age int
phone string
}
type Student struct {
Human // anonymous field
school string
}
type Employee struct {
Human
company string
}
// define a method in Human
func (h *Human) SayHi() {
fmt.Printf("Hi, I am %s you can call me on %s\n", h.name, h.phone)
}
func main() {
sam := Employee{Human{"Sam", 45, "111-888-XXXX"}, "Golang Inc"}
mark := Student{Human{"Mark", 25, "222-222-YYYY"}, "MIT"}
sam.SayHi()
mark.SayHi()
}If we want Employee to have its own method SayHi, we can define a method that has the same name in Employee, and it will hide SayHi in Human when we call it.
package main
import "fmt"
type Human struct {
name string
age int
phone string
}
type Student struct {
Human
school string
}
type Employee struct {
Human
company string
}
func (h *Human) SayHi() {
fmt.Printf("Hi, I am %s you can call me on %s\n", h.name, h.phone)
}
func (e *Employee) SayHi() {
fmt.Printf("Hi, I am %s, I work at %s. Call me on %s\n", e.name,
e.company, e.phone) //Yes you can split into 2 lines here.
}
func main() {
sam := Employee{Human{"Sam", 45, "111-888-XXXX"}, "Golang Inc"}
mark := Student{Human{"Mark", 25, "222-222-YYYY"}, "MIT"}
sam.SayHi()
mark.SayHi()
}You are able to write an Object-oriented program now, and methods use rule of capital letter to decide whether public or private as well.