Spring Boot (十)：郵件服務

時間 2019-12-05

原文原文鏈接

Spring Boot 仍然在狂速發展，才幾個多月沒有關注，如今看官網已經到 2.1.0.RELEASE 版本了。準備慢慢在寫寫 Spring Boot 相關的文章，本篇文章使用 Spring Boot 最新版本 2.1.0 進行開發。html

發送郵件應該是網站的必備功能之一，什麼註冊驗證，忘記密碼或者是給用戶發送營銷信息。最先期的時候咱們會使用 JavaMail 相關 api 來寫發送郵件的相關代碼，後來 Spring 推出了 JavaMailSender 更加簡化了郵件發送的過程，在以後 Spring Boot 對此進行了封裝就有了如今的 spring-boot-starter-mail ,本章文章的介紹主要來自於此包。java

簡單使用

一、pom 包配置

pom 包裏面添加 spring-boot-starter-mail 包引用git

<dependencies>github
<dependency>面試
<groupId>org.springframework.boot</groupId>spring
<artifactId>spring-boot-starter-mail</artifactId>api
</dependency>服務器
</dependencies>網絡

二、在 application.properties 中添加郵箱配置

spring.mail.host=smtp.qiye.163.com //郵箱服務器地址併發
spring.mail.username=xxx@oo.com //用戶名
spring.mail.password=xxyyooo //密碼
spring.mail.default-encoding=UTF-8
mail.fromMail.addr=xxx@oo.com //以誰來發送郵件

三、編寫 mailService，這裏只提出實現類。

@Component
public class MailServiceImpl implements MailService{
private final Logger logger = LoggerFactory.getLogger(this.getClass());
@Autowired
private JavaMailSender mailSender;
@Value("${mail.fromMail.addr}")
private String from;
@Override
public void sendSimpleMail(String to, String subject, String content) {
SimpleMailMessage message = new SimpleMailMessage();
message.setFrom(from);
message.setTo(to);
message.setSubject(subject);
message.setText(content);
try {
mailSender.send(message);
logger.info("簡單郵件已經發送。");
} catch (Exception e) {
logger.error("發送簡單郵件時發生異常！", e);
}
}
}

四、編寫 test 類進行測試

@RunWith(SpringRunner.class)
@SpringBootTest
public class MailServiceTest {
@Autowired
private MailService MailService;
@Test
public void testSimpleMail() throws Exception {
MailService.sendSimpleMail("ityouknow@126.com","test simple mail"," hello this is simple mail");
}
}

至此一個簡單的文本發送就完成了。

加點料

可是在正常使用的過程當中，咱們一般在郵件中加入圖片或者附件來豐富郵件的內容，下面講介紹如何使用 Spring Boot 來發送豐富的郵件。

發送 html 格式郵件

其它都不變在 MailService 添加 sendHtmlMail 方法.

public void sendHtmlMail(String to, String subject, String content) {
MimeMessage message = mailSender.createMimeMessage();
try {
//true表示須要建立一個multipart message
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(from);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, true);
mailSender.send(message);
logger.info("html郵件發送成功");
} catch (MessagingException e) {
logger.error("發送html郵件時發生異常！", e);
}
}

在測試類中構建 html 內容，測試發送

@Test
public void testHtmlMail() throws Exception {
String content="<html>\n" +
"<body>\n" +
" <h3>hello world ! 這是一封Html郵件!</h3>\n" +
"</body>\n" +
"</html>";
MailService.sendHtmlMail("ityouknow@126.com","test simple mail",content);
}

發送帶附件的郵件

在 MailService 添加 sendAttachmentsMail 方法.

public void sendAttachmentsMail(String to, String subject, String content, String filePath){
MimeMessage message = mailSender.createMimeMessage();
try {
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(from);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, true);
FileSystemResource file = new FileSystemResource(new File(filePath));
String fileName = filePath.substring(filePath.lastIndexOf(File.separator));
helper.addAttachment(fileName, file);
mailSender.send(message);
logger.info("帶附件的郵件已經發送。");
} catch (MessagingException e) {
logger.error("發送帶附件的郵件時發生異常！", e);
}
}

添加多個附件可使用多條 helper.addAttachment(fileName,file)

在測試類中添加測試方法

@Test
public void sendAttachmentsMail() {
String filePath="e:\\tmp\\application.log";
mailService.sendAttachmentsMail("ityouknow@126.com", "主題：帶附件的郵件", "有附件，請查收！", filePath);
}

發送帶靜態資源的郵件

郵件中的靜態資源通常就是指圖片，在 MailService 添加 sendAttachmentsMail 方法.

public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId){
MimeMessage message = mailSender.createMimeMessage();
try {
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(from);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, true);
FileSystemResource res = new FileSystemResource(new File(rscPath));
helper.addInline(rscId, res);
mailSender.send(message);
logger.info("嵌入靜態資源的郵件已經發送。");
} catch (MessagingException e) {
logger.error("發送嵌入靜態資源的郵件時發生異常！", e);
}
}

在測試類中添加測試方法

@Test
public void sendInlineResourceMail() {
String rscId = "neo006";
String content="<html><body>這是有圖片的郵件：<img src=\'cid:" + rscId + "\' ></body></html>";
String imgPath = "C:\\Users\\summer\\Pictures\\favicon.png";
mailService.sendInlineResourceMail("ityouknow@126.com", "主題：這是有圖片的郵件", content, imgPath, rscId);
}

添加多個圖片可使用多條 <imgsrc='cid:" + rscId + "'> 和 helper.addInline(rscId,res) 來實現

到此全部的郵件發送服務已經完成了。

郵件系統

上面發送郵件的基礎服務就這些了，可是若是咱們要作成一個郵件系統的話還須要考慮如下幾個問題：

郵件模板

咱們會常常收到這樣的郵件：

尊敬的neo用戶：
恭喜您註冊成爲xxx網的用戶,，同時感謝您對xxx的關注與支持並歡迎您使用xx的產品與服務。
...

其中只有 neo 這個用戶名在變化，其它郵件內容均不變，若是每次發送郵件都須要手動拼接的話會不夠優雅，而且每次模板的修改都須要改動代碼的話也很不方便，所以對於這類郵件需求，都建議作成郵件模板來處理。模板的本質很簡單，就是在模板中替換變化的參數，轉換爲 html 字符串便可，這裏以 thymeleaf爲例來演示。

一、pom 中導入 thymeleaf 的包

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

*二、在 resorces/templates 下建立 emailTemplate.html *

<!DOCTYPE html>
<html lang="zh" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8"/>
<title>Title</title>
</head>
<body>
您好,這是驗證郵件,請點擊下面的連接完成驗證,<br/>
<a href="#" th:href="@{ http://www.ityouknow.com/neo/{id}(id=${id}) }">激活帳號</a>
</body>
</html>