02 Hello World

Tags:

在剛開始學習一個程式語言的時候，我喜歡先用很簡單的程式來盡量體驗實際開發和部署流程中可能會用到的相關工具，而不是等到大部分的程式語法都學會之後才去學那些工具的用法。

因此，這裡要練習撰寫的 Hello World 範例程式會有幾個不同的版本：

  1. 首先要寫一個最簡單的 Hello World 程式，開始認識 Go 應用程式的基本結構：模組和套件。
  2. 接著對 Hello World 做一點小改版，以便快速體驗如何撰寫單元測試。
  3. 繼續修改 Hello World 範例。這次要加入一點註解，然後用 godoc 工具來產生文件。
  4. 一個非常簡單的 HTTP server。

乍看可能會覺得練習的份量多了點，但其實每一個練習都很簡單。

Hello World

首先要建立一個專案目錄，並使用 go mod init 命令來建立模組：

mkdir demo01
cd demo01
go mod init demo01

備註：這個 "mod" 一般讀音近似「罵的」。似乎比較少聽到「mode」的唸法。

上述命令會在當前目前建立一個 go.mod 檔案，內容是該模組的資訊，以及描述它依賴哪些外部模組（如果有的話）。上述指令所建立的 go.mod 檔案內容會像這樣：

module demo01

go 1.23.0

這個模組即代表一個 project，其名稱通常是你的 Git repository 的名稱，而且所在目錄的名稱也會跟模組名稱一樣。比如說，如果是 GitHub 平台上的一個名為 "learning-go" 的 repository，那麼剛才的 go mod init 指令會這麼寫：

mkdir learning-go
cd learning-go
go mod init github.com/learning-go

而此命令一樣只是單純地在當前目錄下建立一個 go.mod 檔案，內容為：

module github.com/learning-go

go 1.23.0

有關 module 的運作方式與內容寫法還有許多細節可談，這裡只先整理一點小常識：

  • 一個 module 即是一個 project，有一個版本編號。
  • go.mod 檔案所在的目錄稱為 模組根目錄（module root directory）。

透過 go.mod 檔案把專案的基本資訊定義好之後，接著要往下一個實作議題靠近：套件（package）。

一個 project 是由一個或多個程式檔案組成，而這個組成的方式，是以 package 來作為邏輯分割單位。之所以說「邏輯分割」，是因為一個 package 通常會由多個 .go 的程式檔案所組成。

延續剛才的範例，在 demo01 目錄下建立一個 hello.go 檔案，內容為：

package main

import (
    "fmt"
)

func main() {
    fmt.Println("Hello, World!")
}

在這個檔案中：

  • package main 表明此套件的名稱叫做 main。
  • import 表明此套件需要引用 fmt 套件。
  • main() 函式為應用程式的進入點。

這裡需要介紹一點 Go 的 package 小常識，即 Go 的 package 有兩種：

  • Executable package：要編譯成可執行的應用程式，其 package 名稱必須是 main，而且會包含程式的進入點：main 函式。
  • Library package：供其他套件引用，不會編譯成可執行檔。這類套件的名稱不會是 main，而應該是符合該套件用途的名稱，例如 http、list、fmt 等等。注意 Go 官方建議的套件命名慣例是簡短而且全部小寫，即不要大小寫混用，也不要使用底線字元 ( _ )。此外，套件名稱是可以用縮寫的——前提是那個縮寫是很常見、且一看就明白，例如 fmt、strconv 等等。

命名不是一件容易的事。有關 package 的命名，可參考 Go 部落格的 Package names。

現在回到我們的範例程式。到目前為止，此應用程式的檔案目錄結構會像這樣：

/demo01
    go.mod
    hello.go

由於我們打算建立一個可執行的應用程式，故此範例的 package 名稱是 main，而且有進入點 main 函式。順便提及，雖然套件名稱是 main，但程式檔案名稱並不需要命名為 main.go（當然也可以這麼做）。

建置與執行程式

接著，使用 go run 命令來執行此程式：

cd demo01
go run hello.go

或者

cd demo01
go run .

或者

go run demo01/hello.go

以上三種寫法都行。

如果要建置應用程式，則是用 go build 命令來將程式碼編譯成可執行檔：

cd demo01
go build

上述命令會在當前目錄下產生一個可執行檔，檔案名稱會是 demo01.exe（因為 go.mod 檔案中宣告的模組名稱是 demo01）。

如果要在 Windows 作業環境的 PowerShell 命令視窗中執行此範例程式，請輸入 ./demo01，而不要只輸入 demo01，否則 PowerShell 可能會告訴你無法識別該命令。

建置應用程式時，也可以透過參數來指定輸出的可執行檔案名稱。例如：

go build -o hello.exe

由 go build 命令所產生的可執行檔案就是一個可直接部署的應用程式。也就是說，不需要額外打包函式庫，而只要把這個可執行檔複製到其他電腦上面就能執行。

不過，如果建置應用程式所在的作業環境跟部署的目標環境是不同平台，就需要稍微動一點手腳。關於這個部分，會需要知道 Go 的兩個環境變數：

  • GOOS：指定目標作業系統。
  • GOARCH：指定目標機器的指令架構。

詳情可參閱官方文件：Environment variables。

加入單元測試

本節要為先前的範例程式加入單元測試，稍微體會一下「單元測試是 Go 程式的一級公民」這句話的意思。

首先，把之前的 demo01 目錄下的 hello.go 檔案改成以下內容：

package main

func hello() string {
    return "Hello, World!"
}

這裡定義了一個名為 hello 的函式，此函式沒有傳入參數，而回傳值是一個字串 "Hello, World!"。

接著，在相同目錄下新增一個 main.go 檔案，內容為：

package main

import "fmt"

func main() {
    fmt.Println(hello())
}

也就是說，程式的進入點 main() 函式會去呼叫 hello.go 中的 hello() 函式來取得欲顯示的字串。

在加入單元測試之前，先用 go build 命令來建置應用程式，看看能否順利編譯和執行。

Go 的單元測試檔案有固定的命名慣例：其主檔名必須以 _test 結尾。比如說，要測試的對象是 hello.go，那麼其測試檔案的名稱就必須是 hello_test.go，而且兩個檔案要放在同一個目錄下。

因此，我們接著要新增一個 hello_test.go 檔案，內容如下：

package main

import "testing"

func TestHello(t *testing.T) {
    actual := hello()
    expect := "Hello, World!"

    if actual != expect {
        t.Errorf("got %q want %q", actual, expect)
    }
}

此測試函式的邏輯不難看懂，以下是比較需要解釋的地方：

  • 測試函式的命名必須以大寫英文字母開頭，也就是 exported 函式（可供外界存取），這樣才能讓測試工具「看得見」它。
  • 測試函式固定有一個傳入參數： t *testing.T。這個參數會由測試工具傳入，內容則是測試框架的執行個體。
  • actual 和 expect 是變數，這裡透過運算子 := 來一次完成兩件事：宣告一個變數並賦予初始值。

這裡順便說一下有關變數的語法。

宣告變數時，可使用關鍵字 var，並且使用 = 運算子來賦值。

範例：

var x int
var y int = 100

也使用 := 運算子來一次完成兩件事：宣告變數且賦值，而且不用寫 var。例如：

sum := 100          // sum 是一個整數。
actual := hello()   // actual 是一個字串，因為 hello 函式返回的是字串。

回到剛才的範例程式，接著請開啟一個命令視窗，使用以下命令來運行測試：

cd demo01
go test

如果測試成功，應該會顯示 "PASS"：

PASS
ok      hellogo 0.116s

go test 命令的其他常用選項：

  • -v：Verbose output，即輸出詳細訊息。
  • failfast：只要碰到一個失敗的測試就立即停止，不再往下執行其餘測試。使用此選項可以讓我們一次專注處理一個失敗的測試。
See also

除了單元測試，go test 還可以執行效能測試。在後面介紹字串處理的時候有示範如何撰寫和執行效能測試，詳見練習：打亂字串內容。

用 godoc 產生文件

Go 工具組當中有一個 godoc 可以用來產生應用程式的文件。我們可以用前面的範例程式來簡單體驗一下。

首先，在 main.go 檔案的最上方加入一些註解：

/*
Demo01 is a simple program that prints "Hello, World!" to the console.
It also demonstrates how to write tests for Go programs.
*/
package main

import "fmt"

func main() {
    fmt.Println(hello())
}

接著開啟命令視窗，執行 godoc：

cd demo01
godoc -http=localhost:8000

然後 godoc 會輸出一些訊息：

using module mode; GOMOD=D:\Projects\learning-go\demo01\go.mod
go: no module dependencies to download

然後，本機應該會起始一個 HTTP 服務，你可以用瀏覽器開啟 http://localhost:8000 來查看生成的文件，看起來會像底下這張截圖。

在此頁面搜尋字串 "demo01"，應該就能找到剛才加入的註解。

簡單的 HTTP server

Go 標準函式庫的 http 套件提供了開發 web client 和 web server 的相關功能。底下是一個簡單的 HTTP server 範例程式。

package main

import (
    "fmt"
    "net/http"
)

func hello(w http.ResponseWriter, req *http.Request) {
    fmt.Fprintf(w, "Hello world!\n")
}

func main() {
    http.HandleFunc("/hello", hello)
    http.ListenAndServe(":8090", nil)
}

在此程式檔案的所在目錄下使用 go run . 命令來執行此程式，便可啟動一個 HTTP server，監聽的 port 是 8090。

接著開啟瀏覽器測試看看，在網址列輸入 http://localhost:8090/hello，應該能在網頁上看到 "Hello world!"。這是因為程式中使用了 http.HandleFunc() 函式來指定路徑 /hello 的 HTTP 請求要指派給 hello 函式處理。

Factored import

此範例的 import 敘述採用了所謂的「factored`」 import 寫法，也就是以圓形括弧包住所有需要引用的套件。引用多個套件十，一般的慣例是先寫標準函式庫的套件，然後是其他非標準函式庫的套件。例如：

import (
    "fmt"
    "net/http"

    "golang.org/x/net/html"
)

Summary

前面幾個練習涵蓋了下列議題：

  • 如何建立模組和套件，以及它們是怎麼運作的。
  • 如何宣告變數和賦值。
  • 使用 go build 來建置應用程式。
  • 撰寫和運行單元測試。
  • 一個極陽春的 HTTP server。

以下回顧幾個重點觀念：

  • Go 的 package 有兩種：executable package 和 library package。
  • Executable package 會編譯成可執行的應用程式，其 package 名稱必須是 main，而且會包含程式的進入點：main 函式。
  • 除了 main package 之外，一般的 packages 都應該取一個符合其用途的名稱，例如 http、list、fmt 等等。
    • 套件的命名慣例是簡短而且全部小寫，即不要大小寫混用，也不要使用底線字元 ( _ )。
    • 套件名稱是可以用縮寫的——前提是那個縮寫是很常見、且一看就明白，例如 fmt、strconv 等等。
  • 單元測試：
    • Go 的單元測試檔案有固定的命名慣例：其主檔名必須以 _test 結尾。比如說，要測試的對象是 hello.go，那麼其測試檔案的名稱就必須是 hello_test.go，而且兩個檔案要放在同一個目錄下。
    • 測試函式的命名必須以大寫英文字母開頭，也就是 exported 函式（可供外界存取），這樣才能讓測試工具「看得見」它。

先這樣，也許有空時會再更新。   我的其他站點：      

Last modified: 2024-10-20