如何从解析后的模板中获取模板“操作”的地图或列表?

时间:2016-11-14 08:33:59

标签: templates go go-templates

所以我想以某种方式将模板中定义的所有{{ .blahblah }}动作作为字符串切片。

例如,如果我有这个模板:

<h1>{{ .name }} {{ .age }}</h1>

我希望能够获得[]string{"name", "age"}。假设模板具有方法func (t *Template) Fields() []string

t := template.New("cooltemplate").Parse(`<h1>{{ .name }} {{ .age }}</h1>`)
if t.Fields() == []string{"name", "age"} {
    fmt.Println("Yay, now I know what fields I can pass in!")
    // Now lets pass in the name field that we just discovered.
    _ = t.Execute(os.Stdout, map[string]string{"name": "Jack", "age":"120"})
}

有没有办法检查这样的解析模板?
谢谢!

3 个答案:

答案 0 :(得分:2)

前言:正如Voker建议的那样,Template.Tree字段&#34;仅导出供html /模板使用,并且应视为所有其他客户端未导出。&#34;

您不应该依赖这样的东西来为模板执行提供输入。您必须知道要执行的模板及其预期的数据。你不应该&#34;探索&#34;它在运行时为它提供参数。

解析模板时得到的值是template.Templatetext/templatehtml/template,它们具有相同的API)。此模板将模板表示为parse.Tree类型的树。文本模板包含的所有内容都存储在节点中的此树中,包括静态文本,操作等。

话虽如此,您可以遍历此树并查找标识访问字段或调用函数的此类操作的节点。节点类型为parse.Node,其Node.Type()方法返回其类型。可能的类型在parse包中定义为常量,在parse.NodeType类型旁边,例如。

const (
        NodeText    NodeType = iota // Plain text.
        NodeAction                  // A non-control action such as a field evaluation.
        NodeBool                    // A boolean constant.
        NodeChain                   // A sequence of field accesses.
        NodeCommand                 // An element of a pipeline.
        NodeDot                     // The cursor, dot.

        NodeField      // A field or method name.
        NodeIdentifier // An identifier; always a function name.
        NodeIf         // An if action.
        NodeList       // A list of Nodes.
        NodeNil        // An untyped nil constant.
        NodeNumber     // A numerical constant.
        NodePipe       // A pipeline of commands.
        NodeRange      // A range action.
        NodeString     // A string constant.
        NodeTemplate   // A template invocation action.
        NodeVariable   // A $ variable.
        NodeWith       // A with action.
)

所以这是一个递归遍历模板树的示例程序,并查找NodeAction类型的节点,即&#34;非控制动作,如字段评估。&# 34;

这个解决方案只是一个演示,一个概念证明,它不能处理所有情况。

func ListTemplFields(t *template.Template) []string {
    return listNodeFields(t.Tree.Root, nil)
}

func listNodeFields(node parse.Node, res []string) []string {
    if node.Type() == parse.NodeAction {
        res = append(res, node.String())
    }

    if ln, ok := node.(*parse.ListNode); ok {
        for _, n := range ln.Nodes {
            res = listNodeFields(n, res)
        }
    }
    return res
}

使用它的示例:

t := template.Must(template.New("cooltemplate").
    Parse(`<h1>{{ .name }} {{ .age }}</h1>`))
fmt.Println(ListTemplFields(t))

输出(在Go Playground上尝试):

[{{.name}} {{.age}}]

答案 1 :(得分:0)

我碰巧需要大致相同的代码。 在我的用例中,我们允许用户在一侧创建模板,并输入map[string]string变量以不同的形式呈现。

这是我到目前为止提出的代码(受icza的回答启发):

// Extract the template vars required from *simple* templates.
// Only works for top level, plain variables. Returns all problematic parse.Node as errors.
func RequiredTemplateVars(t *template.Template) ([]string, []error) {
    var res []string
    var errors []error
    var ln *parse.ListNode
    ln = t.Tree.Root
Node:
    for _, n := range ln.Nodes {
        if nn, ok := n.(*parse.ActionNode); ok {
            p := nn.Pipe
            if len(p.Decl) > 0 {
                errors = append(errors, fmt.Errorf("Node %v not supported", n))
                continue Node
            }
            for _, c := range p.Cmds {
                if len(c.Args) != 1 {
                    errors = append(errors, fmt.Errorf("Node %v not supported", n))
                    continue Node
                }
                if a, ok := c.Args[0].(*parse.FieldNode); ok {
                    if len(a.Ident) != 1 {
                        errors = append(errors, fmt.Errorf("Node %v not supported", n))
                        continue Node
                    }
                    res = append(res, a.Ident[0])
                } else {
                    errors = append(errors, fmt.Errorf("Node %v not supported", n))
                    continue Node
                }

            }
        } else {
            if _, ok := n.(*parse.TextNode); !ok {
                errors = append(errors, fmt.Errorf("Node %v not supported", n))
                continue Node
            }
        }
    }
    return res, errors
}

https://play.golang.org/p/nH95B45jUmI

答案 2 :(得分:0)

对@icza的答案进行小的优化,也许有一点帮助:)

func listNodeFieldsV2(node parse.Node) []string {
    var res []string
    if node.Type() == parse.NodeAction {
        res = append(res, node.String())
    }
    if ln, ok := node.(*parse.ListNode); ok {
        for _, n := range ln.Nodes {
            res = append(res, listNodeFieldsV2(n)...)
        }
    }
    return res
}