Golang 模板变量 isset

Question

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

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（这是一个包含映射和字符串的自定义结构）中，则此函数有效，但如果变量不存在，它会给我一个错误。

错误是：

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

在我的例子中，“base.go”是处理程序，“customData”定义为：type customData struct{..}。

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

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

有什么想法吗？

Answer 1

推荐方式

首先，推荐的方法是不要依赖结构字段是否存在。当然模板中可能有可选的部分，但是决定是否渲染一个部分的条件应该依赖于所有情况下都存在的字段。

问题，并使用地图避免它

如果模板数据的类型是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.

Answer 2

如果您不向模板发送包含变量的数据但使用{{ if .Variable }}，您将收到错误：

在 <.variable> 处执行“模板名称”：无法评估类型 handler.Data 中的字段变量

我的解决方案是将“电子邮件”变量作为布尔值 (false) 发送，以便通过 {{ if .Email }} 函数检查。但这是我不喜欢的短期解决方案。

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

Answer 3

简单的做法：

{{ if .Email }}

是使用索引：

{{ if index . "Email" }}