Go 語言 基于指針對(duì)象的方法

原文鏈接：https://gopl-zh.github.io/ch6/ch6-02.html

6.2. 基于指針對(duì)象的方法

當(dāng)調(diào)用一個(gè)函數(shù)時(shí)，會(huì)對(duì)其每一個(gè)參數(shù)值進(jìn)行拷貝，如果一個(gè)函數(shù)需要更新一個(gè)變量，或者函數(shù)的其中一個(gè)參數(shù)實(shí)在太大我們希望能夠避免進(jìn)行這種默認(rèn)的拷貝，這種情況下我們就需要用到指針了。對(duì)應(yīng)到我們這里用來更新接收器的對(duì)象的方法，當(dāng)這個(gè)接受者變量本身比較大時(shí)，我們就可以用其指針而不是對(duì)象來聲明方法，如下：

func (p *Point) ScaleBy(factor float64) {
    p.X *= factor
    p.Y *= factor
}

這個(gè)方法的名字是(*Point).ScaleBy。這里的括號(hào)是必須的；沒有括號(hào)的話這個(gè)表達(dá)式可能會(huì)被理解為*(Point.ScaleBy)。

在現(xiàn)實(shí)的程序里，一般會(huì)約定如果Point這個(gè)類有一個(gè)指針作為接收器的方法，那么所有Point的方法都必須有一個(gè)指針接收器，即使是那些并不需要這個(gè)指針接收器的函數(shù)。我們?cè)谶@里打破了這個(gè)約定只是為了展示一下兩種方法的異同而已。

只有類型（Point）和指向他們的指針(*Point)，才可能是出現(xiàn)在接收器聲明里的兩種接收器。此外，為了避免歧義，在聲明方法時(shí)，如果一個(gè)類型名本身是一個(gè)指針的話，是不允許其出現(xiàn)在接收器中的，比如下面這個(gè)例子：

type P *int
func (P) f() { /* ... */ } // compile error: invalid receiver type

想要調(diào)用指針類型方法(*Point).ScaleBy，只要提供一個(gè)Point類型的指針即可，像下面這樣。

r := &Point{1, 2}
r.ScaleBy(2)
fmt.Println(*r) // "{2, 4}"

或者這樣：

p := Point{1, 2}
pptr := &p
pptr.ScaleBy(2)
fmt.Println(p) // "{2, 4}"

或者這樣:

p := Point{1, 2}
(&p).ScaleBy(2)
fmt.Println(p) // "{2, 4}"

不過后面兩種方法有些笨拙。幸運(yùn)的是，go語言本身在這種地方會(huì)幫到我們。如果接收器p是一個(gè)Point類型的變量，并且其方法需要一個(gè)Point指針作為接收器，我們可以用下面這種簡(jiǎn)短的寫法：

p.ScaleBy(2)

編譯器會(huì)隱式地幫我們用&p去調(diào)用ScaleBy這個(gè)方法。這種簡(jiǎn)寫方法只適用于“變量”，包括struct里的字段比如p.X，以及array和slice內(nèi)的元素比如perim[0]。我們不能通過一個(gè)無法取到地址的接收器來調(diào)用指針方法，比如臨時(shí)變量的內(nèi)存地址就無法獲取得到：

Point{1, 2}.ScaleBy(2) // compile error: can't take address of Point literal

但是我們可以用一個(gè)*Point這樣的接收器來調(diào)用Point的方法，因?yàn)槲覀兛梢酝ㄟ^地址來找到這個(gè)變量，只要用解引用符號(hào)*來取到該變量即可。編譯器在這里也會(huì)給我們隱式地插入*這個(gè)操作符，所以下面這兩種寫法等價(jià)的：

pptr.Distance(q)
(*pptr).Distance(q)

這里的幾個(gè)例子可能讓你有些困惑，所以我們總結(jié)一下：在每一個(gè)合法的方法調(diào)用表達(dá)式中，也就是下面三種情況里的任意一種情況都是可以的：

要么接收器的實(shí)際參數(shù)和其形式參數(shù)是相同的類型，比如兩者都是類型T或者都是類型*T：

Point{1, 2}.Distance(q) //  Point
pptr.ScaleBy(2)         // *Point

或者接收器實(shí)參是類型T，但接收器形參是類型*T，這種情況下編譯器會(huì)隱式地為我們?nèi)∽兞康牡刂罚?

p.ScaleBy(2) // implicit (&p)

或者接收器實(shí)參是類型*T，形參是類型T。編譯器會(huì)隱式地為我們解引用，取到指針指向的實(shí)際變量：

pptr.Distance(q) // implicit (*pptr)

如果命名類型T（譯注：用type xxx定義的類型）的所有方法都是用T類型自己來做接收器（而不是*T），那么拷貝這種類型的實(shí)例就是安全的；調(diào)用他的任何一個(gè)方法也就會(huì)產(chǎn)生一個(gè)值的拷貝。比如time.Duration的這個(gè)類型，在調(diào)用其方法時(shí)就會(huì)被全部拷貝一份，包括在作為參數(shù)傳入函數(shù)的時(shí)候。但是如果一個(gè)方法使用指針作為接收器，你需要避免對(duì)其進(jìn)行拷貝，因?yàn)檫@樣可能會(huì)破壞掉該類型內(nèi)部的不變性。比如你對(duì)bytes.Buffer對(duì)象進(jìn)行了拷貝，那么可能會(huì)引起原始對(duì)象和拷貝對(duì)象只是別名而已，實(shí)際上它們指向的對(duì)象是一樣的。緊接著對(duì)拷貝后的變量進(jìn)行修改可能會(huì)有讓你有意外的結(jié)果。

譯注： 作者這里說的比較繞，其實(shí)有兩點(diǎn)：

1. 不管你的method的receiver是指針類型還是非指針類型，都是可以通過指針/非指針類型進(jìn)行調(diào)用的，編譯器會(huì)幫你做類型轉(zhuǎn)換。
2. 在聲明一個(gè)method的receiver該是指針還是非指針類型時(shí)，你需要考慮兩方面的因素，第一方面是這個(gè)對(duì)象本身是不是特別大，如果聲明為非指針變量時(shí)，調(diào)用會(huì)產(chǎn)生一次拷貝；第二方面是如果你用指針類型作為receiver，那么你一定要注意，這種指針類型指向的始終是一塊內(nèi)存地址，就算你對(duì)其進(jìn)行了拷貝。熟悉C或者C++的人這里應(yīng)該很快能明白。

6.2.1. Nil也是一個(gè)合法的接收器類型

就像一些函數(shù)允許nil指針作為參數(shù)一樣，方法理論上也可以用nil指針作為其接收器，尤其當(dāng)nil對(duì)于對(duì)象來說是合法的零值時(shí)，比如map或者slice。在下面的簡(jiǎn)單int鏈表的例子里，nil代表的是空鏈表：

// An IntList is a linked list of integers.
// A nil *IntList represents the empty list.
type IntList struct {
    Value int
    Tail  *IntList
}
// Sum returns the sum of the list elements.
func (list *IntList) Sum() int {
    if list == nil {
        return 0
    }
    return list.Value + list.Tail.Sum()
}

當(dāng)你定義一個(gè)允許nil作為接收器值的方法的類型時(shí)，在類型前面的注釋中指出nil變量代表的意義是很有必要的，就像我們上面例子里做的這樣。

下面是net/url包里Values類型定義的一部分。

net/url

package url

// Values maps a string key to a list of values.
type Values map[string][]string
// Get returns the first value associated with the given key,
// or "" if there are none.
func (v Values) Get(key string) string {
    if vs := v[key]; len(vs) > 0 {
        return vs[0]
    }
    return ""
}
// Add adds the value to key.
// It appends to any existing values associated with key.
func (v Values) Add(key, value string) {
    v[key] = append(v[key], value)
}

這個(gè)定義向外部暴露了一個(gè)map的命名類型，并且提供了一些能夠簡(jiǎn)單操作這個(gè)map的方法。這個(gè)map的value字段是一個(gè)string的slice，所以這個(gè)Values是一個(gè)多維map?？蛻舳耸褂眠@個(gè)變量的時(shí)候可以使用map固有的一些操作（make，切片，m[key]等等），也可以使用這里提供的操作方法，或者兩者并用，都是可以的：

gopl.io/ch6/urlvalues

m := url.Values{"lang": {"en"}} // direct construction
m.Add("item", "1")
m.Add("item", "2")

fmt.Println(m.Get("lang")) // "en"
fmt.Println(m.Get("q"))    // ""
fmt.Println(m.Get("item")) // "1"      (first value)
fmt.Println(m["item"])     // "[1 2]"  (direct map access)

m = nil
fmt.Println(m.Get("item")) // ""
m.Add("item", "3")         // panic: assignment to entry in nil map

對(duì)Get的最后一次調(diào)用中，nil接收器的行為即是一個(gè)空map的行為。我們可以等價(jià)地將這個(gè)操作寫成Value(nil).Get("item")，但是如果你直接寫nil.Get("item")的話是無法通過編譯的，因?yàn)閚il的字面量編譯器無法判斷其準(zhǔn)確類型。所以相比之下，最后的那行m.Add的調(diào)用就會(huì)產(chǎn)生一個(gè)panic，因?yàn)樗麌L試更新一個(gè)空map。

由于url.Values是一個(gè)map類型，并且間接引用了其key/value對(duì)，因此url.Values.Add對(duì)這個(gè)map里的元素做任何的更新、刪除操作對(duì)調(diào)用方都是可見的。實(shí)際上，就像在普通函數(shù)中一樣，雖然可以通過引用來操作內(nèi)部值，但在方法想要修改引用本身時(shí)是不會(huì)影響原始值的，比如把他置換為nil，或者讓這個(gè)引用指向了其它的對(duì)象，調(diào)用方都不會(huì)受影響。（譯注：因?yàn)閭魅氲氖谴鎯?chǔ)了內(nèi)存地址的變量，你改變這個(gè)變量本身是影響不了原始的變量的，想想C語言，是差不多的）