在學習go語言的過程當中, 你也許問過自己一個問題, GOPATH到底是做什麼的? 或許在寫過一些程式碼之後, 很快你就會在網上找到一些資料, 它告訴我們GOPATH這個環境變數它指定了一個目錄, 這個目錄包含了我們所有的原始碼, 比如這裡的介紹, 但是我覺得光是理解這一點是不夠的, 因為你會發現讓人為難的是, 看起來似乎我們每新建一個專案, 都要往GOPATH再補充一條路徑, 這實在是反人類的做法啊.

我自己曾經也有過那樣的顧慮, 為了鞏固自己的理解, 同時也為了讓其他讀者更清楚GOPATH的作用, 我希望這篇小文希望能夠起到一定的作用.
基本探索

讓我們先從目錄結構開始說起, 在寫registry-watch這個專案的時候, 編輯器經常提示我結構不正確, 於是在網上搜了搜, 找到了這個.

按照文件的說法, 作為一個workspace, 它需要包含三個目錄:

workspace
|– src
|– pkg
|– bin

src表示我們的原始碼目錄, 在不考慮另外兩個目錄的情況下, 假設我寫了一個demo專案, 並新建了一個hello.go, 它是main模組, 同時它依賴於另外一個函式, 該函式位於library/world.go:

hello.go

package main

import “fmt”
import “demo/library”

func main() {
fmt.Println(“Hello, ” + library.World())
}

world.go

package library

// World return “World”
func World() string {
return “World”
}

於是目錄結構變成了現在這個樣子:

workspace
|– src
| |– demo
| | |– hello.go
| | |– library
| | | |– world.go
|– pkg
|– bin

現在我cd src目錄並執行go install demo後, 我們發現以下變化:

workspace
|– src
| |– demo
| | |– hello.go
| | |– library
| | | |– world.go
|– pkg
| |– darwin_amd64
| | |– demo
| | | |– library.a
|– bin
| |– demo

這個例子基本說明了問題, 當我們寫的模組是main時, 它會對應到一個可執行檔案, 並且編譯後的檔案會被複制到bin目錄, 如果是其他模組, 它會被編譯成一個庫檔案, 並且被複制到pkg目錄. 這就是我們必須提供三個目錄的原因, 一個放原始碼, 一個放編譯後的可執行檔案, 另外一個放編譯後的庫檔案.
協作

一個專案總是會由多個成員進行協作開發, 在觀察我們的專案結構之後, 很自然的, 我們會發現應該被提交的程式碼只有hello.go和library/world.go, 也就是說我們的.git目錄應該位於src/demo之下.

workspace
|– src
| |– demo
| | |– .git
| | |– hello.go
| | |– library
| | | |– world.go
|– pkg
|– bin

再考慮另外一個問題, 我們經常會執行go get xxx去安裝一些包, 這些包會被下載到$GOPATH/src目錄下, 當另外一個團隊成員拉下我們的程式碼時, 如果還需要逐個去執行go get xxx那就太不方便了, 於是我們需要藉助一個依賴管理的工具, 這就是godep. 當我們執行過go get xxxx安裝過依賴之後, 只要再到專案目錄下, 執行godep save, 便會將所有的依賴記錄在一個檔案當中, 並且這個時候我們的目錄結構再次發生了一些小小的變化.

workspace
|– src
| |– demo
| | |– .git
| | |– Godeps
| | | |– _workspace
| | | |– Godeps.json
| | |– hello.go
| | |– library
| | | |– world.go
|– pkg
|– bin

現在來到需要拉程式碼的這一方, 對於像上面這樣一個倉庫. 我們需要多考慮一些事情. 我們不如以kubernetes為例來做示例:

初看可能會奇怪, 為什麼需要指定目的目錄呢, 尤其是k8s.io看起來好生奇怪, 其實只要大概找一個原始碼檔案看看就知道了, 比如這個檔案

pkg/api/context.go

package api

import (
stderrs “errors”
“time”

"golang.org/x/net/context"
"k8s.io/kubernetes/pkg/auth/user"

)

我們知道import路徑都是針對$GOPATH/src的, 所以很自然的我們要有k8s.io這個目錄.
總結

這個時候, 我們回到一開始提到的顧慮, 我們真的需要對每一個專案都新增一條GOPATH路徑嗎? 不然, 我們所說的專案不過是以一個資料夾的形式存在於$GOPATH/src中, 我們只需要配置一個GOPATH, 並把專案都建在src目錄下就可以了.