快捷導(dǎo)航

Go html/template 模板的使用實(shí)例詳解

更新時(shí)間：2019年05月31日 15:13:19 作者：big_cat

這篇文章主要介紹了Go html/template 模板的使用實(shí)例詳解，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

從字符串載入模板

我們可以定義模板字符串，然后載入并解析渲染：

template.New(tplName string).Parse(tpl string)

// 從字符串模板構(gòu)建
tplStr := `
  {{ .Name }} {{ .Age }}
`
// if parse failed Must will render a panic error
tpl := template.Must(template.New("tplName").Parse(tplStr))
tpl.Execute(os.Stdout, map[string]interface{}{Name: "big_cat", Age: 29})

從文件載入模板

模板語法

模板文件，建議為每個(gè)模板文件顯式的定義模板名稱： {{ define "tplName" }} ，否則會(huì)因模板對(duì)象名與模板名不一致，無法解析（條件分支很多，不如按一種標(biāo)準(zhǔn)寫法實(shí)現(xiàn)），另展示一些基本的模板語法。

使用 {{ define "tplName" }} 定義模板名
使用 {{ template "tplName" . }} 引入其他模板
使用 . 訪問當(dāng)前數(shù)據(jù)域：比如 range 里使用 . 訪問的其實(shí)是循環(huán)項(xiàng)的數(shù)據(jù)域
使用 $. 訪問絕對(duì)頂層數(shù)據(jù)域

views/header.html

{{ define "header" }}
<!doctype html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport"
     content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>{{ .PageTitle }}</title>
</head>
{{ end }}
views/footer.html
{{ define "footer" }}
</html>
{{ end }}

views/index/index.html

{{ define "index/index" }}
  {{/*引用其他模板 注意后面的 . */}}
  {{ template "header" . }}
  <body>
  <div>
    hello, {{ .Name }}, age {{ .Age }}
  </div>
  </body>
  {{ template "footer" . }}
{{ end }}

views/news/index.html

{{ define "news/index" }}
  {{ template "header" . }}
  <body>
  {{/* 頁面變量定義 */}}
  {{ $pageTitle := "news title" }}
  {{ $pageTitleLen := len $pageTitle }}
  {{/* 長度 > 4 才輸出 eq ne gt lt ge le */}}
  {{ if gt $pageTitleLen 4 }}
    <h4>{{ $pageTitle }}</h4>
  {{ end }}

  {{ $c1 := gt 4 3}}
  {{ $c2 := lt 2 3 }}
  {{/*and or not 條件必須為標(biāo)量值 不能是邏輯表達(dá)式 如果需要邏輯表達(dá)式請(qǐng)先求值*/}}
  {{ if and $c1 $c2 }}
    <h4>1 == 1 3 > 2 4 < 5</h4>
  {{ end }}

  <div>
    <ul>
      {{ range .List }}
        {{ $title := .Title }}
        {{/* .Title 上下文變量調(diào)用  func param1 param2 方法/函數(shù)調(diào)用  $.根節(jié)點(diǎn)變量調(diào)用 */}}
        <li>{{ $title }} -- {{ .CreatedAt.Format "2006-01-02 15:04:05" }} -- Author {{ $.Author }}</li>
      {{end}}
    </ul>
    {{/* !empty Total 才輸出*/}}
    {{ with .Total }}
      <div>總數(shù)：{{ . }}</div>
    {{ end }}
  </div>
  </body>
  {{ template "footer" . }}
{{ end }}

template.ParseFiles

手動(dòng)定義需要載入的模板文件，解析后制定需要渲染的模板名 news/index 。

// 從模板文件構(gòu)建
tpl := template.Must(
  template.ParseFiles(
    "views/index/index.html",
    "views/news/index.html",
    "views/header.html",
    "views/footer.html",
  ),
)

// render template with tplName index
_ = tpl.ExecuteTemplate(
  os.Stdout,
  "index/index",
  map[string]interface{}{
    PageTitle: "首頁",
    Name: "big_cat",
    Age: 29,
  },
)
// render template with tplName index
_ = tpl.ExecuteTemplate(
  os.Stdout,
  "news/index",
  map[string]interface{}{
    "PageTitle": "新聞",
    "List": []struct {
      Title   string
      CreatedAt time.Time
    }{
      {Title: "this is golang views/template example", CreatedAt: time.Now()},
      {Title: "to be honest, i don't very like this raw engine", CreatedAt: time.Now()},
    },
    "Total": 1,
    "Author": "big_cat",
  },
)

template.ParseGlob

