SpringBoot 2.0 集成 JavaMail ,实现异步发送邮件
一、JavaMail的核心API
1、API功能圖解
2、API說明
(1)、Message 類:
javax.mail.Message 類是創(chuàng)建和解析郵件的一個(gè)抽象類
子類javax.mail.internet.MimeMessage :表示一份電子郵件。
發(fā)送郵件時(shí),首先創(chuàng)建出封裝了郵件數(shù)據(jù)的 Message 對象, 然后把這個(gè)對象傳遞給郵件發(fā)送Transport 類,執(zhí)行發(fā)送。
接收郵件時(shí),把接收到的郵件數(shù)據(jù)封裝在Message 類的實(shí)例中,從這個(gè)對象中解析收到的郵件數(shù)據(jù)。
(2)、Transport 類
javax.mail.Transport 類是發(fā)送郵件的核心API 類
創(chuàng)建好 Message 對象后, 只需要使用郵件發(fā)送API 得到 Transport 對象, 然后把 Message 對象傳遞給 Transport 對象, 并調(diào)用它的發(fā)送方法, 就可以把郵件發(fā)送給指定的郵件服務(wù)器。
(3)、Store 類
javax.mail.Store 類是接收郵件的核心 API 類
實(shí)例對象代表實(shí)現(xiàn)了某個(gè)郵件接收協(xié)議的郵件接收對象,接收郵件時(shí), 只需要得到 Store 對象, 然后調(diào)用 Store 對象的接收方法,就可以從指定的郵件服務(wù)器獲得郵件數(shù)據(jù),并把這些郵件數(shù)據(jù)封裝到表示郵件的 Message 對象中。
(4)、Session 類:
javax.mail.Session 類定義郵件服務(wù)器的主機(jī)名、端口號、協(xié)議等
Session 對象根據(jù)這些信息構(gòu)建用于郵件收發(fā)的 Transport 和 Store 對象, 以及為客戶端創(chuàng)建 Message 對象時(shí)提供信息支持。
二、郵件服務(wù)器配置
以 smtp 為例
1、smtp.mxhichina.com 阿里云企業(yè)郵箱配置(賬號+密碼)2、smtp.aliyun.com 阿里云個(gè)人郵箱配置(賬號+密碼)3、smtp.163.com 網(wǎng)易郵箱配置(賬號+授權(quán)碼)三、公共代碼塊
1、郵件通用配置
package com.email.send.param; /*** 郵箱發(fā)送參數(shù)配置*/ public class EmailParam {/*** 郵箱服務(wù)器地址*/// public static final String emailHost = "smtp.mxhichina.com" ; 阿里云企業(yè)郵箱配置(賬號+密碼)// public static final String emailHost = "smtp.aliyun.com" ; 阿里云個(gè)人郵箱配置(賬號+密碼)public static final String emailHost = "smtp.163.com" ; // 網(wǎng)易郵箱配置(賬號+授權(quán)碼)/*** 郵箱協(xié)議*/public static final String emailProtocol = "smtp" ;/*** 郵箱發(fā)件人*/public static final String emailSender = "xxxxxx@163.com" ;/*** 郵箱授權(quán)碼*/public static final String password = "authCode";/*** 郵箱授權(quán)*/public static final String emailAuth = "true" ;/*** 郵箱昵稱*/public static final String emailNick = "知了一笑" ; }2、常用常量
package com.email.send.param; /*** 郵件發(fā)送類型*/ public enum EmailType {EMAIL_TEXT_KEY("email_text_key", "文本郵件"),EMAIL_IMAGE_KEY("email_image_key", "圖片郵件"),EMAIL_FILE_KEY("email_file_key", "文件郵件");private String code;private String value;EmailType(String code, String value) {this.code = code;this.value = value;}public static String getByCode(String code) {EmailType[] values = EmailType.values();for (EmailType emailType: values) {if (emailType.code.equalsIgnoreCase(code)) {return emailType.value;}}return null;}// 省略 get set }四、郵件發(fā)送封裝
1、純文本郵件發(fā)送
(1)、代碼封裝
/*** 郵箱發(fā)送模式01:純文本格式*/ public static void sendEmail01(String receiver, String title, String body) throws Exception {Properties prop = new Properties();prop.setProperty("mail.host", EmailParam.emailHost);prop.setProperty("mail.transport.protocol", EmailParam.emailProtocol);prop.setProperty("mail.smtp.auth", EmailParam.emailAuth);//使用JavaMail發(fā)送郵件的5個(gè)步驟//1、創(chuàng)建sessionSession session = Session.getInstance(prop);//開啟Session的debug模式,這樣就可以查看到程序發(fā)送Email的運(yùn)行狀態(tài)session.setDebug(true);//2、通過session得到transport對象Transport ts = session.getTransport();//3、使用郵箱的用戶名和密碼連上郵件服務(wù)器,發(fā)送郵件時(shí),發(fā)件人需要提交郵箱的用戶名和密碼給smtp服務(wù)器,用戶名和密碼都通過驗(yàn)證之后才能夠正常發(fā)送郵件給收件人。ts.connect(EmailParam.emailHost, EmailParam.emailSender, EmailParam.password);//4、創(chuàng)建郵件// Message message = createEmail01(session,receiver,title,body);Message message = createEmail01(session, receiver, title, body);//5、發(fā)送郵件ts.sendMessage(message, message.getAllRecipients());ts.close(); } /*** 創(chuàng)建文本郵件*/ private static MimeMessage createEmail01(Session session, String receiver, String title, String body) throws Exception {//創(chuàng)建郵件對象MimeMessage message = new MimeMessage(session);//指明郵件的發(fā)件人String nick = javax.mail.internet.MimeUtility.encodeText(EmailParam.emailNick);message.setFrom(new InternetAddress(nick + "<" + EmailParam.emailSender + ">"));//指明郵件的收件人message.setRecipient(Message.RecipientType.TO, new InternetAddress(receiver));//郵件的標(biāo)題message.setSubject(title);//郵件的文本內(nèi)容message.setContent(body, "text/html;charset=UTF-8");//返回創(chuàng)建好的郵件對象return message; }(2)、執(zhí)行效果圖
2、文本+圖片+附件郵件
(1)、代碼封裝
/*** 郵箱發(fā)送模式02:復(fù)雜格式*/ public static void sendEmail02(String receiver, String title, String body) throws Exception {Properties prop = new Properties();prop.setProperty("mail.host", EmailParam.emailHost);prop.setProperty("mail.transport.protocol", EmailParam.emailProtocol);prop.setProperty("mail.smtp.auth", EmailParam.emailAuth);//使用JavaMail發(fā)送郵件的5個(gè)步驟//1、創(chuàng)建sessionSession session = Session.getInstance(prop);//開啟Session的debug模式,這樣就可以查看到程序發(fā)送Email的運(yùn)行狀態(tài)session.setDebug(true);//2、通過session得到transport對象Transport ts = session.getTransport();//3、使用郵箱的用戶名和密碼連上郵件服務(wù)器,發(fā)送郵件時(shí),發(fā)件人需要提交郵箱的用戶名和密碼給smtp服務(wù)器,用戶名和密碼都通過驗(yàn)證之后才能夠正常發(fā)送郵件給收件人。ts.connect(EmailParam.emailHost, EmailParam.emailSender, EmailParam.password);//4、創(chuàng)建郵件// Message message = createEmail01(session,receiver,title,body);Message message = createEmail02(session, receiver, title, body);//5、發(fā)送郵件ts.sendMessage(message, message.getAllRecipients());ts.close(); } private static MimeMessage createEmail02(Session session, String receiver, String title, String body) throws Exception {//創(chuàng)建郵件對象MimeMessage message = new MimeMessage(session);//指明郵件的發(fā)件人String nick = javax.mail.internet.MimeUtility.encodeText(EmailParam.emailNick);message.setFrom(new InternetAddress(nick + "<" + EmailParam.emailSender + ">"));//指明郵件的收件人message.setRecipient(Message.RecipientType.TO, new InternetAddress(receiver));//郵件的標(biāo)題message.setSubject(title);//文本內(nèi)容MimeBodyPart text = new MimeBodyPart();text.setContent(body, "text/html;charset=UTF-8");//圖片內(nèi)容MimeBodyPart image = new MimeBodyPart();image.setDataHandler(new DataHandler(new FileDataSource("ware-email-send/src/gzh.jpg")));image.setContentID("gzh.jpg");//附件內(nèi)容MimeBodyPart attach = new MimeBodyPart();DataHandler file = new DataHandler(new FileDataSource("ware-email-send/src/gzh.zip"));attach.setDataHandler(file);attach.setFileName(file.getName());//關(guān)系:正文和圖片MimeMultipart multipart1 = new MimeMultipart();multipart1.addBodyPart(text);multipart1.addBodyPart(image);multipart1.setSubType("related");//關(guān)系:正文和附件MimeMultipart multipart2 = new MimeMultipart();multipart2.addBodyPart(attach);// 全文內(nèi)容MimeBodyPart content = new MimeBodyPart();content.setContent(multipart1);multipart2.addBodyPart(content);multipart2.setSubType("mixed");// 封裝 MimeMessage 對象message.setContent(multipart2);message.saveChanges();// 本地查看文件格式message.writeTo(new FileOutputStream("F:\\MixedMail.eml"));//返回創(chuàng)建好的郵件對象return message; }(2)、執(zhí)行效果
3、實(shí)現(xiàn)異步發(fā)送
(1)、配置異步執(zhí)行線程
package com.email.send.util; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; import java.util.concurrent.Executor; import java.util.concurrent.ThreadPoolExecutor; /*** 定義異步任務(wù)執(zhí)行線程池*/ @Configuration public class TaskPoolConfig {@Bean("taskExecutor")public Executor taskExecutor () {ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();// 核心線程數(shù)10:線程池創(chuàng)建時(shí)候初始化的線程數(shù)executor.setCorePoolSize(10);// 最大線程數(shù)20:線程池最大的線程數(shù),只有在緩沖隊(duì)列滿了之后才會(huì)申請超過核心線程數(shù)的線程executor.setMaxPoolSize(15);// 緩沖隊(duì)列200:用來緩沖執(zhí)行任務(wù)的隊(duì)列executor.setQueueCapacity(200);// 允許線程的空閑時(shí)間60秒:當(dāng)超過了核心線程數(shù)之外的線程在空閑時(shí)間到達(dá)之后會(huì)被銷毀executor.setKeepAliveSeconds(60);// 線程池名的前綴:設(shè)置好了之后可以方便定位處理任務(wù)所在的線程池executor.setThreadNamePrefix("taskExecutor-");/*線程池對拒絕任務(wù)的處理策略:這里采用了CallerRunsPolicy策略,當(dāng)線程池沒有處理能力的時(shí)候,該策略會(huì)直接在 execute 方法的調(diào)用線程中運(yùn)行被拒絕的任務(wù);如果執(zhí)行程序已關(guān)閉,則會(huì)丟棄該任務(wù)*/executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());// 設(shè)置線程池關(guān)閉的時(shí)候等待所有任務(wù)都完成再繼續(xù)銷毀其他的Beanexecutor.setWaitForTasksToCompleteOnShutdown(true);// 設(shè)置線程池中任務(wù)的等待時(shí)間,如果超過這個(gè)時(shí)候還沒有銷毀就強(qiáng)制銷毀,以確保應(yīng)用最后能夠被關(guān)閉,而不是阻塞住。executor.setAwaitTerminationSeconds(600);return executor;} }(2)、業(yè)務(wù)方法使用
注意兩個(gè)注解
@Component
@Async(“taskExecutor”)
(3)、啟動(dòng)類注解
@EnableAsync
五、源代碼地址
GitHub:知了一笑 https://github.com/cicadasmile/middle-ware-parent
總結(jié)
以上是生活随笔為你收集整理的SpringBoot 2.0 集成 JavaMail ,实现异步发送邮件的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 走进移动web开发的四大框架
- 下一篇: 务实云计算培训:帮您顺利走好云之旅