How to Write Go Code

本文為官方文檔How to Write Go Code的閱讀總結(jié)：https://golang.org/doc/code.html

概覽

• 介紹一些基本概念和規(guī)范。
• 介紹如何寫package和使用go tool。

代碼結(jié)構(gòu)

go tool要求代碼結(jié)構(gòu)遵循固定的規(guī)范。

規(guī)范概要

• 所有g(shù)o代碼都放在一個(gè)workspace下，也就是workspace下包含多個(gè)repository。
• 每個(gè)repository可以包含多個(gè)package，每個(gè)package也可以包含多個(gè)go代碼文件。
• package所在目錄的路徑就是它的import path。

workspace

默認(rèn)是$HOME/go，可以通過GOPATH環(huán)境變量修改。

• workspace下的src子目錄用于存放repository源碼。
• bin子目錄用于存放go tool生成的可執(zhí)行文件。

注意點(diǎn)：文中說workspace下不應(yīng)使用軟鏈，原因尚不明確。

GOPATH

GOPATH環(huán)境變量的作用是指定workspace的路徑。
可以通過執(zhí)行g(shù)o env GOPATH檢查確認(rèn)當(dāng)前的workspace設(shè)置。

技巧：go env可以查看所有GO環(huán)境變量。

import paths

package類型可以分三種：

• go語言標(biāo)準(zhǔn)庫里的package。
• 本地workspace下的package。
• 遠(yuǎn)端repository。

注意點(diǎn)：自己的package不要跟標(biāo)準(zhǔn)庫的package名字相同。

first program/library and using go tool

首先創(chuàng)建一個(gè)目錄作為package，然后在這個(gè)package下編寫代碼文件。
文中將代碼分成了兩個(gè)類型

• 待main函數(shù)的代碼，叫command source或program。
• 不帶main函數(shù)的代碼，叫package source或library。

go tool

• 對(duì)于command source，執(zhí)行g(shù)o install package會(huì)編譯生成可執(zhí)行文件，并安裝到bin子目錄。
• 對(duì)于package source，執(zhí)行g(shù)o install package會(huì)生成.a目標(biāo)文件，放在 pkg子目錄。（本人測(cè)試過。）

另說明：文中提到執(zhí)行g(shù)o build package會(huì)將編譯后的package放在local build cache中，經(jīng)查1.10以前的版本沒有build cache，按照本人測(cè)試機(jī)1.9.4版本go help build的說法，對(duì)于non-main package，go build package執(zhí)行完后會(huì)刪除目標(biāo)文件，因此只起到證明package可以build的作用。

技巧及注意點(diǎn)：

• go tool命令后面跟的package名，必須是相對(duì)src目錄的路徑，不是相對(duì)當(dāng)前目錄的路徑。
• 當(dāng)前目錄是package時(shí)，可以直接執(zhí)行g(shù)o tool命令，不用跟package名。
• go tool只會(huì)在出錯(cuò)時(shí)有輸出，因此無輸出就是執(zhí)行正常。

package name

幾條規(guī)則和規(guī)范：

• 所有g(shù)o代碼文件第一行必須是package name。
• 同一個(gè)package里的代碼文件必須是同一個(gè)package name。
• 按慣例，package name就是import path的最后一級(jí)目錄名。
• 可執(zhí)行代碼文件必須是package main。
• package name沒有必要是唯一的，只需要import path唯一即可。

Test

go語言包含一個(gè)輕量級(jí)的測(cè)試框架，有兩部分：

• 一個(gè)package：testing。
• 一個(gè)命令：go test package。

規(guī)范：

• 測(cè)試代碼文件以*_test.go命名。
• import “testing”。
• 測(cè)試函數(shù)以TestXXX命名，以*testing.T為參數(shù)。
• 調(diào)用t.Error或t.Fail表示失敗。

package stringutil
import "testing"
func TestReverse(t *testing.T){
}

Remote packages

go get命令會(huì)執(zhí)行fetch，build，install等步驟。
包含remote package的項(xiàng)目且remote package沒被拉到本地時(shí)，需要用go get，用go install不行。

疑問

• rune

參考資料

• 1.10版本中才出現(xiàn)build cache：https://golang.org/doc/go1.10