GoPath和Go Modules是什么?

1,792 阅读4分钟

在上一篇文章成功的打印出“Hello World!”之后,我们接下来就来换种方式打印它。将打印的这个函数,放到另外一个文件hello.go里面,然后在main.go里面引入hello这个模块,再执行打印函数,代码如下:

// ./main.go
package main

import (
  "hello"
)

func mian() {
  hello.Hello()
}

// =================

// ./hello.go

package hellp

import (
  "fmt"
)

func Hello() {

  fmt.Println("Hello Wrold!")
}

然后我再运行go run main.go时,它就报错了

image.png

提示hello这个包没在GOROOT(/use/local/go/src/hello)。

这里就要说到go语言查找依赖包的机制了

编译时的依赖包查找机制

GoPath

在Go没有Go Modules之前,所有依赖距均从$GOPATH/src/$GOROOT/src/ 中进行查找导入

所以我换了一种方式,在GoPath(这个可以自己配置文件夹,参考上一篇文章)下面新建如下文件结构,将hello.go,移动到GOPATH/src/hello下:

image_1.png

然后运行命令,还是不对。

image_2.png

GO111MODULE

用环境变量 GO111MODULE 开启或关闭模块支持,它有三个可选值:off、on、auto,默认值是 auto。

GO111MODULE=off 无模块支持,go 会从 GOPATH vendor 文件夹寻找包。 GO111MODULE=on 模块支持,go 会忽略 GOPATH vendor 文件夹,只根据 go.mod 下载依赖。 GO111MODULE=auto $GOPATH/src 外面且根目录有 go.mod 文件时,开启模块支持。 在使用模块的时候,GOPATH 是无意义的,不过它还是会把下载的依赖储存在 $GOPATH/src/mod 中,也会把 go install 的结果放在 $GOPATH/bin

运行go env 之后发现,我的GO111MODULE没有设置(可能是因为系统是win的原因):

image_3.png

通过命令设置成GO111MODULE=off后,“hello world!”就出现了。

image_4.png

然后下面是分别GO111MODULE各个状态的表现:

image_5.png

走到这一步,我发现要跑一个go程序可太不自由了,程序还得在固定路径下才能跑起来。然后往下走,就又了Go Modules,也就是上面频繁提到过的东西。

Go Modules

Go Modules 是为了提升使用其他开发者代码,即添加**依赖项(模块、包)**时的体验,也是为了让代码的正确性、安全性得到保障。

想要详细了解Go Modules可以看这里:Go Modules 详解 - Go语言中文网 - Golang中文社区 (studygolang.com)

Go 支持 Go Modules 之后,编译时编译器会从工作目录(当前所在目录)开始并逐级向上查找是否具有 go.mod 文件。

  • 如果有,go.mod 文件中声明的 module 名称就视作 go.mod 所在的路径,然后以指定的 main 包为依赖入口,所有以 go.mod 中声明的 module 名称开头的导入路径都以 go.mod 所在的路径为相对路径进行包的查找导入。所有需要导入的路径中如果在 go.mod 中指定了版本,则从 $GOPATH/pkg/mod/ 下取得相应版本进行导入,如果没有被指定则从 $GOPATH/src/$GOROOT/src/ 中进行查找导入。
  • 如果没有,所有依赖均从 $GOPATH/src/$GOROOT/src/ 中进行查找导入。
  • 编译时,不在乎源文件在哪(只要指定入口,依赖路径便可依次拿到),而是在乎工作目录在哪(从工作目录开始逐级向上查找,是否可以找到 go.mod)。

所以我要如何使用Go Modules呢?

这里贴上gomod的常用命令

  • go mod init:创建一个新模块,初始化 go.mod 文件,参数为该模块的导入路径,推荐使用这种形式。如:go mod init github.com/linehk/example
  • go get:更改依赖项版本(或添加新的依赖项)。
  • go buildgo test 等命令:Go 命令行工具会根据需要添加新的依赖项。如:go test ./...,测试当前模块。
  • go list -m all:打印当前模块依赖。
  • go mod tidy:移除无用依赖。
  • go list -m -versions github.com/gin-gonic/gin:列出该模块的所有版本。
  • go mod verify:验证哈希。

先确保自己的GO111MODULE模式为auto

然后自己新建文件夹的路径下去运行go mod init [module] 命令,生产如下文件:

image_6.png

module dust/demo

go 1.17

然后将hello.go放入hello文件夹,这里就需要谈到Go语言的包机制:

  • 同一目录下只能存在一个包。若同一目录下存在多个包,该目录被别的源文件导入时编译时会报错,不可同一路径导入两个包。
  • 目录和目录下源文件的包命名可以不同,目录被导入时只是提供包的路径而已;若目录名称和目录下包名称不同,当目录被导入时不必为包起别名即可在下文中使用包,当然,使用方式不是以目录名为前缀,而是以目录下的包名为前缀,不过这会导致读代码时不知道该包是来自哪个路径。所以一般规范的写法是保持目录和目录下的包名称相同。
  • 不同目录下若存在相同名称的包,若在一个源文件中需同时导入使用这些包,首先一定是需要导入多个目录路径的,所以这些来自不同路径的相同名称的包就被视为了不同的包,但因为名称一样,所以同时导入到一个源文件时会导致命名冲突编译不通过:redeclared as imported package name previous declaration,因此这种情况下需要给包起别名避免冲突。

完成之后是这样

image_7.png

然后我们在main.go中导入hello包,导入的路径成为了mod文件里的module+导入包的名称,代码如下:

package main

import (
  "dust/demo/hello" // dust/demo/ + hello
)

func main() {
  hello.Hello()
}

然后再运行 go run main.go,就能正常运行程序,打印“hello world!”了。