经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » Java相关 » Spring Boot » 查看文章
SpringBoot 2.0 集成 JavaMail ,实现异步发送邮件
来源:cnblogs  作者:知了一笑  时间:2019/6/4 15:54:22  对本文有异议

一、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. 1smtp.mxhichina.com
  2. 阿里云企业邮箱配置(账号+密码)
  3. 2smtp.aliyun.com
  4. 阿里云个人邮箱配置(账号+密码)
  5. 3smtp.163.com
  6. 网易邮箱配置(账号+授权码)

三、公共代码块

1、邮件通用配置

  1. package com.email.send.param;
  2. /**
  3. * 邮箱发送参数配置
  4. */
  5. public class EmailParam {
  6. /**
  7. * 邮箱服务器地址
  8. */
  9. // public static final String emailHost = "smtp.mxhichina.com" ; 阿里云企业邮箱配置(账号+密码)
  10. // public static final String emailHost = "smtp.aliyun.com" ; 阿里云个人邮箱配置(账号+密码)
  11. public static final String emailHost = "smtp.163.com" ; // 网易邮箱配置(账号+授权码)
  12. /**
  13. * 邮箱协议
  14. */
  15. public static final String emailProtocol = "smtp" ;
  16. /**
  17. * 邮箱发件人
  18. */
  19. public static final String emailSender = "xxxxxx@163.com" ;
  20. /**
  21. * 邮箱授权码
  22. */
  23. public static final String password = "authCode";
  24. /**
  25. * 邮箱授权
  26. */
  27. public static final String emailAuth = "true" ;
  28. /**
  29. * 邮箱昵称
  30. */
  31. public static final String emailNick = "知了一笑" ;
  32. }

2、常用常量

  1. package com.email.send.param;
  2. /**
  3. * 邮件发送类型
  4. */
  5. public enum EmailType {
  6. EMAIL_TEXT_KEY("email_text_key", "文本邮件"),
  7. EMAIL_IMAGE_KEY("email_image_key", "图片邮件"),
  8. EMAIL_FILE_KEY("email_file_key", "文件邮件");
  9. private String code;
  10. private String value;
  11. EmailType(String code, String value) {
  12. this.code = code;
  13. this.value = value;
  14. }
  15. public static String getByCode(String code) {
  16. EmailType[] values = EmailType.values();
  17. for (EmailType emailType: values) {
  18. if (emailType.code.equalsIgnoreCase(code)) {
  19. return emailType.value;
  20. }
  21. }
  22. return null;
  23. }
  24. // 省略 get set
  25. }

四、邮件发送封装

1、纯文本邮件发送

(1)、代码封装

  1. /**
  2. * 邮箱发送模式01:纯文本格式
  3. */
  4. public static void sendEmail01(String receiver, String title, String body) throws Exception {
  5. Properties prop = new Properties();
  6. prop.setProperty("mail.host", EmailParam.emailHost);
  7. prop.setProperty("mail.transport.protocol", EmailParam.emailProtocol);
  8. prop.setProperty("mail.smtp.auth", EmailParam.emailAuth);
  9. //使用JavaMail发送邮件的5个步骤
  10. //1、创建session
  11. Session session = Session.getInstance(prop);
  12. //开启Session的debug模式,这样就可以查看到程序发送Email的运行状态
  13. session.setDebug(true);
  14. //2、通过session得到transport对象
  15. Transport ts = session.getTransport();
  16. //3、使用邮箱的用户名和密码连上邮件服务器,发送邮件时,发件人需要提交邮箱的用户名和密码给smtp服务器,用户名和密码都通过验证之后才能够正常发送邮件给收件人。
  17. ts.connect(EmailParam.emailHost, EmailParam.emailSender, EmailParam.password);
  18. //4、创建邮件
  19. // Message message = createEmail01(session,receiver,title,body);
  20. Message message = createEmail01(session, receiver, title, body);
  21. //5、发送邮件
  22. ts.sendMessage(message, message.getAllRecipients());
  23. ts.close();
  24. }
  25. /**
  26. * 创建文本邮件
  27. */
  28. private static MimeMessage createEmail01(Session session, String receiver, String title, String body)
  29. throws Exception {
  30. //创建邮件对象
  31. MimeMessage message = new MimeMessage(session);
  32. //指明邮件的发件人
  33. String nick = javax.mail.internet.MimeUtility.encodeText(EmailParam.emailNick);
  34. message.setFrom(new InternetAddress(nick + "<" + EmailParam.emailSender + ">"));
  35. //指明邮件的收件人
  36. message.setRecipient(Message.RecipientType.TO, new InternetAddress(receiver));
  37. //邮件的标题
  38. message.setSubject(title);
  39. //邮件的文本内容
  40. message.setContent(body, "text/html;charset=UTF-8");
  41. //返回创建好的邮件对象
  42. return message;
  43. }

(2)、执行效果图

2、文本+图片+附件邮件

(1)、代码封装

  1. /**
  2. * 邮箱发送模式02:复杂格式
  3. */
  4. public static void sendEmail02(String receiver, String title, String body) throws Exception {
  5. Properties prop = new Properties();
  6. prop.setProperty("mail.host", EmailParam.emailHost);
  7. prop.setProperty("mail.transport.protocol", EmailParam.emailProtocol);
  8. prop.setProperty("mail.smtp.auth", EmailParam.emailAuth);
  9. //使用JavaMail发送邮件的5个步骤
  10. //1、创建session
  11. Session session = Session.getInstance(prop);
  12. //开启Session的debug模式,这样就可以查看到程序发送Email的运行状态
  13. session.setDebug(true);
  14. //2、通过session得到transport对象
  15. Transport ts = session.getTransport();
  16. //3、使用邮箱的用户名和密码连上邮件服务器,发送邮件时,发件人需要提交邮箱的用户名和密码给smtp服务器,用户名和密码都通过验证之后才能够正常发送邮件给收件人。
  17. ts.connect(EmailParam.emailHost, EmailParam.emailSender, EmailParam.password);
  18. //4、创建邮件
  19. // Message message = createEmail01(session,receiver,title,body);
  20. Message message = createEmail02(session, receiver, title, body);
  21. //5、发送邮件
  22. ts.sendMessage(message, message.getAllRecipients());
  23. ts.close();
  24. }
  25. private static MimeMessage createEmail02(Session session, String receiver, String title, String body)
  26. throws Exception {
  27. //创建邮件对象
  28. MimeMessage message = new MimeMessage(session);
  29. //指明邮件的发件人
  30. String nick = javax.mail.internet.MimeUtility.encodeText(EmailParam.emailNick);
  31. message.setFrom(new InternetAddress(nick + "<" + EmailParam.emailSender + ">"));
  32. //指明邮件的收件人
  33. message.setRecipient(Message.RecipientType.TO, new InternetAddress(receiver));
  34. //邮件的标题
  35. message.setSubject(title);
  36. //文本内容
  37. MimeBodyPart text = new MimeBodyPart();
  38. text.setContent(body, "text/html;charset=UTF-8");
  39. //图片内容
  40. MimeBodyPart image = new MimeBodyPart();
  41. image.setDataHandler(new DataHandler(new FileDataSource("ware-email-send/src/gzh.jpg")));
  42. image.setContentID("gzh.jpg");
  43. //附件内容
  44. MimeBodyPart attach = new MimeBodyPart();
  45. DataHandler file = new DataHandler(new FileDataSource("ware-email-send/src/gzh.zip"));
  46. attach.setDataHandler(file);
  47. attach.setFileName(file.getName());
  48. //关系:正文和图片
  49. MimeMultipart multipart1 = new MimeMultipart();
  50. multipart1.addBodyPart(text);
  51. multipart1.addBodyPart(image);
  52. multipart1.setSubType("related");
  53. //关系:正文和附件
  54. MimeMultipart multipart2 = new MimeMultipart();
  55. multipart2.addBodyPart(attach);
  56. // 全文内容
  57. MimeBodyPart content = new MimeBodyPart();
  58. content.setContent(multipart1);
  59. multipart2.addBodyPart(content);
  60. multipart2.setSubType("mixed");
  61. // 封装 MimeMessage 对象
  62. message.setContent(multipart2);
  63. message.saveChanges();
  64. // 本地查看文件格式
  65. message.writeTo(new FileOutputStream("F:\\MixedMail.eml"));
  66. //返回创建好的邮件对象
  67. return message;
  68. }

(2)、执行效果

3、实现异步发送

(1)、配置异步执行线程

  1. package com.email.send.util;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
  5. import java.util.concurrent.Executor;
  6. import java.util.concurrent.ThreadPoolExecutor;
  7. /**
  8. * 定义异步任务执行线程池
  9. */
  10. @Configuration
  11. public class TaskPoolConfig {
  12. @Bean("taskExecutor")
  13. public Executor taskExecutor () {
  14. ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
  15. // 核心线程数10:线程池创建时候初始化的线程数
  16. executor.setCorePoolSize(10);
  17. // 最大线程数20:线程池最大的线程数,只有在缓冲队列满了之后才会申请超过核心线程数的线程
  18. executor.setMaxPoolSize(15);
  19. // 缓冲队列200:用来缓冲执行任务的队列
  20. executor.setQueueCapacity(200);
  21. // 允许线程的空闲时间60秒:当超过了核心线程数之外的线程在空闲时间到达之后会被销毁
  22. executor.setKeepAliveSeconds(60);
  23. // 线程池名的前缀:设置好了之后可以方便定位处理任务所在的线程池
  24. executor.setThreadNamePrefix("taskExecutor-");
  25. /*
  26. 线程池对拒绝任务的处理策略:这里采用了CallerRunsPolicy策略,
  27. 当线程池没有处理能力的时候,该策略会直接在 execute 方法的调用线程中运行被拒绝的任务;
  28. 如果执行程序已关闭,则会丢弃该任务
  29. */
  30. executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
  31. // 设置线程池关闭的时候等待所有任务都完成再继续销毁其他的Bean
  32. executor.setWaitForTasksToCompleteOnShutdown(true);
  33. // 设置线程池中任务的等待时间,如果超过这个时候还没有销毁就强制销毁,以确保应用最后能够被关闭,而不是阻塞住。
  34. executor.setAwaitTerminationSeconds(600);
  35. return executor;
  36. }
  37. }

(2)、业务方法使用
注意两个注解
@Component
@Async("taskExecutor")

  1. @Component
  2. @Service
  3. public class EmailServiceImpl implements EmailService {
  4. @Async("taskExecutor")
  5. @Override
  6. public void sendEmail(String emailKey, SendEmailModel model) {
  7. try{
  8. // 异步执行
  9. Thread.sleep(1000);
  10. String textBody = EmailUtil.convertTextModel(BodyType.getByCode(emailKey),"知了","一笑");
  11. // 发送文本邮件
  12. EmailUtil.sendEmail01(model.getReceiver(), EmailType.getByCode(emailKey),textBody);
  13. // 发送复杂邮件:文本+图片+附件
  14. String body = "自定义图片:<img src='cid:gzh.jpg'/>,网络图片:<img src='http://pic37.nipic.com/20140113/8800276_184927469000_2.png'/>";
  15. // EmailUtil.sendEmail02(model.getReceiver(),"文本+图片+附件",body);
  16. } catch (Exception e){
  17. e.printStackTrace();
  18. }
  19. }
  20. }

(3)、启动类注解
@EnableAsync

  1. @EnableAsync
  2. @SpringBootApplication
  3. public class EmailApplication {
  4. public static void main(String[] args) {
  5. SpringApplication.run(EmailApplication.class,args) ;
  6. }
  7. }

五、源代码地址

  1. GitHub:知了一笑
  2. https://github.com/cicadasmile/middle-ware-parent

原文链接:http://www.cnblogs.com/cicada-smile/p/10970208.html

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号