Golang学习系列:(一)介绍和安装
Java程序员带你来到Go的世界,让我们开始探索吧!
Go是一种新的语言,一种并发的,带有垃圾回收的、快速编译的语言,它具有一下特点:
- 他可以在一台计算机上用几秒钟的时间编译一个大型的Go程序
- Go为软件构造提供了一种模型,它使依赖分析更加容易,且避免了大部分C风格include文件与库的开头。
- Go是静态类型的语言,它的类型系统没有层级。因此用户不需要在定义类型之间的关系上花费时间,这样感觉起来比典型的面向对象语言更轻量级。
- Go完全是垃圾回收型的语言,并为并发执行与通信提供了基本的支持。
- 按照其设计,Go打算为多核机器上系统软件的构造提供一种方法。
Go是一种编译型语言,它结合了解释型语言的游刃有余,动态类型语言的开发效率,以及静态类型的安全性。它也打算成为现代的,支持网络与多核计算的语言。要满足这些目标,需要解决一些语言上的问题:一个富有表达能力但轻量级的类型系统,并发与垃圾回收机制,严格的依赖规范等等。这些无法通过库或工具解决好,因此Go也就应运而生了。
一、Windows安装
访问Golang
官网下载页,32 位请选择名称中包含windows-386
的msi
安装包,64位请选择名称中包含windows-amd64
的。下载好后运行,不要修改默认安装目录C:\Go\
,若安装到其他位置会导致不能执行自己所编写的Go
代码。安装完成后默认会在环境变量Path
后添加Go
安装目录下的bin
目录 C:\Go\bin\
,并添加环境变量GOROOT
,值为Go
安装根目录 C:\Go\
。
测试是否成功
在运行中输入cmd
打开命令行工具,在提示符下输入go
,检查是否能看到Usage
信息。输入cd%GOROOT%
,看是否能进入Go
安装目录。若都功,说明安装成功(如下所示)。不能的话请检查上述环境变量Path
和GOROOT
的值。若不存在请卸载后重新安装,存在请重启计算机后重试以上步骤。
$ go
Go is a tool for managing Go source code.
Usage:
go command [arguments]
The commands are:
build compile packages and dependencies
clean remove object files and cached files
doc show documentation for package or symbol
env print Go environment information
bug start a bug report
fix update packages to use new APIs
fmt gofmt (reformat) package sources
generate generate Go files by processing source
get download and install packages and dependencies
install compile and install packages and dependencies
list list packages
run compile and run Go program
test test packages
tool run specified go tool
version print Go version
vet report likely mistakes in packages
Use "go help [command]" for more information about a command.
Additional help topics:
c calling between Go and C
buildmode build modes
cache build and test caching
filetype file types
gopath GOPATH environment variable
environment environment variables
importpath import path syntax
packages package lists
testflag testing flags
testfunc testing functions
Use "go help [topic]" for more information about that topic
二、GOPATH与工作空间
前面我们在安装Go的时候看到需要设置GOPATH变量,Go从1.1版本到1.7必须设置这个变量,而且不能和Go的安装目录一样,这个目录用来存放Go源码,Go的可运行文件,以及相应的编译之后的包文件。所以这个目录下面有三个子目录:src、bin、pkg
从go 1.8开始,GOPATH环境变量现在有一个默认值,如果它没有被设置。 在Windows上默认为%USERPROFILE%/go。
GOPATH设置
go 命令依赖一个重要的环境变量:$GOPATH
Windows系统中环境变量的形式为%GOPATH%
(注:这个不是Go安装目录。下面以笔者的工作目录为示例,如果你想不一样请把GOPATH替换成你的工作目录。)
Windows 设置如下,新建一个环境变量名称叫做GOPATH:
GOPATH=c:\mygo
GOPATH允许多个目录,当有多个目录时,请注意分隔符,多个目录的时候Windows是分号,Linux系统是冒号,当有多个GOPATH时,默认会将go get的内容放在第一个目录下。
以上 $GOPATH 目录约定有三个子目录:
- src 存放源代码(比如:.go .c .h .s等)
- pkg 编译后生成的文件(比如:.a)
- bin 编译后生成的可执行文件(为了方便,可以把此目录加入到 \(PATH 变量中,如果有多个gopath,那么使用`\){GOPATH///bin:}/bin`添加所有的bin目录)
以后我所有的例子都是以mygo作为我的gopath目录
代码目录结构规划
GOPATH下的src目录就是接下来开发程序的主要目录,所有的源码都是放在这个目录下面,那么一般我们的做法就是一个目录一个项目,例如: $GOPATH/src/mymath 表示mymath这个应用包或者可执行应用,这个根据package是main还是其他来决定,main的话就是可执行应用,其他的话就是应用包,这个会在后续详细介绍package。
所以当新建应用或者一个代码包时都是在src目录下新建一个文件夹,文件夹名称一般是代码包名称,当然也允许多级目录,例如在src下面新建了目录$GOPATH/src/demo/test 那么这个包路径就是"demo/test",包名称是最后一个目录test
下面我就以mymath为例来讲述如何编写应用包,执行如下代码
cd $GOPATH/src
mkdir mymath
新建文件sqrt.go,内容如下
// $GOPATH/src/mymath/sqrt.go源码如下:
package mymath
func Sqrt(x float64) float64 {
z := 0.0
for i := 0; i < 1000; i++ {
z -= (z*z - x) / (2 * x)
}
return z
}
这样我的应用包目录和代码已经新建完毕,注意:一般建议package的名称和目录名保持一致
编译应用
上面我们已经建立了自己的应用包,如何进行编译安装呢?有两种方式可以进行安装
1、只要进入对应的应用包目录,然后执行go install
,就可以安装了
2、在任意的目录执行如下代码go install mymath
安装完之后,我们可以进入如下目录
cd $GOPATH/pkg/${GOOS}_${GOARCH}
//可以看到如下文件
mymath.a
这个.a文件是应用包,那么我们如何进行调用呢?
接下来我们新建一个应用程序来调用这个应用包
新建应用包mathapp
cd $GOPATH/src
mkdir mathapp
cd mathapp
vim main.go
$GOPATH/src/mathapp/main.go
源码:
package main
import (
"mymath"
"fmt"
)
func main() {
fmt.Printf("Hello, world. Sqrt(2) = %v\n", mymath.Sqrt(2))
}
可以看到这个的package是main
,import里面调用的包是mymath
,这个就是相对于$GOPATH/src
的路径,如果是多级目录,就在import里面引入多级目录,如果你有多个GOPATH,也是一样,Go会自动在多个$GOPATH/src
中寻找。
如何编译程序呢?进入该应用目录,然后执行go build
,那么在该目录下面会生成一个mathapp的可执行文件
./mathapp
输出如下内容
Hello, world. Sqrt(2) = 1.414213562373095
如何安装该应用,进入该目录执行go install
,那么在\(GOPATH/bin/下增加了一个可执行文件mathapp, 还记得前面我们把`\)GOPATH/bin`加到我们的PATH里面了,这样可以在命令行输入如下命令就可以执行
mathapp
也是输出如下内容
Hello, world. Sqrt(2) = 1.414213562373095
这里我们展示如何编译和安装一个可运行的应用,以及如何设计我们的目录结构。
获取远程包
go语言有一个获取远程包的工具就是go get
,目前go get支持多数开源社区(例如:github、googlecode、bitbucket、Launchpad)
go get github.com/astaxie/beedb
go get -u 参数可以自动更新包,而且当go get的时候会自动获取该包依赖的其他第三方包
通过这个命令可以获取相应的源码,对应的开源平台采用不同的源码控制工具,例如github采用git、googlecode采用hg,所以要想获取这些源码,必须先安装相应的源码控制工具
通过上面获取的代码在我们本地的源码相应的代码结构如下
$GOPATH
src
|--github.com
|-astaxie
|-beedb
pkg
|--相应平台
|-github.com
|--astaxie
|beedb.a
go get本质上可以理解为首先第一步是通过源码工具clone代码到src下面,然后执行go install
在代码中如何使用远程包,很简单的就是和使用本地包一样,只要在开头import相应的路径就可以
import "github.com/astaxie/beedb"
程序的整体结构
通过上面建立的我本地的mygo的目录结构如下所示
bin/
mathapp
pkg/
平台名/ 如:darwin_amd64、linux_amd64
mymath.a
github.com/
astaxie/
beedb.a
src/
mathapp
main.go
mymath/
sqrt.go
github.com/
astaxie/
beedb/
beedb.go
util.go
从上面的结构我们可以很清晰的看到,bin目录下面存的是编译之后可执行的文件,pkg下面存放的是应用包,src下面保存的是应用源代码
Go 命令
Go语言自带有一套完整的命令操作工具,你可以通过在命令行中执行go
来查看它们(参考上方测试安装成功的输出界面)
这些命令对于我们平时编写的代码非常有用,接下来就让我们了解一些常用的命令。
go build
这个命令主要用于编译代码。在包的编译过程中,若有必要,会同时编译与之相关联的包。
-
如果是普通包,就像我们在1.2节中编写的
mymath
包那样,当你执行go build
之后,它不会产生任何文件。如果你需要在$GOPATH/pkg
下生成相应的文件,那就得执行go install
。 -
如果是
main
包,当你执行go build
之后,它就会在当前目录下生成一个可执行文件。如果你需要在$GOPATH/bin
下生成相应的文件,需要执行go install
,或者使用go build -o 路径/a.exe
。 -
如果某个项目文件夹下有多个文件,而你只想编译某个文件,就可在
go build
之后加上文件名,例如go build a.go
;go build
命令默认会编译当前目录下的所有go文件。 -
你也可以指定编译输出的文件名。例如1.2节中的
mathapp
应用,我们可以指定go build -o astaxie.exe
,默认情况是你的package名(非main包),或者是第一个源文件的文件名(main包)。
(注:实际上,package名在Go语言规范中指代码中“package”后使用的名称,此名称可以与文件夹名不同。默认生成的可执行文件名是文件夹名。)
-
go build会忽略目录下以“_”或“.”开头的go文件。
-
如果你的源代码针对不同的操作系统需要不同的处理,那么你可以根据不同的操作系统后缀来命名文件。例如有一个读取数组的程序,它对于不同的操作系统可能有如下几个源文件:
array_linux.go
array_darwin.go
array_windows.go
array_freebsd.go
go build
的时候会选择性地编译以系统名结尾的文件(Linux、Darwin、Windows、Freebsd)。例如Linux系统下面编译只会选择array_linux.go文件,其它系统命名后缀文件全部忽略。
参数的介绍
-o
指定输出的文件名,可以带上路径,例如go build -o a/b/c
-i
安装相应的包,编译+go install
-a
更新全部已经是最新的包的,但是对标准包不适用-n
把需要执行的编译命令打印出来,但是不执行,这样就可以很容易的知道底层是如何运行的-p n
指定可以并行可运行的编译数目,默认是CPU数目-race
开启编译的时候自动检测数据竞争的情况,目前只支持64位的机器-v
打印出来我们正在编译的包名-work
打印出来编译时候的临时文件夹名称,并且如果已经存在的话就不要删除-x
打印出来执行的命令,其实就是和-n
的结果类似,只是这个会执行-ccflags 'arg list'
传递参数给5c, 6c, 8c 调用-compiler name
指定相应的编译器,gccgo还是gc-gccgoflags 'arg list'
传递参数给gccgo编译连接调用-gcflags 'arg list'
传递参数给5g, 6g, 8g 调用-installsuffix suffix
为了和默认的安装包区别开来,采用这个前缀来重新安装那些依赖的包,-race
的时候默认已经是-installsuffix race
,大家可以通过-n
命令来验证-ldflags 'flag list'
传递参数给5l, 6l, 8l 调用-tags 'tag list'
设置在编译的时候可以适配的那些tag,详细的tag限制参考里面的 Build Constraints
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产生
*.so 由 SWIG 产生
我一般都是利用这个命令清除编译文件,然后github递交源码,在本机测试的时候这些编译文件都是和系统相关的,但是对于源码管理来说没必要。
$ go clean -i -n
cd /Users/astaxie/develop/gopath/src/mathapp
rm -f mathapp mathapp.exe mathapp.test mathapp.test.exe app app.exe
rm -f /Users/astaxie/develop/gopath/bin/mathapp
参数介绍
-i
清除关联的安装的包和可运行文件,也就是通过go install安装的文件-n
把需要执行的清除命令打印出来,但是不执行,这样就可以很容易的知道底层是如何运行的-r
循环的清除在import中引入的包-x
打印出来执行的详细命令,其实就是-n
打印的执行版本
go fmt
有过C/C++经验的读者会知道,一些人经常为代码采取K&R风格还是ANSI风格而争论不休。在go中,代码则有标准的风格。由于之前已经有的一些习惯或其它的原因我们常将代码写成ANSI风格或者其它更合适自己的格式,这将为人们在阅读别人的代码时添加不必要的负担,所以go强制了代码格式(比如左大括号必须放在行尾),不按照此格式的代码将不能编译通过,为了减少浪费在排版上的时间,go工具集中提供了一个go fmt
命令 它可以帮你格式化你写好的代码文件,使你写代码的时候不需要关心格式,你只需要在写完之后执行go fmt <文件名>.go
,你的代码就被修改成了标准格式,但是我平常很少用到这个命令,因为开发工具里面一般都带了保存时候自动格式化功能,这个功能其实在底层就是调用了go fmt
。接下来的一节我将讲述两个工具,这两个工具都自带了保存文件时自动化go fmt
功能。
使用go fmt命令,其实是调用了gofmt,而且需要参数-w,否则格式化结果不会写入文件。gofmt -w -l src,可以格式化整个项目。
所以go fmt是gofmt的上层一个包装的命令,我们想要更多的个性化的格式化可以参考 gofmt
gofmt的参数介绍
-l
显示那些需要格式化的文件-w
把改写后的内容直接写入到文件中,而不是作为结果打印到标准输出。-r
添加形如“a[b:len(a)] -> a[b:]”的重写规则,方便我们做批量替换-s
简化文件中的代码-d
显示格式化前后的diff而不是写入文件,默认是false-e
打印所有的语法错误到标准输出。如果不使用此标记,则只会打印不同行的前10个错误。-cpuprofile
支持调试模式,写入相应的cpufile到指定的文件
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
。
参数介绍:
-d
只下载不安装-f
只有在你包含了-u
参数的时候才有效,不让-u
去验证import中的每一个都已经获取了,这对于本地fork的包特别有用-fix
在获取源码之后先运行fix,然后再去做其他的事情-t
同时也下载需要为运行测试所需要的包-u
强制使用网络去更新包和它的依赖包-v
显示执行的命令
go install
这个命令在内部实际上分成了两步操作:第一步是生成结果文件(可执行文件或者.a包),第二步会把编译好的结果移到$GOPATH/pkg
或者$GOPATH/bin
。
参数支持go build
的编译参数。大家只要记住一个参数-v
就好了,这个随时随地的可以查看底层的执行信息。
go test
执行这个命令,会自动读取源码目录下面名为*_test.go
的文件,生成并运行测试用的可执行文件。输出的信息类似
ok archive/tar 0.011s
FAIL archive/zip 0.022s
ok compress/gzip 0.033s
...
默认的情况下,不需要任何的参数,它会自动把你源码包下面所有test文件测试完毕,当然你也可以带上参数,详情请参考go help testflag
这里我介绍几个我们常用的参数:
-bench regexp
执行相应的benchmarks,例如-bench=.
-cover
开启测试覆盖率-run regexp
只运行regexp匹配的函数,例如-run=Array
那么就执行包含有Array开头的函数-v
显示测试的详细命令
go tool
go tool
下面下载聚集了很多命令,这里我们只介绍两个,fix和vet
go tool fix .
用来修复以前老版本的代码到新版本,例如go1之前老版本的代码转化到go1,例如API的变化go tool vet directory|files
用来分析当前目录的代码是否都是正确的代码,例如是不是调用fmt.Printf里面的参数不正确,例如函数里面提前return了然后出现了无用代码之类的。
go generate
这个命令是从Go1.4开始才设计的,用于在编译前自动化生成某类代码。go generate
和go build
是完全不一样的命令,通过分析源码中特殊的注释,然后执行相应的命令。这些命令都是很明确的,没有任何的依赖在里面。而且大家在用这个之前心里面一定要有一个理念,这个go generate
是给你用的,不是给使用你这个包的人用的,是方便你来生成一些代码的。
这里我们来举一个简单的例子,例如我们经常会使用yacc
来生成代码,那么我们常用这样的命令:
go tool yacc -o gopher.go -p parser gopher.y
-o 指定了输出的文件名, -p指定了package的名称,这是一个单独的命令,如果我们想让go generate
来触发这个命令,那么就可以在当然目录的任意一个xxx.go
文件里面的任意位置增加一行如下的注释:
//go:generate go tool yacc -o gopher.go -p parser gopher.y
这里我们注意了,//go:generate
是没有任何空格的,这其实就是一个固定的格式,在扫描源码文件的时候就是根据这个来判断的。
所以我们可以通过如下的命令来生成,编译,测试。如果gopher.y
文件有修改,那么就重新执行go generate
重新生成文件就好。
$ go generate
$ go build
$ go test
godoc
在Go1.2版本之前还支持go doc
命令,但是之后全部移到了godoc这个命令下,需要这样安装go get golang.org/x/tools/cmd/godoc
很多人说go不需要任何的第三方文档,例如chm手册之类的(其实我已经做了一个了,chm手册),因为它内部就有一个很强大的文档工具。
如何查看相应package的文档呢?
例如builtin包,那么执行godoc builtin
如果是http包,那么执行godoc 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
中所有项目的相关文档,这对于经常被墙的用户来说是一个不错的选择。
其它命令
go还提供了其它很多的工具,例如下面的这些工具
go version 查看go当前的版本
go env 查看当前go的环境变量
go list 列出当前全部安装的package
go run 编译并运行Go程序
以上这些工具还有很多参数没有一一介绍,用户可以使用go help 命令
获取更详细的帮助信息。