Go創(chuàng)建一個包并使用(導入本地包和注意事項)

更新時間：2023年11月06日 09:44:01 作者：zhonguncle

有時候需要自己寫一個包方便多次使用,但是在導入自己寫的包時遇到了問題,本文主要介紹了Go創(chuàng)建一個包并使用(導入本地包和注意事項),感興趣的可以了解一下

有時候需要自己寫一個包方便多次使用，但是在導入自己寫的包時遇到了問題。我以前以為import部分直接就是包的路徑，但是實際自己寫了之后發(fā)現(xiàn)不是這樣的。這部分實際上這部分是可以解釋成一個標識符，是由一個go.mod文件確定，一般含義確實是路徑末端。

Go 中模塊的概念其實還包含了一部分版本管理的功能。所以 Go 的模塊和版本管理無論是學習還是開發(fā)都不是一件容易的事情，Go 團隊也在一直努力調整和優(yōu)化。本文只能代表當前版本go1.20.2版本的情況，如果未來更新了我會進行備注。

go.mod是什么

每個 Go 的模塊都是由go.mod確定，該文件描述了模塊的屬性，例如模塊存放的路徑是否依賴其他模塊、最低使用 Go 版本等信息。比如mod@v0.8.0的go.mod內容為：

module golang.org/x/mod

go 1.17

require golang.org/x/tools v0.1.12 // tagx:ignore

然后在編譯的時候，編譯器會去找有沒有這個標識這個模塊的go.mod，如果有的話找到對應的xxx.go，然后導入相應的包中使用的功能進行編譯。

這里有兩個問題：

Go 在哪找模塊的？
如何讓 Go 從特定目錄下搜索包？

模塊（module）和包（package）的區(qū)別在于：模塊是一系列包的集合，并且在模塊文件結構的根目錄下有個go.mod文件，自己甚至可以直接被編譯成一個程序。而包是某一個或多個.go文件，用來劃分包級別的作用域（package level），可以當做其他語言的庫。范圍應該是：模塊>>>包>>>源代碼文件。但是在某些情況下，包、模塊、庫這三個詞是可以混用的（在不同情況下叫法不同，但是卻指同一個東西）。
需要注意package main是個例外，這并不是一個庫（盡管開頭有個package），而是用來表示這是個可以單獨執(zhí)行的程序。

創(chuàng)建模塊和編寫包的內容

這里舉個例子來進行演示，演示的例子來自《The Go Programming Language》中 Section 2.7，是用來數(shù)一個數(shù)的二進制有多少位為1，比如輸入1返回1，輸入0x1234567890ABCDEF返回32。

新建一個文件夾popcount，然后在里面創(chuàng)建一個名為popcount.go的文件：

$ mkdir popcount
$ cd popcount
$ touch popcount.go

輸入以下內容（下面這個算法不是最快的，也不是最容易理解的，但是可以解釋很多東西）：

package popcount

// pc[i]用來計數(shù)第i位是不是
var pc [256]byte
//初始化包
func init() {
	for i := range pc {
		pc[i] = pc[i/2] + byte(i&1)
	}
}

// PopCount返回x有多少位為1.
func PopCount(x uint64) int {
	return int(pc[byte(x>>(0*8))] +
		pc[byte(x>>(1*8))] +
		pc[byte(x>>(2*8))] +
		pc[byte(x>>(3*8))] +
		pc[byte(x>>(4*8))] +
		pc[byte(x>>(5*8))] +
		pc[byte(x>>(6*8))] +
		pc[byte(x>>(7*8))])
}

上文中：pc首字母是小寫的，所以只能在popcount包中使用，而PopCount首字母是大寫的，所以可以在導入popcount包的文件中使用。

繼續(xù)在popcount中通過go mod init命令創(chuàng)建go.mod文件，如下：

$ go mod init test/popcount
go: creating new go.mod: module test/popcount
go: to add module requirements and sums:
	go mod tidy
$ ls
go.mod		popcount.go

可以看到多了個go.mod文件。

導入自建包（本地包）

然后在其他地方新建一個目錄pop_test來編寫使用這個包的程序代碼（可以和popcount在同一個目錄下，或者其他地方都行），這里選擇和popcount在同一個目錄下，如下：

$ cd ..
$ mkdir pop_test

然后在pop_test中新建一個go.mod：

$ go mod init pop_test

這時候go.mod的內容應該是如下樣式：

module pop_test

go 1.20

用你喜歡的文本編輯器打開它，在末尾添加這樣兩句話，變成如下樣式：

module pop_test

go 1.20

require test/popcount v0.0.0
replace test/popcount => ../popcount

最后這兩句都不能省略，少一句都不行。

第一句是為了說明使用popcount的版本，第二句是因為我們使用的是本地包（local package），而不是下載導入的庫，本地包的位置并不在GOROOT/src/test/popcount中，Go 編譯的時候找不到的（關于GOROOT后面還有一些內容）。第二句話其實類似于 C 編譯器中的選項-I。（這里解決了開頭的那兩個問題）

然后新建一個main.go文件，輸入以下內容：

package main

import (
	"fmt"
	"test/popcount"
)

func main() {
	a := popcount.PopCount(0x1234567890ABCDEF)
	fmt.Println(a)
}

這時候運行應該看到以下結果：

$ go run main.go
32

這種方法是官方推薦的，但是問題在于要在項目的根目錄（如上的pop_test）下創(chuàng)建一個go.mod。

第二種方法

下面這種方法是根據(jù)運行機制進行設置的，說實話并不是很方便管理，但是某些情況下卻挺方便的。

上文中提到：Go 默認是在GOROOT/src下尋找包的，某個包就是GOROOT/src/包名。那么就可以直接在GOROOT/src下按照包名的結構放置自建的本地包，然后就可以在程序代碼中直接使用了，不用再在項目根目錄下創(chuàng)建一個go.mod文件來說明使用的本地包的位置了。

通過以下命令找到你的GOROOT，如下：