本文是 How to Write Go Code 的学习笔记。通过示范介绍了Go 语言的开发过程和 go 工具的使用。
1. 代码结构
go 语言特点
- go 开发者通常将所有代码组织在一个工作空间下
- 一个工作空间包含多个版本控制库(git)
- 一个版本控制库中包含一个或多个应用包
- 一个包由多个go 源代码文件组成
1.1 工作空间
工作空间包含三个子目录
-
src包含所有源代码文件 -
pkg包含所有包对象，库依赖文件等 -
bin包含所有可执行文件
go 工具编译源码产生的结果，会存放到 pkg 和 bin 目录。src 目录一般包含多个版本控制库，以追踪多个源码库的开发.
一个典型的 go 工作空间如下:
bin/
hello # command executable
outyet # command executable
pkg/
linux_amd64/
github.com/golang/example/
stringutil.a # package object
src/
github.com/golang/example/
.git/ # Git repository metadata
hello/
hello.go # command source
outyet/
main.go # command source
main_test.go # test source
stringutil/
reverse.go # package source
reverse_test.go # test source
golang.org/x/image/
.git/ # Git repository metadata
bmp/
reader.go # package source
writer.go # package source
示例包含两个版本库(example 和 image)，可执行目录和依赖库目录。
1.2 GOPATH 环境变量
GOPATH 环境变量指定 go 工作空间的位置，在开发go 代码前指定。
一般设置在当前用户目录下，如下所示:
$ mkdir $HOME/work # 创建工作空间目录
export GOPATH=$HOME/work # 指定go 工作空间
export PATH=$PATH:$GOPATH/bin # 将可执行文件目录加入环境变量，方便使用
1.3 导入路径
导入路径是一个包的唯一标识，指定包所在的位置。
导入标准库的包时，指定短导入路径，例如 "fmt", "net/http" 等
导入自定义包时，根据 $GOPATH 相对路径引入
1.4 第一个程序
go 源码放在 $GOPATH/src 路径下。
新建 $GOPATH/src/go_note/src/hello/hello.go 文件，内容如下:
// go "hello world" 示例
package main
import "fmt"
func main() {
fmt.Printf("Hello, world.\n")
}
通过 go install 命令编译安装程序:
$ go install go_note/src/hello
go 会找到 $GOPATH/src/go_note/src/hello/ 目录下的源码文件，编译完成将编译结果存放在 $GOPATH/bin 目录下。
执行该程序
$ $GOPATH/bin/hello
Hello, world.
1.5 第一个库
新建 $GOPATH/src/go_note/src/stringutil/reverse.go 库文件，内容如下:
// Package stringutil contains utility functions for working with strings.
package stringutil
// Reverse returns its argument string reversed rune-wise left to right.
func Reverse(s string) string {
r := []rune(s)
for i, j := 0, len(r)-1; i < len(r)/2; i, j = i+1, j-1 {
r[i], r[j] = r[j], r[i]
}
return string(r)
}
使用 go build 命令进行编译检查
$ go build go_note/src/stringutil
go build 不会输出任何文件，通过 go install 将包对象放入 pkg 目录
确认包编译检查正确后，在 hello.go 文件中使用该包
package main
import (
"fmt"
"go_note/src/stringutil"
)
func main() {
// 输出字符串
fmt.Printf("hello, world\n")
// 反转字符串
fmt.Printf(stringutil.Reverse("\nhello, world"))
}
重新编译安装 hello
$ go install go_note/src/hello
go install 自动引入 stringutil 库
执行编译后的 hello
$ $GOPATH/bin/hello
hello, world
dlrow ,olleh
此时工作空间结构如下:
bin/
hello # command executable
pkg/
darwin_amd64/ # this will reflect your OS and architecture
go_note/src/
stringutil.a # package object
src/
go_note/src/
hello/
hello.go # command source
stringutil/
reverse.go # package source
1.6 包名
go 代码的第一条语句是包名声明语句。
package name
导入包时，通过包名指定需要导入的包
2. 测试
go 通过 go test 命令和测试包组成了一个轻量测试框架。
创建以 _test.go 结尾，函数名以 TestXXX 形式组成并且包含 func (t *testing.T) 结构的代码文件，测试框架会逐个运行这些函数，如果函数抛出 t.Error 或者 t.Fail 异常，就表示测试不通过。
新建测试文件 $GOPATH/src/go_note/src/stringutil/reverse_test.go，内容如下:
// reverse library 的测试包
package stringutil
import "testing"
func TestReverse(t *testing.T) {
cases := []struct {
in, want string
} {
{"hello, world", "dlrow ,olleh"},
{"hello, 世界", "界世 ,olleh"},
{"", ""},
}
for _, c := range cases {
got := Reverse(c.in)
if got != c.want {
t.Errorf("Reverse(%q) == %q, want %q", c.in, got, c.want)
}
}
}
执行测试工具 go test
$ go test go_note/src/stringutil
ok go_note/src/stringutil 0.006s
3. 远程包
导入路径描述如何从版本控制系统中过去代码，go 工具通过这个属性，可以获取远程包
go get 获取 https://github.com/golang/example 代码，编译并且安装相应文件
$ go get github.com/golang/example/hello
$ $GOPATH/bin/hello
Hello, Go examples!
参考
