使用go module導入本地包
go module
是Go1.11版本之后官方推出的版本管理工具,並且從Go1.13
版本開始,go module
將是Go語言默認的依賴管理工具。到今天Go1.14
版本推出之后Go modules
功能已經被正式推薦在生產環境下使用了。
如何使用go module
導入本地包,作為初學者大家剛開始接觸package的時候肯定都是先在本地創建一個包,然后本地調用一下,然后就被卡住了,如何使用go module
導入本地包。
前提
假設我們現在有moduleDemo
和mypackage
兩個包,其中moduleDemo
包中會導入packageDemo
包並使用它的New
方法。
mypackage/packageDemo.go
內容如下:
package mypackage
import "fmt"
func New(){
fmt.Println("mypackage.New")
}
我們現在分兩種情況討論:
在同一個項目下
注意:在一個項目(project)下我們是可以定義多個包(package)的。
目錄結構
現在的情況是,我們在moduledemo/main.go
中調用了mypackage
這個包。
moduleDemo
├── go.mod
├── main.go
└── mypackage
└── packageDemo.go
go mod
模式
go mod init moduleDemo
注:init
初始化的名字, 在導入包時候是以init
后面的名字為基准開始導包
導入包
這個時候,我們需要在moduledemo/go.mod
中按如下定義:
module moduleDemo
go 1.17
然后在moduleDemo/main.go
中按如下方式導入mypackage
package main
import (
"fmt"
"moduleDemo/mypackage" // 導入同一項目下的mypackage包
)
/*
@author RandySun
@create 2021-09-30-8:47
*/
func main() {
mypackage.New()
fmt.Println("main")
}
舉個例子
舉一反三,假設我們現在有文件目錄結構如下:
└── bubble
├── dao
│ └── mysql.go
├── go.mod
└── main.go
其中bubble/go.mod
內容如下:
go mod init github.com/randysun/bubble
module github.com/randysun/bubble
go 1.17
bubble/dao/mysql.go
內容如下:
package dao
import "fmt"
func New(){
fmt.Println("dao....")
}
bubble/main.go
內容如下:
package main
import (
"fmt"
"github.com/randysun/bubble/dao"
)
/*
@author RandySun
@create 2021-09-30-8:56
*/
func main() {
dao.New()
fmt.Println("main")
}
不在同一個項目下
目錄結構
├── moduledemo
│ ├── go.mod
│ └── main.go
└── mypackage
├── go.mod
└── mypackage.go
導入包
這個時候,mypackage
也需要進行module初始化,即擁有一個屬於自己的go.mod
文件,內容如下:
module mypackage
go 1.17
然后我們在moduledemo/main.go
中按如下方式導入:
package main
import (
"fmt"
"mypackage"
)
/*
@author RandySun
@create 2021-09-30-8:47
*/
func main() {
mypackage.New()
fmt.Println("main")
}
因為這兩個包不在同一個項目路徑下,你想要導入本地包,並且這些包也沒有發布到遠程的github或其他代碼倉庫地址。這個時候我們就需要在go.mod
文件中使用replace
指令。
在調用方也就是moduledemo/go.mod
中按如下方式指定使用相對路徑來尋找mypackage
這個包。
module moduleDemo
go 1.17
require "mypackage" v0.0.0
replace "mypackage" => "../mypackage"
舉個例子
最后我們再舉個例子鞏固下上面的內容。
我們現在有文件目錄結構如下:
├── p1
│ ├── go.mod
│ └── main.go
└── p2
├── go.mod
└── p2.go
p1/main.go
中想要導入p2.go
中定義的函數。
p2/go.mod
內容如下:
module randy.com/randysun/p2
go 1.17
p1/main.go
中按如下方式導入
import (
"fmt"
"randy.com/randysun/p2"
)
func main() {
p2.New()
fmt.Println("main")
}
因為我並沒有把randy.com/randysun/p2
這個包上傳到randy.com
這個網站,我們只是想導入本地的包,這個時候就需要用到replace
這個指令了。
p1/go.mod
內容如下:
module github.com/randysun/p1
go 1.17
require "randy.com/randysun/p2" v0.0.0
replace "randy.com/randysun/p2" => "../p2"
此時,我們就可以正常編譯p1
這個項目了。