Spring Boot (十)：郵件服務

純潔的微笑發表於2017-05-08
Spring Boot

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

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

簡單使用

1、pom 包配置

pom 包裡面新增 spring-boot-starter-mail 包引用

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

2、在 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  //以誰來傳送郵件

3、編寫 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);
        }

    }
}

4、編寫 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);
}

新增多個圖片可以使用多條 <img src='cid:" + rscId + "' > 和 helper.addInline(rscId, res) 來實現

到此所有的郵件傳送服務已經完成了。

郵件系統

上面傳送郵件的基礎服務就這些了，但是如果我們要做成一個郵件系統的話還需要考慮以下幾個問題：

郵件模板

我們會經常收到這樣的郵件：

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

其中只有 neo 這個使用者名稱在變化，其它郵件內容均不變，如果每次傳送郵件都需要手動拼接的話會不夠優雅，並且每次模板的修改都需要改動程式碼的話也很不方便，因此對於這類郵件需求，都建議做成郵件模板來處理。模板的本質很簡單，就是在模板中替換變化的引數，轉換為 html 字串即可，這裡以thymeleaf為例來演示。

1、pom 中匯入 thymeleaf 的包

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

2、在 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>

3、解析模板併傳送

@Test
public void sendTemplateMail() {
    //建立郵件正文
    Context context = new Context();
    context.setVariable("id", "006");
    String emailContent = templateEngine.process("emailTemplate", context);

    mailService.sendHtmlMail("ityouknow@126.com","主題：這是模板郵件",emailContent);
}

傳送失敗

因為各種原因，總會有郵件傳送失敗的情況，比如：郵件傳送過於頻繁、網路異常等。在出現這種情況的時候，我們一般會考慮重新重試傳送郵件，會分為以下幾個步驟來實現：

  • 1、接收到傳送郵件請求，首先記錄請求並且入庫。
  • 2、呼叫郵件傳送介面傳送郵件，並且將傳送結果記錄入庫。
  • 3、啟動定時系統掃描時間段內，未傳送成功並且重試次數小於3次的郵件，進行再次傳送

非同步傳送

很多時候郵件傳送並不是我們主業務必須關注的結果，比如通知類、提醒類的業務可以允許延時或者失敗。這個時候可以採用非同步的方式來傳送郵件，加快主交易執行速度，在實際專案中可以採用MQ傳送郵件相關引數，監聽到訊息佇列之後啟動傳送郵件。

可以參考前期文章：Spring Boot(八)：RabbitMQ 詳解 來實現。

文章內容已經升級到 Spring Boot 2.x

示例程式碼-github

示例程式碼-碼雲

參考:
spring boot 傳送郵件

相關文章