淺談用Go構建不可變的數據結構的方法

 更新時間:2020-01-15 16:01:44   作者:佚名   我要評論(0)

共享狀態是比較容易理解和使用的,但是可能產生隱晦以至于很難追蹤的 bugs。尤其是在我們的數據結構只有部分是通過引用傳遞的。切片就是這么一個很好的例子。后續我

共享狀態是比較容易理解和使用的,但是可能產生隱晦以至于很難追蹤的 bugs。尤其是在我們的數據結構只有部分是通過引用傳遞的。切片就是這么一個很好的例子。后續我會作出更加詳細的講解。

在處理經過多級變換或狀態的數據時,不可變數據結構是非常有用的。不可變僅意味著原始結構是不可以被改變的,而每一個新的結構副本都是以新的屬性值創建。

讓我們看個簡單的例子:

type Person struct {
  Name      string
  FavoriteColors []string
}

顯然,我們可以實例化一個Person然后隨心所欲地更改它的屬性。事實上,這樣做并沒有任何錯。但是,當你處理更加復雜的、傳遞引用和切片的嵌套式數據結構,或者利用通道傳遞副本時,以某些姿勢更改這些共享的數據副本可能會導致不易察覺的 bugs。

為啥我之前就沒有遇到過這種問題呢?

如果沒有重度使用 channel 或代碼基本是串行執行的,由于從定義上講每次只有一個操作能夠作用在數據上,你不大可能會遇見這些不明顯的 bugs。

再者,除了避免 bugs外,不可變數據結構還有其他優勢:

  1. 由于狀態絕不會原地更新,這對一般的調試和記錄每個變換步驟以用于后續監控是非常有用的
  2. 撤銷或“時光倒流”的能力不僅是可能的,而且是小菜一碟,只需一個賦值操作即可
  3. 由于正確且安全的實現需要損失性能和費盡心思地仔細設置/測試內存鎖,共享狀態被廣泛認為是糟糕的做法

Getter 和 Wither

Getter 返回數據,setter 改變數據,wither 創建新狀態。

基于 getter 和 wither,我們可以精準控制能被改變的屬性。這也為我們提供了一種記錄變換的有效方式(后續)。

新的代碼如下:

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
}

需要注意的關鍵點如下:

  1. Person 的屬性都是私有的,因此外部包無法繞過 Person 提供的方法來訪問其屬性
  2. Person 的方法接收的不是 *Person。這就保證了結構通過值傳遞,返回的也是值
  3. 注意一下:我用了“With”而不是“Set”來表明重要的是返回值且原始對象并沒有像調用 setter 那樣被更改
  4. 對同一個包下的代碼來說,所有屬性依然是可訪問(也就可更改)的。我們絕不應該直接和屬性交互,而是在同一個包下也應一直堅持使用方法
  5. 每個 wither 返回的都是 Person,所以他們是可串聯的
 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,參見反例,稍作調整即可得到正確實現

現在我們就可以放心使用:

func updateFavoriteColors(p Person) Person {
  return p.WithFavoriteColorAt(0, "red")
}

想要了解更多切片的妙用參見這篇牛逼的wiki:https://github.com/golang/go/wiki/SliceTricks

構造函數

某些情況下,我們會假設結構體的默認值是合理的。但是,強烈建議總是創建構造函數,一旦將來需要改變默認值時,我們只需要改動一個地方:

func NewPerson() Person {
  return Person{}
}

你可以隨心所欲地實例化 Person,但個人偏愛總是通過 setter 來執行狀態變換從而保持代碼一致性:

func NewPerson() Person {
  return Person{}.
    WithName("No Name")
}

接口 (Interface)

到現在為止,我們使用的還是公有的結構體。任由這些結構體方法擺布之下,加上創建 mock 可能會引發非預期的副作用,測試起來會很痛苦。

我們可以創建一個同名的接口,并把相應的結構體重命名為 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
}

我們現在就可以只重寫想要替換的邏輯來創建測試 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"

記錄變化

如我早前所言,完整的狀態轉換非常有益于調試,而且我們可以 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"}}

你可以添加更多諸如此類的信息。例如,時間戳、棧追蹤記錄和其他自定義的上下文信息來使得調試更加容易。

歷史及回滾

除了打印變化之外,我們還可以收集這些狀態作為歷史:

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

這非常利于最后進行審查。記錄所有日志打印的歷史對處理后續異常的場景也是很有用的,如果不需要的話,讓歷史隨實例消亡即可。

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。

您可能感興趣的文章:

  • Golang中數據結構Queue的實現方法詳解

相關文章

  • 淺談用Go構建不可變的數據結構的方法

    淺談用Go構建不可變的數據結構的方法

    共享狀態是比較容易理解和使用的,但是可能產生隱晦以至于很難追蹤的 bugs。尤其是在我們的數據結構只有部分是通過引用傳遞的。切片就是這么一個很好的例子。后續我
    2020-01-15
  • Go 防止 goroutine 泄露的方法

    Go 防止 goroutine 泄露的方法

    概述 Go 的并發模型與其他語言不同,雖說它簡化了并發程序的開發難度,但如果不了解使用方法,常常會遇到 goroutine 泄露的問題。雖然 goroutine 是輕量級的線程,占
    2020-01-15
  • Go實現雙向鏈表的示例代碼

    Go實現雙向鏈表的示例代碼

    本文介紹什么是鏈表,常見的鏈表有哪些,然后介紹鏈表這種數據結構會在哪些地方可以用到,以及 Redis 隊列是底層的實現,通過一個小實例來演示 Redis 隊列有哪些功能
    2020-01-15
  • golang中之strconv包的具體使用方法

    golang中之strconv包的具體使用方法

    在編程過程中,我們常常需要用到字符串與其它類型的轉換,strconv包可以幫我們實現此功能。 1.string -> int 使用方法:func Atoi(s string) (i int, err error)
    2020-01-15
  • golang實現對docker容器心跳監控功能

    golang實現對docker容器心跳監控功能

    自己寫的go程序放到線上本來編譯成二進制扔上去就行啦,但是懷著一顆docker的心,最終還是將它放到docker容器中運行起來了,運行起來也ok,一個最小容器64M,統一管
    2020-01-15
  • golang之數據校驗的實現代碼示例

    golang之數據校驗的實現代碼示例

    目前大都是使用 validator 安裝 go get gopkg.in/go-playground/validator.v9 原理 當然只能通過反射來實現了,之前寫過一篇反射的文章 golang之反射和斷言
    2020-01-15
  • golang協程池設計詳解

    golang協程池設計詳解

    Why Pool go自從出生就身帶“高并發”的標簽,其并發編程就是由groutine實現的,因其消耗資源低,性能高效,開發成本低的特性而被廣泛應用到各種場景,例如服務端開
    2020-01-15
  • golang之反射和斷言的具體使用

    golang之反射和斷言的具體使用

    1. 反射 反射這個概念絕大多數語言都有,比如Java,PHP之類,golang自然也不例外,反射其實程序能夠自描述和自控制的一類機制。 比如,通過PHP的反射,你可以
    2020-01-15
  • golang中使用proto3協議導致的空值字段不顯示的問題處理方案

    golang中使用proto3協議導致的空值字段不顯示的問題處理方案

    最近在使用grpc協議的時候,由于采用的是Proto3協議,在查找記錄信息的時候,由于某些字段會有默認空值,導致在通過協議調用后,返回的json結構中并沒有這些字段,雖
    2020-01-15
  • 使用Go添加HTTPS的實現代碼示例

    使用Go添加HTTPS的實現代碼示例

    簡介 現在的網站沒有 HTTPS 都不好意思見人了. 超文本傳輸安全協議(英語:HyperText Transfer Protocol Secure,縮寫:HTTPS;常稱為 HTTP over TLS、HTTP over
    2020-01-15

最新評論

老快3投注技巧