---
title: GOLANG 踩坑之 Local Import with Go Module
---
###### tags `Golang`

# GOLANG 踩坑之 Local Import with Go Module

### 這個大坑踩了超過一整天的時間。

問題出現在import local source的時候無法正常導入。

不容易查詢到解決辦法的原因在於,go lang的套件管理方式歷經數種變化，因此搜尋錯誤訊息時很有可能查詢到的是不同的套件管理方式下的解決方案，尤其特別多種解決建議都是基於golang原生套件管理模式下。 甚至有人提出相同的問題，下面的回答卻有不同管理方式的解決方案...

收錄以下解決資料：

go module是Go1.11版本之后官方推出的版本管理工具，并且从Go1.13版本开始，go module将是Go语言默认的依赖管理工具。到今天Go1.14版本推出之后Go modules 功能已经被正式推荐在生产环境下使用了。

目前已经有很多教程讲解如何使用go module，以及如何使用go module导入gitlab私有仓库，我这里就不再啰嗦了。

最近我发现很多小伙伴在群里问如何使用go module导入本地包，毕竟初学者刚开始接触package概念的时候都是先在本地创建一个包，然后尝试本地调用一下，但是在go module模式下调用本地包就很容易被卡住了。

本文就详细介绍下如何使用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"

此时，我们就可以正常编译p1这个项目了。