19.3.2　使用 Thymeleaf 构建 Email 消息

如我们第 6 章所讨论的那样，Thymeleaf 是一种很有吸引力的 HTML 模板引擎，因为它能够创建 WYSIWYG 的模板。与 JSP 和 Velocity 不同，Thymeleaf 模板不包含任何特殊的标签库和特有的标签。这样模板设计师在工作的时候，能够使用任意他们所喜欢的 HTML 工具，而不必担心某个工具无法处理特定的标签。

当我们将 Email 模板转换为 Thymeleaf 模板时，Thymeleaf 的 WYSIWYG 特性体现得非常明显：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<body>
  <img src="spitterLogo.png" th:src='cid:spitterLogo'>
  <h4><span th:text="${spitterName}">Craig Walls</span>says...</h4>
  <i><span th:text="${spittleText}">Hello there!</span></i>
</body>
</html>

注意，这里没有任何自定义的标签（在 JSP 中可能会见到这种情况）。尽管模型属性是通过 “${}” 标记的，但是它们仅用于属性的值中，不会像 Velocity 那样用在外边。这种模板可以很容易地在 Web 浏览器中打开，并且以完整的形式进行展现，不必依赖于 Thymeleaf 引擎的处理。

使用 Thymeleaf 来生成和发送 Email 消息的做法非常类似于 Velocity：

Context ctx = new Context();
ctx.setVariable("spitterName", spitterName);
ctx.setVariable{"spittleText", spittle.getText());
String emailText = thymeleaf.process("emailTemplate.html", ctx);
helper.setText(emailText, true);
mailSender.send(message);

这里做的第一件事情就是创建 Thymeleaf Context 实例，并将模型数据填充进去。这与我们使用 Velocity 的时候，将模型数据填充到 Map 中很类似。然后，我们要求 Thymeleaf 处理模板，通过调用 Thymeleaf 引擎的 process() 方法，将上下文中的模型数据合并到模板中。最后，我们将结果形成的文本借助消息 helper 设置到 Email 消息中，并使用邮件发送器将消息发送出去。

这看起来很简单。但是 Thymeleaf 引擎（也就是 thymeleaf 变量）是从哪里来的呢？

这里的 Thymeleaf 引擎与我们在第 6 章构建 Web 视图时所使用的 SpringTemplateEngine bean 是相同的。在这里，我们使用构造器注入的方式将其注入到 SpitterEmailServiceImpl 中：

@Autowired
private SpringTemplateEngine thymeleaf;

@Autowired
public SpittleEmailServiceImpl(SpringTemplateEngine thymeleaf){
  this.engine = engine;
}

不过，我们必要要对 SpringTemplateEngine bean 做一点小修改。在第 6 章中，它配置为从 Servlet 上下文中解析模板，而我们的 Email 模板需要从类路径中解析。所以，除了 ServletContextTemplateResolver，还需要一个 ClassLoaderTemplateResolver：

@Bean
public ClassLoaderTemplateResolver emailTemplateResolver() {
  ClassLoaderTemplateResolver resolver = new ClassLoaderTemplateResolver();
  resolver.setPrefix("mail/");
  resolver.setTemplateMode("HTML5");
  resolver.setCharacterEncoding("UTF-8");
  setOrder(1);
  return resolver;
}

就大部分而言，配置 ClassLoaderTemplateResolver bean 的方式类似于 ServletContextTemplateResolver。不过，需要注意，我们将 prefix 属性设置为 “mail/”，这表明它会在类路径根的 “mail” 目录下开始查找 Thymeleaf 模板。因此，Email 模板文件的名字必须是 emailTemplate.html，并且位于类路径根的 “mail” 目录下。

因为我们现在有两个模板解析器，所以需要使用 order 属性表明优先使用哪一个。ClassLoaderTemplateResolver 的 order 属性为 1，因此我们修改一下 ServletContextTemplateResolver，将其 order 属性设置为 2：

@Bean
public ServletContextTemplateResolver webTemplateResolver() {
  ServletContextTemplateResolver resolver = new ServletContextTemplateResolver();
  resolver.setPrefix("mail/");
  resolver.setTemplateMode("HTML5");
  resolver.setCharacterEncoding("UTF-8");
  setOrder(2);
  return resolver;
}

现在，剩下的任务就是修改 SpringTemplateEngine bean 的配置，让它使用这两个模板解析器：

@Bean
public SpringTemplateEngine templateEngine(
    Set<ITemplateResolver> resolvers) {
  SpringTemplateEngine engine = new SpringTemplateEngine();
  engine.setTemplateResolvers(resolvers);
  return engine;
}

在此之前，我们只有一个模板解析器，所以可以将其注入到 SpringTemplateEngine 的 templateResolver 属性中。但现在我们有了两个模板解析器，所以必须将它们作为 Set 的成员，然后将这个 Set 注入到 templateResolvers（复数）属性中。

Previous19.3.1　使用 Velocity 构建 Email 消息 Next19.4　小结

Last updated 4 years ago