SpringBoot整合Mail輕松實現(xiàn)郵件自動推送功能

更新時間：2024年12月15日 10:30:09 作者：技術(shù)棧人員

在項目中經(jīng)常會遇到SpringBoot推送消息的業(yè)務(wù),除了站內(nèi)推送通知,郵件推送也是一種常見的方式,本文小編就給大家介紹了SpringBoot整合Mail輕松實現(xiàn)郵件自動推送功能,需要的朋友可以參考下

簡單使用

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 //郵箱服務(wù)器地址
spring.mail.username=xxx@oo.com //用戶名
spring.mail.password=xxyyooo    //密碼
spring.mail.default-encoding=UTF-8
 
mail.fromMail.addr=xxx@oo.com  //以誰來發(fā)送郵件

3、編寫 mailService，這里只提出實現(xiàn)類。

@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("簡單郵件已經(jīng)發(fā)送。");
        } catch (Exception e) {
            logger.error("發(fā)送簡單郵件時發(fā)生異常！", e);
        }
    }
}

4、編寫 test 類進行測試

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

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

高級玩法

但是在正常使用的過程中，我們通常在郵件中加入圖片或者附件來豐富郵件的內(nèi)容，下面講介紹如何使用 Spring Boot 來發(fā)送豐富的郵件。

發(fā)送 html 格式郵件

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

public void sendHtmlMail(String to, String subject, String content) {
    MimeMessage message = mailSender.createMimeMessage();
 
    try {
        //true表示需要創(chuàng)建一個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郵件發(fā)送成功");
    } catch (MessagingException e) {
        logger.error("發(fā)送html郵件時發(fā)生異常！", e);
    }
}

在測試類中構(gòu)建 html 內(nèi)容，測試發(fā)送

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

發(fā)送帶附件的郵件

在 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("帶附件的郵件已經(jīng)發(fā)送。");
    } catch (MessagingException e) {
        logger.error("發(fā)送帶附件的郵件時發(fā)生異常！", e);
    }
}

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

在測試類中添加測試方法

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

發(fā)送帶靜態(tài)資源的郵件

郵件中的靜態(tài)資源一般就是指圖片，在 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("嵌入靜態(tài)資源的郵件已經(jīng)發(fā)送。");
    } catch (MessagingException e) {
        logger.error("發(fā)送嵌入靜態(tài)資源的郵件時發(fā)生異常！", 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("test@126.com", "主題：這是有圖片的郵件", content, imgPath, rscId);
}

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

到此所有的郵件發(fā)送服務(wù)已經(jīng)完成了。

郵件系統(tǒng)

上面發(fā)送郵件的基礎(chǔ)服務(wù)就這些了，但是如果我們要做成一個郵件系統(tǒng)的話還需要考慮以下幾個問題：

郵件模板

我們會經(jīng)常收到這樣的郵件：

尊敬的xxx用戶：

恭喜您注冊成為xxx網(wǎng)的用戶,，同時感謝您對xxx的關(guān)注與支持并歡迎您使用xx的產(chǎn)品與服務(wù)。
...

其中只有 xxx 這個用戶名在變化，其它郵件內(nèi)容均不變，如果每次發(fā)送郵件都需要手動拼接的話會不夠優(yōu)雅，并且每次模板的修改都需要改動代碼的話也很不方便，因此對于這類郵件需求，都建議做成郵件模板來處理。模板的本質(zhì)很簡單，就是在模板中替換變化的參數(shù)，轉(zhuǎn)換為 html 字符串即可，這里以 thymeleaf為例來演示。

1、pom 中導(dǎo)入 thymeleaf 的包

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

2、在 resorces/templates 下創(chuàng)建 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="#" rel="external nofollow"  th:href="@{ http://www.test.com/{id}(id=${id}) }" rel="external nofollow" >激活賬號</a>
    </body>
 
</html>

3、解析模板并發(fā)送

@Test
public void sendTemplateMail() {
    //創(chuàng)建郵件正文
    Context context = new Context();
    context.setVariable("id", "006");
    String emailContent = templateEngine.process("emailTemplate", context);
 
    mailService.sendHtmlMail("test@126.com","主題：這是模板郵件",emailContent);
}

發(fā)送失敗

因為各種原因，總會有郵件發(fā)送失敗的情況，比如：郵件發(fā)送過于頻繁、網(wǎng)絡(luò)異常等。在出現(xiàn)這種情況的時候，我們一般會考慮重新重試發(fā)送郵件，會分為以下幾個步驟來實現(xiàn)：

1、接收到發(fā)送郵件請求，首先記錄請求并且入庫。
2、用郵件發(fā)送接口發(fā)送郵件，并且將發(fā)送結(jié)果記錄入庫。
3、啟動定時系統(tǒng)掃描時間段內(nèi)，未發(fā)送成功并且重試次數(shù)小于3次的郵件，進行再次發(fā)送

異步發(fā)送

很多時候郵件發(fā)送并不是我們主業(yè)務(wù)必須關(guān)注的結(jié)果，比如通知類、提醒類的業(yè)務(wù)可以允許延時或者失敗。這個時候可以采用異步的方式來發(fā)送郵件，加快主交易執(zhí)行速度，在實際項目中可以采用MQ發(fā)送郵件相關(guān)參數(shù)，監(jiān)聽到消息隊列之后啟動發(fā)送郵件。

以上就是SpringBoot整合Mail輕松實現(xiàn)郵件自動推送功能的詳細內(nèi)容，更多關(guān)于SpringBoot Mail郵件推送的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: