Tuesday, December 22, 2020

A tour of Go (4) - 方法和介面

1. 方法

Go 沒有類。不過你可以為結構體型別定義方法。

方法就是一類帶特殊的 接收者 引數的函式。

方法接收者在它自己的引數列表內，位於 func 關鍵字和方法名之間。

在此例中，Abs 方法擁有一個名為 v，型別為 Vertex 的接收者。

package main

import (
	"fmt"
	"math"
)

type Vertex struct { // 相當於“類的變數屬性等”
	X, Y float64
}

func (v Vertex) Abs() float64 { // 相當於為結構體定義函式，即“類的函式方法”
	return math.Sqrt(v.X*v.X + v.Y*v.Y)
}

func main() {
	v := Vertex{3, 4}
	fmt.Println(v.Abs())
    // fmt.Println(v.Abs())   這樣會報錯：undefined: Abs
}
 

指標接收者：你可以為指標接收者宣告方法。

這意味著對於某型別 T，接收者的型別可以用 *T 的文法。（此外，T 不能是像 *int 這樣的指標。）

例如，這裡為 *Vertex 定義了 Scale 方法。

指標接收者的方法可以修改接收者指向的值（就像 Scale 在這做的）。由於方法經常需要修改它的接收者，指標接收者比值接收者更常用。

type Vertex struct {
	X, Y float64
}

func (v Vertex) Abs() float64 {
	return math.Sqrt(v.X*v.X + v.Y*v.Y)
}

//func (v Vertex) Scale(f float64)     值接收者，不會修改v Vertex的值，最終print=5
func (v *Vertex) Scale(f float64) { // 指標接收者，會修改v Vertex的值
	v.X = v.X * f
	v.Y = v.Y * f
}

func main() {
	v := Vertex{3, 4}
	v.Scale(10)
	fmt.Println(v.Abs()) // result：50
}
 

若使用值接收者，那麼 Scale 方法會對原始 Vertex 值的副本進行操作。（對於函式的其它引數也是如此。）Scale 方法必須用指標接受者來更改 main 函式中宣告的 Vertex 的值。

指標與函式：現在我們要把 Abs 和 Scale 方法重寫為函式。

func Abs(v Vertex) float64 {
	return math.Sqrt(v.X*v.X + v.Y*v.Y)
}

func Scale(v *Vertex, f float64) {
	v.X = v.X * f
	v.Y = v.Y * f
}

func main() {
	v := Vertex{3, 4}
	Scale(&v, 10)
	fmt.Println(Abs(v)) // 50
}
 

注意：帶指標引數的函式必須接受一個指標：

var v Vertex
ScaleFunc(v, 5)  // 編譯錯誤！
ScaleFunc(&v, 5) // OK

而以指標為接收者的方法被呼叫時，接收者既能為值又能為指標：

var v Vertex
v.Scale(5)  // OK,為方便起見，Go 會將語句 v.Scale(5) 解釋為 (&v).Scale(5)。
p := &v
p.Scale(10) // OK

方法與指標重定向：對於語句 v.Scale(5)，即便 v 是個值而非指標，帶指標接收者的方法也能被直接呼叫。也就是說，由於 Scale 方法有一個指標接收者，為方便起見，Go 會將語句 v.Scale(5) 解釋為 (&v).Scale(5)。

同樣的事情也發生在相反的方向。

接受一個值作為引數的函式必須接受一個指定型別的值：

var v Vertex
fmt.Println(AbsFunc(v))  // OK
fmt.Println(AbsFunc(&v)) // 編譯錯誤！

而以值為接收者的方法被呼叫時，接收者既能為值又能為指標：

var v Vertex
fmt.Println(v.Abs()) // OK
p := &v
fmt.Println(p.Abs()) // OK，p.Abs() 會被解釋為 (*p).Abs()。

這種情況下，方法呼叫 p.Abs() 會被自動解釋為 (*p).Abs()。

選擇值或指標作為接收者：

使用指標接收者的原因有二：

首先，方法能夠修改其接收者指向的值。

其次，這樣可以避免在每次呼叫方法時複製該值。若值的型別為大型結構體時，這樣做會更加高效。

在本例中，Scale 和 Abs 接收者的型別為 *Vertex，即便 Abs 並不需要修改其接收者。

func (v *Vertex) Scale(f float64) {
	v.X = v.X * f
	v.Y = v.Y * f
}

func (v *Vertex) Abs() float64 {
	return math.Sqrt(v.X*v.X + v.Y*v.Y)
}