手動(dòng)的指定每一個(gè)模板文件，在一些場(chǎng)景下難免難以滿足需求，我們可以使用通配符正則匹配載入。

1、正則不應(yīng)包含文件夾，否則會(huì)因文件夾被作為視圖載入無法解析而報(bào)錯(cuò)

2、可以設(shè)定多個(gè)模式串，如下我們載入了一級(jí)目錄和二級(jí)目錄的視圖文件

// 從模板文件構(gòu)建
tpl := template.Must(template.ParseGlob("views/*.html"))
template.Must(tpl.ParseGlob("views/*/*.html"))
// render template with tplName index
// render template with tplName index
_ = tpl.ExecuteTemplate(
  os.Stdout,
  "index/index",
  map[string]interface{}{
    PageTitle: "首頁",
    Name: "big_cat",
    Age: 29,
  },
)
// render template with tplName index
_ = tpl.ExecuteTemplate(
  os.Stdout,
  "news/index",
  map[string]interface{}{
    "PageTitle": "新聞",
    "List": []struct {
      Title   string
      CreatedAt time.Time
    }{
      {Title: "this is golang views/template example", CreatedAt: time.Now()},
      {Title: "to be honest, i don't very like this raw engine", CreatedAt: time.Now()},
    },
    "Total": 1,
    "Author": "big_cat",
  },
)

Web服務(wù)器

結(jié)合模板庫和 Gin 實(shí)現(xiàn)一個(gè)可以使用模板渲染并返回 html 頁面的 web 服務(wù)。

package main

import (
  "html/template"
  "log"
  "net/http"
  "time"
)

var (
  htmlTplEngine  *template.Template
  htmlTplEngineErr error
)

func init() {
  // 初始化模板引擎 并加載各層級(jí)的模板文件
  // 注意 views/* 不會(huì)對(duì)子目錄遞歸處理 且會(huì)將子目錄匹配 作為模板處理造成解析錯(cuò)誤
  // 若存在與模板文件同級(jí)的子目錄時(shí) 應(yīng)指定模板文件擴(kuò)展名來防止目錄被作為模板文件處理
  // 然后通過 view/*/*.html 來加載 view 下的各子目錄中的模板文件
  htmlTplEngine = template.New("htmlTplEngine")

  // 模板根目錄下的模板文件 一些公共文件
  _, htmlTplEngineErr = htmlTplEngine.ParseGlob("views/*.html")
  if nil != htmlTplEngineErr {
    log.Panic(htmlTplEngineErr.Error())
  }
  // 其他子目錄下的模板文件
  _, htmlTplEngineErr = htmlTplEngine.ParseGlob("views/*/*.html")
  if nil != htmlTplEngineErr {
    log.Panic(htmlTplEngineErr.Error())
  }

}

// index
func IndexHandler(w http.ResponseWriter, r *http.Request) {
  _ = htmlTplEngine.ExecuteTemplate(
    w,
    "index/index",
    map[string]interface{}{"PageTitle": "首頁", "Name": "sqrt_cat", "Age": 25},
  )
}

// news
func NewsHandler(w http.ResponseWriter, r *http.Request) {
  _ = htmlTplEngine.ExecuteTemplate(
    w,
    "news/index",
    map[string]interface{}{
      "PageTitle": "新聞",
      "List": []struct {
        Title   string
        CreatedAt time.Time
      }{
        {Title: "this is golang views/template example", CreatedAt: time.Now()},
        {Title: "to be honest, i don't very like this raw engine", CreatedAt: time.Now()},
      },
      "Total": 1,
      "Author": "big_cat",
    },
  )
}

func main() {
  http.HandleFunc("/", IndexHandler)
  http.HandleFunc("/index", IndexHandler)
  http.HandleFunc("/news", NewsHandler)

  serverErr := http.ListenAndServe(":8085", nil)

  if nil != serverErr {
    log.Panic(serverErr.Error())
  }
}

注意：模板對(duì)象是有名字屬性的， template.New("tplName") ，如果沒有顯示的定義名字，則會(huì)使用第一個(gè)被載入的視圖文件的 baseName 做默認(rèn)名，比如我們使用 template.ParseFiles/template.ParseGlob 直接生成模板對(duì)象時(shí)，沒有指定模板對(duì)象名，則會(huì)使用第一個(gè)被載入的文件，比如 views/index/index.html 的 baseName 即 index.html 做默認(rèn)名，而后如果 tplObj.Execute 方法執(zhí)行渲染時(shí)，會(huì)去查找名為 index.html 的模板，所以常用的還是 tplObj.ExecuteTemplate 自己指定要渲染的模板名，省的一團(tuán)亂。

以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: