Go环境变量

为方便开发,在开发环境往往需要设置三个环境变量:

  1. $GOROOT:go的安装目录,配置后不会再更改;
  2. $GOPATH:go项目在本地的开发环境的的项目根路径(以便项目编译,go build, go install),不同的项目在编译的时候该环境变量可以不同;
  3. $PATH(重要):需要将go的bin目录添加到系统$PATH中以便方便使用go的相关命令,配置后也不会再更改;

Go的环境变量在官方文档中也有详情的说明,请参考链接:https://golang.google.cn/doc/install/source

环境变量中的$GOOS$GOARCH是比较实用的两个变量,可以用在不同平台的交叉编译中,只需要在go build之前设置这两个变量即可,这也是go语言的优势之一:可以编译生成跨平台运行的可执行文件。感觉比QT更高效更轻量级,虽然生成的可执行文件是大了一点,不过也在可接受的范围之内。例如,在Linux amd64架构下编译Windows x86的可执行文件,可以使用如下命令:

  1. CGO_ENABLED=0 GOOS=windows GOARCH=386 go build hello.go

遗憾的是交叉编译暂不支持cgo方式,因此需要将环境变量$CGO_ENABLED设置为0,这样执行之后会在当前目录生成一个hello.exewindows x86架构的可执行文件。

环境变量设置

除了$PATH环境外,其他环境变量都是可选的。

为什么说这个步骤可选呢?因为未来的Go版本慢慢开始移除对$GOPATH/$GOROOT的支持。此外,在Goland这个IDE中集成有Terminal功能,直接使用这个功能中已经设置好了环境变量。

开发环境配置 - 图1

*nix下设置环境变量

