Go範例:文字範本

Go透過text/template套件提供內建支援,供建立動態內容或向使用者展示自訂輸出。名為html/template的相關套件提供相同的API,但具有額外的安全性功能,應使用於產生HTML。

package main
import (
    "os"
    "text/template"
)
func main() {

我們可以建立新的範本並從字串解析其主體。範本是靜態文字和在{{...}}中封閉的「動作」的混和,用於動態插入內容。

    t1 := template.New("t1")
    t1, err := t1.Parse("Value is {{.}}\n")
    if err != nil {
        panic(err)
    }

或者,我們可以使用template.Must函式在Parse傳回錯誤的情況下發出恐慌。這對於在全域範圍中初始化的範本特別有用。

    t1 = template.Must(t1.Parse("Value: {{.}}\n"))

透過「執行」範本來產生文字,並使用特定值作為其動作。{{.}}動作會替換為傳遞給Execute作為參數的值。

    t1.Execute(os.Stdout, "some text")
    t1.Execute(os.Stdout, 5)
    t1.Execute(os.Stdout, []string{
        "Go",
        "Rust",
        "C++",
        "C#",
    })

輔助函式會使用在下方。

    Create := func(name, t string) *template.Template {
        return template.Must(template.New(name).Parse(t))
    }

如果資料為結構體,我們可以使用{{.FieldName}}動作存取其欄位。在範本執行時,應公開欄位以供存取。

    t2 := Create("t2", "Name: {{.Name}}\n")
    t2.Execute(os.Stdout, struct {
        Name string
    }{"Jane Doe"})

對應套用於地圖;在對應中對應名稱的大小寫沒有限制。

    t2.Execute(os.Stdout, map[string]string{
        "Name": "Mickey Mouse",
    })

if/else提供範本的條件式執行。如果某個值是某種類型的預設值,例如0、空字串、空白指標,則該值會被視為假。此範例說明了範本的另一個功能:在動作中使用-來移除空白。

    t3 := Create("t3",
        "{{if . -}} yes {{else -}} no {{end}}\n")
    t3.Execute(os.Stdout, "not empty")
    t3.Execute(os.Stdout, "")

range區塊讓我們得以迴圈瀏覽切片、陣列、對應或頻道。在range區塊內,{{.}}會設定為反覆運算的目前項目。

    t4 := Create("t4",
        "Range: {{range .}}{{.}} {{end}}\n")
    t4.Execute(os.Stdout,
        []string{
            "Go",
            "Rust",
            "C++",
            "C#",
        })
}
$ go run templates.go 
Value: some text
Value: 5
Value: [Go Rust C++ C#]
Name: Jane Doe
Name: Mickey Mouse
yes 
no 
Range: Go Rust C++ C# 

下個範例:正規表示法