Go Modules 常用命令速查 #

┌─────────────────────────────────────────────────────────────┐
│                    Go Modules 命令                           │
├─────────────────────────────────────────────────────────────┤
│                                                              │
│  go mod init      初始化模块                                 │
│  go mod tidy      整理依赖                                   │
│  go mod download  下载依赖                                   │
│  go mod verify    验证依赖                                   │
│  go mod graph     查看依赖图                                 │
│  go mod why       查看依赖原因                               │
│  go mod vendor    创建 vendor                                │
│  go mod edit      编辑 go.mod                                │
│                                                              │
│  go get           添加/更新依赖                              │
│  go list          列出模块信息                               │
│  go clean         清理缓存                                   │
│                                                              │
└─────────────────────────────────────────────────────────────┘

# 基本用法
go mod init <module-path>

# 示例
go mod init myproject
go mod init github.com/myuser/myproject
go mod init gitlab.company.com/team/project

// go.mod
module myproject

go 1.21

# 基本用法
go mod tidy

# 详细输出
go mod tidy -v

# 忽略错误继续
go mod tidy -e

# 下载所有依赖
go mod download

# 下载特定模块
go mod download github.com/gin-gonic/gin

# 下载特定版本
go mod download github.com/gin-gonic/gin@v1.9.1

# 下载并输出 JSON
go mod download -json
go mod download -json github.com/gin-gonic/gin

{
  "Path": "github.com/gin-gonic/gin",
  "Version": "v1.9.1",
  "Error": "",
  "Info": "/path/to/cache/download/github.com/gin-gonic/gin/@v/v1.9.1.info",
  "GoMod": "/path/to/cache/download/github.com/gin-gonic/gin/@v/v1.9.1.mod",
  "Zip": "/path/to/cache/download/github.com/gin-gonic/gin/@v/v1.9.1.zip",
  "Dir": "/path/to/cache/github.com/gin-gonic/gin@v1.9.1",
  "Sum": "h1:4idEAncQnU5cB7BeOkPtxjfCSye0AAm1R0RVIqFPSHk=",
  "GoModSum": "h1:hPrL6YRBqCtAI1IJFI4BYmqfvzDv3w=="
}

# 验证所有依赖
go mod verify

# 输出
# all modules verified

# 验证失败示例
# github.com/gin-gonic/gin@v1.9.1: dir has been modified

# 查看依赖图
go mod graph

# 输出格式
# 模块 依赖模块@版本
myproject github.com/gin-gonic/gin@v1.9.1
myproject golang.org/x/text@v0.14.0
github.com/gin-gonic/gin@v1.9.1 github.com/go-playground/validator@v10.15.0
...

# 查看依赖原因
go mod why github.com/json-iterator/go

# 输出
# github.com/json-iterator/go
# myproject
# github.com/gin-gonic/gin
# github.com/gin-gonic/gin/binding

# 查看模块原因
go mod why -m github.com/gin-gonic/gin

# 输出
# # github.com/gin-gonic/gin
# myproject

# 创建 vendor
go mod vendor

# 目录结构
vendor/
├── github.com/
│   └── gin-gonic/
│       └── gin/
├── golang.org/
│   └── x/
│       └── text/
└── modules.txt

# github.com/gin-gonic/gin v1.9.1
## explicit; go 1.20
github.com/gin-gonic/gin
github.com/gin-gonic/gin/binding
# golang.org/x/text v0.14.0
## explicit; go 1.18
golang.org/x/text/encoding

# 打印 go.mod
go mod edit -print

# 格式化 go.mod
go mod edit -fmt

# 添加模块
go mod edit -module=github.com/myuser/myproject
go mod edit -go=1.21

# 添加依赖
go mod edit -require=github.com/gin-gonic/gin@v1.9.1

# 删除依赖
go mod edit -droprequire=github.com/gin-gonic/gin

# 添加 replace
go mod edit -replace=github.com/old/pkg=github.com/new/pkg@v1.0.0

# 删除 replace
go mod edit -dropreplace=github.com/old/pkg

# 添加 exclude
go mod edit -exclude=github.com/problematic/pkg@v1.0.0

# 删除 exclude
go mod edit -dropexclude=github.com/problematic/pkg@v1.0.0

# JSON 输出
go mod edit -json

{
  "Module": {
    "Path": "myproject",
    "Go": "1.21"
  },
  "Require": [
    {
      "Path": "github.com/gin-gonic/gin",
      "Version": "v1.9.1"
    }
  ]
}

# 添加/更新依赖
go get <package>

# 添加最新版本
go get github.com/gin-gonic/gin@latest

# 添加特定版本
go get github.com/gin-gonic/gin@v1.9.1

# 添加特定分支
go get github.com/gin-gonic/gin@main

# 添加特定 commit
go get github.com/gin-gonic/gin@abc123

# 更新到最新次版本
go get -u github.com/gin-gonic/gin

# 更新所有依赖
go get -u

# 只更新补丁版本
go get -u=patch github.com/gin-gonic/gin

# 更新所有补丁版本
go get -u=patch

# 添加开发依赖（标记为 indirect）
go get -d github.com/gin-gonic/gin

# 仅更新 go.mod，不下载
go get -d -t ./...

# 添加测试依赖
go get -t github.com/gin-gonic/gin

