SpringBoot 2.0 集成 JavaMail ,实现异步发送邮件

一、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 = "[e-mail]" ;
    /**
     * 邮箱授权码
     */
    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