9012年都过了，还不会用go modules配置本地模块同学真要死了！

本是古典何须时尚 2023-01-17 06:26 74阅读 0赞

**目录**

1. go 1.16引发的血案

2. 在go modules中配置本地模块

3. 让goland支持go modules模式

--------------------

## 视频版在本文的最后 ##

## 1. go 1.16引发的血案 ##

一直在用go语言做一个编译器项目，从go 1.10开始使用。里面涉及到一堆自己写的本地模块，都用go写的，然后通过GOPATH设置这些模块的搜索路径，其实这么做没问题。只不过go从1.11开始，推出了新的依赖管理模块go modules，只不过google为了给大家一个适应期，一直到go 1.15，默认仍然使用的是GOPATH，除非按如下方式设置环境变量GO111MODULE。

GO111MODULE=on

由于从GOPATH模式改成go modules模式需要配置go.mod文件，而且每一个模块都需要配置，比较麻烦，所以也懒得弄。但到了go1.16，google竟然将GO111MODULE的默认值改成了on。只不过只有windows是这样（linux没测试，不太清楚默认是on还是其他值），而macOS下GO111MODULE的默认值是auto。所以在macOS下与go 1.15表现一样。但我需要开发跨平台的编译器，所以在windows下编译直接报了如下错误。

package core is not in GOROOT (/usr/local/go/src/core)

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70][]

在go modules模式下，go编译器将不会考虑GOPATH中的模块路径，所以只会到go的安装目录去搜索，因此解决的方式有如下两个：

（1）将GO111MODULE变量的值改成off或auto

（2）直接使用go modules模式

但第1种有问题，因为从go 1.17开始，google将永久去掉GO111MODULE变量，也就是说，从go 1.17开始，go modules模式你用也得用，不用也得用。所以还是赶紧将自己的go工程切换到go modules模式吧！

如果大家引用的是网络模块，相信网上已经有很多资料讲如何配置go modules，而本文主要讲如何在go modules模式中配置本地模块。

## 2. 在go modules中配置本地模块 ##

要做这个实验，首先要将你的go版本升级到go 1.11或以上版本，推荐使用最新的go 1.16。由于本文使用goland做这个实验，所以需要安装goland。

现在使用goland创建一个新的go工程，接下来按下面的步骤操作：

（1）在工程中创建一个libs目录，用于保存模块文件。

（2）在libs目录中创建一个Greet.go文件，并输入如下的代码：

package libs
    
    func Greet(name string) string {
       return "hello " + name
    }

（3）在工程根目录创建TestGreet.go文件，并输入如下代码：

package main
    import "libs"
    import "fmt"
    
    func main() {
       fmt.Printf(libs.Greet("Bill"))
    }

如果在这时执行TestGreet.go，肯定会抛出如下错误：

package libs is not in GOROOT (/usr/local/go/src/libs)

这是因为go编译器还无法找到libs下的Greet.go文件。如果这时GO111MODULE的值是on或auto，即使设置了GOPATH环境变量也不好使。这是因为如果使用go modules模式，go编译不会再考虑GOPATH环境变量中的模块路径，而且GOPATH模式还有一个限制，就是要求模块必须在搜索路径的src目录中，而本例未创建src目录，所以即使是GOPATH模式，也无法搜索到Greet.go文件。

下面来配置go modules模式

（4）在libs目录下创建一个go.mod文件，并输入下面的内容：

module libs
    
    go 1.16

如果不想自己创建，使用下面的命令自动创建go.mod文件也可以。

go mod init libs

这里的libs是模块名，其实模块名叫什么都可以，甚至可以是域名或目录结构，如unitymarvel.com/libs也可以，就是个名字而已，后面会使用这个名字。

如果GO111MODULE变量的值是auto，并且发现模块下有go.mod文件，就会自动切换到go modules模式。

（5）在工程根目录创建一个go.mod文件，并输入下面的内容：

module testgreet go 1.16 replace libs => ./libs

这里的“libs”表示（4）中设置的模块名，而“./libs”表示Greet.go所在的路径。

（6）在终端切换到工程根目录，然后执行下面的命令：

go get libs

执行这行命令后，会在go.mod文件中添加一行代码，完整的go.mod文件的内容如下：

module testgreet go 1.16 replace libs => ./libs require libs v0.0.0-00010101000000-000000000000 // indirect

其中多加的就是要引用libs模块，后面的是版本号，以后再有新的本地库，直接用这个版本号即可。

最后在goland中运行TestGreet.go，就会成功调用Greet.go中的Greet函数，输出如下内容：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70 1][]

目前工程中有2个go.mod文件，一个在libs目录，一个在根目录，如下图所示。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70 2][]

## 3. 让goland支持go modules模式 ##

打开工程根目录的go.mod文件，会看到libs都是红色，如下图所示。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70 3][]

这时goland还没有支持go modules模式（其实不要紧，不影响运行程序），不过对某些强迫症患者，可以将goland调整到go modules模式。

打开goland的Preference窗口，找到Go Modules，如下图所示。将右侧的Enable Go modules integration复选框选中即可。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70 4][]

这时libs就都变绿了，如下图所示。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70 5][]

使用go modules模式，需要注意：如果模块中还引用其他模块，那么也需要在libs/go.mod中进行replace和require。

9012年都过了，还不会用go modules配置本地模块同学真要死了！

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70]: /images/20221021/4eb0c0327cda42be9596621bb5341232.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70 1]: /images/20221021/9da1f636fe864f829362e50bd2087149.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70 2]: /images/20221021/50605daacb08486c9d7f0080f68e365d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70 3]: /images/20221021/01f78698955e4d86895dfdc404132215.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70 4]: /images/20221021/dea63a571bd440bd88c0710ef916d4e3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25va2lhZ3V5_size_16_color_FFFFFF_t_70 5]: /images/20221021/a4094900ef1f4d3498d2cdecca95407d.png