Go html/template 模板的使用实例详解

2024-10-22 12:48:01

从字符串载入模板

我们可以定义模板字符串，然后载入并解析渲染：

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

// 从字符串模板构建
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})

从文件载入模板

模板语法

模板文件，建议为每个模板文件显式的定义模板名称： {{ define "tplName" }} ，否则会因模板对象名与模板名不一致，无法解析（条件分支很多，不如按一种标准写法实现），另展示一些基本的模板语法。

使用 {{ define "tplName" }} 定义模板名
使用 {{ template "tplName" . }} 引入其他模板
使用 . 访问当前数据域：比如 range 里使用 . 访问的其实是循环项的数据域
使用 $. 访问绝对顶层数据域

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 条件必须为标量值 不能是逻辑表达式 如果需要逻辑表达式请先求值*/}}
  {{ if and $c1 $c2 }}
    <h4>1 == 1 3 > 2 4 < 5</h4>
  {{ end }}

  <div>
    <ul>
      {{ range .List }}
        {{ $title := .Title }}
        {{/* .Title 上下文变量调用  func param1 param2 方法/函数调用  $.根节点变量调用 */}}
        <li>{{ $title }} -- {{ .CreatedAt.Format "2006-01-02 15:04:05" }} -- Author {{ $.Author }}</li>
      {{end}}
    </ul>
    {{/* !empty Total 才输出*/}}
    {{ with .Total }}
      <div>总数：{{ . }}</div>
    {{ end }}
  </div>
  </body>
  {{ template "footer" . }}
{{ end }}

template.ParseFiles

手动定义需要载入的模板文件，解析后制定需要渲染的模板名 news/index 。

// 从模板文件构建
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

手动的指定每一个模板文件，在一些场景下难免难以满足需求，我们可以使用通配符正则匹配载入。

1、正则不应包含文件夹，否则会因文件夹被作为视图载入无法解析而报错

2、可以设定多个模式串，如下我们载入了一级目录和二级目录的视图文件

// 从模板文件构建
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服务器

结合模板库和 Gin 实现一个可以使用模板渲染并返回 html 页面的 web 服务。

package main

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

var (
  htmlTplEngine  *template.Template
  htmlTplEngineErr error
)

func init() {
  // 初始化模板引擎 并加载各层级的模板文件
  // 注意 views/* 不会对子目录递归处理 且会将子目录匹配 作为模板处理造成解析错误
  // 若存在与模板文件同级的子目录时 应指定模板文件扩展名来防止目录被作为模板文件处理
  // 然后通过 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())
  }
}

注意：模板对象是有名字属性的， template.New("tplName") ，如果没有显示的定义名字，则会使用第一个被载入的视图文件的 baseName 做默认名，比如我们使用 template.ParseFiles/template.ParseGlob 直接生成模板对象时，没有指定模板对象名，则会使用第一个被载入的文件，比如 views/index/index.html 的 baseName 即 index.html 做默认名，而后如果 tplObj.Execute 方法执行渲染时，会去查找名为 index.html 的模板，所以常用的还是 tplObj.ExecuteTemplate 自己指定要渲染的模板名，省的一团乱。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。

golang模板template自定义函数用法示例

本文实例讲述了golang模板template自定义函数用法.分享给大家供大家参考,具体如下: golang的模板十分强大,其中的unix管道风格函数调用很是喜欢. 模板中有很多内置可以参看pkg文档, 另外还可以实现自定义函数. 例子如下: 复制代码代码如下: package main import ( "text/template" "time" "os" ) type User struct { Usern
微信小程序视图template模板引用的实例详解

微信小程序视图template模板引用的实例详解 WXML 提供两种文件引用方式import和include. include可以将目标文件除了的整个代码引入,相当于是拷贝到include位置 temlate.wxml <template name="tmp_data" > <view class="content">  <view class="author-date"> &
Go html/template 模板的使用实例详解

从字符串载入模板我们可以定义模板字符串,然后载入并解析渲染: template.New(tplName string).Parse(tpl string) // 从字符串模板构建 tplStr := ` {{ .Name }} {{ .Age }} ` // if parse failed Must will render a panic error tpl := template.Must(template.New("tplName").Parse(tplStr)) tpl.Exe
django创建自定义模板处理器的实例详解

django创建自定义模板处理器: 一.需求来源: 在django开发中,页面是通过template(模板)进行渲染的,对于一些数据,可以通过{{ 变量 }}的方式进行传递.但是,如果整个网站中,或者整个网站的大部分页面都用到了一些变量或者数据,那么每次渲染的时候都传递一次这几个数据显得相当的冗余.这与django的DRY(Don't repeat yourself)思想不符,因此django提供了一种方式,让你能自定义处理器. 二.django默认的处理器: 在django开发中,django
Django模板继承与模板的导入实例详解

目录一:模版的继承 1.什么是模板继承? 2.使用继承流程原理 3.模板继承语法二:模板的继承使用 1.案例需求 2.总结模板继承三:模版的导入 1.模板导入 2.模板导入格式 3.模板导入使用 4.使用结果总结一:模版的继承 1.什么是模板继承? 你需要事先在你想要使用的主页面上划定区域做好标记,之后在子页面继承的时候你就可以使用在主页面划定的区域,也就意味着,如果你不划定任何区域,那么你子页面将无法修改主页面内容 2.使用继承流程原理 1.先在你想要继承的主页面上通过bolck划定
Django视图层与模板层实例详解

目录 theme: channing-cyan 网页伪静态视图层 1.视图函数的返回值问题 2.视图函数返回json格式数据 3.form表单携带文件数据 4.FBV与CBV 5.CBV源码分析模板层 1.模板语法传值 2.模板语法传值的范围 3.模板语法值过滤器 4.模板语法标签(类似于python中的流程控制) 5.自定义标签函数.过滤器.inclusion_tag 6.模板的继承 7.模板的导入 theme: channing-cyan 网页伪静态将动态网页伪装成静态网页,可以提升网
Android开发之Android.mk模板的实例详解

Android开发之Android.mk模板的实例详解关于Android NDK开发的文章已经比较多了,我的博客中也分享了很多NDK开发相关经验和技巧,今天简单写了一个 Android.mk 的示例模板,供初学者参考. 本模板主要给大家示例 Android NDK 开发中的如下几个问题: 1. 如何自动添加需要编译的源文件列表 2. 如何添加第三方静态库.动态库的依赖 3. 如何构造一个完整的NDK工程框架假设我们的项目依赖 libmath.a, libjson.a, libffmp
Vuejs第九篇之组件作用域及props数据传递实例详解

本篇资料来于官方文档: http://cn.vuejs.org/guide/components.html#Props 本教程是小编结合官方文档整理的一套更加细致,代码更多更全的教程,特别适合新手阅读. props数据传递 ①组件实例的作用域: 是孤立的,简单的来说,组件和组件之间,即使有同名属性,值也不共享. <div id="app"> <add></add> <del></del> </div> <sc
Angular.js之作用域scope'@','=','&'实例详解

什么是scope AngularJS 中,作用域是一个指向应用模型的对象,它是表达式的执行环境.作用域有层次结构,这个层次和相应的 DOM 几乎是一样的.作用域能监控表达式和传递事件. 在 HTML 代码中,一旦一个 ng-app 指令被定义,那么一个作用域就产生了,由 ng-app 所生成的作用域比较特殊,它是一个根作用域($rootScope),它是其他所有$Scope 的最顶层. 除了用 ng-app 指令可以产生一个作用域之外,其他的指令如 ng-controller,ng-repeat
spring对JDBC和orm的支持实例详解

简介 Spring提供的DAO(数据访问对象)支持主要的目的是便于以标准的方式使用不同的数据访问技术,如JDBC,Hibernate或者JDO等.它不仅可以让你方便地在这些持久化技术间切换, 而且让你在编码的时候不用考虑处理各种技术中特定的异常. 一致的异常层次 Spring提供了一种方便的方法,把特定于某种技术的异常,如SQLException, 转化为自己的异常,这种异常属于以 DataAccessException 为根的异常层次.这些异常封装了原始异常对象,这样就不会有丢失任何错误信息的
Angular2 组件交互实例详解

1. 组件通信我们知道Angular2应用程序实际上是有很多父子组价组成的组件树,因此,了解组件之间如何通信,特别是父子组件之间,对编写Angular2应用程序具有十分重要的意义,通常来讲,组件之间的交互方式主要有如下几种: l 使用输入型绑定,把数据从父组件传到子组件 l 通过 setter 拦截输入属性值的变化 l 使用 ngOnChanges 拦截输入属性值的变化 l 父组件监听子组件的事件 l 父组件与子组件通过本地变量互动 l 父组件调用 ViewChild l 父组件和子组件通过服

Go html/template 模板的使用实例详解

相关推荐

随机推荐