SpringBoot+mail 輕松實現各類郵件自動推送

一、簡介

在實際的項目開發過程中，經常需要用到郵件通知功能。例如，通過郵箱注冊，郵箱找回密碼，郵箱推送報表等等，實際的應用場景非常的多。

早期的時候，為了能實現郵件的自動發送功能，通常會使用 JavaMail 相關的 api 來完成。后來 Spring 推出的 JavaMailSender 工具，進一步簡化了郵件的自動發送過程，調用其 send 方法即可發送郵件。再之后， Spring Boot 針對郵件推送功能推出了spring-boot-starter-mail工具包，開發者可以通過它來快速實現郵件發送服務。

今天通過這篇文章，我們一起來學習如何在 Spring Boot 中快速實現一個自動發送郵件的功能。

二、環境準備

在介紹郵件推送實現之前，我們需要先準備一臺郵件推送的服務器，以便實現相關功能。

這里以騰訊郵箱為例，將其作為郵件發送的中轉平臺。

2.1、開啟 SMTP 服務

登陸騰訊郵箱，打開【設置】-》【收發信設置】，開啟 SMTP 服務，最后點擊【保存更改】。

2.2、生成客戶端專用密碼

點擊【設置】-》【賬戶】，進入頁面后點擊【開啟安全登陸】，點擊【生成新密碼】。

這個新密碼會用于郵箱的自動發送，因此需要記錄下來，最后點擊【保存更改】。

2.3、相關擴展知識

什么是 SMTP？

SMTP（simple mail transfer protocol），也被稱為簡單郵件傳輸協議，主要用于發送電子郵件的，通過它可以實現郵件的發送或者中轉。遵循 SMTP 協議的服務器，通常稱為發送郵件服務器。

什么是 POP3？

POP3（Post Office Protocol），一種郵局通信協議。主要用于接受電子郵件的，POP3 允許用戶從服務器上把郵件存儲到自己的計算機上，同時刪除保存在郵件服務器上的郵件。同理，遵循 POP3 協議的服務器，通常稱為接收郵件服務器。

什么是 IMAP？

IMAP（Internet Mail Access Protocol），一種交互式郵件存取協議。與 POP3 協議類似，主要用于接收電子郵件，稍有不同的是：IMAP 允許電子郵件客戶端收取的郵件仍然保留在服務器上，同時在客戶端上的操作都會反饋到服務器上，例如刪除郵件，標記已讀等，服務器上的郵件也會做相應的動作。所以無論從瀏覽器登錄郵箱或者客戶端軟件登錄郵箱，看到的郵件以及狀態都是一致的。

總結下來就是：SMTP 負責發送郵件，POP3/IMAP 負責接收郵件。

常見郵箱發、收服務器如下！

三、郵件推送實現

用于發送郵件的服務器、賬戶和密碼準備好了之后，就可以正式使用了。下面我們以 Spring Boot 的 2.1.0版本為基礎，實現過程如下。

2.1、添加依賴包

在pom.xml文件中，添加spring-boot-starter-mail依賴包。

<!--mail 支持-->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-mail</artifactId>
</dependency>

2.2、添加相關配置

在application.properties中添加郵箱相關配置。

# 配置郵件發送主機地址
spring.mail.host=smtp.exmail.qq.com
# 配置郵件發送服務端口號
spring.mail.port=465
# 配置郵件發送服務協議
spring.mail.protocol=smtp
# 配置郵件發送者用戶名或者賬戶
spring.mail.username=xxx@qq.com
# 配置郵件發送者密碼或者授權碼
spring.mail.password=xxxxxxx
# 配置郵件默認編碼
spring.mail.default-encoding=UTF-8
# 配置smtp相關屬性
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.ssl.enable=true
spring.mail.properties.mail.smtp.ssl.required=true

2.3、簡單發送一封郵件

通過單元測試來實現一封簡單郵件的發送，示例如下：

@RunWith(SpringRunner.class)
@SpringBootTest
public class MailSimpleTest {@Autowiredprivate JavaMailSender mailSender;@Testpublic void sendSimpleMail() throws Exception {SimpleMailMessage message = new SimpleMailMessage();// 配置發送者郵箱message.setFrom("xxxx@qq.com");// 配置接受者郵箱message.setTo("xxxxxx@qq.com");// 配置郵件主題message.setSubject("主題：簡單郵件");// 配置郵件內容message.setText("測試郵件內容");// 發送郵件mailSender.send(message);}
}

運行單元測試之后，如果不出意外的話，接受者會收到這樣的一封郵件。

至此，郵件發送成功！

2.4、發送 HTML 格式郵件

在實際的業務開發中，郵件的內容通常會要求豐富，比如會發送一些帶有圖片的內容，包括字體大小，各種超鏈接等，這個時候如何實現呢？

實際上，郵件內容支持 HTML 格式，因此可以借助頁面模板引擎來實現絢麗多彩的內容。

下面我們以freemarker模板引擎為例，發送一封內容為 HTML 格式的郵件。

2.4.1、引入 freemarker 依賴包

首先，在pom.xml文件中，添加freemarker依賴包。

<!--freemarker 支持-->
<dependency><groupId>org.freemarker</groupId><artifactId>freemarker</artifactId><version>2.3.23</version>
</dependency>

2.4.2、編寫郵件頁面模板

然后，在resources/templates目錄下，創建一個demo.ftl文件，示例如下！

<html>
<head><meta charset="utf-8"><title></title>
</head>
<body>
<div>您好：${userName}</div>
<div>這是html文本內容</div>
<img src="https://rescdn.qqmail.com/zh_CN/htmledition/images/logo/logo_0_0@2X1f1937.png" />
</body>
</html>

2.4.3、編寫一個郵件推送服務

雖然采用 Spring Boot 提供的自動配置屬性來實現郵件推送，可以極大的簡化開發過程。而實際開發的時候，通常更推薦自定義一個郵件統一推送服務，這樣更便于靈活的控制代碼實現以及排查相關問題。

郵件統一發送服務，示范如下。

@Component
public class MailPushService {private final Logger LOGGER = LoggerFactory.getLogger(MailPushService.class);@Value("${mail.host}")private String host;@Value("${mail.port}")private String port;@Value("${mail.protocol}")private String protocol;@Value("${mail.username}")private String username;@Value("${mail.password}")private String password;@Value("${mail.fromEmail}")private String fromEmail;@Value("${mail.fromPersonal}")private String fromPersonal;@Autowiredprivate JavaMailSender mailSender;/*** 發送郵件（簡單模式）* @param toEmail* @param subject* @param content*/public void sendMail(String toEmail, String subject,String content)  {try {final Properties props = new Properties();//服務器props.put("mail.smtp.host", host);//端口props.put("mail.smtp.port", port);//協議props.setProperty("mail.transport.protocol", protocol);//用戶名props.put("mail.user", username);//密碼props.put("mail.password", password);//使用smtp身份驗證props.put("mail.smtp.auth", "true");//開啟安全協議MailSSLSocketFactory sf = new MailSSLSocketFactory();sf.setTrustAllHosts(true);props.put("mail.smtp.ssl.enable", "true");props.put("mail.smtp.ssl.socketFactory", sf);Authenticator authenticator = new Authenticator() {@Overrideprotected PasswordAuthentication getPasswordAuthentication() {return new PasswordAuthentication(props.getProperty("mail.user"),props.getProperty("mail.password"));}};Session session = Session.getDefaultInstance(props, authenticator);session.setDebug(true);MimeMessage mimeMessage = new MimeMessage(session);mimeMessage.setFrom(new InternetAddress(fromEmail, MimeUtility.encodeText(fromPersonal)));mimeMessage.setRecipient(MimeMessage.RecipientType.TO, new InternetAddress(toEmail));mimeMessage.setSubject(subject);mimeMessage.setContent(content, "text/html;charset=UTF-8");//保存信息mimeMessage.saveChanges();//發送消息Transport.send(mimeMessage);LOGGER.info("簡單郵件已經發送。");} catch (Exception e) {LOGGER.error("發送簡單郵件時發生異常！", e);}}
}

代碼中相關自定義的全局參數配置如下：

mail.host=smtp.exmail.qq.com
mail.port=465
mail.protocol=smtp
mail.username=xxx@qq.com
mail.password=xxxxxx
mail.fromEmail=xxxxxx@qq.com
mail.fromPersonal=發送者昵稱

2.4.4、測試服務的正確性

最后，編寫一個單元測試來驗證服務的正確性，示例如下：

@RunWith(SpringRunner.class)
@SpringBootTest
public class MailTest {@Autowiredprivate MailPushService mailPushService;@Testpublic void testSendHtmlMail() throws Exception {String sendHtml = buildHtmlContent("張三");mailPushService.sendMail("xxxxx@qq.com","簡單標題", sendHtml);}/*** 封裝html頁面* @return* @throws Exception*/private static String buildHtmlContent(String userName) throws Exception {Configuration configuration = new Configuration(Configuration.VERSION_2_3_23);configuration.setDefaultEncoding(Charset.forName("UTF-8").name());configuration.setClassForTemplateLoading(MailTest.class, "/templates");// 獲取頁面模版Template template = configuration.getTemplate("demo.ftl");// 動態變量替換Map<String,Object> map = new HashMap<>();map.put("userName", userName);String htmlStr = FreeMarkerTemplateUtils.processTemplateIntoString(template,map);return htmlStr;}}

運行單元測試之后，如果沒有報錯，接受者會收到這樣的一封郵件。

2.5、發送帶附件的郵件

某些業務場景，用戶希望發送的郵件中能帶上附件，比如上文中，在發送 HTML 格式的郵件時，同時也帶上文件附件，這個時候如何實現呢？

2.5.1、編寫帶附件的郵件發送

此時可以在郵件推送服務中，新增一個支持帶附件的方法，實現邏輯如下。

/*** 發送郵件（復雜模式）* @param toEmail    接受者郵箱* @param subject    主題* @param sendHtml   內容* @param attachment 附件*/
public void sendMail(String toEmail, String subject, String sendHtml, File attachment) {try {//設置了附件名過長問題System.setProperty("mail.mime.splitlongparameters", "false");final Properties props = new Properties();//服務器props.put("mail.smtp.host", host);//端口props.put("mail.smtp.port", port);//協議props.setProperty("mail.transport.protocol", protocol);//用戶名props.put("mail.user", username);//密碼props.put("mail.password", password);//使用smtp身份驗證props.put("mail.smtp.auth", "true");//開啟安全協議MailSSLSocketFactory sf = new MailSSLSocketFactory();sf.setTrustAllHosts(true);props.put("mail.smtp.ssl.enable", "true");props.put("mail.smtp.ssl.socketFactory", sf);Authenticator authenticator = new Authenticator() {@Overrideprotected PasswordAuthentication getPasswordAuthentication() {return new PasswordAuthentication(props.getProperty("mail.user"),props.getProperty("mail.password"));}};Session session = Session.getDefaultInstance(props, authenticator);session.setDebug(true);MimeMessage mimeMessage = new MimeMessage(session);// 發送者郵箱mimeMessage.setFrom(new InternetAddress(fromEmail, MimeUtility.encodeText(fromPersonal)));// 接受者郵箱mimeMessage.setRecipient(MimeMessage.RecipientType.TO, new InternetAddress(toEmail));// 郵件主題mimeMessage.setSubject(subject);// 定義郵件內容Multipart multipart = new MimeMultipart();// 添加郵件正文BodyPart contentPart = new MimeBodyPart();contentPart.setContent(sendHtml, "text/html;charset=UTF-8");multipart.addBodyPart(contentPart);// 添加附件if (attachment != null) {BodyPart attachmentBodyPart = new MimeBodyPart();// MimeUtility.encodeWord可以避免文件名亂碼FileDataSource fds=new FileDataSource(attachment);attachmentBodyPart.setDataHandler(new DataHandler(fds));attachmentBodyPart.setFileName(MimeUtility.encodeText(fds.getName()));multipart.addBodyPart(attachmentBodyPart);}// 將multipart對象放到message中mimeMessage.setContent(multipart);//保存信息mimeMessage.saveChanges();//發送消息Transport.send(mimeMessage);LOGGER.info("郵件已經發送。");} catch (Exception e) {LOGGER.error("發送郵件時發生異常！", e);}
}

2.5.2、測試服務的正確性

最后，編寫一個單元測試來驗證服務的正確性，示例如下：

@Test
public void doSendHtmlEmail() throws Exception {// 獲取正文內容String sendHtml = buildHtmlContent("張三");// 獲取附件File file = new File( "~/doc/Java開發手冊.pdf");// 發送郵件mailPushService.sendMail("xxxxx@qq.com","帶附件的郵件推送", sendHtml, file);
}