繁体   English   中英

文本/模板如何确定地图的“默认文本表示”?

[英]How does text/template determine the “default textual representation” of a map?

根据Go标准库中的text/template包的文档 ,(据我所知, html/template在这里是相同的)简单地使用管道操作符将吐出任何不同的“默认文本表示”:

{{管道}}

 The default textual representation of the value of the pipeline is copied to the output. 

在地图的情况下,你会得到一个很好的打印格式,其中包含键名和所有内容......顺便说一句,这是有效的JavaScript,因此如果你愿意,它可以很容易地将整个结构传递给你的JS代码。

我的问题是,这个文本表示是如何确定的,更具体地说,我可以加入它吗? 我想也许它会检查管道是否是fmt.Stringer ,我可以给我的map子类型一个String() string方法,但似乎并非如此。 我正在寻找text/template代码,但我似乎不知道它是如何做到的。

text/template如何确定“默认文本表示”?

默认文本表示由fmt包打印值的方式决定。 所以你正在吠叫正确的树。

看这个例子:

t := template.Must(template.New("").Parse("{{.}}"))
m := map[string]interface{}{"a": "abc", "b": 2}
t.Execute(os.Stdout, m)

它输出:

map[a:abc b:2]

现在,如果我们使用带有String()方法的自定义地图类型:

type MyMap map[string]interface{}

func (m MyMap) String() string { return "custom" }

mm := MyMap{"a": "abc", "b": 2}
t.Execute(os.Stdout, mm)

输出是:

custom

Go Playground上试试这些(及以下示例)。

需要注意什么?

请注意, MyMap.String()有一个值接收器(不是指针)。 我传递了MyMap的值,所以它有效。 如果将接收器类型更改为指向MyMap指针,则它将不起作用。 这是因为只有*MyMap类型的值才会有String()方法,而不是MyMap的值。

如果String()方法有一个指针接收器,如果希望自定义表示工作,则必须传递&mm (类型为*MyMap的值)。

另请注意,在html/template情况下,模板引擎执行上下文转义,因此fmt包的结果可能会被进一步转义。

例如,如果您的自定义String()方法将返回“不安全”的内容:

func (m MyMap2) String() string { return "<html>" }

试图插入它:

mm2 := MyMap2{"a": "abc", "b": 2}
t.Execute(os.Stdout, mm2)

获取转义:

&lt;html&gt;

履行

这是在text/template包中实现的地方: text/template/exec.go ,unexported function state.PrintValue() ,当前行#848:

_, err := fmt.Fprint(s.wr, iface)

如果你正在使用html/template包,它是用html/template/content.go ,未实现的函数stringify() ,当前第135行:

return fmt.Sprint(args...), contentTypePlain

更多选择

另请注意,如果值实现error ,将调用Error()方法,它优先于String()

type MyMap map[string]interface{}

func (m MyMap) Error() string { return "custom-error" }

func (m MyMap) String() string { return "custom" }

t := template.Must(template.New("").Parse("{{.}}"))
mm := MyMap{"a": "abc", "b": 2}
t.Execute(os.Stdout, mm)

将输出:

custom-error

而不是custom Go Playground尝试一下。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM