golang模块管理

November 6, 2022

参考： https://go.dev/doc/modules/managing-dependencies
https://go.dev/blog/using-go-modules

初始化模块

首先创建项目文件夹

mkdir mymod
cd mymod

go mod init 命令：在当前目录下初始化新的模块

go mod init example.com/m

该命令创建 go.mod 文件，内容如下

module example.com/m

go 1.19

该文件描述了当前模块和依赖

配置镜像

https://goproxy.cn/
https://goproxy.io/zh/
https://mirrors.aliyun.com/goproxy/

安装依赖

go get 命令：安装依赖

go get example.com/pkg

例如：

go get github.com/subosito/gotenv

go.mod 文件如下

module example.com/m

go 1.19

require github.com/subosito/gotenv v1.4.1 // indirect

为了测试，创建一个 .env 文件

echo -e "APP_ID=1234567\nAPP_SECRET=abcdef" > .env

创建一个 go 源代码文件，内容如下

package main

import (
    "github.com/subosito/gotenv"
    "log"
    "os"
)

func init() {
    gotenv.Load()
}

func main() {
    log.Println(os.Getenv("APP_ID"))     // "1234567"
    log.Println(os.Getenv("APP_SECRET")) // "abcdef"
}

运行试试

go run test.go

2022/11/06 12:00:00 1234567
2022/11/06 12:00:01 abcdef

由于我们已经使用了该依赖，运行 go mod tidy 命令
该命令将去掉 go.mod 文件中项目不需要的依赖
现在，go.mod 内容如下
可以发现，// indirect 注释消失了

module example.com/m

go 1.19

require github.com/subosito/gotenv v1.4.1

安装的依赖存在于 ~/go/pkg/mod 目录中
运行 go mod vendor 命令，则将在当前项目生成 vendor 目录，保存所有依赖
此后一旦修改了 go.mod 文件，就需要执行 go mod vendor，重新生成 vendor 目录

导出

包名应当与目录名相同
包名为 internal 的包只可被直接父级包和同级的相邻包使用

// mymod/any_name.go

package mymod

import "fmt"

func Hello(name string) {
    fmt.Printf("Hello, %s!", name)
}

导入

要导入上面创建的包，我们再创建一个项目

cd ..
mkdir test
go mod init test

# 因为我们的包在本地，所以执行
go mod edit -replace example.com/m/mymod=../mymod
go get example.com/m/mymod

// test.go
package main

import "example.com/m/mymod"

func main() {
    mymod.Hello("Ray") // Hello, Ray!
}

此时 go.mod 文件内容如下

module test

go 1.19

replace example.com/m/mymod => ../mymod

require example.com/m/mymod v0.0.0-00010101000000-000000000000 // indirect

运行 go mod tidy 还是可以将 // indirect 注释消除的

更新依赖

# List all of the modules that are dependencies of your current module, along with the latest version available for each:
go list -m -u all

# Display the latest version available for a specific module:
go list -m -u example.com/theirmodule

# To get the latest version, append the module path with @latest:
go get example.com/theirmodule@latest

发布包

参见：https://go.dev/blog/publishing-go-modules

←Back to home