Go模板执行模板包含HTML

Question

我已经按照这个教程进行了操作：http://golang.org/doc/articles/wiki/final.go，并稍微修改了一下来满足我的需求。问题是我想在模板中支持HTML标签。我知道这会带来安全风险，但现在还不是问题。

页面渲染的结果：

<h1>this<strong>is</strong>a test</h1>

让我解释一下这段代码：

type Page struct {
    Title string
    Body  []byte
}

我想要以HTML形式显示的数据被存储在Page.Body中。这是[]byte类型，这意味着我不能（或者说我可以吗？）运行html/template.HTML(Page.Body)，因为该函数期望一个字符串。

我有以下代码对模板进行预渲染：

var (
    templates = template.Must(template.ParseFiles("tmpl/edit.html", "tmpl/view.html"))
)

实际上，ExecuteTemplate 的样子是这样的：

err := templates.ExecuteTemplate(w, tmpl+".html", p)

其中w为w http.ResponseWriter，tmpl为tmpl string，p为p *Page

最后，我的'view.html'（模板）如下所示：

<h1>{{.Title}}</h1>
<p>[<a href="/edit/{{.Title}}">edit</a>]</p>
<div>{{printf "%s" .Body}}</div>

已尝试的方法：

• {{printf "%s" .Body | html}} 没有任何作用。
• 我已经包含了 github.com/russross/blackfriday（Markdown 处理器）并运行了 p.Body = blackfriday.MarkdownCommon(p.Body)，它可以正确地将 Markdown 转换为 HTML，但是输出的 HTML 仍然是实体。

• 编辑：我尝试了下面这段代码（我不知道格式为什么混乱），它仍然输出完全相同的内容。

  var s template.HTML s = template.HTML(p.Body) p.Body = []byte(s)

非常感谢您提供任何指导。如果我的问题表述有误，请告诉我，我会进行修改。

- Peter

Answer 1

将您的[]byte或string转换为类型template.HTML（文档在此处记录）

p.Body = template.HTML(s) // where s is a string or []byte

然后，在您的模板中，只需：

{{.Body}}

它将不进行转义而直接打印。

编辑

为了能够在页面正文中包含HTML，你需要更改Page类型声明：

type Page struct {
    Title string
    Body  template.HTML
}

然后将其赋值。

- thwd

---

那不起作用。我收到以下信息：无法使用“html/template”。HTML(p.Body)（类型“html/template”。HTML）无法分配为类型[]byte。 - Peter

不要简单地复制粘贴并说它不起作用。显然，你需要更改 Body 字段的类型才能将 type 为 template.HTML 的内容分配给它。 - thwd

请查看我昨晚在发表评论后对我的问题所做的编辑。我确实更改了Body的类型，但仍然看到完全相同的结果。 - Peter

我添加了一个名为“noescape”的函数，它将字符串转换为template.HTML，然后在管道中使用printf。非常神奇。 - Matt Joiner

我花了几天时间对我的模板感到非常生气，因为当我传递字符串时它可以工作，但是当我传递HTML字符串时却不能工作... - T1960CT

Answer 2

看一下template.HTML类型。它可以用来封装已知安全的 HTML 片段（例如来自 Markdown 的输出）。"html/template" 包不会对这种类型进行转义。

type Page struct {
    Title string
    Body template.HTML
}

page := &Page{
    Title: "Example",
    Body:  template.HTML(blackfriday.MarkdownCommon([]byte("foo bar")),
}

我通常会编写自己的func Markdown(text string) html.Template方法，该方法使用适当的配置调用blackfriday并进行一些类型转换。另一种替代方法也可以在模板解析器中注册一个“html” func，通过执行类似于{{html .MySafeStr}}的操作来输出任何值而无需进行任何转义。代码可能如下所示：

var tmpl = template.Must(template.New("").Funcs(template.FuncMap{
    "html": func(value interface{}) template.HTML {
        return template.HTML(fmt.Sprint(value))
    },
}).ParseFiles("file1.html", "file2.html"))

- tux21b

Answer 3

我为模板创建了一个自定义函数，代码如下：

func noescape(str string) template.HTML {
    return template.HTML(str)
}

var fn = template.FuncMap{
    "noescape": noescape,
}

然后在您的模板上：

{{ noescape $x.Body }}

- majidarif

Answer 4

这里有一种方法，无需对您现有的结构体进行任何更改，并且对您的模板只需要进行非常少量的添加性更改：

将这些行更改为：

var (
    templates = template.Must(template.ParseFiles("tmpl/edit.html", "tmpl/view.html"))
)

将以下内容改为包含一个能够输出未转义HTML的函数映射：

var templates = template.Must(template.New("main").Funcs(template.FuncMap{
    "safeHTML": func(b []byte) template.HTML {
        return template.HTML(b)
    },
}).ParseFiles("tmpl/edit.html", "tmpl/view.html"))

然后只需更改模板HTML，从这个开始：

<div>{{printf "%s" .Body}}</div>

使用您的新函数，将其转换为以下内容：

<div>{{ .Body | safeHTML }}</div>

更加容易！

- Astockwell

Answer 5

我正在使用Beego和React.js，并花费数小时尝试让JSX解析器运行。结果发现html/template会剥离注释，特别是js文档块/** @jsx React.DOM */。

为了解决这个问题，我创建了一个特殊的方法将注释标记为JS，并在模板内部调用它。

// Create a method in your controller (I'm using Beego)
func jsxdoc()(out template.JS) {
    return template.JS(`/** @jsx React.DOM */`)
}

// Add method to your function map available to views
beego.AddFuncMap("jsxdoc", jsxdoc)

// In template
<script type="text/jsx">
    {{ jsxdoc }}
    var CommentBox = React.createClass({
      render: function() {
        return (
          <div class="commentBox">
            Hello, world! I am a CommentBox.
          </div>
        );
      }
    });
    React.renderComponent(
      <CommentBox />,
      document.getElementById('content')
    );
</script>

- mangoavenger

Answer 6

在我的情况下（我正在使用一个struct填充视图，其中包含一个Activity列表），我不得不将属性Message string更改为Message template.HTML。然后，在设置属性值时，我可以调用activity.Message = template.HTML("The <b>HTML</b>")。

- crmepham

Answer 7

为了澄清并更简单地将HTML传递给模板，请参见

https://groups.google.com/forum/#!topic/golang-nuts/8L4eDkr5Q84

只需使用Go创建您的HTML字符串并将其传递到模板中，例如：

Sout := ""
.
.

    Sout += fmt.Sprintf(`<tr><td>%s<td align=center>%.2f<td>%s<td>%s<td>%s<td>%s<td align=center>%d<td align=center>%d
                    <td align=center>%d`, AccountID, amount, remissiondetails, created, begins, ends,
                    freePDFs, freeinformants, freeSDQs)

.
.
    render(w, "templates/Waivers.html", map[string]interface{}{ "Body":template.HTML(Sout), })

- user2099484

Answer 8

为什么不将[]byte转换为字符串？您可以像这样做：

str := string(page.Body)

- David Grayson

---

我尝试过了，问题在于template.ExecuteTemplate需要一个指向Page的指针，这就要求它是一个[]byte。我尝试按照您提到的方法去做，但收到以下错误：cannot use string(p.Body) (type string) as type []byte in assignment。同样地，将我的结构体更改为使用字符串而不是[]byte会在将内容保存到文件时引起其他问题。 - Peter