gopl-zh.github.com/ch10/ch10-06.md

47 lines
2.9 KiB
Markdown
Raw Normal View History

2015-12-09 07:45:11 +00:00
## 10.6. 包和命名
2016-01-08 08:07:44 +00:00
在本節中我們將提供一些關於Go語言獨特的包和成員命名的約定。
2015-12-09 07:45:11 +00:00
2016-01-08 08:07:44 +00:00
當創建一個包一般要用短小的包名但也不能太短導致難以理解。標準庫中最常用的包有bufio、bytes、flag、fmt、http、io、json、os、sort、sync和time等包。
2015-12-09 07:45:11 +00:00
2016-01-08 08:07:44 +00:00
它們的名字都簡潔明了。例如不要將一個類似imageutil或ioutilis的通用包命名爲util雖然它看起來很短小。要盡量避免包名使用可能被經常用於局部變量的名字這樣可能導致用戶重命名導入包例如前面看到的path包。
2015-12-09 07:45:11 +00:00
2016-01-08 08:07:44 +00:00
包名一般采用單數的形式。標準庫的bytes、errors和strings使用了複數形式這是爲了避免和預定義的類型衝突同樣還有go/types是爲了避免和type關鍵字衝突。
2015-12-09 07:45:11 +00:00
2016-01-08 08:07:44 +00:00
要避免包名有其它的含義。例如2.5節中我們的溫度轉換包最初使用了temp包名雖然併沒有持續多久。但這是一個糟糕的嚐試因爲temp幾乎是臨時變量的同義詞。然後我們有一段時間使用了temperature作爲包名雖然名字併沒有表達包的眞實用途。最後我們改成了和strconv標準包類似的tempconv包名這個名字比之前的就好多了。
2015-12-09 07:45:11 +00:00
2016-01-08 08:07:44 +00:00
現在讓我們看看如何命名包的成員。由於是通過包的導入名字引入包里面的成員例如fmt.Println同時包含了包名和成員名信息。因此我們一般併不需要關註Println的具體內容因爲fmt包名已經包含了這個信息。當設計一個包的時候需要考慮包名和成員名兩個部分如何很好地配合。下面有一些例子
2015-12-09 07:45:11 +00:00
```
bytes.Equal flag.Int http.Get json.Marshal
```
2016-01-08 08:07:44 +00:00
我們可以看到一些常用的命名模式。strings包提供了和字符串相關的諸多操作
2015-12-09 07:45:11 +00:00
```Go
package strings
func Index(needle, haystack string) int
type Replacer struct{ /* ... */ }
func NewReplacer(oldnew ...string) *Replacer
type Reader struct{ /* ... */ }
func NewReader(s string) *Reader
```
2016-01-08 08:07:44 +00:00
字符串string本身併沒有出現在每個成員名字中。因爲用戶會這樣引用這些成員strings.Index、strings.Replacer等。
2015-12-09 07:45:11 +00:00
2016-01-08 08:07:44 +00:00
其它一些包可能隻描述了單一的數據類型例如html/template和math/rand等隻暴露一個主要的數據結構和與它相關的方法還有一個以New命名的函數用於創建實例。
2015-12-09 07:45:11 +00:00
```Go
package rand // "math/rand"
type Rand struct{ /* ... */ }
func New(source Source) *Rand
```
2016-01-08 08:07:44 +00:00
這可能導致一些名字重複例如template.Template或rand.Rand這就是爲什麽這些種類的包名往往特别短的原因之一。
2015-12-09 07:45:11 +00:00
2016-01-08 08:07:44 +00:00
在另一個極端還有像net/http包那樣含有非常多的名字和種類不多的數據類型因爲它們都是要執行一個複雜的複合任務。盡管有將近二十種類型和更多的函數但是包中最重要的成員名字卻是簡單明了的Get、Post、Handle、Error、Client、Server等。