Golang常用工具分享

本文主要分享Golang相关的一些使用工具，简单介工具作用和使用场景，不会详细介绍其使用，列举的工具也不是最全的，具体可以参考链接或自行搜索学习。

Go官方的工具可以使用go help xxx命令查看帮助文档，比如查看go get的参数标记和使用文档：

代码语言：text复制

go help get

可以参考Golang官方的文档：https://golang.google.cn/cmd/go/

1. Go官方工具

1.1 go get

该命令可以根据要求和实际情况从互联网上下载或更新指定的代码包及其依赖包，下载后自动编译，一般引用依赖用go get就可以了。

参考：

代码语言：text复制

go get -u "github.com/VictoriaMetrics/fastcache"

https://www.kancloud.cn/cattong/go_command_tutorial/261349

1.2 go build

该命令用于编译我们指定的源码文件或代码包以及它们的依赖包。命令的常用标记说明如下：

标记名称	标记描述
-a	强行对所有涉及到的代码包（包含标准库中的代码包）进行重新构建，即使它们已经是最新的了。
-n	打印编译期间所用到的其它命令，但是并不真正执行它们。
-p n	指定编译过程中执行各任务的并行数量（确切地说应该是并发数量）。在默认情况下，该数量等于CPU的逻辑核数。但是在darwin/arm平台（即iPhone和iPad所用的平台）下，该数量默认是1。
-race	开启竞态条件的检测。不过此标记目前仅在linux/amd64、freebsd/amd64、darwin/amd64和windows/amd64平台下受到支持。
-v	打印出那些被编译的代码包的名字。
-work	打印出编译时生成的临时工作目录的路径，并在编译结束时保留它。在默认情况下，编译结束时会删除该目录。
-x	打印编译期间所用到的其它命令。注意它与-n标记的区别。

编译过程输出到文件：go build -x > result 2>&1，因为go build -x 最终是将日志写到标准错误流当中。

如果只在编译特定包时需要指定参数，可以参考包名=参数列表的格式，比如go build -gcflags='log=-N -l' main.go

参考：https://www.kancloud.cn/cattong/go_command_tutorial/261347

1.3 go install

该命令用于编译并安装指定的代码包及它们的依赖包。当指定的代码包的依赖包还没有被编译和安装时，该命令会先去处理依赖包。与go build命令一样，传给go install命令的代码包参数应该以导入路径的形式提供。

并且，go build命令的绝大多数标记也都可以用于go install命令。实际上，go install命令只比go build命令多做了一件事，即：安装编译后的结果文件到指定目录。

参考：https://www.kancloud.cn/cattong/go_command_tutorial/261348

1.4 go fmt和gofmt

Golang的开发团队制定了统一的官方代码风格，并且推出了gofmt工具（gofmt或go fmt）来帮助开发者格式化他们的代码到统一的风格。

gofmt是一个cli程序，会优先读取标准输入，如果传入了文件路径的话，会格式化这个文件，如果传入一个目录，会格式化目录中所有.go文件，如果不传参数，会格式化当前目录下的所有.go文件。

gofmt默认不对代码进行简化，使用-s参数可以开启简化代码功能

gofmt是一个独立的cli程序，而go中还有一个go fmt命令，go fmt命令是gofmt的简单封装。go fmt在调用gofmt时添加了-l -w参数，相当于执行了gofmt -l -w

参考：https://blog.csdn.net/whatday/article/details/97682094

1.5 go env

该命令用于打印Go语言的环境信息，常见的通用环境信息如下：

名称	说明
CGO_ENABLED	指明cgo工具是否可用的标识。
GOARCH	程序构建环境的目标计算架构。
GOBIN	存放可执行文件的目录的绝对路径。
GOCHAR	程序构建环境的目标计算架构的单字符标识。
GOEXE	可执行文件的后缀。
GOHOSTARCH	程序运行环境的目标计算架构。
GOOS	程序构建环境的目标操作系统。
GOHOSTOS	程序运行环境的目标操作系统。
GOPATH	工作区目录的绝对路径。
GORACE	用于数据竞争检测的相关选项。
GOROOT	Go语言的安装目录的绝对路径。
GOTOOLDIR	Go工具目录的绝对路径。
GORPOXY	设置拉取依赖的代理
GOSUMDB	全称为 Go CheckSum Database，用来校验下载的包的安全性问题

设置或修改环境变量值：

代码语言：text复制

go env -w GOPROXY="https://goproxy.com,direct"

参考：https://www.kancloud.cn/cattong/go_command_tutorial/261359

1.6 go run

该命令可以运行命令源码文件，只能接受一个命令源码文件以及若干个库源码文件（必须同属于main包）作为文件参数，且不能接受测试源码文件。它在执行时会检查源码文件的类型。如果参数中有多个或者没有命令源码文件，那么go run命令就只会打印错误提示信息并退出，而不会继续执行。

在通过参数检查后，go run命令会将编译参数中的命令源码文件，并把编译后的可执行文件存放到临时工作目录中。

参考：https://www.kancloud.cn/cattong/go_command_tutorial/261352

1.7 go test

该命令用于对Go语言编写的程序进行测试，这种测试是以代码包为单位的，命令会自动测试每一个指定的代码包。当然，前提是指定的代码包中存在测试源码文件。

参考：https://www.kancloud.cn/cattong/go_command_tutorial/261353

1.8 go clean

该命令会删除掉执行其它命令时产生的一些文件和目录。

参考：https://www.kancloud.cn/cattong/go_command_tutorial/261350

1.9 go list

该命令的作用是列出指定的代码包的信息。与其他命令相同，我们需要以代码包导入路径的方式给定代码包。被给定的代码包可以有多个。这些代码包对应的目录中必须直接保存有Go语言源码文件，其子目录中的文件不算在内。

标记-e的作用是以容错模式加载和分析指定的代码包。在这种情况下，命令程序如果在加载或分析的过程中遇到错误只会在内部记录一下，而不会直接把错误信息打印出来。

为了看到错误信息可以使用-json标记。这个标记的作用是把代码包的结构体实例用JSON的样式打印出来。-m标记可以打印出modules而不是package。

代码语言：javascript复制

# cd yky-sys-backend/cmd/bidengine
# go list -json -m
{
        "Path": "github.com/Project/test",
        "Main": true,
        "Dir": "/data/test",
        "GoMod": "/data/test/go.mod",
        "GoVersion": "1.15"
}
 
# 进入到.go文件的目录下，可以把文件依赖打印出来
go list -m -json

参考：https://www.kancloud.cn/cattong/go_command_tutorial/261354

1.10 go mod xxx

1.10.1 go mod init

该命令初始化并写入一个新的go.mod至当前目录中，实际上是创建一个以当前目录为根的新模块。文件go.mod必须不存在。如果可能，init会从import注释（参阅“go help importpath”）或从版本控制配置猜测模块路径。要覆盖此猜测，提供模块路径作为参数 module为当前项目名。比如：

代码语言：javascript复制

go mod init demo