Go語言實戰_ZenDei技術網路在線

本文通過從無到有創建一個利用Go語言實現的非常簡單的HttpServer，來讓大家熟悉利用Go語言時的基本流程，工具和代碼的基本佈局，為學習Go語言時碰到的環境問題掃清障礙。 ...

本文通過從無到有創建一個利用Go語言實現的非常簡單的HttpServer，來讓大家熟悉利用Go語言時的基本流程，工具和代碼的基本佈局，為學習Go語言時碰到的環境問題掃清障礙。

以一個簡單的場景來舉例，有一個可復用的庫(hugger)和一個使用這個庫的應用程式(hugmachine)，代碼都托管在Github上。

代碼佈局

go工具

go命令是一個管理Go源代碼的工具，可以用來做很多事情：

build 編譯包和依賴
clean 刪除對象文件
fmt 對代碼風格格式化
get 下載並安裝包和依賴(遞歸地進行)
install 編譯並安裝包和依賴
list 列出所有的包
run 編譯和運行Go程式
test 運行以包為單位的測試
vet 做Go源代碼的檢查，發現編譯器沒有發現的錯誤

go命令大部分(除了run)都是以包為單位的，而不是單個的文件。

概述

go這個工具要求程式猿按照特定的方式把代碼組織在一起，主要體現在：

Go程式猿通常把所有的Go代碼(多個項目)都放到一個工作區(workspace)下，這跟其他的編程環境不一樣，其他的編程環境里，通常是每個項目有各自的工作區
一個工作區下可以包含不同版本控制(Git, VCS)下的代碼倉庫

Go語言中，一個工作區的根目錄下包含三個基本的目錄：

src 裡面是Go的源代碼文件
pkg 裡面是包(package)對象文件
bin 裡面是可執行的命令

其中後兩個目錄是go工具自動產生的：它把源代碼構建過程中生成的對象文件放到pkg目錄下，然後把對應生成的二進位文件放到bin目錄下。

`GOPATH`環境變數

GOPATH環境變數是必須要設置的，$GOPATH環境變數必須指向Go工作區(workspace)的根。開發Go代碼，大部分情況下都只需設置這一個環境變數。Go的構建過程會按照go help gopath里描述的約定來走，例如Go會去GOPATH列出了的所有目錄里尋找Go代碼(所有的包都在$GOPATH/src目錄下)，會把新的包下載到GOPATH列出的第一個目錄里。當然並不是所有的項目都會按照這些約定來，它們可以不使用go工具集。

接下來我們以一個簡單的場景來舉例，從零開始實現一個可復用的庫(hugger)和一個使用這個庫的應用程式(hugmachine)，它們的代碼都托管在Github上，各自在自己的repository里。你在Github上的這兩個repository都會被clone 到$GOPATH/src下的各個文件夾下。即src/github.com/Jack47/下的每個目錄都是一個獨立git clone出來的repository。

你的代碼佈局可能看起來是這樣的：

$GOPATH
  src/
    github.com/
        Jack47/
            hugger/
                .git/
                hugger.go
                hugger_test.go
                README.md
            hugmachine/
                .git/
                hugmachine.go
                hugmachine_test.go
                README.md

創建工作區(workspace)

先在Github上創建這兩個新的repositories。然後在本地設置GOPATH，建好上級目錄，克隆出兩個repository出來：

cd ~/
mkdir go-workspace 
export GOPATH=~/go-workspace
cd $GOPATH
mkdir -p  src/github.com/Jack47
cd src/github.com/Jack47
git clone [email protected]:Jack47/hugmachine.git
git clone [email protected]:Jack47/hugger.git

自己的程式庫(Libraries)

按慣例，代碼倉庫的名稱和它包含的Go包(package)的名稱應該是保持一致的。我們的hugger代碼倉庫包含定義了hugger包的hugger.go文件:

package hugger

func Hugger() string {
    return "You are warmly hugged!\n"
}

應用程式

一個應用程式--將被編譯成可執行命令的Go代碼--總是需要定義為package main並有一個main()函數。

因此hugmachine.go可能看起來是這樣的：

package main

import (
    "os"
    "io"
    "net/http"
    "strconv"

    "github.com/Jack47/hugger"
    logging "github.com/op/go-logging"
)

func heartbreakerHandler(w http.ResponseWriter, req *http.Request) {
    logger.Infof("Meet heartbreaker from %s", req.Host)
    io.WriteString(w, hugger.Hug())
}

var LISTENING_PORT = 1024
var logger = logging.MustGetLogger("hugmachine.log")

func main() {
    logging.NewLogBackend(os.Stderr, "", 0)
    http.HandleFunc("/heartbreaker", heartbreakerHandler)
    logger.Infof("Listening on port %d", LISTENING_PORT)
    err := http.ListenAndServe("0.0.0.0:"+strconv.Itoa(LISTENING_PORT), nil)
    if err != nil {
        logger.Fatal("ListenAndServe: " + err.Error())
    }
}

import path

在Go中，約定是把代碼的位置包含在import path中，例如 hugger 包:

    $GOPATH/src/github.com/Jack47/hugger

在hugmachine.go中引用hugger時，是這樣寫的:

    import(
        "github.com/Jack47/hugger"
    )

讓你的包可以通過go get下載

go get有一個特點是它可以識別出知名的代碼托管網站的路徑，例如Github,Bitbucket。這樣它就可以把包的import path轉換成正確的命令來check out出代碼。這樣你甚至可以通過go get import-path/package-name來自動下載並安裝package-name及其依賴包。例如：

$ go get github.com/golang/example/hello
$ $GOPATH/bin/hello
Hello, Go examples!

如果go get時指定的包已經在工作區下，那麼go get會跳過checkout遠程代碼這一步，執行類似go install的操作。此時如果需要更新這個包，使用go get -u。但是所有通過go get checkout出來的Github repo都預設使用只讀的 https://。為了能把修改push回github，需要修改.git/config里的origin/master引用，指向Github上的SSH的repo。

依賴

你的項目可能會直接依賴很多已有的包。上面的hugmachine程式直接依賴於github.com/op/go-logging和github.com/Jack47/hugger。通過go list ...命令可以看到這個項目所有的依賴包。可以通過在你的工作區(workspace)的根路徑上運行 go get -v ./...(go help packages來看完整的對...語法的解釋)來安裝所有的依賴(直接和間接依賴)。go get命令跟go install命令類似，它會嘗試build然後遞歸安裝所有的依賴包到工作區下$GOPATH/src目錄下。

構建

在開發過程中可以通過命令go build ...hugger來構建hugger庫。也可以指定到包名的全路徑，go build github.com/Jack47/hugger。

使用命令go build ...hugmachine 來編譯 hugmachine.go和相關依賴為可執行文件。此時在 $GOPATH目錄下會出現hugmachine可執行文件。也可以使用go install ...hugmachine,他會編譯並安裝指定的包到$GOPATH/bin目錄下。

此時執行hugmachine命令,會看到程式運行起來了：

$ ./hugmachine
2016/10/28 09:31:43 Listening on port 1024

通過在瀏覽器里訪問http://localhost:1024/heartbreaker ，可以看到hugmachine的返回結果。

如果你的工程項目比較複雜，可以參考下這些開源軟體的代碼佈局：
filebeat

參考資料
Github Code Layout
go lang wiki

Go語言實戰