邮件
邮件
本节描述了如何使用 Spring 框架发送电子邮件。
Spring 框架提供了一个有用的工具库，用于发送电子邮件，它使您免受底层邮件系统的具体细节影响，并负责代表客户端进行低级资源处理。
org.springframework.mail 包是 Spring 框架电子邮件支持的根级包。发送电子邮件的中心接口是 MailSender 接口。一个简单的值对象，封装了简单邮件的属性，如 from 和 to（以及许多其他属性），是 SimpleMailMessage 类。该包还包含一系列受检异常，这些异常提供了对低级邮件系统异常的更高抽象级别，根异常是 MailException。有关丰富邮件异常层次结构的更多信息，请参见 javadoc。
org.springframework.mail.javamail.JavaMailSender 接口为 MailSender 接口（它继承自该接口）添加了专门的 JavaMail 功能，例如 MIME 消息支持。JavaMailSender 还提供了一个回调接口，称为 org.springframework.mail.javamail.MimeMessagePreparator，用于准备 MimeMessage。
使用
假设我们有一个名为 OrderManager 的业务接口，如下例所示：
- Java
- Kotlin
public interface OrderManager {
void placeOrder(Order order);
}
interface OrderManager {
fun placeOrder(order: Order)
}
进一步假设我们有一个要求，说明需要生成一封包含订单号码的电子邮件，并将其发送给下单的客户。
基本 MailSender 和 SimpleMailMessage 用法
以下示例展示了如何使用 MailSender 和 SimpleMailMessage 在有人下订单时发送电子邮件：
- Java
- Kotlin
public class SimpleOrderManager implements OrderManager {
private MailSender mailSender;
private SimpleMailMessage templateMessage;
public void setMailSender(MailSender mailSender) {
this.mailSender = mailSender;
}
public void setTemplateMessage(SimpleMailMessage templateMessage) {
this.templateMessage = templateMessage;
}
@Override
public void placeOrder(Order order) {
// Do the business calculations...
// Call the collaborators to persist the order...
// Create a thread-safe "copy" of the template message and customize it
SimpleMailMessage msg = new SimpleMailMessage(this.templateMessage);
msg.setTo(order.getCustomer().getEmailAddress());
msg.setText(
"Dear " + order.getCustomer().getFirstName()
+ order.getCustomer().getLastName()
+ ", thank you for placing order. Your order number is "
+ order.getOrderNumber());
try {
this.mailSender.send(msg);
}
catch (MailException ex) {
// simply log it and go on...
System.err.println(ex.getMessage());
}
}
}
class SimpleOrderManager : OrderManager {
lateinit var mailSender: MailSender
lateinit var templateMessage: SimpleMailMessage
override fun placeOrder(order: Order) {
// Do the business calculations...
// Call the collaborators to persist the order...
// Create a thread-safe "copy" of the template message and customize it
val msg = SimpleMailMessage(this.templateMessage)
msg.setTo(order.customer.emailAddress)
msg.text = ("Dear " + order.customer.firstName
+ order.customer.lastName
+ ", thank you for placing order. Your order number is "
+ order.orderNumber)
try {
mailSender.send(msg)
} catch (ex: MailException) {
// simply log it and go on...
System.err.println(ex.message)
}
}
}
以下示例显示了前面代码的 bean 定义：
- Java
- Kotlin
- Xml
@Bean
JavaMailSender mailSender() {
JavaMailSenderImpl mailSender = new JavaMailSenderImpl();
mailSender.setHost("mail.mycompany.example");
return mailSender;
}
@Bean // this is a template message that we can pre-load with default state
SimpleMailMessage templateMessage() {
SimpleMailMessage message = new SimpleMailMessage();
message.setFrom("customerservice@mycompany.example");
message.setSubject("Your order");
return message;
}
@Bean
SimpleOrderManager orderManager(JavaMailSender mailSender, SimpleMailMessage templateMessage) {
SimpleOrderManager orderManager = new SimpleOrderManager();
orderManager.setMailSender(mailSender);
orderManager.setTemplateMessage(templateMessage);
return orderManager;
}
@Bean
fun mailSender(): JavaMailSender {
return JavaMailSenderImpl().apply {
host = "mail.mycompany.example"
}
}
@Bean // this is a template message that we can pre-load with default state
fun templateMessage() = SimpleMailMessage().apply {
from = "customerservice@mycompany.example"
subject = "Your order"
}
@Bean
fun orderManager(javaMailSender: JavaMailSender, simpleTemplateMessage: SimpleMailMessage) = SimpleOrderManager().apply {
mailSender = javaMailSender
templateMessage = simpleTemplateMessage
}
<bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
<property name="host" value="mail.mycompany.example"/>
</bean>
<!-- this is a template message that we can pre-load with default state -->
<bean id="templateMessage" class="org.springframework.mail.SimpleMailMessage">
<property name="from" value="customerservice@mycompany.example"/>
<property name="subject" value="Your order"/>
</bean>
<bean id="orderManager" class="com.mycompany.businessapp.support.SimpleOrderManager">
<property name="mailSender" ref="mailSender"/>
<property name="templateMessage" ref="templateMessage"/>
</bean>
使用 JavaMailSender 和 MimeMessagePreparator
本节描述了另一种实现 OrderManager 的方式，该方式使用 MimeMessagePreparator 回调接口。在以下示例中，mailSender 属性的类型为 JavaMailSender，因此我们能够使用 JavaMail 的 MimeMessage 类：
import jakarta.mail.Message;
import jakarta.mail.MessagingException;
import jakarta.mail.internet.InternetAddress;
import jakarta.mail.internet.MimeMessage;
import jakarta.mail.internet.MimeMessage;
import org.springframework.mail.MailException;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessagePreparator;
public class SimpleOrderManager implements OrderManager {
private JavaMailSender mailSender;
public void setMailSender(JavaMailSender mailSender) {
this.mailSender = mailSender;
}
public void placeOrder(final Order order) {
// Do the business calculations...
// Call the collaborators to persist the order...
MimeMessagePreparator preparator = new MimeMessagePreparator() {
public void prepare(MimeMessage mimeMessage) throws Exception {
mimeMessage.setRecipient(Message.RecipientType.TO,
new InternetAddress(order.getCustomer().getEmailAddress()));
mimeMessage.setFrom(new InternetAddress("mail@mycompany.example"));
mimeMessage.setText("Dear " + order.getCustomer().getFirstName() + " " +
order.getCustomer().getLastName() + ", thanks for your order. " +
"Your order number is " + order.getOrderNumber() + ".");
}
};
try {
this.mailSender.send(preparator);
}
catch (MailException ex) {
// simply log it and go on...
System.err.println(ex.getMessage());
}
}
}
邮件代码是一个横切关注点，很可能是重构为一个 自定义 Spring AOP 切面 的候选者，这样可以在 OrderManager 目标的适当连接点上运行。
Spring 框架的邮件支持附带标准的 JavaMail 实现。有关更多信息，请参见相关的 javadoc。
使用 JavaMail MimeMessageHelper
一个在处理 JavaMail 消息时非常有用的类是 org.springframework.mail.javamail.MimeMessageHelper，它让你不必使用冗长的 JavaMail API。使用 MimeMessageHelper，创建 MimeMessage 非常简单，如下例所示：
// of course you would use DI in any real-world cases
JavaMailSenderImpl sender = new JavaMailSenderImpl();
sender.setHost("mail.host.com");
MimeMessage message = sender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(message);
helper.setTo("test@host.com");
helper.setText("Thank you for ordering!");
sender.send(message);
发送附件和内嵌资源
多部分电子邮件消息允许同时包含附件和内联资源。内联资源的示例包括您希望在消息中使用但不希望作为附件显示的图像或样式表。
附件
以下示例向您展示了如何使用 MimeMessageHelper 发送带有单个 JPEG 图像附件的电子邮件：
JavaMailSenderImpl sender = new JavaMailSenderImpl();
sender.setHost("mail.host.com");
MimeMessage message = sender.createMimeMessage();
// use the true flag to indicate you need a multipart message
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setTo("test@host.com");
helper.setText("Check out this image!");
// let's attach the infamous windows Sample file (this time copied to c:/)
FileSystemResource file = new FileSystemResource(new File("c:/Sample.jpg"));
helper.addAttachment("CoolImage.jpg", file);
sender.send(message);
内联资源
以下示例向您展示如何使用 MimeMessageHelper 发送带有内嵌图像的电子邮件：
JavaMailSenderImpl sender = new JavaMailSenderImpl();
sender.setHost("mail.host.com");
MimeMessage message = sender.createMimeMessage();
// use the true flag to indicate you need a multipart message
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setTo("test@host.com");
// use the true flag to indicate the text included is HTML
helper.setText("<html><body><img src='cid:identifier1234'></body></html>", true);
// let's include the infamous windows Sample file (this time copied to c:/)
FileSystemResource res = new FileSystemResource(new File("c:/Sample.jpg"));
helper.addInline("identifier1234", res);
sender.send(message);
内联资源通过使用指定的 Content-ID（在上面的示例中为 identifier1234）添加到 MimeMessage 中。添加文本和资源的顺序非常重要。请确保先添加文本，然后再添加资源。如果你反过来做，这将不起作用。
使用模板库创建电子邮件内容
在前面章节中示例中的代码通过使用方法调用，例如 message.setText(..)，显式地创建了电子邮件消息的内容。这对于简单的情况是可以的，并且在上述示例的上下文中也是可以的，因为其目的是向您展示 API 的基本知识。
在典型的企业应用程序中，开发人员通常不会使用之前展示的方法来创建电子邮件消息的内容，原因有很多：
-
在 Java 代码中创建基于 HTML 的电子邮件内容是繁琐且容易出错的。
-
显示逻辑和业务逻辑之间没有明确的分离。
-
更改电子邮件内容的显示结构需要编写 Java 代码、重新编译、重新部署等。
通常，解决这些问题的方法是使用模板库（例如 FreeMarker）来定义电子邮件内容的显示结构。这使得您的代码仅需负责创建要在电子邮件模板中呈现的数据并发送电子邮件。当您的电子邮件消息的内容变得稍微复杂时，这绝对是一种最佳实践，并且借助 Spring Framework 对 FreeMarker 的支持类，这变得相当简单。