workspace

Golang 的代码必须放置在一个 workspace 中。一个 workspace 是一个目录，此目录中包含几个子目录：

  • src 目录。包含源文件，源文件被组织为包（一个目录一个包）
  • pkg 目录。包含包目标文件（package objects）
  • bin 目录。包含可执行的命令包源文件（package source）被编译为包目标文件（package object），命令源文件（command source）被编译为可执行命令（command executable）。使用 go 命令进行构建生成的包目标文件位于 pkg 目录中，生成的可执行命令位于 bin 目录中。开发 Golang 需要设置一个环境变量 GOPATH，此环境变量用于指定 workspace 的路径，另外，也可以把 workspace 的 bin 目录加入到 PATH 环境变量中去。

包路径

包位于 src 目录下，只要不发生冲突（例如和标准库冲突），我们可以使用任意的包路径。假如我们在 GitHub 有一个账号 name5566，并且存在一个项目 hello，那么我们可以在 src 目录下构建这样的目录结构：

  1. github.com/name5566/hello

在 import 中使用此包路径来导入相关的包。

第一个可执行命令

现在来编写第一个 Golang 程序 hello。假定已经配置好了 GOPATH，并且包路径使用 github.com/name5566/hello，在此目录下创建文件 hello.go：

  1. package main
  3. import "fmt"
  5. func main() {
  6.     fmt.Printf("Hello, world.\n")
  7. }

执行命令（可在任意处执行）：

  1. go install github.com/name5566/hello

这个命令可以编译 hello 命令，生成一个可执行命令 hello 并放置于 bin 目录下。如果 go 命令没有任何输出表示执行成功。

第一个包目标文件

现在开始创建一个包目标文件（也就是库文件），首先建立包路径 github.com/name5566/newmath，在此目录下创建文件 sqrt.go：

  1. package newmath
  3. func Sqrt(x float64) float64 {
  4.     z := 1.0
  5.     for i := 0; i < 1000; i++ {
  6.         z -= (z*z - x) / (2 * z)
  7.     }
  8.     return z
  9. }

我们可以测试编译此包：

  1. go build github.com/name5566/newmath

此命令不会有任何输出文件，如果需要在 pkg 目录下生成包目标文件，使用 go install。

现在来修改一下 hello.go：

  1. package main
  3. import (
  4.     "fmt"
  5.     "github.com/name5566/newmath"
  6. )
  8. func main() {
  9.     fmt.Printf("Hello, world. Sqrt(2) = %v\n", newmath.Sqrt(2))
  10. }

编译安装 hello：

  1. go install github.com/name5566/hello

go 命令能够自己分析依赖关系，这里的 newmath 包会被自动安装到 pkg 目录下。

另外需要注意的是，Golang 使用静态链接（运行 Go 程序无需包目标文件）。

测试

Golang 带有轻量级测试框架，主要包括：

  • go test 命令
  • testing 包创建文件 _test.go 来编写测试，例如为 sqrt.go 创建的测试文件为 sqrt_test.go：
  1. package newmath
  3. import "testing"
  5. func TestSqrt(t *testing.T) {
  6.     const in, out = 4, 2
  7.     if x := Sqrt(in); x != out {
  8.         t.Errorf("Sqrt(%v) = %v, want %v", in, x, out)
  9.     }
  10. }

执行测试使用 go test：

  1. go test github.com/name5566/newmath

测试文件中包含的所有测试函数 func TestXxx(t *testing.T) 都会被执行。测试函数可以通过 Error、Fail 等相关方法告知出现错误。

另外，在测试文件中还可以编写范例代码，例如：

  1. func ExampleHello() {
  2.     fmt.Println("hello")
  3.     // Output: hello
  4. }

这里 Example 函数结尾可以跟上一个以 “Output:” 字符串开始的注释（被叫做输出注释），在测试运行时会将 Example 函数输出注释中字符串和函数标准输出进行比对。需要注意的是，如果没有输出注释，Example 函数是不会被运行的（但是会被编译）。

Example 函数命名有这样的习惯：

  1. func Example() { ... }
  2. func ExampleF() { ... }
  3. func ExampleT() { ... }
  4. func ExampleT_M() { ... }

这里的 F 为函数名，T 为类型名，T_M 为类型 T 上的方法 M。

获取远程仓库的包

使用 go get 能够自动获取并安装远程仓库的包，例如：

  1. go get code.google.com/p/go.example/hello