SpringBoot 集成邮件服务(七)

2019-04-10 本文已影响7人 3d0829501918

互联网发展到现在，相必大家都知道发送邮件应该是网站的必备功能之一:用户注册发送邮箱验证、忘记密码、监控提醒以及发送营销信息等。
Spring Email抽象的核心是MailSender接口，MailSender的实现能够把Email发送给邮件服务器，由邮件服务器实现邮件发送的功能。
早期发送邮件是通过Java自带的JavaMail类来发送邮件的，需要自己封装消息体；
后来Spring推出了JavaMailSender类大大简化了发送邮件的过程，JavaMailSender继承自MailSender，提供了更强大的邮件发送功能，可支持不同类型的邮件发送。再到现在的Spring Boot又对其进行封装从而出现了spring-boot-starter-mail，进一步优化和完善邮件发送功能。

一、邮箱授权

在集成邮件服务前，需要获取邮箱的授权码。

1、163邮箱步骤
163邮箱- > 设置 - > 邮箱安全设置 - >客户端授权密码 - > 开启客户端授权码 - > 填写授权码。

2、QQ邮箱步骤
QQ邮箱 - > 设置 - > 账户- >POP3/SMTP服务:开启服务后会获得QQ的授权码。

二、搭建准备

1、pom.xml文件

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

2、配置文件

 spring.mail.host=smtp.163.com
 # 邮箱地址
 spring.mail.username=****@qq.com
 # 邮箱授权码
 spring.mail.password=****
 spring.mail.properties.mail.smtp.auth=true
 spring.mail.properties.mail.smtp.starttls.enable=true
 spring.mail.properties.mail.smtp.starttls.required=true
 spring.mail.default-encoding=UTF-8

3、创建邮件发送Bean

 public class MailBean implements Serializable {
        private static final long serialVersionUID = -2116367492649751914L;
        private String recipient;//邮件接收人
        private String subject; //邮件主题
        private String content; //邮件内容
       // 省略setget方法
}

三、文本邮件发送

Spring已经帮我们内置了JavaMailSender，直接在项目中引用即可。有了JavaMailSender，那么邮件发送就是一件再简单不过的事情了。我们只需要将JavaMailSender的Bean注入到我们自己的实现类中，然后使用JavaMail API来发送Email。

@Component
public class MailUtil {
@Value("${spring.mail.username}")
private String MAIL_SENDER; //邮件发送者

@Autowired
private JavaMailSender javaMailSender;

private Logger logger = LoggerFactory.getLogger(MailUtil.class);

/**
 * 发送文本邮件
 *
 * @param mailBean
 */
public  void sendSimpleMail(MailBean mailBean) {
    try {
        SimpleMailMessage mailMessage= new SimpleMailMessage();
        mailMessage.setFrom(MAIL_SENDER);
        mailMessage.setTo(mailBean.getRecipient());
        mailMessage.setSubject(mailBean.getSubject());
        mailMessage.setText(mailBean.getContent());
        //mailMessage.copyTo(copyTo);

        javaMailSender.send(mailMessage);
    } catch (Exception e) {
        logger.error("邮件发送失败", e.getMessage());
    }
}
}

其中：
from：即为邮件发送者，一般设置在配置文件中
to：邮件接收者，此参数可以为数组，同时发送多人
subject：邮件主题
content：邮件的主体
copyTo：抄送人

文本邮件测试类

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootMailApplicationTests {

@Autowired
private MailUtil mailUtil;

@Autowired
private TemplateEngine templateEngine;

//接收人
private static final String RECIPINET = "****@163.com";

/**
 * 发送文本邮件
 */
@Test
public void sendSimpleMail() {
    MailBean mailBean = new MailBean();
    mailBean.setRecipient(RECIPINET);
    mailBean.setSubject("SpringBootMail之这是一封文本的邮件");
    mailBean.setContent("SpringBootMail发送一个简单格式的邮件，时间为：" + DateUtils.format(new Date()));

    mailUtil.sendSimpleMail(mailBean);
}

}

稍微等待几秒，就可以在邮箱中找到此邮件内容了。至此一个简单的文本邮件发送就完成了。

四、HTML格式邮件发送

与文本格式邮件代码对比，富文本HTML邮件发送使用MimeMessageHelper类，把setText()方法的消息文本设置为html,并将第二个参数设置为true,表示这是html的富文本。MimeMessageHelper支持发送复杂邮件模板，支持文本、附件、HTML、图片等。

 public void sendHTMLMail(MailBean mailBean) {
         MimeMessage mimeMailMessage = null;
   try {
        mimeMailMessage = javaMailSender.createMimeMessage();
        //true 表示需要创建一个multipart message
        MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMailMessage, true);
        mimeMessageHelper.setFrom(MAIL_SENDER);
        mimeMessageHelper.setTo(mailBean.getRecipient());
        mimeMessageHelper.setSubject(mailBean.getSubject());
        //邮件抄送
        //mimeMessageHelper.addCc("抄送人");
        mimeMessageHelper.setText(mailBean.getContent(), true);
        javaMailSender.send(mimeMailMessage);
        } catch (Exception e) {
           logger.error("邮件发送失败", e.getMessage());
      }
 }

HTML格式邮件测试类

 @Test
 public void sendHTMLMail() {
       MailBean mailBean = new MailBean();
       mailBean.setRecipient(RECIPINET);
       mailBean.setSubject("SpringBootMailHTML之这是一封HTML格式的邮件");
       StringBuilder sb = new StringBuilder();
       sb.append("<h2>SpirngBoot测试邮件HTML</h2>")
         .append("<p style='text-align:left'>这是一封HTML邮件...</p>")
         .append("<p> 时间为："+ DateUtils.format(new Date()) +"</p>");
       mailBean.setContent(sb.toString());
       mailUtil.sendHTMLMail(mailBean);
}

邮件内容写了一段话，下面为接收到的效果：

由此我们发现发送HTML邮件，就是需要拼接一段HTML的String字符串交给MimeMessageHelper来处理，最后由邮件客户端负责渲染显示内容。

五、附件格式邮件发送

发送附件需要用到FileSystemResource类对文件进行封装，再添加到MimeMessageHelper中。可以通过多个addAttachment方法发送多个附件,File.separator是用来分隔同一个路径字符串中的目录。

public void sendAttachmentMail(MailBean mailBean) {
       MimeMessage mimeMailMessage = null;
       try {
            mimeMailMessage = javaMailSender.createMimeMessage();
            //true 表示需要创建一个multipart message
            MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMailMessage, true);
            mimeMessageHelper.setFrom(MAIL_SENDER);
            mimeMessageHelper.setTo(mailBean.getRecipient());
            mimeMessageHelper.setSubject(mailBean.getSubject());
            mimeMessageHelper.setText(mailBean.getContent());
            //文件路径 目前写死在代码中，之后可以当参数传过来，或者在MailBean中添加属性absolutePath
           String absolutePath = "D:\\Program Files\\test.jpg";
           FileSystemResource file = new FileSystemResource(new File(absolutePath));
           //FileSystemResource file = new FileSystemResource(new File("src/main/resources/static/image/email.png"));
           String fileName = absolutePath.substring(absolutePath.lastIndexOf(File.separator));
           //添加附件,第一个参数表示添加到 Email 中附件的名称，第二个参数是图片资源
           mimeMessageHelper.addAttachment(fileName, file);
          //多个附件
          //mimeMessageHelper.addAttachment(fileName1, file1);

           javaMailSender.send(mimeMailMessage);
           } catch (Exception e) {
               logger.error("邮件发送失败", e.getMessage());
           }   
}

测试邮件发送

@Test
public void sendAttachmentMail(){
   MailBean mailBean = new MailBean();
   mailBean.setRecipient(RECIPINET);
   mailBean.setSubject("SpringBootMail之这是一封有附件格式的邮件");
   mailBean.setContent("SpringBootMail发送一封有附件格式的邮件，时间为："+ DateUtils.format(new Date()));

   mailUtil.sendAttachmentMail(mailBean);
}

效果图如下：

六、静态资源格式邮件发送

邮件格式的静态资源，需要用到MimeMessageHelper中的addInline方法。需要注意的是：添加内联资源，一个id对应一个资源，最终通过id来找到该资源。
即<img src='cid:"+ rscId + "' >和addInline(rscId,res)中的rscId要一致。
同时要添加多个图片，可以使用多条<img src='cid:"+ rscId + "' >和addInline(rscId,res)来实现。

public void sendInlineMail(MailBean mailBean) {
       MimeMessage mimeMailMessage = null;
    try {
         mimeMailMessage = javaMailSender.createMimeMessage();
         MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMailMessage, true);
         mimeMessageHelper.setFrom(MAIL_SENDER);
         mimeMessageHelper.setTo(mailBean.getRecipient());
         mimeMessageHelper.setSubject(mailBean.getSubject());
         mimeMessageHelper.setText(mailBean.getContent(), true);
         //文件路径
         String absolutePath = "D:\\Program Files\\email.png";
         FileSystemResource file = new FileSystemResource(new File(absolutePath));
        //FileSystemResource file = new FileSystemResource(new File("src/main/resources/static/image/email.png"))
        //添加多个图片可以使用多条 <img src='cid:" + rscId + "' > 和 
        mimeMessageHelper.addInline(rscId, res) 来实现
        mimeMessageHelper.addInline("picture", file);

       javaMailSender.send(mimeMailMessage);
     } catch (Exception e) {
         logger.error("邮件发送失败", e.getMessage());
     }
}

静态资源格式邮件发送

@Test
public void sendInlineMail() {
     MailBean mailBean = new MailBean();
     //id,目前写死了，可根据需要封装
      String rscId = "picture";
     String content="<html><body>这是有图片的邮件：<img src=\'cid:" + rscId + "\' ></body></html>";
      mailBean.setRecipient(RECIPINET);
      mailBean.setSubject("SpringBootMail之这是一封有静态资源格式的邮件");
      mailBean.setContent(content);
      mailUtil.sendInlineMail(mailBean);
}

返回结果如下:

七、Thymeleaf模板邮件发送

上述介绍HTML格式的邮件不太优雅，修改起来也很不便，并且HTML硬编码在程序中。另外模板也适用于局部变化的内容，例如某云的邮件提示

更改邮件内容时只需更改用户名和链接地址即可。

添加依赖

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

创建email.html

 <!DOCTYPE html>
 <html lang="en" xmlns:th="http://www.thymeleaf.org">
 <head>
    <meta charset="UTF-8">
    <title>Title</title>
 </head>
<body>
<h3 th:text="|尊敬的${username} :|"></h3><br />
        <img src="http://gtms02.alicdn.com/tps/i2/T1YoblFq4cXXa94Hfd-32-32.png" /> 您有代金券即将到期，逾期失效，请尽早使用。<a th:href = "${url}" >点此查看</a>
        <br />
  </body>
</html>

解析模板并发送
注意:Context类是在org.thymeleaf.context.Context包下的。process第一个参数名称要和templates下的模板页面视图名称一致，要不然会报错。

@Test
public void sendTemplate2Mail() {
     //注意：Context 类是在org.thymeleaf.context.Context包下的。
     Context context = new Context();
     //html中填充动态属性值
     context.setVariable("username", "码农用户");
     context.setVariable("url", "https://www.aliyun.com/?utm_content=se_1000301881");
     //注意：process第一个参数名称要和templates下的模板名称一致。要不然会报错
     //org.thymeleaf.exceptions.TemplateInputException: Error resolving template [email]
     String emailContent = templateEngine.process("email", context);

     MailBean mailBean = new MailBean();
     mailBean.setRecipient(RECIPINET);
     mailBean.setSubject("主题：这是模板邮件");
     mailBean.setContent(emailContent);
     mailUtil.sendHTMLMail(mailBean);
}

返回结果如下：

八、常见问题

九、总结

使用 Spring Boot 集成发送邮件的功能非常简单，只需要简单编码就可以实现发送普通文本邮件、带附件邮件、HTML 格式邮件、带图片邮件等。
如果需要做成一个邮件系统还需要考虑很多因素，比如：邮箱发送失败重试机制、防止邮件被识别为垃圾邮件，固定时间内发送邮件的限制等。
在微服务架构中，常常将一些基础功能下沉下来，作为独立的服务来使用，邮件系统作为平台的基础功能，特别适合做为独立的微服务来支持整个系统。

本文代码：
https://github.com/xiaonongOne/springboot-mail/