Question

我有一个插件项目，我正在使用Velocity模板。用户可以从首选项页面更改模板正文，我想在用户在首选项页面中单击“确定”时获取模板正文中的变量。我需要帮助从Velocity模板体中提取变量。

Answer 1

Velocity使用JavaCC来解析模板并创建AST。

RuntimeInstance是解析模板所需的全部内容。

RuntimeInstance ri = new RuntimeInstance();
SimpleNode node = ri.parse( reader, "templateName" );

现在您必须根据需要扩展BaseVisitor。 BaseVisitor是所有访问者的抽象类。 BaseVisitor有一种节点类型方法，因此您可以轻松过滤AST节点。

ParserVisitor visitor = new BaseVisitor() {
@Override
public Object visit(final ASTReference node, final Object data) {
    //insert here your logic ...
    System.out.println(node.getFirstToken();
    //use super.visit( node, data) if you need to traverse all node children 
    return null;
    }
};

然后访问节点......

visitor.visit(node, null);

如果您有以下模板：

some text $var other text

建议的代码仅打印$var。

请注意，ASTReference是任何参考。如果您有以下模板：

some text $var other text
#set( $primate = "monkey" )

此代码打印出来：$var和$primate。

Answer 2

我能想到的唯一方法是将这样的东西添加到速度引擎中：

VelocityContext context = new VelocityContext();
context.put("parameters", new HashMap());

...在模板中，让用户将值放入参数hashmap中，如下所示：

#set ($t = $parameters.put("value", "key"))

（重要的是：用户必须为临时参数赋值，例如$ t）

...然后，在渲染后，取出值：

HashMap map = (HashMap)context.get("parameters");
for (String key : map.keySet()) {
    // ...
}

Answer 3

xdocreport项目完成了这项工作。

<dependency>
    <groupId>fr.opensagres.xdocreport</groupId>
    <artifactId>xdocreport</artifactId>
    <version>1.0.6</version>
</dependency>


StringReader templateReader = new StringReader(stringyTemplateContent);
FieldsExtractor<FieldExtractor> extractor = FieldsExtractor.create();
VelocityFieldsExtractor.getInstance().extractFields(templateReader, templateName, extractor);

for (FieldExtractor fieldExtractor : extractor.getFields()) {
    System.out.println(fieldExtractor.getName());
}

我以VelocityFieldsExtractorTestCase为例。

Answer 4

我通过注册一个存储实例的事件，然后用盒式磁带中的事件评估模板来做到这一点。这不是100％的项目证明，因为引用可能包含很多different things，但是我还没有看到一个明确的例子来说明它也失败了。

import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.app.event.EventCartridge;
import org.apache.velocity.app.event.ReferenceInsertionEventHandler;

import java.io.StringWriter;
import java.util.HashSet;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

public class TemplateAnalyzer{

public static Set<String> getReferences(String template){
    HashSet<String> names = new HashSet<>();

    VelocityContext velocityContext = new VelocityContext();
    EventCartridge ec = new EventCartridge();
    ec.addEventHandler((ReferenceInsertionEventHandler)
        (reference, value) -> names.add(reference)
    );
    ec.attachToContext(velocityContext);

    Velocity.evaluate(velocityContext, new StringWriter(), "velocity", template);
    return names;
}

private static Pattern namePattern = Pattern.compile("\\$!?\\{?([a-zA-Z][\\w*\\-])");

public static Set<String> getVariableNames(String template)
{
    Set<String> references = getReferences(template);
    return references.stream()
        .map(r -> namePattern.matcher(r))
        .filter(Matcher::find)
        .map(m -> m.group(1))
        .collect(Collectors.toSet());
}

}

您需要第二种方法来过滤掉不是简单变量的所有内容，并清除美元符号和花括号。

获取Velocity中的变量

4 个答案: