20. Go 語言中關於包導入必學的 8 個知識點

Hi,大家好,我是明哥。

在自己學習 Golang 的這段時間裏,我寫了詳細的學習筆記放在我的個人微信公衆號 《Go編程時光》,對於 Go 語言,我也算是個初學者,因此寫的東西應該會比較適合剛接觸的同學,如果你也是剛學習 Go 語言,不防關注一下,一起學習,一起成長。

我的在線博客:http://golang.iswbm.com 我的 Github:github.com/iswbm/GolangCodingTime


1. 單行導入與多行導入

在 Go 語言中,一個包可包含多個 .go 文件(這些文件必須得在同一級文件夾中),只要這些 .go 文件的頭部都使用 package 關鍵字聲明瞭同一個包。

導入包主要可分爲兩種方式:

  • 單行導入
import "fmt"
import "sync" 
  • 多行導入
import(
    "fmt"
    "sync"
)

如你所見,Go 語言中 導入的包,必須得用雙引號包含,在這裏吐槽一下。

2. 使用別名

在一些場景下,我們可能需要對導入的包進行重新命名,比如

  • 我們導入了兩個具有同一包名的包時產生衝突,此時這裏爲其中一個包定義別名
import (
    "crypto/rand"
    mrand "math/rand" // 將名稱替換爲mrand避免衝突
)
  • 我們導入了一個名字很長的包,爲了避免後面都寫這麼長串的包名,可以這樣定義別名
import hw "helloworldtestmodule"
  • 防止導入的包名和本地的變量發生衝突,比如 path 這個很常用的變量名和導入的標準包衝突。
import pathpkg "path"

3. 使用點操作

如裏在我們程序內部裏頻繁使用了一個工具包,比如 fmt,那每次使用它的打印函數打印時,都要 包名+方法名。

對於這種使用高頻的包,可以在導入的時,就把它定義會 "自己人"(方法是使用一個 . ),自己人的話,不分彼此,它的方法,就是我們的方法。

從此,我們打印再也不用加 fmt 了。

import . "fmt"

func main() {
    Println("hello, world")
}

但這種用法,會有一定的隱患,就是導入的包裏可能有函數,會和我們自己的函數發生衝突。

4. 包的初始化

每個包都允許有一個 init 函數,當這個包被導入時,會執行該包的這個 init 函數,做一些初始化任務。

對於 init 函數的執行有兩點需要注意

  1. init 函數優先於 main 函數執行

  2. 在一個包引用鏈中,包的初始化是深度優先的。比如,有這樣一個包引用關係:main→A→B→C,那麼初始化順序爲

    C.init→B.init→A.init→main

5. 包的匿名導入

當我們導入一個包時,如果這個包沒有被使用到,在編譯時,是會報錯的。

但是有些情況下,我們導入一個包,只想執行包裏的 init 函數,來運行一些初始化任務,此時怎麼辦呢?

可以使用匿名導入,用法如下,其中下劃線爲空白標識符,並不能被訪問

// 註冊一個PNG decoder
import _ "image/png"

由於導入時,會執行 init 函數,所以編譯時,仍然會將這個包編譯到可執行文件中。

6. 導入的是路徑還是包?

當我們使用 import 導入 testmodule/foo 時,初學者,經常會問,這個 foo 到底是一個包呢,還是隻是包所在目錄名?

import "testmodule/foo"

爲了得出這個結論,專門做了個試驗(請看「第七點裏的代碼示例」),最後得出的結論是:

  • 導入時,是按照目錄導入。導入目錄後,可以使用這個目錄下的所有包。
  • 出於習慣,包名和目錄名通常會設置成一樣,所以會讓你有一種你導入的是包的錯覺。

7. 相對導入和絕對導入

據我瞭解在 Go 1.10 之前,好像是不支持相對導入的,在 Go 1.10 之後纔可以。

絕對導入:從 $GOPATH/src$GOROOT 或者 $GOPATH/pkg/mod 目錄下搜索包並導入

相對導入:從當前目錄中搜索包並開始導入。就像下面這樣

import (
    "./module1"
    "../module2"
    "../../module3"
    "../module4/module5"
)

分別舉個例子吧

一、使用絕對導入

有如下這樣的目錄結構(注意確保當前目錄在 GOPATH 下)

其中 main.go 是這樣的

package main

import (
    "app/utilset"   // 這種使用的就是絕對路徑導入
)

func main() {
    utils.PrintHello()
}

而在 main.go 的同級目錄下,還有另外一個文件夾 utilset ,爲了讓你理解 「第六點:import 導入的是路徑而不是包」,我在 utilset 目錄下定義了一個 hello.go 文件,這個go文件定義所屬包爲 utils

package utils

import "fmt"

func PrintHello(){
    fmt.Println("Hello, 我在 utilset 目錄下的 utils 包裏")
}

運行結果如下

二、使用相對導入

還是上面的代碼,將絕對導入改爲相對導入後

將 GOPATH 路徑設置回去(請對比上面使用絕對路徑的 GOPATH)

然後再次運行

總結一下,使用相對導入,有兩點需要注意

  • 項目不要放在 $GOPATH/src 下,否則會報錯(比如我修改當前項目目錄爲GOPATH後,運行就會報錯)

  • Go Modules 不支持相對導入,在你開啓 GO111MODULE 後,無法使用相對導入。

最後,不得不說的是:使用相對導入的方式,項目可讀性會大打折扣,不利用開發者理清整個引用關係。

所以一般更推薦使用絕對引用的方式。使用絕對引用的話,又要談及優先級了

8. 包導入路徑優先級

前面一節,介紹了三種不同的包依賴管理方案,不同的管理模式,存放包的路徑可能都不一樣,有的可以將包放在 GOPATH 下,有的可以將包放在 vendor 下,還有些包是內置包放在 GOROOT 下。

那麼問題就來了,如果在這三個不同的路徑下,有一個相同包名但是版本不同的包,我們導入的時候,是選擇哪個進行導入呢?

這就需要我們搞懂,在 Golang 中包搜索路徑優先級是怎樣的?

這時候就需要區分,是使用哪種模式進行包的管理的。

如果使用 govendor

當我們導入一個包時,它會:

  1. 先從項目根目錄的 vendor 目錄中查找
  2. 最後從 $GOROOT/src 目錄下查找
  3. 然後從 $GOPATH/src 目錄下查找
  4. 都找不到的話,就報錯。

爲了驗證這個過程,我在創建中創建一個 vendor 目錄後,就開啓了 vendor 模式了,我在 main.go 中隨便導入一個包 pkg,由於這個包是我隨便指定的,當然會找不到,找不到就會報錯, Golang 會在報錯信息中打印中搜索的過程,從這個信息中,就可以看到 Golang 的包查找優先級了。

如果使用 go modules

你導入的包如果有域名,都會先在 $GOPATH/pkg/mod 下查找,找不到就連網去該網站上尋找,找不到或者找到的不是一個包,則報錯。

而如果你導入的包沒有域名(比如 "fmt"這種),就只會到 $GOROOT 裏查找。

還有一點很重要,當你的項目下有 vendor 目錄時,不管你的包有沒有域名,都只會在 vendor 目錄中想找。

通常vendor 目錄是通過 go mod vendor 命令生成的,這個命令會將項目依賴全部打包到你的項目目錄下的 verdor 文件夾中。

延伸閱讀

系列導讀

01. 開發環境的搭建(Goland & VS Code)

02. 學習五種變量創建的方法

03. 詳解數據類型:**整形與浮點型**

04. 詳解數據類型:byte、rune與string

05. 詳解數據類型:數組與切片

06. 詳解數據類型:字典與布爾類型

07. 詳解數據類型:指針

08. 面向對象編程:結構體與繼承

09. 一篇文章理解 Go 裏的函數

10. Go語言流程控制:if-else 條件語句

11. Go語言流程控制:switch-case 選擇語句

12. Go語言流程控制:for 循環語句

13. Go語言流程控制:goto 無條件跳轉

14. Go語言流程控制:defer 延遲調用

15. 面向對象編程:接口與多態

16. 關鍵字:make 和 new 的區別?

17. 一篇文章理解 Go 裏的語句塊與作用域

18. 學習 Go 協程:goroutine

19. 學習 Go 協程:詳解信道/通道

20. 幾個信道死鎖經典錯誤案例詳解

21. 學習 Go 協程:WaitGroup

22. 學習 Go 協程:互斥鎖和讀寫鎖

23. Go 裏的異常處理:panic 和 recover

24. 超詳細解讀 Go Modules 前世今生及入門使用

25. Go 語言中關於包導入必學的 8 個知識點

26. 如何開源自己寫的模塊給別人用?

27. 說說 Go 語言中的類型斷言?

28. 這五點帶你理解Go語言的select用法


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章