func main() {
	v := &Vertex{3, 4}
	fmt.Printf("Before scaling: %+v, Abs: %v\n", v, v.Abs())//&{X:3 Y:4}, Abs:5
	v.Scale(5)
	fmt.Printf("After scaling: %+v, Abs: %v\n", v, v.Abs())//&{X:15 Y:20},Abs:25
}

通常來說，所有給定型別的方法都應該有值或指標接收者，但並不應該二者混用。

2. 介面

介面型別 是由一組方法簽名定義的集合。

介面型別的變數可以儲存任何實現了這些方法的值。

type Abser interface {
	Abs() float64
}

func main() {
	var a Abser
	f := MyFloat(-math.Sqrt2)
	v := Vertex{3, 4}

	a = f  // a MyFloat 實現了 Abser
	fmt.Println(a.Abs())
	a = &v // a *Vertex 實現了 Abser
	fmt.Println(a.Abs())
	// 下面一行，v 是一個 Vertex（而不是 *Vertex）
	// 所以沒有實現 Abser。
	a = v
	fmt.Println(a.Abs()) // 所以，會報錯
}

type MyFloat float64

func (f MyFloat) Abs() float64 { // 方法名為 Abs()
	if f < 0 {
		return float64(-f)
	}
	return float64(f)
}

type Vertex struct {
	X, Y float64
}

func (v *Vertex) Abs() float64 { // 方法名為 Abs()
	return math.Sqrt(v.X*v.X + v.Y*v.Y)
}

介面與隱式實現：型別通過實現一個介面的所有方法來實現該介面。既然無需專門顯式宣告，也就沒有“implements”關鍵字。

隱式介面從介面的實現中解耦了定義，這樣介面的實現可以出現在任何包中，無需提前準備。

因此，也就無需在每一個實現上增加新的介面名稱，這樣同時也鼓勵了明確的介面定義。（沒看懂）

type I interface {
	M()
}

type T struct {
	S string
}

// 此方法表示型別 T 實現了介面 I，但我們無需顯式宣告此事。
// 因為方法名為M()，即介面 I 的方法
func (t T) M() {
	fmt.Println(t.S)
}

func main() {
	var i I = T{"hello"}
	i.M() // result：hello
}

介面值：介面也是值。它們可以像其它值一樣傳遞。

介面值可以用作函式的引數或返回值。

在內部，介面值可以看做包含值和具體型別的元組：

(value, type)

介面值儲存了一個具體底層型別的具體值。

介面值呼叫方法時會執行其底層型別的同名方法。

package main

import (
	"fmt"
	"math"
)

type I interface {
	M()
}

type T struct {
	S string
}

func (t *T) M() { // 隱式實現
	fmt.Println(t.S)
}

type F float64

func (f F) M() { // 隱式實現
	fmt.Println(f)
}

func main() {
	var i I

	i = &T{"Hello"}
	describe(i)
	i.M()

	i = F(math.Pi)
	describe(i)
	i.M()
}

func describe(i I) { // 介面值包括 v value 和 T type
	fmt.Printf("(%v, %T)\n", i, i)
}

底層值為 nil 的介面值

即便介面內的具體值為 nil，方法仍然會被 nil 接收者呼叫。

在一些語言中，這會觸發一個空指標異常，但在 Go 中通常會寫一些方法來優雅地處理它（如本例中的 M 方法）。

注意: 儲存了 nil 具體值的介面其自身並不為 nil。

package main

import "fmt"

type I interface {
	M()
}

type T struct {
	S string
}

func (t *T) M() {
	if t == nil { // 處理空指標異常的 if 判斷
		fmt.Println("<nil>")
		return
	}
	fmt.Println(t.S)
}

func main() {
	var i I

	var t *T // 空指標
	fmt.Println(t) // <nil>
	i = t
	describe(i)	   // (<nil>, *main.T)
	i.M()		   // <nil>

	i = &T{"hello"}
	describe(i)	   // (&{hello}, *main.T)
	i.M()
}

func describe(i I) {
	fmt.Printf("(%v, %T)\n", i, i)
}

nil 介面值

nil 介面值既不儲存值也不儲存具體型別。

為 nil 介面呼叫方法會產生執行時錯誤，因為介面的元組內並未包含能夠指明該呼叫哪個 具體 方法的型別。

type I interface {
	M()
}

func main() {
	var i I
	describe(i) // (<nil>, <nil>)，不儲存值和具體型別
	i.M() // 執行時錯誤
}

func describe(i I) {
	fmt.Printf("(%v, %T)\n", i, i)
}

空介面

指定了零個方法的介面值被稱為 空介面：

interface{}

