Velocity 在哪里搜索模板？

Question

我需要在 Web 应用程序中使用 Java 代码中的 Velocity（我将其用作邮件模板处理器）。

所以，我有一个标准代码：

VelocityEngine ve = new VelocityEngine ();
try {
   ve.init ();
   Template t = ve.getTemplate (templatePath);
   ...   
} catch (Exception e) {
   throw new MailingException (e);
}

此代码总是抛出 ResourceNotFoundException。我应该将模板放在 Web 应用程序中的哪里（WEB-INF？类路径？等？）以及如何指定路径（即我应该作为 templatePath 传递什么）？

Answer 1

设置速度模板

我最终使用这个问题来解决设置模板路径的问题。我正在使用 Velocity 来模板化 html 电子邮件。

您可以使用以下几种很好的方法来说明如何设置模板路径。它将属性“file.resource.loader.path”设置为绝对路径。我为模板创建了一个目录，然后右键单击模板文件以获取完整路径（在 Eclipse 中）。您可以使用该完整路径作为 file.resource.loader.path 属性的值。我还添加了“runtime.log.logsystem.class”属性，并设置它，因为我收到了抱怨日志记录的异常。

实用程序速度方法

public static VelocityEngine  getVelocityEngine(){

    VelocityEngine ve = new VelocityEngine();
    Properties props = new Properties();
    // THIS PATH CAN BE HARDCODED BUT IDEALLY YOUD GET IT FROM A PROPERTIES FILE
    String path = "/absolute/path/to/templates/dir/on/your/machine";
    props.put("file.resource.loader.path", path);
    props.setProperty("runtime.log.logsystem.class", "org.apache.velocity.runtime.log.NullLogSystem");
    ve.init(props);
    return ve;
}

public static String getHtmlByTemplateAndContext(String templateName, VelocityContext context){

    VelocityEngine ve = getVelocityEngine();

    Template template = ve.getTemplate(templateName);

      StringWriter writer = new StringWriter();
      template.merge(context, writer );
      System.out.println( writer.toString());
      String velocityHtml = writer.toString();
      return velocityHtml;
}

如何使用上述代码，创建速度上下文以提供给实用程序方法

以下是如何使用上述方法。您只需指定模板文件的文件名，并创建一个简单的 VelocityContext 上下文来存储模板变量。

        VelocityContext context = new VelocityContext();
        context.put("lastName", "Mavis");
        context.put("firstName", "Roger");
        context.put("email", "[email protected]");
        context.put("title", "Mr.");

        String html =    VelocityUtil.getHtmlByTemplateAndContext("email_template_2015_10_09.vm", context);

示例模板 HTML

可以像这样访问变量（在我的例子中保存在文件 email_template_2015_10_09.vm 中）：

<p> Hello $firstName $lastName </p>

Answer 2

您需要首先通过调用 Velocity.init()（在单例使用模型中），或 VelocityEngine.init()（如果您使用单独的实例），并传递适当的配置参数。其中包括资源加载器配置。

将模板文件放在哪里取决于您选择的资源加载器 - 有文件、类路径、jar、url 等资源加载器可用。

如果使用文件资源加载器，模板路径应该是绝对（目录/文件）路径。但是，对于 jar 资源加载器，它不能是绝对路径（如果您的模板位于 jar 中）。对于模板中的链接也是如此，即，如果您的一个模板通过绝对路径包含另一个模板，则 jar 资源加载器将无法加载它。