go module是Go1.11版本之後官方推出的版本管理工具，並且從Go1.13版本開始，go module將是Go語言預設的依賴管理工具。到今天Go1.14版本推出之後Go modules 功能已經被正式推薦在生產環境下使用了。

這幾天已經有很多教程講解如何使用go module，以及如何使用go module匯入gitlab私有倉庫，我這裡就不再囉嗦了。但是最近我發現很多小夥伴在群裡問如何使用go module匯入本地包，作為初學者大家剛開始接觸package的時候肯定都是先在本地建立一個包，然後本地呼叫一下，然後就被卡住了。。。

這裡就詳細介紹下如何使用go module匯入本地包。

前提

假設我們現在有moduledemo和mypackage兩個包，其中moduledemo包中會匯入mypackage包並使用它的New方法。

mypackage/mypackage.go內容如下：

package mypackage

import "fmt"

func New(){
	fmt.Println("mypackage.New")
}

我們現在分兩種情況討論：

在同一個專案下

注意：在一個專案（project）下我們是可以定義多個包（package）的。

目錄結構

現在的情況是，我們在moduledemo/main.go中呼叫了mypackage

moduledemo
├── go.mod
├── main.go
└── mypackage
    └── mypackage.go

匯入包

這個時候，我們需要在moduledemo/go.mod中按如下定義：

module moduledemo

go 1.14

然後在moduledemo/main.go中按如下方式匯入mypackage

package main

import (
	"fmt"
	"moduledemo/mypackage"  // 匯入同一專案下的mypackage包
)
func main() {
	mypackage.New()
	fmt.Println("main")
}
 

舉個例子

舉一反三，假設我們現在有檔案目錄結構如下：

└── bubble
    ├── dao
    │   └── mysql.go
    ├── go.mod
    └── main.go

其中bubble/go.mod內容如下：

module github.com/q1mi/bubble

go 1.14

bubble/dao/mysql.go內容如下：

package dao

import "fmt"

func New(){
	fmt.Println("mypackage.New")
}

bubble/main.go內容如下：

package main

import (
	"fmt"
	"github.com/q1mi/bubble/dao"
)
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.14

然後我們在moduledemo/main.go中按如下方式匯入：

import (
	"fmt"
	"mypackage"
)
func main() {
	mypackage.New()
	fmt.Println("main")
}

因為這兩個包不在同一個專案路徑下，你想要匯入本地包，並且這些包也沒有釋出到遠端的github或其他程式碼倉庫地址。這個時候我們就需要在go.mod檔案中使用replace指令。

在呼叫方也就是packagedemo/go.mod中按如下方式指定使用相對路徑來尋找mypackage這個包。

module moduledemo

go 1.14


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 liwenzhou.com/q1mi/p2

go 1.14

p1/main.go中按如下方式匯入

import (
	"fmt"
	"liwenzhou.com/q1mi/p2"
)
func main() {
	p2.New()
	fmt.Println("main")
}

因為我並沒有把liwenzhou.com/q1mi/p2這個包上傳到liwenzhou.com這個網站，我們只是想匯入本地的包，這個時候就需要用到replace這個指令了。

p1/go.mod內容如下：

module github.com/q1mi/p1

go 1.14


require "liwenzhou.com/q1mi/p2" v0.0.0
replace "liwenzhou.com/q1mi/p2" => "../p2"

轉自： https://www.liwenzhou.com/posts/Go/import_local_package_in_go_module/