Golang模板变量isset

时间:2017-06-21 11:41:06

标签: if-statement go struct go-templates

我创建了一个函数来检查是否定义了变量:

fm["isset"] = func(a interface{}) bool {
        if a == nil || a == "" || a == 0 {
            fmt.Println("is not set")
            return false
        }
        fmt.Println("is set")
        return false
    }

tmpl :=  template.Must(template.New("").Funcs(fm).ParseFiles("templates/header.html"))

err := tmpl.ExecuteTemplate(w, "header", templateData)

在模板中我有:

{{ if isset .Email }}
    email is set
{{ end }}

如果变量包含在templateData(这是一个包含地图和字符串的自定义结构)中,则此函数有效,但如果变量不存在则会给出错误。< / p>

错误是:

executing "header" at <.Email>: can't evaluate field Email in type base.customData

在我的情况下&#34; base.go&#34;是处理程序和&#34; customData&#34;由type customData struct{..}定义。

我希望能够重用模板并仅在从处理程序发送一些变量时才显示某些部分。任何想法如何在模板端实现变量isset检查?

我也尝试过使用:{{ if .Email}} do stuff {{ end }}但这也给了我同样的错误。

有什么想法吗?

3 个答案:

答案 0 :(得分:7)

推荐方式

首先,建议的方法是不依赖于结构域是否存在。当然可能有模板的可选部分,但决定是否渲染零件的条件应该依赖于所有情况下都存在的字段。

问题,并避免使用地图

如果模板数据的类型是struct(或指向结构的指针),并且没有具有给定名称的字段或方法,则模板引擎会为此返回错误。

如果您要使用地图,则可以轻松摆脱此错误,因为地图可以使用不包含的键进行索引,而index expression的结果是zero value值类型(而不是错误)。

要演示,请参阅此示例:

s := `{{if .Email}}Email is: {{.Email}}{{else}}Email is NOT set.{{end}}`

t := template.Must(template.New("").Parse(s))
exec := func(name string, param interface{}) {
    fmt.Printf("\n%s:\n  ", name)
    if err := t.Execute(os.Stdout, param); err != nil {
        fmt.Println("Error:", err)
    }
}

exec("Filled map", map[string]interface{}{"Email": "as@as"})
exec("Empty map", map[string]interface{}{})

exec("Filled struct", struct {
    Email string
}{Email: "as@as.com"})
exec("Empty struct", struct{}{})

输出(在Go Playground上尝试):

Filled map:
  Email is: as@as
Empty map:
  Email is NOT set.
Filled struct:
  Email is: as@as.com
Empty struct:
  Error: template: :1:5: executing "" at <.Email>: can't evaluate field Email in type struct {}

坚持struct并提供“isset”

如果您必须或想要坚持struct,可以实施和提供此“isset”,我将其称为avail()

此实现使用反射,并且为了检查其名称给出的字段是否存在(可用),还必须将(包装器)数据传递给它:

func avail(name string, data interface{}) bool {
    v := reflect.ValueOf(data)
    if v.Kind() == reflect.Ptr {
        v = v.Elem()
    }
    if v.Kind() != reflect.Struct {
        return false
    }
    return v.FieldByName(name).IsValid()
}

使用它的示例:

s := `{{if (avail "Email" .)}}Email is: {{.Email}}{{else}}Email is unavailable.{{end}}`

t := template.Must(template.New("").Funcs(template.FuncMap{
    "avail": avail,
}).Parse(s))
exec := func(name string, param interface{}) {
    fmt.Printf("\n%s:\n  ", name)
    if err := t.Execute(os.Stdout, param); err != nil {
        fmt.Println("Error:", err)
    }
}

exec("Filled struct", struct {
    Email string
}{Email: "as@as.com"})
exec("Empty struct", struct{}{})

输出(在Go Playground上尝试):

Filled struct:
  Email is: as@as.com
Empty struct:
  Email is unavailable.

答案 1 :(得分:0)

如果您不将包含变量的数据发送到模板,但使用{{ if .Variable }},则会收到错误消息:

  

执行&#34; templatename&#34; at&lt; .Variable&gt;:无法在类型handler.Data

中评估字段变量

我的解决方案是发送&#34;电子邮件&#34;变量作为布尔值(false)以传递{{ if .Email }}函数检查。但这是一个我不喜欢的短期解决方案。

我的灵感来自:https://stackoverflow.com/a/31527618/1564840。在该示例中,它们为经过身份验证和未经身份验证的用户显示不同的HTML。您会看到,在这两种情况下,他们都会发送&#34; Logged&#34;变量。尝试从结构中删除该变量并执行该函数。您将收到我上面提到的错误。

答案 2 :(得分:0)

简单的方法:

{{ if .Email }}

是要使用索引:

{{ if index . "Email" }}