Go Web Tutorial

go中好用的Web Framework

ProjectDesc
gin-gonic/gin

go中如何渲染HTML

我這邊講用原始的html/template 或 text/template

gin的框架範例很多，上網搜一下不難發現好文章。

但用原始的套件就很少(我自己是連一個都沒看到)

html/template v.s. text/template

html/template 和 text/template 有什麼不同？

  • html/template: 網路上因為會有攻擊存在，所以go已經事先幫我對一些特殊的符號進行轉譯

    📙 有時候您用html/template但是您覺得是安全的不想要進行轉譯，可以用

    template.HTML(value.String())

    能把轉譯取消

  • text/template: 當作文字檔，所以不會進行任何的轉譯

html.template

原始套件生成HTML文件，就是用 html.template

而從golang1.16開始推出了embed，

所以如果您想要把執行檔丟出去，可以把這些templates的檔案鑲嵌到執行檔之中

  • 2列: 是embed的語法，這裡我們抓取當前目錄中的static和templates下所有的東西

    ❗ 這句話會把這些資料夾中的檔案都包進去，不論您後面有沒有用到這些檔案

  • 7列: ParseFS需要的是一個fs.FS的結構，後面指定要抓取這些結構的那些檔案

    完成之後回到前面的template.New，他的參數名稱Name，就是剛才ParseFS之中的檔案名稱

  • 13列: 這一列是主要實作的核心

    HandleFunc第二個參數需要http.Handler，

    而http.Handler是一個

    type Handler interface {
    ServeHTTP(ResponseWriter, *Request)
}

    也就是只要具備ServeHTTP的方法就可以算是了，

    所以就可以去抄html.template.Template.ServerHTTP

    您可以這樣定義

    type ht struct { *template.Template }

func (t *ht) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  if err := t.Execute(w, t.context); err != nil {
      fmt.Println(err)
      w.WriteHeader(http.StatusBadRequest)
      _, _ = w.Write([]byte("BadRequest\n"))
  }
  return
}

    最後創建一個ht的instance丟過去即可(可以參見完整範例 )

 1
 2//go:embed static/* templates/*
 3var f embed.FS
 4
 5func main() {
 6    homeTemplates := template.Must(
 7        template.New("index.go.html").ParseFS(f, "templates/*.go.html", "templates/shopping-car/*.go.html"),
 8    )
 9
10    http.HandleFunc("/home/", func(w http.ResponseWriter, r *http.Request) {
11        switch r.Method {
12        case http.MethodGet:
13            homeT.ServeHTTP(w, r)
14        default:
15            return
16        }
17    })
18
19    log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", "8080"), nil))
20}

完整代碼

package main

import (
	"embed"
	"fmt"
	"html/template"
	"log"
	"net/http"
)

type Setting struct {
	EnableBootstrap bool
	ProgramInfo
}

type ProgramInfo struct {
	Author  string
	Version string
}

var (
	Config Setting
)

//go:embed static/* templates/*
var f embed.FS

type ht struct {
	*template.Template
	context map[string]interface{}
}

func (t *ht) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	if err := t.Execute(w, t.context); err != nil {
		fmt.Println(err)
		w.WriteHeader(http.StatusBadRequest)
		_, _ = w.Write([]byte("BadRequest\n"))
	}
	return
}

func main() {
	homeTemplates := template.Must(
		template.New("index.go.html").ParseFS(f, "templates/*.go.html", "templates/shopping-car/*.go.html"),
	)
	Config.EnableBootstrap = true
	Config.ProgramInfo.Version = "0.0.0"
	Config.ProgramInfo.Author = "Carson"
	homeT := ht{homeTemplates,
		map[string]interface{}{
			"Site":  Config,
			"Title": "Welcome server!",
			"Msg":   "golang is awesome!",
		},
	}

	// localhost:8080/home/
	http.HandleFunc("/home/", func(w http.ResponseWriter, r *http.Request) {
		switch r.Method {
		case http.MethodGet:
			homeT.ServeHTTP(w, r)
		default:
			return
		}
	})

	log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", "8080"), nil))
}

★template內容能怎麼寫

這一段很重要，如果您首次接觸go的template，一定要去看一下官方文檔，我這邊抓出我覺得比較重要的，

如果您想看原始說明，可以隨時點標題連結就可以連過去了

Actions

SyntaxDesc.
{{/* a comment */}}註解
{{- /* a comment */ -}}也是註解但是會移除前後的換行(我會推薦用這種方式)
{{ pipeline }}變數
{{if pipeline}} T1 {{end}}If表示式
{{if pipeline}} T1 {{else}} T0 {{end}}If else
{{if pipeline}} T1 {{else if pipeline}} T0 {{end}}if elif else
{{range pipeline}} T1 {{end}}pipeline必須是array, slice, map, channel其中之一, 如果該物件的length為0不執行T1的描述
{{range pipeline}} T1 {{else}} T0 {{end}}同上
{{template "name"}}不帶任何資料的render某樣板
{{template "name" pipeline}}以pipeline的資料render某樣板 (通常我們都用這種方式，並且pipeline通常用「.」去給，把所有東西都丟進去
{{block "name" pipeline}} T1 {{end}}當您在{{template "xxx" pipeline}}中該xxx的樣板內有{{define "name"}} T1 {{end}}，這裡的define的實作其實就是這邊block的內容
{{with pipeline}} T1 {{end}}如果pipeline為空則不執行T1，另外您也可以放入dot(.)他也會執行T1
{{with pipeline}} T1 {{else}} T0 {{end}}

Arguments

NameDesc.
.
nil同Go的nil
$myVar變數
.Field取得Field(go中render此樣板必須含有Field才行
.Field.Filed支持嵌套 嵌套的內容幾乎甚麼都可以像是變數、Map,Method等等

Variables

宣告某變數

$variable := pipeline

重新設定某變數

$variable = pipeline

range用法

range $index, $element := pipeline

Functions

Nameexample
andand x y if x then y else x
callcall .X.Y 1 2 Go notation, dot.X,Y(1, 2)
indexindex x 1 2 3 x[1][2][3]
sliceslice x x[:], slice x 1 x[1:], slice x 1 2 3 x[1:2:3]
htmlReturns the escaped HTML equivalent of the textual representation of its arguments
jsReturns the escaped JavaScript equivalent of the textual representation of its arguments.
len
not
or
printAn alias for fmt.Sprint
printfAn alias for fmt.Sprintf
printlnAn alias for fmt.Sprintln
urlquery

binary comparison operators

NameDesc
eqReturns the boolean truth of arg1 == arg2
neReturns the boolean truth of arg1 != arg2
ltReturns the boolean truth of arg1 < arg2
leReturns the boolean truth of arg1 <= arg2
gtReturns the boolean truth of arg1 > arg2
geReturns the boolean truth of arg1 >= arg2
comments powered by Disqus