*nix系统下(Linux/Unix/MacOS/*BSD等等),需要在/etc/profile中增加以下环境变量设置后,执行命令#source /etc/profile重新加载profile配置文件(或重新登录),将以下变量添加到用户的环境变量中:

  1. export GOROOT=/usr/local/go
  2. export GOPATH=/Users/john/Workspace/Go/GOPATH
  3. export PATH=$GOPATH/bin:$GOROOT/bin:$PATH

Windows下设置环境变量

Windows如何修改系统环境变量,以及修改环境变量PATH,请参考网上教程(百度Google)。

IDE工具配置

本文以Goland开发工具为基础,介绍在该IDE下的常用工具配置。

常用的工具包括:

  1. go fmt : 统一的代码格式化工具(必须)。
  2. golangci-lint : 静态代码质量检测工具,用于包的质量分析(推荐)。
  3. goimports : 自动import依赖包工具(可选)。
  4. golint : 代码规范检测,并且也检测单文件的代码质量,比较出名的Go质量评估站点Go Report在使用(可选)。

go fmt, goimports, golangci-lint的配置

由于这三个工具是Goland自带的,因此配置比较简单,参考以下图文操作示例:

  1. Goland的设置中,选择Tools - File Watchers,随后选择添加 开发环境配置 - 图2

  2. 依次点击添加这3个工具,使用默认的配置即可 开发环境配置 - 图3

  3. 随后在撸代码的过程中保存代码文件时将会自动触发这3个工具的自动检测。

golint工具的安装及配置

golint的安装

由于Goland没有自带golint工具,因此首先要自己去下载安装该工具。

使用以下命令安装:

  1. mkdir -p $GOPATH/src/golang.org/x/
  2. cd $GOPATH/src/golang.org/x/
  3. git clone https://github.com/golang/lint.git
  4. git clone https://github.com/golang/tools.git
  5. cd $GOPATH/src/golang.org/x/lint/golint
  6. go install

安装成功之后将会在$GOPATH/bin目录下看到自动生成了golint二进制工具文件。

golint的配置

  1. 随后在GolandTools - File Watchers配置下,通过复制go fmt的配置 开发环境配置 - 图4

  2. 修改Name, Program, Arguments三项配置,其中Arguments需要加上-set_exit_status参数,如图所示: 开发环境配置 - 图5

  3. 保存即可,随后在代码编写中执行保存操作时将会自动触发golint工具检测。

配置备份导入

也可以通过保存以下XML配置文件内容,使用import导入功能即可完成配置(golint还是得自己安装)。

开发环境配置 - 图6

文件内容:

  1. <TaskOptions>
  2. <TaskOptions>
  3. <option name="arguments" value="fmt $FilePath$" />
  4. <option name="checkSyntaxErrors" value="true" />
  5. <option name="description" />
  6. <option name="exitCodeBehavior" value="ERROR" />
  7. <option name="fileExtension" value="go" />
  8. <option name="immediateSync" value="false" />
  9. <option name="name" value="go fmt" />
  10. <option name="output" value="$FilePath$" />
  11. <option name="outputFilters">
  12. <array />
  13. </option>
  14. <option name="outputFromStdout" value="false" />
  15. <option name="program" value="$GoExecPath$" />
  16. <option name="runOnExternalChanges" value="false" />
  17. <option name="scopeName" value="Project Files" />
  18. <option name="trackOnlyRoot" value="true" />
  19. <option name="workingDir" value="$ProjectFileDir$" />
  20. <envs>
  21. <env name="GOROOT" value="$GOROOT$" />
  22. <env name="GOPATH" value="$GOPATH$" />
  23. <env name="PATH" value="$GoBinDirs$" />
  24. </envs>
  25. </TaskOptions>
  26. <TaskOptions>
  27. <option name="arguments" value="-w $FilePath$" />
  28. <option name="checkSyntaxErrors" value="true" />
  29. <option name="description" />
  30. <option name="exitCodeBehavior" value="ERROR" />
  31. <option name="fileExtension" value="go" />
  32. <option name="immediateSync" value="false" />
  33. <option name="name" value="goimports" />
  34. <option name="output" value="$FilePath$" />
  35. <option name="outputFilters">
  36. <array />
  37. </option>
  38. <option name="outputFromStdout" value="false" />
  39. <option name="program" value="goimports" />
  40. <option name="runOnExternalChanges" value="false" />
  41. <option name="scopeName" value="Project Files" />
  42. <option name="trackOnlyRoot" value="true" />
  43. <option name="workingDir" value="$ProjectFileDir$" />
  44. <envs>
  45. <env name="GOROOT" value="$GOROOT$" />
  46. <env name="GOPATH" value="$GOPATH$" />
  47. <env name="PATH" value="$GoBinDirs$" />
  48. </envs>
  49. </TaskOptions>
  50. <TaskOptions>
  51. <option name="arguments" value="run --disable=typecheck $FileDir$" />
  52. <option name="checkSyntaxErrors" value="true" />
  53. <option name="description" />
  54. <option name="exitCodeBehavior" value="ERROR" />
  55. <option name="fileExtension" value="go" />
  56. <option name="immediateSync" value="false" />
  57. <option name="name" value="golangci-lint" />
  58. <option name="output" value="" />
  59. <option name="outputFilters">
  60. <array />
  61. </option>
  62. <option name="outputFromStdout" value="false" />
  63. <option name="program" value="golangci-lint" />
  64. <option name="runOnExternalChanges" value="false" />
  65. <option name="scopeName" value="Project Files" />
  66. <option name="trackOnlyRoot" value="true" />
  67. <option name="workingDir" value="$ProjectFileDir$" />
  68. <envs>
  69. <env name="GOROOT" value="$GOROOT$" />
  70. <env name="GOPATH" value="$GOPATH$" />
  71. <env name="PATH" value="$GoBinDirs$" />
  72. </envs>
  73. </TaskOptions>
  74. <TaskOptions>
  75. <option name="arguments" value="-set_exit_status $FilePath$" />
  76. <option name="checkSyntaxErrors" value="true" />
  77. <option name="description" />
  78. <option name="exitCodeBehavior" value="ERROR" />
  79. <option name="fileExtension" value="go" />
  80. <option name="immediateSync" value="false" />
  81. <option name="name" value="golint" />
  82. <option name="output" value="$FilePath$" />
  83. <option name="outputFilters">
  84. <array />
  85. </option>
  86. <option name="outputFromStdout" value="false" />
  87. <option name="program" value="golint" />
  88. <option name="runOnExternalChanges" value="false" />
  89. <option name="scopeName" value="Project Files" />
  90. <option name="trackOnlyRoot" value="true" />
  91. <option name="workingDir" value="$ProjectFileDir$" />
  92. <envs>
  93. <env name="GOROOT" value="$GOROOT$" />
  94. <env name="GOPATH" value="$GOPATH$" />
  95. <env name="PATH" value="$GoBinDirs$" />
  96. </envs>
  97. </TaskOptions>
  98. </TaskOptions>