SpringBoot Mail郵件任務詳情
一、引言
發送郵件應該是網站的必備功能之一，什麼註冊驗證，忘記密碼或者是給用戶發送營銷信息。最早期的時候我們會使用JavaMail相關api來寫發送郵件的相關代碼，後來spring退出瞭JavaMailSender更加簡化瞭郵件發送的過程，在之後springboot對此進行瞭封裝就有瞭現在的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.1234.163.com //郵箱服務器地址 [email protected] //用戶名 spring.mail.password=09876 //密碼 spring.mail.default-encoding=UTF-8 [email protected] //以誰來發送郵件
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("[email protected]","test simple mail"," hello this is simple mail");
}
}
至此一個簡單的文本發送就完成瞭。
三、加點料
但是在正常使用的過程中，我們通常在郵件中加入圖片或者附件來豐富郵件的內容，下面講介紹如何使用springboot來發送豐富的郵件。
3、發送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("[email protected]","test simple mail",content);
}
3、發送帶附件的郵件
在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)
4、在測試類中添加測試方法
@Test
public void sendAttachmentsMail() {
String filePath="e:\\tmp\\application.log";
mailService.sendAttachmentsMail("[email protected]", "主題：帶附件的郵件", "有附件，請查收！", filePath);
}
5、發送帶靜態資源的郵件
郵件中的靜態資源一般就是指圖片，在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 = "12345";
String content="<html><body>這是有圖片的郵件：<img src=\'cid:" + rscId + "\' ></body></html>";
String imgPath = "C:\\Users\\summer\\Pictures\\favicon.png";
mailService.sendInlineResourceMail("[email protected]", "主題：這是有圖片的郵件", content, imgPath, rscId);
}
添加多個圖片可以使用多條 <img src='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>
您好,這是驗證郵件,請點擊下面的鏈接完成驗證,
<a href="#" rel="external nofollow" th:href="@{%20http://www.i123456w.com/neo/{id}(id=${id})%20}" rel="external nofollow" >激活賬號</a>
</body>
</html>
六、解析模板並發送
@Test
public void sendTemplateMail() {
//創建郵件正文
Context context = new Context();
context.setVariable("id", "006");
String emailContent = templateEngine.process("emailTemplate", context);
mailService.sendHtmlMail("[email protected]","主題：這是模板郵件",emailContent);
}
1、發送失敗
因為各種原因，總會有郵件發送失敗的情況，比如：郵件發送過於頻繁、網絡異常等。在出現這種情況的時候，我們一般會考慮重新重試發送郵件，會分為以下幾個步驟來實現：
- 1、接收到發送郵件請求，首先記錄請求並且入庫。
- 2、調用郵件發送接口發送郵件，並且將發送結果記錄入庫。
- 3、啟動定時系統掃描時間段內，未發送成功並且重試次數小於3次的郵件，進行再次發送
七、異步發送
很多時候郵件發送並不是我們主業務必須關註的結果，比如通知類、提醒類的業務可以允許延時或者失敗。這個時候可以采用異步的方式來發送郵件，加快主交易執行速度，在實際項目中可以采用MQ發送郵件相關參數，監聽到消息隊列之後啟動發送郵件。
到此這篇關於SpringBoot Mail郵件任務詳情的文章就介紹到這瞭,更多相關SpringBoot Mail 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！
推薦閱讀：
- Springboot實現發送郵件
- SpringBoot實現定時發送郵件的三種方法案例詳解
- SpringBoot QQ郵箱發送郵件實例代碼
- SpringBoot任務之詳解郵件任務
- springboot發送郵件功能的實現代碼