# 升级/降级到特定版本
go get github.com/gin-gonic/gin@v1.9.0

# go get - 添加依赖到当前模块
go get github.com/tools/godep
# 添加到 go.mod

# go install - 安装可执行文件到 $GOPATH/bin
go install github.com/tools/godep@latest
# 不修改 go.mod

# 列出所有依赖
go list -m all

# 输出
# myproject
# github.com/gin-gonic/gin v1.9.1
# github.com/go-playground/validator v10.15.0
# ...

# JSON 格式
go list -m -json all

# 输出
{
  "Path": "github.com/gin-gonic/gin",
  "Version": "v1.9.1",
  "Time": "2023-05-09T14:32:45Z",
  "Dir": "/path/to/cache/github.com/gin-gonic/gin@v1.9.1",
  "GoMod": "/path/to/cache/download/.../v1.9.1.mod"
}

# 列出所有版本
go list -m -versions github.com/gin-gonic/gin

# 输出
# github.com/gin-gonic/gin v1.0.0 v1.1.0 v1.2.0 ... v1.9.1

# JSON 格式
go list -m -versions -json github.com/gin-gonic/gin

# 列出可更新的依赖
go list -u -m all

# 输出
# github.com/gin-gonic/gin v1.9.0 [v1.9.1]
# golang.org/x/text v0.13.0 [v0.14.0]

# 查看特定模块信息
go list -m -json github.com/gin-gonic/gin@v1.9.1

# 输出
{
  "Path": "github.com/gin-gonic/gin",
  "Version": "v1.9.1",
  "Query": "v1.9.1",
  "Time": "2023-05-09T14:32:45Z",
  "Dir": "/path/to/cache/github.com/gin-gonic/gin@v1.9.1",
  "GoMod": "/path/to/cache/download/.../v1.9.1.mod",
  "GoVersion": "1.20",
  "Sum": "h1:4idEAncQnU5cB7BeOkPtxjfCSye0AAm1R0RVIqFPSHk=",
  "GoModSum": "h1:hPrL6YRBqCtAI1IJFI4BYmqfvzDv3w=="
}

# 列出当前模块的包
go list ./...

# 输出
# myproject
# myproject/pkg/utils
# myproject/internal/config

# 列出所有包（包括依赖）
go list all

# JSON 格式
go list -json ./...

# 只列出包名
go list -f '{{.Name}}' ./...

# 列出包的导入路径
go list -f '{{.ImportPath}}' ./...

# 清理构建缓存
go clean -cache

# 清理模块缓存
go clean -modcache

# 清理测试缓存
go clean -testcache

# 清理所有
go clean -cache -modcache -testcache

# 清理特定包
go clean -cache github.com/gin-gonic/gin

# 查看将删除的文件
go clean -n -cache

# 正常构建
go build

# 使用 vendor 目录
go build -mod=vendor

# 只读模式（不修改 go.mod）
go build -mod=readonly

# 更新依赖后构建
go build -mod=mod

# 指定输出文件
go build -o myapp

# 减小二进制大小
go build -ldflags="-s -w" -o myapp

# 交叉编译
GOOS=linux GOARCH=amd64 go build -o myapp
GOOS=windows GOARCH=amd64 go build -o myapp.exe
GOOS=darwin GOARCH=arm64 go build -o myapp

# 运行程序
go run main.go

# 使用 vendor
go run -mod=vendor main.go

# 只读模式
go run -mod=readonly main.go

# 运行特定包
go run ./cmd/server

# 传递参数
go run main.go -port=8080

# 运行测试
go test ./...

# 使用 vendor
go test -mod=vendor ./...

# 详细输出
go test -v ./...

# 运行特定测试
go test -run TestFunction ./...

# 测试覆盖率
go test -cover ./...

# 生成覆盖率报告
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out -o coverage.html

# 基准测试
go test -bench=. ./...

# 竞态检测
go test -race ./...

# 安装当前模块
go install

# 安装特定版本的工具
go install github.com/go-delve/delve/cmd/dlv@latest
go install golang.org/x/tools/cmd/goimports@latest

# 安装到指定目录
GOBIN=/path/to/bin go install

# 安装特定平台的工具
GOOS=linux GOARCH=amd64 go install github.com/tools/godep@latest

# 查看所有环境变量
go env

# 查看特定变量
go env GOPATH
go env GOPROXY
go env GOMODCACHE
go env GOPRIVATE

# JSON 格式
go env -json

# 以 shell 格式输出
go env -w

# 设置全局配置
go env -w GOPROXY=https://goproxy.cn,direct
go env -w GOPRIVATE=github.com/mycompany/*
go env -w GONOSUMDB=github.com/mycompany/*

# 取消设置
go env -u GOPROXY

# 创建新项目
mkdir myproject && cd myproject
go mod init github.com/myuser/myproject

# 更新所有依赖
go get -u
go mod tidy
go mod verify

# 完全清理并重建
rm -rf vendor
go clean -modcache
go mod download
go mod tidy

# CI 构建脚本
go mod download      # 下载依赖
go mod verify        # 验证依赖
go build ./...       # 构建
go test -race ./...  # 测试

# 发布检查清单
go mod tidy
go mod verify
go test ./...
go vet ./...
go build ./...