空介面可儲存任何型別的值。（因為每個型別都至少實現了零個方法。）

空介面被用來處理未知型別的值。例如，fmt.Print 可接受型別為 interface{} 的任意數量的引數。

func main() {
	var i interface{}
	describe(i) // (<nil>, <nil>)

	i = 42
	describe(i) // (42, int)

	i = "hello"
	describe(i) // (hello, string)
}

func describe(i interface{}) {
	fmt.Printf("(%v, %T)\n", i, i)
}

型別斷言：提供了訪問介面值底層具體值的方式。

t := i.(T)

該語句斷言介面值 i 儲存了具體型別 T，並將其底層型別為 T 的值賦予變數 t。

若 i 並未儲存 T 型別的值，該語句就會觸發一個恐慌（panic）。

為了 判斷 一個介面值是否儲存了一個特定的型別，型別斷言可返回兩個值：其底層值以及一個報告斷言是否成功的布林值。

t, ok := i.(T)

若 i 儲存了一個 T，那麼 t 將會是其底層值，而 ok 為 true。

否則，ok 將為 false 而 t 將為 T 型別的零值，程式並不會產生恐慌。

回顧：對映讀取， elem, ok = m[key]

型別選擇：是一種按順序從幾個型別斷言中選擇分支的結構。

型別選擇與一般的 switch 語句相似，不過型別選擇中的 case 為型別（而非值）， 它們針對給定介面值所儲存的值的型別進行比較。

	switch v := i.(type) { // 關鍵字 type 替換了具體型別 T
	case int:
		fmt.Printf("Twice %v is %v\n", v, v*2)
	case string:
		fmt.Printf("%q is %v bytes long\n", v, len(v))
	default:
		fmt.Printf("I don't know about type %T!\n", v)
	}

型別選擇中的宣告與型別斷言 i.(T) 的語法相同，只是具體型別 T 被替換成了關鍵字 type

此選擇語句判斷介面值 i 儲存的值型別是 T 還是 S。在 T 或 S 的情況下，變數 v 會分別按 T 或 S 型別儲存 i 擁有的值。在預設（即沒有匹配）的情況下，變數 v 與 i 的介面型別和值相同。

Stringer：fmt包中定義的 Stringer 是最普遍的介面之一。

type Stringer interface {
    String() string
}

Stringer 是一個可以用字串描述自己的型別。fmt 包（還有很多包）都通過此介面來列印值。

type Person struct {
	Name string
	Age  int
}

func (p Person) String() string {
	return fmt.Sprintf("%v (%v years)", p.Name, p.Age)
}

func main() {
	a := Person{"Arthur Dent", 42}
	fmt.Println(a) // Arthur Dent (42 years)
    // 如果註釋掉 String() 方法，Println 結果為：即列印 {Arthur Dent 42}
}

練習：Stringer：https://tour.go-zh.org/methods/18

題目描述：通過讓 IPAddr 型別實現 fmt.Stringer 來列印點號分隔的地址。

例如，IPAddr{1, 2, 3, 4} 應當列印為 "1.2.3.4"。

package main

import "fmt"

type IPAddr [4]byte

// TODO: 給 IPAddr 新增一個 "String() string" 方法

func (ip IPAddr) String() string { // 因為型別是 [4]byte，所以可以直接按照序號 0-3
	return fmt.Sprintf("%v.%v.%v.%v", ip[0], ip[1], ip[2], ip[3])
}

func main() {
	hosts := map[string]IPAddr{
		"loopback":  {127, 0, 0, 1},
		"googleDNS": {8, 8, 8, 8},
	}
	for name, ip := range hosts {
		fmt.Printf("%v: %v\n", name, ip)
	}
}

錯誤：Go 程式使用 error 值來表示錯誤狀態。

與 fmt.Stringer 類似，error 型別是一個內建介面：

type error interface {
    Error() string
}

（與 fmt.Stringer 類似，fmt 包在列印值時也會滿足 error。）

通常函式會返回一個 error 值，呼叫的它的程式碼應當判斷這個錯誤是否等於 nil 來進行錯誤處理。

i, err := strconv.Atoi("42")
if err != nil {
    fmt.Printf("couldn't convert number: %v\n", err)
    return
}
fmt.Println("Converted integer:", i)

error 為 nil 時表示成功；非 nil 的 error 表示失敗。

練習：錯誤 https://tour.go-zh.org/methods/20

題目描述：從之前的練習中複製 Sqrt 函式，修改它使其返回 error 值。

Sqrt 接受到一個負數時，應當返回一個非 nil 的錯誤值。複數同樣也不被支援。

建立一個新的型別

type ErrNegativeSqrt float64

併為其實現

func (e ErrNegativeSqrt) Error() string

方法使其擁有 error 值，通過 ErrNegativeSqrt(-2).Error() 呼叫該方法應返回 "cannot Sqrt negative number: -2"。

注意: 在 Error 方法內呼叫 fmt.Sprint(e) 會讓程式陷入死迴圈。可以通過先轉換 e 來避免這個問題：fmt.Sprint(float64(e))。這是為什麼呢？

修改 Sqrt 函式，使其接受一個負數時，返回 ErrNegativeSqrt 值。

package main

import (
	"fmt"
)

type ErrNegativeSqrt float64 // 建立一個新型別

func (e ErrNegativeSqrt) Error() string { // 為新型別實現方法，名Error()，返回string
	return fmt.Sprintf("cannot Sqrt negative number: %v", float64(e))
}

func Sqrt(x float64) (float64, error) {
	if x < 0 {
		return 0, ErrNegativeSqrt(x)
	}
	z := 1.0
	for i := 0; i < 10; i++{
		z -= (z*z - x) / (2*x)
	}
	return z, nil
}

func main() {
	fmt.Println(Sqrt(2))	// 1.4142103896495881 <nil>
	fmt.Println(Sqrt(-2))	// 0 cannot Sqrt negative number: -2
}

將 fmt.Sprint(float64(e)) 改為 fmt.Sprint(e)， 將會棧溢位：runtime: goroutine stack exceeds 250000000-byte limit fatal error: stack overflow

理解1：第一次執行 ErrNegativeSqrt 的 Error()函式，是由 main函式中的 fmt.Println(Sqrt(-2)) 觸發的。Sqrt(-2) 返回 error 為 ErrNegativeSqrt，在main中列印這個 error，就會執行 ErrNegativeSqrt 的 Error()函式。
然後在 Error()函式內部，執行 fmt.Sprintf("cannot Sqrt negative number: %v", e)，e為ErrNegativeSqrt ，所以，再一次列印 ErrNegativeSqrt，所以，還會呼叫 ErrNegativeSqrt 的 Error()函式。這樣就出現了死迴圈，直到呼叫棧溢位報錯。

理解2：fmt.Sprint(e) will call e.Error() to convert the value e to a string. If the Error() method calls fmt.Sprint(e), then the program recurses until out of memory. You can break the recursion by converting the e to a value without String or Error method.

Reader：io 包指定了 io.Reader 介面，它表示從資料流的末尾進行讀取。

Go 標準庫包含了該介面的許多實現，包括檔案、網路連線、壓縮和加密等等。

io.Reader 介面有一個 Read 方法：

func (T) Read(b []byte) (n int, err error) // 將資料填充到切片 b 中

Read 用資料填充給定的位元組切片並返回填充的位元組數和錯誤值。在遇到資料流的結尾時，它會返回一個 io.EOF 錯誤。

示例程式碼建立了一個 strings.Reader 並以每次 8 位元組的速度讀取它的輸出。

package main

import (
	"fmt"
	"io"
	"strings"
)

func main() {
	r := strings.NewReader("Hello, Reader!")

	b := make([]byte, 8) // 保證以每次 8 位元組的速度讀取它的輸出
	for {
		n, err := r.Read(b) // 返回填充的位元組數 n 和錯誤值 err
		fmt.Printf("n = %v err = %v b = %v\n", n, err, b)
		fmt.Printf("b[:n] = %q\n", b[:n]) // 迴圈賦值，每次把前 n 位覆蓋了
		if err == io.EOF { // 遇到資料流的結尾時，Read 會返回一個 io.EOF 錯誤賦值給 err。
			break
		}
	}
}

/* 
Results: 
n = 8 err = <nil> b = [72 101 108 108 111 44 32 82]
b[:n] = "Hello, R"
n = 6 err = <nil> b = [101 97 100 101 114 33 32 82]
b[:n] = "eader!"
n = 0 err = EOF b = [101 97 100 101 114 33 32 82]
b[:n] = ""
*/

練習：Reader https://tour.go-zh.org/methods/22

題目描述：實現一個 Reader 型別，它產生一個 ASCII 字元 'A' 的無限流。

package main

import "golang.org/x/tour/reader"

type MyReader struct{}

// TODO: 給 MyReader 新增一個 Read([]byte) (int, error) 方法
func (r MyReader) Read(buf []byte) (int, error) {
	for i := 0; i < len(buf); i++ {
		buf[i] = 'A'
	}
	return len(buf), nil // 由上面例子可以看出，返回填充的位元組數 n 和錯誤值 err = nil
}

func main() {
    reader.Validate(MyReader{}) // Result: OK! 即完成了題目要求
}

練習：rot13Reader https://tour.go-zh.org/methods/23

題目描述：有種常見的模式是一個 io.Reader 包裝另一個 io.Reader，然後通過某種方式修改其資料流。

例如，gzip.NewReader 函式接受一個 io.Reader（已壓縮的資料流）並返回一個同樣實現了 io.Reader 的 *gzip.Reader（解壓後的資料流）。

編寫一個實現了 io.Reader 並從另一個 io.Reader 中讀取資料的 rot13Reader，通過應用 rot13 代換密碼對資料流進行修改。

rot13Reader 型別已經提供。實現 Read 方法以滿足 io.Reader。

package main

import (
	"io"
	"os"
	"strings"
)

type rot13Reader struct {
	r io.Reader
}

// rot13代換程式碼：1. [a, n): A(a) +13 -> N(n); 2. [n, z]: N(n) - 13 -> A(a)
func (r13 rot13Reader) Read(buf []byte) (int, error) {
	inbuf := make([]byte, 128) // 建立一個 inbuf 來接收 r13 中 io.Reader 的輸入
	n, err := r13.r.Read(inbuf)
	if err != nil{ // 判斷是否已經讀完了 inbuf，讀完了就返回這個非nil 的 err
		return 0, err
	}
	for i:= 0; i < n; i++ { // 根據rot13代換密碼，將變換後值的賦值給 buf
		if (inbuf[i] >= 'A' && inbuf[i] < 'N') || (inbuf[i] >= 'a' && inbuf[i] < 'n') {
				buf[i] = inbuf[i] + 13
		}else if (inbuf[i] >= 'N' && inbuf[i] <= 'Z') || (inbuf[i] >= 'n' && inbuf[i] <= 'z') {
				buf[i] = inbuf[i] - 13
		}else { // Golang 裡的"else if" 和 "else" 必須緊貼上一個語句末尾的 "}"
			buf[i] = inbuf[i] // 不屬於英文字母的，不做替換
		}
	}
	return n, nil
}

func main() {
	s := strings.NewReader("Lbh penpxrq gur pbqr!")
	r := rot13Reader{s}
    io.Copy(os.Stdout, &r) // Result: You cracked the code!
}

影象：image 包定義了 Image 介面：

package image

type Image interface {
    ColorModel() color.Model
    Bounds() Rectangle
    At(x, y int) color.Color
}

注意: Bounds 方法的返回值 Rectangle 實際上是一個 image.Rectangle，它在 image 包中宣告。

（請參閱文件瞭解全部資訊。）

color.Color 和 color.Model 型別也是介面，但是通常因為直接使用預定義的實現 image.RGBA 和 image.RGBAModel 而被忽視了。這些介面和型別由 image/color 包定義。

m := image.NewRGBA(image.Rect(0, 0, 100, 100))
fmt.Println(m.Bounds())			// (0,0)-(100,100)
fmt.Println(m.At(0, 0).RGBA())	// 0 0 0 0

練習：影象 https://tour.go-zh.org/methods/25

題目描述：還記得之前編寫的圖片生成器 嗎？我們再來編寫另外一個，不過這次它將會返回一個 image.Image 的實現而非一個數據切片。

定義你自己的 Image 型別，實現必要的方法並呼叫 pic.ShowImage。

Bounds 應當返回一個 image.Rectangle ，例如 image.Rect(0, 0, w, h)。

ColorModel 應當返回 color.RGBAModel。

At 應當返回一個顏色。上一個圖片生成器的值 v 對應於此次的 color.RGBA{v, v, 255, 255}。

package main

import (
	"golang.org/x/tour/pic"
	"image"
	"image/color"
)
type Image struct{
	w int
	h int
}
/* 參考
type Image interface {
	ColorModel() color.Model
	Bounds() Rectangle
	At(x, y int) color.Color
}*/
func (self Image) ColorModel() color.Model {
	return color.RGBAModel
}

func (self Image) Bounds() image.Rectangle {
	return image.Rect(0, 0, self.w, self.h)
}

func (self Image) At(x int, y int) color.Color  {
	r := (uint8)((float64)(x) / (float64)(self.w) * 255.0)
	g := (uint8)((float64)(y) / (float64)(self.h) * 255.0)
	b := (uint8)((float64)(x * y) / (float64)(self.w * self.h) * 255.0) 
	return color.RGBA{r, g, b, 255}
}


func main() {
	m := Image{255, 255}
	pic.ShowImage(m)
}

結果：