共享狀態(tài)是比較容易理解和使用的,但是可能產(chǎn)生隱晦以至于很難追蹤的 bugs。尤其是在我們的數(shù)據(jù)結(jié)構(gòu)只有部分是通過引用傳遞的。切片就是這么一個很好的例子。后續(xù)我會作出更加詳細的講解。
在處理經(jīng)過多級變換或狀態(tài)的數(shù)據(jù)時,不可變數(shù)據(jù)結(jié)構(gòu)是非常有用的。不可變僅意味著原始結(jié)構(gòu)是不可以被改變的,而每一個新的結(jié)構(gòu)副本都是以新的屬性值創(chuàng)建。
讓我們看個簡單的例子:
type Person struct {
Name string
FavoriteColors []string
}
顯然,我們可以實例化一個Person然后隨心所欲地更改它的屬性。事實上,這樣做并沒有任何錯。但是,當你處理更加復雜的、傳遞引用和切片的嵌套式數(shù)據(jù)結(jié)構(gòu),或者利用通道傳遞副本時,以某些姿勢更改這些共享的數(shù)據(jù)副本可能會導致不易察覺的 bugs。
為啥我之前就沒有遇到過這種問題呢?
如果沒有重度使用 channel 或代碼基本是串行執(zhí)行的,由于從定義上講每次只有一個操作能夠作用在數(shù)據(jù)上,你不大可能會遇見這些不明顯的 bugs。
再者,除了避免 bugs外,不可變數(shù)據(jù)結(jié)構(gòu)還有其他優(yōu)勢:
- 由于狀態(tài)絕不會原地更新,這對一般的調(diào)試和記錄每個變換步驟以用于后續(xù)監(jiān)控是非常有用的
- 撤銷或“時光倒流”的能力不僅是可能的,而且是小菜一碟,只需一個賦值操作即可
- 由于正確且安全的實現(xiàn)需要損失性能和費盡心思地仔細設置/測試內(nèi)存鎖,共享狀態(tài)被廣泛認為是糟糕的做法
Getter 和 Wither
Getter 返回數(shù)據(jù),setter 改變數(shù)據(jù),wither 創(chuàng)建新狀態(tài)。
基于 getter 和 wither,我們可以精準控制能被改變的屬性。這也為我們提供了一種記錄變換的有效方式(后續(xù))。
新的代碼如下:
type Person struct {
name string
favoriteColors []string
}
func (p Person) WithName(name string) Person {
p.name = name
return p
}
func (p Person) Name() string {
return p.name
}
func (p Person) WithFavoriteColors(favoriteColors []string) Person {
p.favoriteColors = favoriteColors
return p
}
func (p Person) FavoriteColors() []string {
return p.favoriteColors
}
需要注意的關鍵點如下:
- Person 的屬性都是私有的,因此外部包無法繞過 Person 提供的方法來訪問其屬性
- Person 的方法接收的不是 *Person。這就保證了結(jié)構(gòu)通過值傳遞,返回的也是值
- 注意一下:我用了“With”而不是“Set”來表明重要的是返回值且原始對象并沒有像調(diào)用 setter 那樣被更改
- 對同一個包下的代碼來說,所有屬性依然是可訪問(也就可更改)的。我們絕不應該直接和屬性交互,而是在同一個包下也應一直堅持使用方法
- 每個 wither 返回的都是 Person,所以他們是可串聯(lián)的
me := Person{}.
WithName("Elliot").
WithFavoriteColors([]string{"black", "blue"})
fmt.Printf("%+#v\n", me)
// main.Person{name:"Elliot", favoriteColors:[]string{"black", "blue"}}
處理切片
目前為止仍然不是完美的,因為對于最愛顏色我們返回的是切片。由于切片通過引用傳遞,我們來看看這么一個稍不留神就會忽略的 bug:
func updateFavoriteColors(p Person) Person {
colors := p.FavoriteColors()
colors[0] = "red"
return p
}
func main() {
me := Person{}.
WithName("Elliot").
WithFavoriteColors([]string{"black", "blue"})
me2 := updateFavoriteColors(me)
fmt.Printf("%+#v\n", me)
fmt.Printf("%+#v\n", me2)
}
// main.Person{name:"Elliot", favoriteColors:[]string{"red", "blue"}}
// main.Person{name:"Elliot", favoriteColors:[]string{"red", "blue"}}
我們想要改變第一種顏色,但是連帶地改變了 me 變量。因為在復雜應用程序中這不會導致代碼無法運行,試圖搜尋出這么個變化是相當煩人和耗時的。
解決方法之一是確保我們絕不通過索引賦值,而是永遠都是分配一個新的切片:
func updateFavoriteColors(p Person) Person {
return p.WithFavoriteColors(append([]string{"red"}, p.FavoriteColors()[1:]...))
}
// main.Person{name:"Elliot", favoriteColors:[]string{"black", "blue"}}
// main.Person{name:"Elliot", favoriteColors:[]string{"red", "blue"}}
在我看來,這有點拙而且容易出錯。更好的方式是一開始就不返回切片。拓展我們的 getter 和 wither 來僅對元素操作(而不是整個切片):
func (p Person) NumFavoriteColors() int {
return len(p.favoriteColors)
}
func (p Person) FavoriteColorAt(i int) string {
return p.favoriteColors[i]
}
func (p Person) WithFavoriteColorAt(i int, favoriteColor string) Person {
p.favoriteColors = append(p.favoriteColors[:i],
append([]string{favoriteColor}, p.favoriteColors[i+1:]...)...)
return p
}
譯者注:上述代碼是錯誤的,如果p.favoriteColors的容量大于i則會就地改變副本的favoriteColors,參見反例,稍作調(diào)整即可得到正確實現(xiàn)
現(xiàn)在我們就可以放心使用:
func updateFavoriteColors(p Person) Person {
return p.WithFavoriteColorAt(0, "red")
}
想要了解更多切片的妙用參見這篇牛逼的wiki:https://github.com/golang/go/wiki/SliceTricks
構(gòu)造函數(shù)
某些情況下,我們會假設結(jié)構(gòu)體的默認值是合理的。但是,強烈建議總是創(chuàng)建構(gòu)造函數(shù),一旦將來需要改變默認值時,我們只需要改動一個地方:
func NewPerson() Person {
return Person{}
}
你可以隨心所欲地實例化 Person,但個人偏愛總是通過 setter 來執(zhí)行狀態(tài)變換從而保持代碼一致性:
func NewPerson() Person {
return Person{}.
WithName("No Name")
}
接口 (Interface)
到現(xiàn)在為止,我們使用的還是公有的結(jié)構(gòu)體。任由這些結(jié)構(gòu)體方法擺布之下,加上創(chuàng)建 mock 可能會引發(fā)非預期的副作用,測試起來會很痛苦。
我們可以創(chuàng)建一個同名的接口,并把相應的結(jié)構(gòu)體重命名為 person 使之私有化:
type Person interface {
WithName(name string) Person
Name() string
WithFavoriteColors(favoriteColors []string) Person
NumFavoriteColors() int
FavoriteColorAt(i int) string
WithFavoriteColorAt(i int, favoriteColor string) Person
}
type person struct {
name string
favoriteColors []string
}
我們現(xiàn)在就可以只重寫想要替換的邏輯來創(chuàng)建測試 mock:
type personMock struct {
Person
receivedNewColor string
}
func (m personMock) WithFavoriteColorAt(i int, favoriteColor string) Person {
m.receivedNewColor = favoriteColor
return m
}
測試代碼樣例如下:
mock := personMock{}
result := updateFavoriteColors(mock)
result.(personMock).receivedNewColor // "red"
記錄變化
如我早前所言,完整的狀態(tài)轉(zhuǎn)換非常有益于調(diào)試,而且我們可以 wither 來掛入鉤子的方式捕捉到所有或部分變換過程:
func (p person) nextState() Person {
fmt.Printf("nextState: %#+v\n", p)
return p
}
func (p person) WithName(name string) Person {
p.name = name
return p.nextState() // - Use "nextState" whenever you return.
}
對于更加復雜的邏輯或個人偏好,你也可以采用 defer 的方式:
func (p person) WithFavoriteColors(favoriteColors []string) Person {
defer func() {
p.nextState()
}()
p.favoriteColors = favoriteColors
return p
}
這樣變換就可看到了:
nextState: main.person{name:"No Name", favoriteColors:[]string(nil)}
nextState: main.person{name:"Elliot", favoriteColors:[]string(nil)}
nextState: main.person{name:"Elliot", favoriteColors:[]string{"black", "blue"}}
你可以添加更多諸如此類的信息。例如,時間戳、棧追蹤記錄和其他自定義的上下文信息來使得調(diào)試更加容易。
歷史及回滾
除了打印變化之外,我們還可以收集這些狀態(tài)作為歷史:
type Person interface {
// ...
AtVersion(version int) Person
}
type person struct {
// ...
history []person
}
func (p *person) nextState() Person {
p.history = append(p.history, *p)
return *p
}
func (p person) AtVersion(version int) Person {
return p.history[version]
}
func main() {
me := NewPerson().
WithName("Elliot").
WithFavoriteColors([]string{"black", "blue"})
// We discard the result, but it will be put into the history.
updateFavoriteColors(me)
fmt.Printf("%s\n", me.AtVersion(0).Name())
fmt.Printf("%s\n", me.AtVersion(1).Name())
}
// No Name
// Elliot
這非常利于最后進行審查。記錄所有日志打印的歷史對處理后續(xù)異常的場景也是很有用的,如果不需要的話,讓歷史隨實例消亡即可。
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
您可能感興趣的文章:- Golang中數(shù)據(jù)結(jié)構(gòu)Queue的實現(xiàn)方法詳解
- 使用go實現(xiàn)常見的數(shù)據(jù)結(jié)構(gòu)
- Go語言模型:string的底層數(shù)據(jù)結(jié)構(gòu)與高效操作詳解
- 淺析go中的map數(shù)據(jù)結(jié)構(gòu)字典
- golang數(shù)據(jù)結(jié)構(gòu)之golang稀疏數(shù)組sparsearray詳解