SpringBoot(十)之郵件服務(wù)

更新時(shí)間：2017年05月08日 10:12:08 作者：純潔的微笑

這篇文章給大家介紹了SpringBoot郵件服務(wù)的相關(guān)知識(shí)，此文是使用springboot最新版本1.5.3進(jìn)行開(kāi)發(fā)的。本文給大家介紹的非常詳細(xì)，具有參考借鑒價(jià)值，需要的的朋友參考下吧

springboot仍然在狂速發(fā)展，才五個(gè)多月沒(méi)有關(guān)注，現(xiàn)在看官網(wǎng)已經(jīng)到1.5.3.RELEASE版本了。準(zhǔn)備慢慢在寫(xiě)寫(xiě)springboot相關(guān)的文章，本篇文章使用springboot最新版本1.5.3進(jìn)行開(kāi)發(fā)。

發(fā)送郵件應(yīng)該是網(wǎng)站的必備功能之一，什么注冊(cè)驗(yàn)證，忘記密碼或者是給用戶發(fā)送營(yíng)銷(xiāo)信息。最早期的時(shí)候我們會(huì)使用JavaMail相關(guān)api來(lái)寫(xiě)發(fā)送郵件的相關(guān)代碼，后來(lái)spring退出了JavaMailSender更加簡(jiǎn)化了郵件發(fā)送的過(guò)程，在之后springboot對(duì)此進(jìn)行了封裝就有了現(xiàn)在的spring-boot-starter-mail,本章文章的介紹主要來(lái)自于此包。

簡(jiǎ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 //以誰(shuí)來(lái)發(fā)送郵件

3、編寫(xiě)mailService,這里只提出實(shí)現(xiàn)類(lèi)。

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

4、編寫(xiě)test類(lèi)進(jìn)行測(cè)試

@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");
  }
}

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

加點(diǎn)料

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

發(fā)送html格式郵件

其它都不變?cè)贛ailService添加sendHtmlMail方法.

public void sendHtmlMail(String to, String subject, String content) {
  MimeMessage message = mailSender.createMimeMessage();
  try {
    //true表示需要?jiǎng)?chuàng)建一個(gè)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郵件時(shí)發(fā)生異常！", e);
  }
}

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

@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);
}

發(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ā)送帶附件的郵件時(shí)發(fā)生異常！", e);
  }
}

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

在測(cè)試類(lèi)中添加測(cè)試方法

@Test
public void sendAttachmentsMail() {
  String filePath="e:\\tmp\\application.log";
  mailService.sendAttachmentsMail("ityouknow@126.com", "主題：帶附件的郵件", "有附件，請(qǐng)查收！", 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)資源的郵件時(shí)發(fā)生異常！", e);
  }
}

在測(cè)試類(lèi)中添加測(cè)試方法

@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);
}

添加多個(gè)圖片可以使用多條 <img src='cid:" + rscId + "' > 和 helper.addInline(rscId, res) 來(lái)實(shí)現(xiàn)

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

郵件系統(tǒng)

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

郵件模板

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

尊敬的neo用戶：

恭喜您注冊(cè)成為xxx網(wǎng)的用戶,，同時(shí)感謝您對(duì)xxx的關(guān)注與支持并歡迎您使用xx的產(chǎn)品與服務(wù)。
...
其中只有neo這個(gè)用戶名在變化，其它郵件內(nèi)容均不變，如果每次發(fā)送郵件都需要手動(dòng)拼接的話會(huì)不夠優(yōu)雅，并且每次模板的修改都需要改動(dòng)代碼的話也很不方便，因此對(duì)于這類(lèi)郵件需求，都建議做成郵件模板來(lái)處理。模板的本質(zhì)很簡(jiǎn)單，就是在模板中替換變化的參數(shù)，轉(zhuǎn)換為html字符串即可，這里以thymeleaf為例來(lái)演示。

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>
    您好,這是驗(yàn)證郵件,請(qǐng)點(diǎn)擊下面的鏈接完成驗(yàn)證,<br/>
    <a href="#" rel="external nofollow" th:href="@{ http://www.ityouknow.com/neo/{id}(id=${id}) }">激活賬號(hào)</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("ityouknow@126.com","主題：這是模板郵件",emailContent);
}

發(fā)送失敗

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

1、接收到發(fā)送郵件請(qǐng)求，首先記錄請(qǐng)求并且入庫(kù)。

2、調(diào)用郵件發(fā)送接口發(fā)送郵件，并且將發(fā)送結(jié)果記錄入庫(kù)。

3、啟動(dòng)定時(shí)系統(tǒng)掃描時(shí)間段內(nèi)，未發(fā)送成功并且重試次數(shù)小于3次的郵件，進(jìn)行再次發(fā)送

異步發(fā)送

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

以上所述是小編給大家介紹的SpringBoot(十)之郵件服務(wù)，希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)請(qǐng)給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持！

您可能感興趣的文章: