Go基礎系列：struct的匯出和暴露問題

標籤：如何   tin   sync   func   ack   package   構造   ret   基礎   

struct的匯出和暴露問題關於struct的匯出

struct的屬性是否被匯出，也遵循大小寫原則：首字母大寫的被匯出，首字母小寫不被匯出。

所以：

1. 如果struct名稱首字母是小寫，這個struct不會被匯出。連同它裡面的欄位也不會匯出，即使有首字母大寫的欄位名。
   
2. 如果struct名稱首字母大寫，則struct會被匯出，但只會匯出它內部首字母大寫的欄位，那些小寫首字母的欄位不會被匯出。

也就是說，struct的匯出情況是混合的。

但並非絕對如此，如果struct嵌套了，那麼即使被嵌套在內部的struct名稱首字母小寫，也能訪問到它裡面首字母大寫的欄位。

例如：

type animal struct{    name string    Speak string}type Horse struct {    animal    sound string}

Horse中嵌套的animal是小寫字母開頭的，但Horse是能被匯出的，所以能在其它包中使用Horse struct，其他包也能訪問到animal中的Speak屬性。

很多時候，Horse這個名字是不安全的，因為這表示匯出Horse這個struct給其他包，也就是將Horse給暴露出去了，外界可以直接開啟Horse這個"黑匣子"。

但如果不將Horse匯出，如何能在其它包構建出Horse執行個體？見下文。

不要暴露struct

很多時候，不應該將某包(如包abc)中的struct(如animal)直接暴露給其它包，暴露意味著開啟了那個"黑匣子"，所以struct會以小寫字母開頭，不將其匯出。

這時在外界其它包中構建包abc的animal，就沒法直接通過以下幾種方式實現：

• var xxx abc.animal
• new(abc.animal)
  
• &abc.animal{...}
  
• abc.animal{...}

例如，下面的是錯誤的：

// abc/abc.go檔案內容：package abctype animal struct{    name string    Speak string}// test.go內容：package mainimport "./abc"func main() {    // 全都錯誤    var t1 abc.animal    t2 := new(abc.animal)    t3 := &abc.animal{}    t4 := abc.animal{}}

那麼如何在外界構建隱藏起來的struct執行個體？這時可以在abc包中寫一個可匯出的函數，通過這個函數來構建struct執行個體。例如：

// abc/abc.go檔案內容：package abctype animal struct{    name string    Speak string}func NewAnimal() *animal{    a := new(animal)    return a}// test.go內容：package mainimport (    "fmt"    "./abc")func main() {    t1 := abc.NewAnimal()//  t1.name = "haha"    // 無法訪問name屬性    t1.Speak = "hhhh"    fmt.Println(t1.Speak)}

上面的代碼一切正常，在main包中可以通過NewAnimal()構建出abc包中未匯出的animal struct。注意，上面NewAnimal()中是使用new()函數構造執行個體的，它返回的是執行個體的指標，至於如何構造執行個體，完全可以根據自己的需求，但對於struct類型來說，一般都是使用指標的，也就是完全可以將new()通用化。

由於animal中的name欄位是不匯出的欄位，所以在外界即便是通過NewAnimal()構建出了animal執行個體，也無法訪問該執行個體的name屬性，所以沒法為name欄位賦值。換句話說，name屬性永遠是初始化的0值。

因此，為了讓構建執行個體時自訂name屬性，需要在構造方法NewAnimal()上指定設定給name屬性的參數。修改NewAnimal()函數：

func NewAnimal(name string) *animal{    a := new(animal)    a.name = name    return a}

然後在其它包中構建animal執行個體：

t1 := abc.NewAnimal("longshuai")

雖然其它包中構建的animal執行個體已經具備了name屬性，但還是無法訪問該執行個體的name屬性。所以，在abc包中繼續寫一個可匯出的方法，該方法用於擷取執行個體的name屬性：

// abc/abc.go中添加：func (a *animal) GetName() string {    return a.name}

於是外界包中可以通過這個匯出的方法擷取執行個體的name屬性：

t1 := abc.NewAnimal("longshuai")fmt.Println(abc.GetName())

實際上，上面NewAnimal()構造對象時，可以不用傳遞name參數，而是像GetName()一樣，寫一個專門的可匯出方法來設定執行個體的name屬性。改寫abc/abc.go中的代碼：

func NewAnimal() *animal{    a := new(animal)    return a}func (a *animal) SetName(name string){    a.name = name}

現在，abc/abc.go中的animal struct就完全對外隱藏了。

但需要注意的是，上面的setter類方法SetName()不能同時被2個或多個線程修改，否則值被覆蓋，出現安全執行緒問題，可以使用sync包或者goroutine和channel來解決這個問題。

嵌套struct中的方法匯出問題

當內部struct嵌套進外部struct時，內部struct的方法也會被嵌套，也就是說外部struct擁有了內部struct的方法。

但是需要注意方法的首字母大小寫問題。由於內、外struct在同一包內，所以直接在該包內構建外部struct執行個體，外部struct執行個體是可以直接存取內部struct的所有方法的。但如果在其它包內構建外部struct執行個體，該執行個體將無法訪問內部struct中首字母小寫方法。

以下是在同一個包內測試，外部執行個體可以直接調用內部struct的方法：

package mainimport (    "fmt")type person struct {    name string    age  int}// 未匯出方法func (p *person) speak() {    fmt.Println("speak in person")}// 匯出的方法func (p *person) Sing() {    fmt.Println("Sing in person")}// Admin exportedtype Admin struct {    person    salary int}func main() {    a := new(Admin)    a.speak()  // 正常輸出    a.Sing()   // 正常輸出}

執行結果時a.speak()和a.Sing()都正常輸出。

以下是不同包內測試，struct定義在abc/abc.go檔案中，main在test.go中，它們的目錄結構如下：

$ tree ..├── abc│   └── abc.go├── test.go

abc/abc.go的內容為：

package abcimport "fmt"// 未匯出的persontype person struct {    name string    age  int}// 未匯出的方法func (p *person) speak() {    fmt.Println("speak in person")}// 匯出的方法func (p *person) Sing() {    fmt.Println("Sing in person")}// Admin exportedtype Admin struct {    person    salary int}

test.go的內容為：

package mainimport "./abc"func main() {    a := new(abc.Admin)    // 下面報錯//  a.speak()    // 下面正常    a.Sing()}

執行結果是，a.speak()報錯，但a.Sing()正常。

Go基礎系列：struct的匯出和暴露問題