golang 模板(template)的常用基本語法


1. 模板

  在寫動態頁面的網站的時候,我們常常將不變的部分提出成為模板,可變部分通過后端程序的渲染來生成動態網頁,golang提供了html/template包來支持模板渲染。

這篇文章不討論golang后端的模板讀取及渲染方法,只討論模板中嵌入變量,渲染變量、循環等一些基本用法。

 

2. 變量

  在golang渲染template的時候,可以接受一個interface{}類型的變量,我們在模板文件中可以讀取變量內的值並渲染到模板里。

有兩個常用的傳入參數的類型。一個是struct,在模板內可以讀取該struct域的內容來進行渲染。還有一個是map[string]interface{},在模板內可以使用key來進行渲染。

我一般使用第二種,效率可能會差一點兒,但是用着方便。

模板內內嵌的語法支持,全部需要加{{}}來標記。

在模板文件內, . 代表了當前變量;  在非循環體內,.就代表了傳入的那個變量。

 

假設我們定義了一個結構體:

type Article struct { 
ArticleId int 
ArticleContent string 
}

 

那么我們在模板內可以通過

<p>{{.ArticleContent}}<span>{{.ArticleId}}</span></p>

 

來獲取並把變量的內容渲染到模板內。

假設上述的結構體的內容為ArticleId:1 ArticleContent:”hello”, 則對應渲染后的模板內容為:

<p>hello<span>1</span></p>

 

當然,我們有時候需要定義變量,比如我們需要定義一個article變量,同時將其初始化為”hello”,那么我們可以這樣寫:

{{$article := "hello"}}

 

假設我們想要把傳入值的內容賦值給article,則可以這樣寫:

{{$article := .ArticleContent}}

 

這樣我們只要使用{{$article}}則可以獲取到這個變量的內容。

 

3. 函數

  golang的模板其實功能很有限,很多復雜的邏輯無法直接使用模板語法來表達,所以只能使用模板函數來繞過。

  首先,template包創建新的模板的時候,支持.Funcs方法來將自定義的函數集合導入到該模板中,后續通過該模板渲染的文件均支持直接調用這些函數。

 

該函數集合的定義為:

type FuncMap map[string]interface{}

 

key為方法的名字,value則為函數。這里函數的參數個數沒有限制,但是對於返回值有所限制。有兩種選擇,一種是只有一個返回值,還有一種是有兩個返回值,但是第二個返回值必須是error類型的。這兩種函數的區別是第二個函數在模板中被調用的時候,假設模板函數的第二個參數的返回不為空,則該渲染步驟將會被打斷並報錯。

在模板文件內,調用方法也非常的簡單:

{{funcname .arg1 .arg2}}

 

假設我們定義了一個函數

func add(left int, right int) int

 

則在模板文件內,通過調用

{{add 1 2}}

 

就可以獲得取值: 3

這個結果,golang的預定義函數沒有add,所以有點兒麻煩。

 

4. 判斷

  golang的模板也支持if的條件判斷,當前支持最簡單的bool類型和字符串類型的判斷

{{if .condition}} {{end}}

  當.condition為bool類型的時候,則為true表示執行,當.condition為string類型的時候,則非空表示執行。

當然也支持else , else if嵌套

{{if .condition1}} {{else if .contition2}} {{end}}

 

假設我們需要邏輯判斷,比如與或、大小不等於等判斷的時候,我們需要一些內置的模板函數來做這些工作,目前常用的一些內置模板函數有:

  • not 非

    {{if not .condition}} 
    {{end}}
  • and 與

    {{if and .condition1 .condition2}} 
    {{end}}
  • or 或

    {{if or .condition1 .condition2}} 
    {{end}}
  • eq 等於

    {{if eq .var1 .var2}} 
    {{end}}
  • ne 不等於

    {{if ne .var1 .var2}} 
    {{end}}
  • lt 小於 (less than)

    {{if lt .var1 .var2}} 
    {{end}}
  • le 小於等於

    {{if le .var1 .var2}} 
    {{end}}
  • gt 大於

    {{if gt .var1 .var2}} 
    {{end}}
  • ge 大於等於

    {{if ge .var1 .var2}} 
    {{end}}

 

5. 循環

  golang的template支持range循環來遍歷map、slice內的內容,語法為:

{{range $i, $v := .slice}} 
...
{{end}}

在這個range循環內,我們可以通過iv來訪問遍歷的值。 

 

還有一種遍歷方式為:

{{range .slice}} 
...
{{end}}

這種方式無法訪問到index或者key的值,需要通過.來訪問對應的value

{{range .slice}} 
{{.field}} 
{{end}}

 

當然這里使用了.來訪問遍歷的值,那么我們想要在其中訪問外部的變量怎么辦?(比如渲染模板傳入的變量),在這里,我們需要使用$.來訪問外部的變量

{{range .slice}} 
{{$.ArticleContent}} 
{{end}}

 

6. 模板的嵌套

  在編寫模板的時候,我們常常將公用的模板進行整合,比如每一個頁面都有導航欄和頁腳,我們常常將其編寫為一個單獨的模塊,讓所有的頁面進行導入,這樣就不用重復的編寫了。

任何網頁都有一個主模板,然后我們可以在主模板內嵌入子模板來實現模塊共享。

當模板想要引入子模板的時候,我們使用以下語句:

{{template "navbar"}}

這樣子就會嘗試載入名稱為navbar的子模板,同時我們也得定義一個子模板來實現”navbar”這個子模板。

子模板的定義為:

{{define "navbar"}} {{end}}

 

在定義之間的內容將會覆蓋{{template “navbar”}}

當然子模板是分離了,那么子模板能否獲得父模板的變量呢? 這是當然的,我們只需要使用

{{template "navbar" .}}

 

就可以將當前的變量傳給子模板了,這個也是相當方便的; 使用.是把父模板的所有變量都傳入到子模板中,如果只需要傳入單個變量可以使用以下方式

{{template "navbar" Field}}

這樣就只會傳入Field變量的值到子模板中了

 

有沒有覺得go的模板功能相當強大呢。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM