SpringBoot 2.0 集成 JavaMail ,實現異步發送郵件


本文源碼:GitHub·點這里 || GitEE·點這里

一、JavaMail的核心API

1、API功能圖解

2、API說明

(1)、Message 類:
javax.mail.Message 類是創建和解析郵件的一個抽象類
子類javax.mail.internet.MimeMessage :表示一份電子郵件。
發送郵件時,首先創建出封裝了郵件數據的 Message 對象, 然后把這個對象傳遞給郵件發送Transport 類,執行發送。
接收郵件時,把接收到的郵件數據封裝在Message 類的實例中,從這個對象中解析收到的郵件數據。

(2)、Transport 類
javax.mail.Transport 類是發送郵件的核心API 類
創建好 Message 對象后, 只需要使用郵件發送API 得到 Transport 對象, 然后把 Message 對象傳遞給 Transport 對象, 並調用它的發送方法, 就可以把郵件發送給指定的郵件服務器。

(3)、Store 類
javax.mail.Store 類是接收郵件的核心 API 類
實例對象代表實現了某個郵件接收協議的郵件接收對象,接收郵件時, 只需要得到 Store 對象, 然后調用 Store 對象的接收方法,就可以從指定的郵件服務器獲得郵件數據,並把這些郵件數據封裝到表示郵件的 Message 對象中。

(4)、Session 類:
javax.mail.Session 類定義郵件服務器的主機名、端口號、協議等
Session 對象根據這些信息構建用於郵件收發的 Transport 和 Store 對象, 以及為客戶端創建 Message 對象時提供信息支持。

二、郵件服務器配置

以 smtp 為例

1、smtp.mxhichina.com  
阿里雲企業郵箱配置(賬號+密碼)

2、smtp.aliyun.com
阿里雲個人郵箱配置(賬號+密碼)

3、smtp.163.com
網易郵箱配置(賬號+授權碼)

三、公共代碼塊

1、郵件通用配置

package com.email.send.param;
/**
 * 郵箱發送參數配置
 */
public class EmailParam {
    /**
     * 郵箱服務器地址
     */
    // public static final String emailHost = "smtp.mxhichina.com" ; 阿里雲企業郵箱配置(賬號+密碼)
    // public static final String emailHost = "smtp.aliyun.com" ; 阿里雲個人郵箱配置(賬號+密碼)
    public static final String emailHost = "smtp.163.com" ; // 網易郵箱配置(賬號+授權碼)
    /**
     * 郵箱協議
     */
    public static final String emailProtocol = "smtp" ;
    /**
     * 郵箱發件人
     */
    public static final String emailSender = "xxxxxx@163.com" ;
    /**
     * 郵箱授權碼
     */
    public static final String password = "authCode";
    /**
     * 郵箱授權
     */
    public static final String emailAuth = "true" ;
    /**
     * 郵箱昵稱
     */
    public static final String emailNick = "知了一笑" ;
}

2、常用常量

package com.email.send.param;
/**
 * 郵件發送類型
 */
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
}

四、郵件發送封裝

1、純文本郵件發送

(1)、代碼封裝

/**
 * 郵箱發送模式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發送郵件的5個步驟
	//1、創建session
	Session session = Session.getInstance(prop);
	//開啟Session的debug模式,這樣就可以查看到程序發送Email的運行狀態
	session.setDebug(true);
	//2、通過session得到transport對象
	Transport ts = session.getTransport();
	//3、使用郵箱的用戶名和密碼連上郵件服務器,發送郵件時,發件人需要提交郵箱的用戶名和密碼給smtp服務器,用戶名和密碼都通過驗證之后才能夠正常發送郵件給收件人。
	ts.connect(EmailParam.emailHost, EmailParam.emailSender, EmailParam.password);
	//4、創建郵件
	// Message message = createEmail01(session,receiver,title,body);
	Message message = createEmail01(session, receiver, title, body);
	//5、發送郵件
	ts.sendMessage(message, message.getAllRecipients());
	ts.close();
}
/**
 * 創建文本郵件
 */
private static MimeMessage createEmail01(Session session, String receiver, String title, String body)
throws Exception {
	//創建郵件對象
	MimeMessage message = new MimeMessage(session);
	//指明郵件的發件人
	String nick = javax.mail.internet.MimeUtility.encodeText(EmailParam.emailNick);
	message.setFrom(new InternetAddress(nick + "<" + EmailParam.emailSender + ">"));
	//指明郵件的收件人
	message.setRecipient(Message.RecipientType.TO, new InternetAddress(receiver));
	//郵件的標題
	message.setSubject(title);
	//郵件的文本內容
	message.setContent(body, "text/html;charset=UTF-8");
	//返回創建好的郵件對象
	return message;
}

(2)、執行效果圖

2、文本+圖片+附件郵件

(1)、代碼封裝

/**
 * 郵箱發送模式02:復雜格式
 */
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發送郵件的5個步驟
	//1、創建session
	Session session = Session.getInstance(prop);
	//開啟Session的debug模式,這樣就可以查看到程序發送Email的運行狀態
	session.setDebug(true);
	//2、通過session得到transport對象
	Transport ts = session.getTransport();
	//3、使用郵箱的用戶名和密碼連上郵件服務器,發送郵件時,發件人需要提交郵箱的用戶名和密碼給smtp服務器,用戶名和密碼都通過驗證之后才能夠正常發送郵件給收件人。
	ts.connect(EmailParam.emailHost, EmailParam.emailSender, EmailParam.password);
	//4、創建郵件
	// Message message = createEmail01(session,receiver,title,body);
	Message message = createEmail02(session, receiver, title, body);
	//5、發送郵件
	ts.sendMessage(message, message.getAllRecipients());
	ts.close();
}
private static MimeMessage createEmail02(Session session, String receiver, String title, String body)
throws Exception {
	//創建郵件對象
	MimeMessage message = new MimeMessage(session);
	//指明郵件的發件人
	String nick = javax.mail.internet.MimeUtility.encodeText(EmailParam.emailNick);
	message.setFrom(new InternetAddress(nick + "<" + EmailParam.emailSender + ">"));
	//指明郵件的收件人
	message.setRecipient(Message.RecipientType.TO, new InternetAddress(receiver));
	//郵件的標題
	message.setSubject(title);
	//文本內容
	MimeBodyPart text = new MimeBodyPart();
	text.setContent(body, "text/html;charset=UTF-8");
	//圖片內容
	MimeBodyPart image = new MimeBodyPart();
	image.setDataHandler(new DataHandler(new FileDataSource("ware-email-send/src/gzh.jpg")));
	image.setContentID("gzh.jpg");
	//附件內容
	MimeBodyPart attach = new MimeBodyPart();
	DataHandler file = new DataHandler(new FileDataSource("ware-email-send/src/gzh.zip"));
	attach.setDataHandler(file);
	attach.setFileName(file.getName());
	//關系:正文和圖片
	MimeMultipart multipart1 = new MimeMultipart();
	multipart1.addBodyPart(text);
	multipart1.addBodyPart(image);
	multipart1.setSubType("related");
	//關系:正文和附件
	MimeMultipart multipart2 = new MimeMultipart();
	multipart2.addBodyPart(attach);
	// 全文內容
	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"));
	//返回創建好的郵件對象
	return message;
}

(2)、執行效果

3、實現異步發送

(1)、配置異步執行線程

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;
/**
 * 定義異步任務執行線程池
 */
@Configuration
public class TaskPoolConfig {
    @Bean("taskExecutor")
    public Executor taskExecutor () {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        // 核心線程數10:線程池創建時候初始化的線程數
        executor.setCorePoolSize(10);
        // 最大線程數20:線程池最大的線程數,只有在緩沖隊列滿了之后才會申請超過核心線程數的線程
        executor.setMaxPoolSize(15);
        // 緩沖隊列200:用來緩沖執行任務的隊列
        executor.setQueueCapacity(200);
        // 允許線程的空閑時間60秒:當超過了核心線程數之外的線程在空閑時間到達之后會被銷毀
        executor.setKeepAliveSeconds(60);
        // 線程池名的前綴:設置好了之后可以方便定位處理任務所在的線程池
        executor.setThreadNamePrefix("taskExecutor-");
        /*
        線程池對拒絕任務的處理策略:這里采用了CallerRunsPolicy策略,
        當線程池沒有處理能力的時候,該策略會直接在 execute 方法的調用線程中運行被拒絕的任務;
        如果執行程序已關閉,則會丟棄該任務
         */
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        // 設置線程池關閉的時候等待所有任務都完成再繼續銷毀其他的Bean
        executor.setWaitForTasksToCompleteOnShutdown(true);
        // 設置線程池中任務的等待時間,如果超過這個時候還沒有銷毀就強制銷毀,以確保應用最后能夠被關閉,而不是阻塞住。
        executor.setAwaitTerminationSeconds(600);
        return executor;
    }
}

(2)、業務方法使用
注意兩個注解
@Component
@Async("taskExecutor")

@Component
@Service
public class EmailServiceImpl implements EmailService {
    @Async("taskExecutor")
    @Override
    public void sendEmail(String emailKey, SendEmailModel model) {
        try{
            // 異步執行
            Thread.sleep(1000);
            String textBody = EmailUtil.convertTextModel(BodyType.getByCode(emailKey),"知了","一笑");
            // 發送文本郵件
            EmailUtil.sendEmail01(model.getReceiver(), EmailType.getByCode(emailKey),textBody);
            // 發送復雜郵件:文本+圖片+附件
            String body = "自定義圖片:<img src='cid:gzh.jpg'/>,網絡圖片:<img src='http://pic37.nipic.com/20140113/8800276_184927469000_2.png'/>";
            // EmailUtil.sendEmail02(model.getReceiver(),"文本+圖片+附件",body);
        } catch (Exception e){
            e.printStackTrace();
        }

    }
}

(3)、啟動類注解
@EnableAsync

@EnableAsync
@SpringBootApplication
public class EmailApplication {
    public static void main(String[] args) {
        SpringApplication.run(EmailApplication.class,args) ;
    }
}

五、源代碼地址

GitHub·地址
https://github.com/cicadasmile/middle-ware-parent
GitEE·地址
https://gitee.com/cicadasmile/middle-ware-parent


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM