Spring 发送Email

一、配置Spring发送邮件

Spring Email抽象的核心是MailSender接口。顾名思义，MailSender的实现能够通过连接Email服务器实现邮件发送的功能，如图所示：

Spring自带了一个MailSender的实现也就是JavaMailSenderImpl，它会使用JavaMail API来发送Email。Spring应用在发送Email之前，我们必须要将JavaMailSenderImpl装配为Spring应用上下文中的一个bean。

1.1 配置邮件发送器

按照最简单的形式，我们只需在@Bean方法中使用几行代码就能将JavaMailSenderImpl配置为一个bean：

属性host是可选的（它默认是底层JavaMail会话的主机），但你可能希望设置该属性。它指定了要用来发送Email的邮件服务器主机名。按照这里的配置，会从注入的Environment中获取值，这样我们就能在Spring之外管理邮件服务器的配置（比如在属性文件中）。

默认情况下，JavaMailSenderImpl假设邮件服务器监听25端口（标准的SMTP端口）。如果你的邮件服务器监听不同的端口，那么可以使用port属性指定正确的端口号。例如

类似地，如果邮件服务器需要认证的话，你还需要设置username和password属性：

但是你可能已经在JNDI中配置了javax.mail.MailSession（也可能是你的应用服务器放在那里的）。如果这样的话，那就没有必要为JavaMailSenderImpl配置详细的服务器细节了。我们可以配置它使用JNDI中已就绪的MailSession。

借助JndiObjectFactoryBean，我们可以在如下的@Bean方法中配置一个bean，它会从JNDI中查找MailSession：

我们已经看到过如何使用Spring的<jee:jndi-lookup>元素从JNDI中获取对象，这里可以使用<jee:jndi-lookup>来创建一个bean，它引用了JNDI中的邮件会话：

邮件会话准备就绪之后，我们现在可以将其装配到mailSender bean中了：

通过将邮件会话装配到JavaMailSenderImpl的session属性中，我们已经完全替换了原来的服务器（以及用户名/密码）配置。现在邮件会话完全通过JNDI进行配置和管理。JavaMailSenderImpl能够专注于发送邮件而不必自己处理邮件服务器了。

1.2 装配和使用邮件发送器

邮件发送器已经配置完成，现在需要将其装配到使用它的bean中了。在Spittr应用程序中，最适合发送Email的是SpitterEmailServiceImpl类。这个类有一个mailSender属性，它使用了@Autowired注解：

当Spring将SpitterEmailServiceImpl创建为一个bean的时候，它将查找实现了MailSender的bean，这样的bean可以装配到mailSender属性中。它将会找到我们在前边配置的mailSenderbean并使用它。mailSenderbean装配完成后，我们就可以构建和发送Email了。

我们想要给Spitter用户发送Email提示他的朋友写了新的Spittle，所以我们需要一个方法来发送Email，这个方法要接受Email地址和Spittle对象信息。如下的sendSimpleSpittleEmail()方法使用邮件发送器完成了该功能：

二、构建丰富内容的Email消息

2.1 添加附件

如果发送带有附件的Email，关键技巧是创建multipart类型的消息——Email由多个部分组成，其中一部分是Email体，其他部分是附件。

对于发送附件这样的需求来说，SimpleMailMessage过于简单了。为了发送multipart类型的Email，你需要创建一个MIME（Multipurpose Internet Mail Extensions）的消息，我们可以从邮件发送器的createMimeMessage()方法开始：

就这样，我们已经有了要使用的MIME消息。看起来，我们所需要做的就是指定收件人和发件人地址、主题、一些内容以及一个附件。尽管确实是这样，但并不是你想的那么简单。javax.mail.internet.MimeMessage本身的API有些笨重。好消息是，Spring提供的MimeMessageHelper可以帮助我们。

为了使用MimeMessageHelper，我们需要实例化它并将MimeMessage传给其构造器：

构造方法的第二个参数，在这里是个布尔值true，表明这个消息是multipart类型的。
得到了MimeMessageHelper实例后，我们就可以组装Email消息了。这里最主要区别在于使用helper的方法来指定Email细节，而不再是设置消息对象：

在发送Email之前，你唯一还要做的就是添加附件：在本例中，也就是一张图标图片。为了做到这一点，你需要加载图片并将其作为资源，然后将这个资源传递给helper的addAttachment方法：

在这里，我们使用Spring的FileSystemResource来加载位于应用类路径下的coupon.png。然后，调用addAttachment()。第一个参数是要添加到Email中附件的名称，第二个参数是图片资源。

multipart类型的Email已经构建完成了，现在可以发送它了。完整的sendSpittleEmailWithAttachment()方法如下所示。

multipart类型的Email能够实现很多的功能，添加附件只是其中之一。除此之外，通过将Email体指明为HTML，我们可以生成比简单文本更漂亮的Email。接下来，看一下如何使用MimeMessageHelper来发送更吸引人的Email。

2.2 发送富文本内容的Email

发送富文本的Email与发送简单文本的Email并没有太大区别。关键是将消息的文本设置为HTML。要做到这一点只需将HTML字符串传递给helper的setText()方法，并将第二个参数设置为true：

第二个参数表明传递进来的第一个参数是HTML，所以需要对消息的内容类型进行相应的设置。

要注意的是，传递进来的HTML包含了一个<img>标签，用来在Email中展现Spittr应用程序的logo。src属性可以设置为标准的“http:”URL，以便于从Web中获取Spittr的logo。但在这里，我们将logo图片嵌入在了Email之中。值“cid:spitterLogo”表明在消息中会有一部分是图片并以spitterLogo来进行标识。

为消息添加嵌入式的图片与添加附件很类似。不过这次不再使用helper的addAttachment()方法，而是要调用addInline()方法：

addInline的第一个参数表明内联图片的标识符——与<img>标签的src属性所指定的相同。第二个参数是图片的资源引用，这里使用ClassPathResource从应用程序的类路径中获取图片。

除了setText()方法稍微不同以及使用了addInline()方法以外，发送含有富文本内容的Email与发送带有附件的普通文本消息很类似。为了进行对比，以下是新的sendRichSpitterEmail()方法。

三、使用模板生成Email

使用字符串拼接来构建Email消息的问题在于Email最终会是什么样子并不清晰。在你的大脑中解析HTML标签并想象它在渲染时会是什么样子是挺困难的。而将HTML混合在Java代码中又会使得这个问题更加复杂。如果能够将Email的布局抽取到一个模板中，而这个模板可以由美术设计师（可能是很讨厌Java代码的人）来完成将会是很棒的一件事。

我们需要与最终HTML接近的方式来表达Email布局，然后将模板转换成String并传递给helper的setText()方法。在将模板转换为String时，我们有多种模板方案可供选择，包括Apache Velocity和Thymeleaf。让我们看一下如何使用这两种方案创建富文本的Email消息，先从Velocity开始吧。

3.1 使用Velocity构建Email消息

Apache Velocity是由Apache提供的通用模板引擎。Velocity有挺长的历史了，并且已经应用于各种任务中，包括代码生成以及代替JSP。它还能用于格式化富文本Email消息，也就是我们在这里的用法。

为了使用Velocity对Email进行布局，我们需要将VelocityEngine装配到SpitterEmailServiceImpl中。Spring提供了一个名为VelocityEngineFactoryBean的工厂bean，它能够在Spring应用上下文中很便利地生成VelocityEngine。VelocityEngineFactoryBean的声明如下：

VelocityEngineFactoryBean唯一要设置的属性是velocityProperties。在本例中，我们将其配置为从类路径下加载Velocity模板（关于配置Velocity的更多细节，请查阅Velocity文档）。

现在，我们可以将Velocity引擎装配到SpitterEmailServiceImpl中。因为SpitterEmailServiceImpl是使用组件扫描实现自动注册的，我们可以使用@Autowired来自动装配velocityEngine属性：

现在，velocityEngine属性可用了，我们可以使用它将Velocity模板转换为String，并作为Email文本进行发送。为了帮助我们完成这一点，Spring自带了VelocityEngineUtils来简化将Velocity模板与模型数据合并成String的工作。以下是我们可能的使用方式：

为了给处理模板做准备，我们首先创建了一个Map用来保存模板使用的模型数据。在前面字符串拼接的代码中，我们需要Spitter的全名及其Spittle的文本，这里也是一样。为了产生合并后的Email文本，我们只需调用VelocityEngineUtils的mergeTemplateIntoString()方法并将Velocity引擎、模板路径（相对于类路径根）以及模型Map传递进去。

在Java代码中剩下的事情就是得到合并后的Email文本，并将其传递给helper的setText()方法：

模板位于类路径的根目录下，是一个名为emailTemplate.vm的文件，它看起来可能是这样的：

你可以看到，模板文件比前面的字符串拼接版本读起来容易多了。因此，它也更容易维护和编辑。下图给出了这种类型Email的一个示例。

3.2 使用Thymeleaf构建Email消息

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

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

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

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

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

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

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

不过，我们必要要对SpringTemplateEnginebean做一点小修改。而我们的Email模板需要从类路径中解析。所以，除了ServletContextTemplateResolver，还需要一个ClassLoaderTemplateResolver：


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

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

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

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