9.8 自定義包的目錄結構、go install 和 go test
爲了示範,我們創建了一個名爲 uc 的簡單包,它含有一個 UpperCase
函數將字符串的所有字母轉換爲大寫。當然這並不值得創建一個自己包,同樣的功能已被包含在 strings
包裏,但是同樣的技術也可以應用在更復雜的包中。
9.8.1 自定義包的目錄結構
下面的結構給了你一個好的示範(uc 代表通用包名, 名字爲粗體的代表目錄,斜體代表可執行文件):
/home/user/goprograms
ucmain.go (uc包主程序)
Makefile (ucmain的2-makefile)
ucmain
src/uc (包含uc包的go源碼)
uc.go
uc_test.go
Makefile (包的1-makefile)
uc.a
_obj
uc.a
_test
uc.a
bin (包含最終的執行文件)
ucmain
pkg/linux_amd64
uc.a (包的目標文件)
將你的項目放在 goprograms 目錄下(你可以創建一個環境變量 GOPATH,詳見第 2.2/3 章節:在 .profile 和 .bashrc 文件中添加 export GOPATH=/home/user/goprograms
),而你的項目將作爲 src 的子目錄。uc 包中的功能在 uc.go 中實現。
示例 9.6 uc.go:
package uc
import "strings"
func UpperCase(str string) string {
return strings.ToUpper(str)
}
包通常附帶一個或多個測試文件,在這我們創建了一個 uc_test.go 文件,如第 9.8 節所述。
示例 9.7 test.go
package uc
import "testing"
type ucTest struct {
in, out string
}
var ucTests = []ucTest {
ucTest{"abc", "ABC"},
ucTest{"cvo-az", "CVO-AZ"},
ucTest{"Antwerp", "ANTWERP"},
}
func TestUC(t *testing.T) {
for _, ut := range ucTests {
uc := UpperCase(ut.in)
if uc != ut.out {
t.Errorf("UpperCase(%s) = %s, must be %s", ut.in, uc,
ut.out)
}
}
}
通過指令編譯並安裝包到本地:go install src/uc
, 這會將 uc.a 複製到 pkg/linux_amd64 下面。
另外,使用 make,通過以下內容創建一個包的 Makefile(1) 在 src/uc 目錄下:
include $GOROOT/src/Make.inc
TARG=uc
GOFILES=\
uc.go\
include $(GOROOT)/scr/Make.pkg
在該目錄下的命令行調用: gomake
這將創建一個 _obj 目錄並將包編譯生成的存檔 uc.a 放在該目錄下。
這個包可以通過 go test 測試。
創建一個 uc.a 的測試文件在目錄下,輸出爲 PASS 時測試通過。
在第 13.8 節我們將給出另外一個測試例子並進行深入研究。
備註:有可能你當前的用戶不具有足夠的資格使用 go install(沒有權限)。這種情況下,選擇 root 用戶 su。確保 Go 環境變量和 Go 源碼路徑也設置給 su,同樣也適用你的普通用戶(詳見第 2.3 節)。
接下來我們創建主程序 ucmain.go:
示例 9.8 ucmain.go:
package main
import (
"fmt"
"./uc/uc"
)
func main() {
str1 := "USING package uc"
fmt.Println(uc.UpperCase(str1))
}
然後在這個目錄下輸入 go install
。
另外複製 uc.a 到 uc 目錄並創建一個 Makefile(2) 並寫入文本:
include $GOROOT/src/Make.inc
TARG=ucmain
GOFILES=\
ucmain.go\
include $GOROOT/src/Make.cmd
執行 gomake 編譯 ucmain.go
成可執行文件ucmain
運行 ./ucmain
顯示: USING package uc!
。
9.8.2 本地安裝包
本地包在用戶目錄下,使用給出的目錄結構,以下命令用來從源碼安裝本地包:
go install /home/user/goprograms/src/uc # 編譯安裝uc
cd /home/user/goprograms/uc
go install ./uc # 編譯安裝uc(和之前的指令一樣)
cd ..
go install . # 編譯安裝ucmain
安裝到 $GOPATH
下:
如果我們想安裝的包在系統上的其他 Go 程序中被使用,它一定要安裝到 $GOPATH
下。
這樣做,在 .profile 和 .bashrc 中設置 export GOPATH=/home/user/goprograms
。
然後執行 go install uc 將會複製包存檔到 $GOPATH/pkg/LINUX_AMD64/uc
。
現在,uc 包可以通過 import "uc"
在任何 Go 程序中被引用。
9.8.3 依賴系統的代碼
在不同的操作系統上運行的程序以不同的代碼實現是非常少見的:絕大多數情況下語言和標準庫解決了大部分的可移植性問題。
你有一個很好的理由去寫平臺平臺特定的代碼,例如彙編語言。這種情況下,按照下面的約定是合理的:
prog1.go
prog1_linux.go
prog1_darwin.go
prog1_windows.go
prog1.go 定義了不同操作系統通用的接口,並將系統特定的代碼寫到 prog1os.go 中。
對於 Go 工具你可以指定 `prog1$GOOS.go或
prog1$GOARCH.go或在平臺 Makefile 中:
prog1$(GOOS).go` 或 prog1_$(GOARCH).go\
。
鏈接
- 目錄
- 上一節:使用 go install 安裝自定義包
- 下一節:通過 Git 打包和安裝