你已經使用過 Go 語言編寫了小命令（或者說微型程序）嗎？

當你在編寫“Hello, world”的時候，一個源碼文件就足夠了，雖然這種小玩意兒沒什么用，最多能給你一點點莫名的成就感。如果你對這一點點并不滿足，別著急，跟著學，我肯定你也可以寫出很厲害的程序。

我們在上一篇的文章中學到了命令源碼文件的相關知識，那么除了命令源碼文件，你還能用 Go 語言編寫庫源碼文件。那么什么是庫源碼文件呢？

在我的定義中，庫源碼文件是不能被直接運行的源碼文件，它僅用于存放程序實體，這些程序實體可以被其他代碼使用（只要遵從 Go 語言規范的話）。

這里的“其他代碼”可以與被使用的程序實體在同一個源碼文件內，也可以在其他源碼文件，甚至其他代碼包中。

那么程序實體是什么呢？在 Go 語言中，程序實體是變量、常量、函數、結構體和接口的統稱。我們總是會先聲明（或者說定義）程序實體，然后再去使用。比如在上一篇的例子中，我們先定義了變量name，然后在main函數中調用fmt.Printf函數的時候用到了它。再多說一點，程序實體的名字被統稱為標識符。標識符可以是任何 Unicode 編碼可以表示的字母字符、數字以及下劃線“_”，但是其首字母不能是數字。從規則上說，我們可以用中文作為變量的名字。但是，我覺得這種命名方式非常不好，自己也會在開發團隊中明令禁止這種做法。作為一名合格的程序員，我們應該向著編寫國際水準的程序無限逼近。

回到正題。

我們今天的問題是：怎樣把命令源碼文件中的代碼拆分到其他庫源碼文件？

我們用代碼演示，把這個問題說得更具體一些。

如果在某個目錄下有一個命令源碼文件 demo4.go，如下：

package main
 
import (
 "flag"
)
 
var name string
 
func init() {
 flag.StringVar(name, "name", "everyone", "The greeting object.")
}
 
func main() {
 flag.Parse()
 hello(name)
}

其中的代碼你應該比較眼熟了。我在講命令源碼文件的時候貼過很相似的代碼，那個源碼文件名為 demo2.go。

這兩個文件的不同之處在于，demo2.go 直接通過調用fmt.Printf函數打印問候語，而當前的 demo4.go 在同樣位置調用了一個叫作hello的函數。

函數hello被聲明在了另外一個源碼文件中，我把它命名為 demo4_lib.go，并且放在與 demo4.go 相同的目錄下。如下：

// 需在此處添加代碼。[1]
 
import "fmt"
 
func hello(name string) {
 fmt.Printf("Hello, %s!\n", name)
}

那么問題來了：注釋 1 處應該填入什么代碼？

典型回答

答案很簡單，填入代碼包聲明語句package main。為什么？我之前說過，在同一個目錄下的源碼文件都需要被聲明為屬于同一個代碼包。

如果該目錄下有一個命令源碼文件，那么為了讓同在一個目錄下的文件都通過編譯，其他源碼文件應該也聲明屬于main包。

如此一來，我們就可以運行它們了。比如，我們可以在這些文件所在的目錄下運行如下命令并得到相應的結果。

$ go run demo4.go demo4_lib.go
Hello, everyone!

或者，像下面這樣先構建當前的代碼包再運行。

$ go build puzzlers/article3/q1
$ ./q1   
Hello, everyone!

在這里，我把 demo4.go 和 demo4_lib.go 都放在了一個相對路徑為puzzlers/article3/q1的目錄中。

在默認情況下，相應的代碼包的導入路徑會與此一致。我們可以通過代碼包的導入路徑引用其中聲明的程序實體。但是，這里的情況是不同的。

注意，demo4.go 和 demo4_lib.go 都聲明自己屬于main包。我在前面講 Go 語言源碼的組織方式的時候提到過這種用法，即：源碼文件聲明的包名可以與其所在目錄的名稱不同，只要這些文件聲明的包名一致就可以。

順便說一下，我為本專欄創建了一個名為“Golang_Puzzlers”的項目。該項目的 src 子目錄下會存有我們涉及的所有代碼和相關文件。

也就是說，正確的用法是，你需要把該項目的打包文件下載到本地的任意目錄下，然后經解壓縮后把“Golang_Puzzlers”目錄加入到環境變量GOPATH中。還記得嗎？這會使“Golang_Puzzlers”目錄成為工作區之一。

問題解析

這個問題考察的是代碼包聲明的基本規則。這里再總結一下。

第一條規則，同目錄下的源碼文件的代碼包聲明語句要一致。也就是說，它們要同屬于一個代碼包。這對于所有源碼文件都是適用的。

如果目錄中有命令源碼文件，那么其他種類的源碼文件也應該聲明屬于main包。這也是我們能夠成功構建和運行它們的前提。

第二條規則，源碼文件聲明的代碼包的名稱可以與其所在的目錄的名稱不同。在針對代碼包進行構建時，生成的結果文件的主名稱與其父目錄的名稱一致。

對于命令源碼文件而言，構建生成的可執行文件的主名稱會與其父目錄的名稱相同，這在我前面的回答中也驗證過了。

好了，經過我的反復強調，相信你已經記住這些規則了。下面的內容也將會與它們相關。

在編寫真正的程序時，我們僅僅把代碼拆分到幾個源碼文件中是不夠的。我們往往會用模塊化編程的方式，根據代碼的功能和用途把它們放置到不同的代碼包中。不過，這又會牽扯進一些 Go 語言的代碼組織規則。我們一起來往下看。

知識精講

1. 怎樣把命令源碼文件中的代碼拆分到其他代碼包？

我們先不用關注拆分代碼的技巧。我在這里仍然依從前面的拆分方法。我把 demo4.go 另存為 demo5.go，并放到一個相對路徑為puzzlers/article3/q2的目錄中。

然后我再創建一個相對路徑為puzzlers/article3/q2/lib的目錄，再把 demo4_lib.go 復制一份并改名為 demo5_lib.go 放到該目錄中。

現在，為了讓它們通過編譯，我們應該怎樣修改代碼？你可以先思考一下。我在這里給出一部分答案，我們一起來看看已經過修改的 demo5_lib.go 文件。

package lib5
 
import "fmt"
 
func Hello(name string) {
 fmt.Printf("Hello, %s!\n", name)
}

可以看到，我在這里修改了兩個地方。第一個改動是，我把代碼包聲明語句由package main改為了package lib5。注意，我故意讓聲明的包名與其所在的目錄的名稱不同。第二個改動是，我把全小寫的函數名hello改為首字母大寫的Hello。

基于以上改動，我們再來看下面的幾個問題。

2. 代碼包的導入路徑總會與其所在目錄的相對路徑一致嗎？

庫源碼文件 demo5_lib.go 所在目錄的相對路徑是puzzlers/article3/q2/lib，而它卻聲明自己屬于lib5包。在這種情況下，該包的導入路徑是puzzlers/article3/q2/lib，還是puzzlers/article3/q2/lib5？

這個問題往往會讓 Go 語言的初學者們困惑，就算是用 Go 開發過程序的人也不一定清楚。我們一起來看看。

首先，我們在構建或者安裝這個代碼包的時候，提供給go命令的路徑應該是目錄的相對路徑，就像這樣：

go install puzzlers/article3/q2/lib

該命令會成功完成。之后，當前工作區的 pkg 子目錄下會產生相應的歸檔文件，具體的相對路徑是:

pkg/darwin_amd64/puzzlers/article3/q2/lib.a

其中的darwin_amd64就是我在講工作區時提到的平臺相關目錄。可以看到，這里與源碼文件所在目錄的相對路徑是對應的。

為了進一步說明問題，我需要先對 demo5.go 做兩個改動。第一個改動是，在以import為前導的代碼包導入語句中加入puzzlers/article3/q2/lib，也就是試圖導入這個代碼包。

第二個改動是，把對hello函數的調用改為對lib.Hello函數的調用。其中的lib.叫做限定符，旨在指明右邊的程序實體所在的代碼包。不過這里與代碼包導入路徑的完整寫法不同，只包含了路徑中的最后一級lib，這與代碼包聲明語句中的規則一致。

現在，我們可以通過運行go run demo5.go命令試一試。錯誤提示會類似于下面這種。

./demo5.go:5:2: imported and not used: "puzzlers/article3/q2/lib" as lib5
./demo5.go:16:2: undefined: lib

第一個錯誤提示的意思是，我們導入了puzzlers/article3/q2/lib包，但沒有實際使用其中的任何程序實體。這在 Go 語言中是不被允許的，在編譯時就會導致失敗。

注意，這里還有另外一個線索，那就是“as lib5”。這說明雖然導入了代碼包puzzlers/article3/q2/lib，但是使用其中的程序實體的時候應該以lib5.為限定符。這也就是第二個錯誤提示的原因了。Go 命令找不到lib.這個限定符對應的代碼包。

為什么會是這樣？根本原因就是，我們在源碼文件中聲明所屬的代碼包與其所在目錄的名稱不同。請記住，源碼文件所在的目錄相對于 src 目錄的相對路徑就是它的代碼包導入路徑，而實際使用其程序實體時給定的限定符要與它聲明所屬的代碼包名稱對應。

有兩個方式可以使上述構建成功完成。我在這里選擇把 demo5_lib.go 文件中的代碼包聲明語句改為package lib。理由是，為了不讓該代碼包的使用者產生困惑，我們總是應該讓聲明的包名與其父目錄的名稱一致。

3. 什么樣的程序實體才可以被當前包外的代碼引用？

你可能會有疑問，我為什么要把 demo5_lib.go 文件中的那個函數名稱hello的首字母大寫？實際上這涉及了 Go 語言中對于程序實體訪問權限的規則。

超級簡單，名稱的首字母為大寫的程序實體才可以被當前包外的代碼引用，否則它就只能被當前包內的其他代碼引用。

通過名稱，Go 語言自然地把程序實體的訪問權限劃分為了包級私有的和公開的。對于包級私有的程序實體，即使你導入了它所在的代碼包也無法引用到它。

4. 對于程序實體，還有其他的訪問權限規則嗎？

答案是肯定的。在 Go 1.5 及后續版本中，我們可以通過創建internal代碼包讓一些程序實體僅僅能被當前模塊中的其他代碼引用。這被稱為 Go 程序實體的第三種訪問權限：模塊級私有。

具體規則是，internal代碼包中聲明的公開程序實體僅能被該代碼包的直接父包及其子包中的代碼引用。當然，引用前需要先導入這個internal包。對于其他代碼包，導入該internal包都是非法的，無法通過編譯。

“Golang_Puzzlers”項目的puzzlers/article3/q4包中有一個簡單的示例，可供你查看。你可以改動其中的代碼并體會internal包的作用。

總結

我們在本篇文章中詳細討論了把代碼從命令源碼文件中拆分出來的方法，這包括拆分到其他庫源碼文件，以及拆分到其他代碼包。

這里涉及了幾條重要的 Go 語言基本編碼規則，即：代碼包聲明規則、代碼包導入規則以及程序實體的訪問權限規則。在進行模塊化編程時，你必須記住這些規則，否則你的代碼很可能無法通過編譯。

思考題

1. 如果你需要導入兩個代碼包，而這兩個代碼包的導入路徑的最后一級是相同的，比如：dep/lib/flag和flag，那么會產生沖突嗎？如果會產生沖突，那么怎樣解決這種沖突，有幾種方式？

到此這篇關于模塊一 GO語言基礎知識-庫源碼文件的文章就介紹到這了,更多相關GO語言庫源碼文件內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持腳本之家！