發(fā)送郵件是常用的業(yè)務(wù)手法膀曾,這里記錄使用 Spring 發(fā)送郵件和 Hutool 發(fā)送.
Spring
首先要啟用發(fā)件人郵箱的SMTP發(fā)郵件服務(wù)获印,這里使用QQ郵箱扒俯,QQ郵箱中SMTP密碼是單獨(dú)生成的授權(quán)碼味抖,需要記錄下紧唱。
導(dǎo)入依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
參數(shù)配置
spring:
mail:
host: smtp.qq.com # 郵件服務(wù)器的SMTP地址
port: 465 # 郵件服務(wù)器的SMTP端口
username: xxx@qq.com # 發(fā)件人
password: xxxxxxxxxxxxx # 密碼活尊,授權(quán)碼
protocol: smtps # 使用安全協(xié)議
properties:
mail.smtp.ssl.enable: true # 使用 qq, gmail郵箱時(shí)需強(qiáng)制開啟SSL安全連接
參數(shù)封裝到MailProperties,就是配置郵件的SMTP服務(wù)器
發(fā)送郵件方法
/**
* @author mafei007
* @date 2020/3/31 22:38
*/
@Component
@Slf4j
public class MailClient {
private final JavaMailSender mailSender;
private final MailProperties mailProperties;
public MailClient(JavaMailSender mailSender, MailProperties mailProperties) {
this.mailSender = mailSender;
this.mailProperties = mailProperties;
}
@Async
public void sendMail(String to, String subject, String content) {
try {
MimeMessage message = mailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(message);
//設(shè)置發(fā)件人
helper.setFrom(mailProperties.getUsername());
helper.setTo(to);
helper.setSubject(subject);
// 指定內(nèi)容為 html 文本
helper.setText(content, true);
mailSender.send(helper.getMimeMessage());
} catch (MessagingException e) {
log.error("發(fā)送郵件失斅┮妗:" + e.getMessage(), e);
}
}
}
JavaMailSender 由 SpringBoot 自動配置類生成蛹锰,詳情見MailSenderAutoConfiguration.java。
Thymeleaf模板文件
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.com">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<p>歡迎你绰疤,<span style="color:red;" th:text="${username}"></span></p>
</body>
</html>
存放在 resources/templates/mail/demo.html
發(fā)送
@Test
public void testHtmlMail(){
Context context = new Context();
context.setVariable("username", "zhangsan");
// 模板引擎渲染后的 html 文本
String content = templateEngine.process("/mail/demo", context);
mailClient.sendMail("xxxx@gmail.com", "測試html郵件", content);
}
這里使用了Thymeleaf渲染模板引擎的代碼铜犬,解釋下:
Thymeleaf渲染解讀
先說下Thymeleaf中的幾個(gè)概念:
- Context: 運(yùn)行上下文
- TemplateResolver:模板解析器
- TemplateEngine:模板引擎
Context
上下文: 用來保存模型數(shù)據(jù),就是個(gè) map 存放 key value轻庆,當(dāng)模板引擎渲染時(shí)癣猾,可以從Context上下文中獲取數(shù)據(jù)用于渲染。
當(dāng)與SpringBoot結(jié)合使用時(shí)余爆,我們放入Model的數(shù)據(jù)就會被處理到Context纷宇,作為模板渲染的數(shù)據(jù)使用。
TemplateResolver
模板解析器:用來讀取模板相關(guān)的配置蛾方,例如:模板存放的位置信息像捶,模板文件名稱上陕,模板文件的類型等等。
當(dāng)與SpringBoot結(jié)合時(shí)拓春,TemplateResolver已經(jīng)由其創(chuàng)建完成释簿,并且各種配置也都有默認(rèn)值,比如模板存放位置硼莽,其默認(rèn)值就是:templates辕万。比如模板文件類型,其默認(rèn)值就是html沉删。
TemplateEngine
模板引擎:用來解析模板的引擎,需要使用到 Context上下文醉途、TemplateResolver 模板解析器矾瑰。分別從兩者中獲取模板中需要的數(shù)據(jù),模板文件隘擎。然后利用內(nèi)置的語法規(guī)則解析殴穴,從而輸出解析后的文件。來看下模板引擎進(jìn)行處理的函數(shù):
templateEngine.process("模板名", context, writer);
三個(gè)參數(shù):
- 模板名稱
- 上下文:里面包含模型數(shù)據(jù)
- writer:輸出目的地的流
在輸出時(shí)货葬,我們可以指定輸出的目的地采幌,如果目的地是Response的流,那就是網(wǎng)絡(luò)響應(yīng)震桶。如果目的地是本地文件休傍,那就實(shí)現(xiàn)靜態(tài)化了。
而在SpringBoot中已經(jīng)自動配置了模板引擎蹲姐,可以直接注入使用磨取。
如果不指定輸出流:
String content = templateEngine.process("模板名", context);
就可以得到 Thymeleaf 模板渲染后的 html 文本。
使用Hutool發(fā)送郵件
sendMail() 方法封裝下來跟原生的 javax.mail 郵件操作就沒差多少代碼柴墩,Spring封裝的還是非常繁瑣忙厌,使用 Hutool 就方便多了。
引入依賴
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-extra</artifactId>
<version>5.2.5</version>
</dependency>
<dependency>
<groupId>javax.mail</groupId>
<artifactId>mail</artifactId>
<version>1.4.7</version>
</dependency>
郵件服務(wù)器配置
在classpath(在標(biāo)準(zhǔn)Maven項(xiàng)目中為src/main/resources)的config目錄下新建mail.setting文件.
# 郵件服務(wù)器的SMTP地址江咳,可選逢净,默認(rèn)為smtp.<發(fā)件人郵箱后綴>
host = smtp.yeah.net
# 郵件服務(wù)器的SMTP端口
port = 465
# 發(fā)件人(必須正確,否則發(fā)送失敿咧浮)
from = hutool@yeah.net
# 密碼(注意爹土,某些郵箱需要為SMTP服務(wù)單獨(dú)設(shè)置密碼)
pass = q1w2e3
# 使用SSL安全連接
sslEnable = true
#### 以上是建議手動配置的參數(shù)#################################################################
#### 下面的參數(shù)可以不用配置,默認(rèn)即可##########################################################
# 用戶名(默認(rèn)提取你郵箱@前面的部分。注意:如果使用foxmail郵箱东臀,此處user為qq號)
user = hutool
#使用 STARTTLS安全連接着饥,STARTTLS是對純文本通信協(xié)議的擴(kuò)展。
starttlsEnable = true
# 指定實(shí)現(xiàn)javax.net.SocketFactory接口的類的名稱,這個(gè)類將被用于創(chuàng)建SMTP的套接字
socketFactoryClass = javax.net.ssl.SSLSocketFactory
# 如果設(shè)置為true,未能創(chuàng)建一個(gè)套接字使用指定的套接字工廠類將導(dǎo)致使用java.net.Socket創(chuàng)建的套接字類, 默認(rèn)值為true
socketFactoryFallback = true
# 指定的端口連接到在使用指定的套接字工廠惰赋。如果沒有設(shè)置,將使用默認(rèn)端口456
socketFactoryPort = 465
# SMTP超時(shí)時(shí)長宰掉,單位毫秒呵哨,缺省值不超時(shí)
timeout = 0
# Socket連接超時(shí)值,單位毫秒轨奄,缺省值不超時(shí)
connectionTimeout = 0
發(fā)送郵件
- 發(fā)送普通文本郵件孟害,最后一個(gè)參數(shù)可選是否添加多個(gè)附件:
MailUtil.send("hutool@foxmail.com", "測試", "郵件來自Hutool測試", false);
- 發(fā)送HTML格式的郵件并附帶附件,最后一個(gè)參數(shù)可選是否添加多個(gè)附件:
MailUtil.send("hutool@foxmail.com", "測試", "<h1>郵件來自Hutool測試</h1>", true, FileUtil.file("d:/aaa.xml"));
3.發(fā)郵件挪拟,可選HTML或普通文本挨务,可選多個(gè)附件:
ArrayList<String> tos = CollUtil.newArrayList(
"person1@bbb.com",
"person2@bbb.com",
"person3@bbb.com",
"person4@bbb.com");
MailUtil.send(tos, "測試", "郵件來自Hutool群發(fā)測試", false);
發(fā)送郵件非常簡單,只需一個(gè)方法即可搞定其中按照參數(shù)順序說明如下:
- tos: 對方的郵箱地址玉组,可以是單個(gè)谎柄,也可以是多個(gè)(Collection表示)
- subject:標(biāo)題
- content:郵件正文,可以是文本惯雳,也可以是HTML內(nèi)容
- isHtml: 是否為HTML朝巫,如果是,那參數(shù)3識別為HTML內(nèi)容
- files: 可選:附件石景,可以為多個(gè)或沒有劈猿,將File對象加在最后一個(gè)可變參數(shù)中即可
@Test
public void testHtmlMailByHutool(){
Context context = new Context();
context.setVariable("username", "zhangsan");
// 模板引擎渲染后的 html 文本
String content = templateEngine.process("/mail/demo", context);
MailUtil.send(mailProperties.getUsername(), "htmlByHutool", content, true);
}
使用 Hutool 工具包就不用我們封裝一些發(fā)送郵件的代碼了,比 Spring 的簡單點(diǎn)潮孽。