go的常用命令
你好!在golang 的开发中我们会用到各种的命令,今天介绍下go的各种命令的作用是啥?
1.go get
go get
命令主要是用来动态获取远程代码包的,目前支持的有BitBucket、GitHub、Google Code和Launchpad。这个命令在内部实际上分成了两步操作:第一步是下载源码包,第二步是执行go install。下载源码包的go工具会自动根据不同的域名调用不同的源码工具,对应关系如下
BitBucket (Mercurial Git)
GitHub (Git)
Google Code Project Hosting
(Git, Mercurial, Subversion)
Launchpad (Bazaar)
所以为了go get 能正常工作,你必须确保安装了合适的源码管理工具,并同时把这些命令加入你的PATH中。其实go get支持自定义域名的功能,具体参见go help remote
。
go get
命令本质上可以理解为:首先通过源码工具clone代码到src目录,然后执行go install。
go get 命令的特有标记说明
标记名称 | 标记描述 |
---|---|
-d | 让命令程序只执行下载动作,而不执行安装动作。 |
-f | 仅在使用-u标记时才有效。该标记会让命令程序忽略掉对已下载代码包的导入路径的检查。如果下载并安装的代码包所属的项目是你从别人那里Fork过来的,那么这样做就尤为重要了。 |
-fix | 让命令程序在下载代码包后先执行修正动作,而后再进行编译和安装。 |
-insecure | 允许命令程序使用非安全的scheme(如HTTP)去下载指定的代码包。如果你用的代码仓库(如公司内部的Gitlab)没有HTTPS支持,可以添加此标记。请在确定安全的情况下使用它。 |
-t | 让命令程序同时下载并安装指定的代码包中的测试源码文件中依赖的代码包。 |
-u | 让命令利用网络来更新已有代码包及其依赖包。默认情况下没有u,该命令只会从网络上下载本地不存在的代码包,而不会更新已有的代码包。 |
-v | 打印出被构建的代码包的名字。 |
-x | 打印出用到的命令 |
2.go build
go build
命令主要是用于测试编译。在包的编译过程中,若有必要,会同时编译与之相关联的包。
-
如果是普通包,当你执行go build命令后,不会产生任何文件。
-
如果是main包,当只执行
go build
命令后,会在当前目录下生成一个可执行文件。如果需要在$GOPATH/bin
木下生成相应的exe文件,需要执行go install 或者使用 go build -o 路径/a.exe。 -
如果某个文件夹下有多个文件,而你只想编译其中某一个文件,可以在 go build 之后加上文件名,例如
go build a.go
;go build
命令默认会编译当前目录下的所有go文件。 -
你也可以指定编译输出的文件名。比如,我们可以指定go build -o myapp.exe,默认情况是你的package名(非main包),或者是第一个源文件的文件名(main包)。
-
go build 会忽略目录下以”_”或者”.”开头的go文件。
-
如果你的源代码针对不同的操作系统需要不同的处理,那么你可以根据不同的操作系统后缀来命名文件。例如有一个读取数组的程序,它对于不同的操作系统可能有如下几个源文件:
array_linux.go
array_darwin.go
array_windows.go
array_freebsd.go
附加参数 | 备 注 |
---|---|
-v | 编译时显示包名 |
-p n | 开启并发编译,默认情况下该值为 CPU 逻辑核数 |
-a | 强制重新构建 |
-n | 打印编译时会用到的所有命令,但不真正执行 |
-x | 打印编译时会用到的所有命令 |
-race | 开启竞态检测 |
3.go fmt
go fmt 命令主要是用来帮你格式化所写好的代码文件。
比如我们写了一个格式很糟糕的 test.go 文件,我们只需要使用 fmt go test.go
命令,就可以让go帮我们格式化我们的代码文件。但是我们一般很少使用这个命令,因为我们的开发工具一般都带有保存时自动格式化功能,这个功能底层其实就是调用了 go fmt
命令而已。
使用go fmt
命令,更多时候是用gofmt
,而且需要参数-w,否则格式化结果不会写入文件。gofmt -w src
,可以格式化整个项目。
4.go clean
go clean 命令是用来移除当前源码包里面编译生成的文件,这些文件包括
- _obj/ 旧的object目录,由Makefiles遗留
- _test/ 旧的test目录,由Makefiles遗留
- _testmain.go 旧的gotest文件,由Makefiles遗留
- test.out 旧的test记录,由Makefiles遗留
- build.out 旧的test记录,由Makefiles遗留
- *.[568ao] object文件,由Makefiles遗留
- DIR(.exe) 由 go build 产生
- DIR.test(.exe) 由 go test -c 产生
- MAINFILE(.exe) 由 go build MAINFILE.go产生
5.go install
go install 命令在内部实际上分成了两步操作:第一步是生成结果文件(可执行文件或者.a包),第二步会把编译好的结果移到 $GOPATH/pkg
或者$GOPATH/bin
。
.exe文件: 一般是 go install
带main函数的go文件产生的,有函数入口,所有可以直接运行。
.a应用包: 一般是 go install
不包含main函数的go文件产生的,没有函数入口,只能被调用。
6.go test
go test
命令,会自动读取源码目录下面名为*_test.go的文件,生成并运行测试用的可执行文件。
默认的情况下,不需要任何的参数,它会自动把你源码包下面所有test文件测试完毕,当然你也可以带上参数,详情请参考go help testflag
7.go doc
go doc
命令其实就是一个很强大的文档工具。
如何查看相应package的文档呢? 例如builtin包,那么执行go doc builtin
;如果是http包,那么执行go doc net/http
;查看某一个包里面的函数,那么执行godoc fmt Printf
;也可以查看相应的代码,执行godoc -src fmt Printf;
通过命令在命令行执行 godoc -http=:端口号 比如godoc -http=:8080。然后在浏览器中打开127.0.0.1:8080,你将会看到一个golang.org的本地copy版本,通过它你可以查询pkg文档等其它内容。如果你设置了GOPATH,在pkg分类下,不但会列出标准包的文档,还会列出你本地GOPATH中所有项目的相关文档,这对于经常被限制访问的用户来说是一个不错的选择。
8.其他命令
Go语言还提供了其它有用的工具,例如下面的这些工具
go fix
用来修复以前老版本的代码到新版本,例如go1之前老版本的代码转化到go1
go version
查看go当前的版本
go env
查看当前go的环境变量
go list
列出当前全部安装的package
go run
编译并运行Go程序
go tool: 运行go提供的工具
go vet 文件名 会自动检测代码中的常见错误