電子郵件
本節介紹如何使用 Spring Framework 傳送電子郵件。
Spring Framework 提供了一個有用的實用程式庫，用於傳送電子郵件，它使您免受底層郵件系統細節的影響，並代表客戶端負責低級別資源處理。
org.springframework.mail 包是 Spring Framework 電子郵件支援的根級別包。傳送電子郵件的核心介面是 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("[email protected]");
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 = "[email protected]"
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="[email protected]"/>
<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("[email protected]"));
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 Framework 的郵件支援隨標準 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("[email protected]");
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("[email protected]");
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("[email protected]");
// 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 的支援類，這變得非常容易實現。
