Spring Boot (教程十四:发送邮件)

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/gfd54gd5f46/article/details/77414560

GitHub 地址:

https://github.com/asd821300801/Spring-Boot.git


      相信活跃在互联网的大神都知道,现在大部分网站在注册的时候都要求用户填写邮箱进行注册验证,所以说发送邮件应该是网站必备的功能之一。在没有框架之前,我们是通过Java自带的JavaMail类来发送邮件的,后来spring推出了JavaMailSender类大大简化了发送邮件的过程,再到现在的Spring Boot又对其进行封装从而出现了 spring-boot-starter-mail。



前期准备


本章使用的是QQ的邮件服务,所以在这之前需要麻烦读者先去开通腾讯的SMTP功能

1


2



开通SMTP功能

3



QQ邮箱的授权码将作为邮箱密码使用。

4


如果不会开通,请参考博文:http://blog.csdn.net/caimengyuan/article/details/51224269




pom文件中加入发送邮件相关依赖


<!-- 邮件服务 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

properties文件中添加邮箱配置


  • application.properties
#####qq邮箱#####
#QQ邮件服务地址
spring.mail.host=smtp.qq.com
#用户名
spring.mail.username=xxxx@qq.com  
#密码(授权码)
spring.mail.password=iwfxjjhkziugechb 
#默认编码UTF-8
spring.mail.default-encoding=UTF-8
#端口,这里添加587即可
spring.mail.port=587
#邮件发送人
mail.fromMail.addr=xxxx@qq.com


配置信息这里使用587端口,刚开始用465端口我纠结了好久(使用465端口的错误详情),用不了,你可以尝试,默认的25端口应该也是不适合的



创建EmailService接口


  • EmailService.java

包所在:com.example.email


package com.example.email;

/**
 * 发送邮件服务
 * @author LingDu
 * 2017.8.18
 */
public interface EmailService {
    /**
     * 发送简单邮件
     * @param to
     * @param subject
     * @param content
     */
    public void sendSimpleEmail(String to, String subject, String content);
    /**
     * 发送html格式邮件
     * @param to
     * @param subject
     * @param content
     */
    public void sendHtmlEmail(String to, String subject, String content);
    /**
     * 发送带附件的邮件
     * @param to
     * @param subject
     * @param content
     * @param filePath
     */
    public void sendAttachmentsEmail(String to, String subject, String content, String filePath);
    /**
     * 发送带静态资源的邮件
     * @param to
     * @param subject
     * @param content
     * @param rscPath
     * @param rscId
     */
    public void sendInlineResourceEmail(String to, String subject, String content, String rscPath, String rscId);
}


创建EmailServiceImp实现类


  • EmailServiceImp.java

包所在:com.example.email


package com.example.email;

import java.io.File;

import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.FileSystemResource;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Component;

@Component
public class EmailServiceImp implements EmailService {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Autowired
    private JavaMailSender mailSender;//spring 提供的邮件发送类

    @Value("${mail.fromMail.addr}")
    private String from;

    @Override
    public void sendSimpleEmail(String to, String subject, String content) {
        SimpleMailMessage message = new SimpleMailMessage();//创建简单邮件消息
        message.setFrom(from);//设置发送人
        message.setTo(to);//设置收件人

        /* String[] adds = {"[email protected]","[email protected]"}; //同时发送给多人
        message.setTo(adds);*/

        message.setSubject(subject);//设置主题
        message.setText(content);//设置内容
        try {
            mailSender.send(message);//执行发送邮件
            logger.info("简单邮件已经发送。");
        } catch (Exception e) {
            logger.error("发送简单邮件时发生异常!", e);
        }
    }

    @Override
    public void sendHtmlEmail(String to, String subject, String content) {
        MimeMessage message = mailSender.createMimeMessage();//创建一个MINE消息

        try {
            //true表示需要创建一个multipart message
            MimeMessageHelper helper = new MimeMessageHelper(message, true);
            helper.setFrom(from);
            helper.setTo(to);
            helper.setSubject(subject);
            helper.setText(content, true);

            mailSender.send(message);
            logger.info("html邮件发送成功");
        } catch (MessagingException e) {
            logger.error("发送html邮件时发生异常!", e);
        }

    }

    @Override
    public void sendAttachmentsEmail(String to, String subject, String content, String filePath) {
        MimeMessage message = mailSender.createMimeMessage();//创建一个MINE消息

        try {
            MimeMessageHelper helper = new MimeMessageHelper(message, true);
            helper.setFrom(from);
            helper.setTo(to);
            helper.setSubject(subject);
            helper.setText(content, true);// true表示这个邮件是有附件的

            FileSystemResource file = new FileSystemResource(new File(filePath));//创建文件系统资源
            String fileName = filePath.substring(filePath.lastIndexOf(File.separator));
            helper.addAttachment(fileName, file);//添加附件

            mailSender.send(message);
            logger.info("带附件的邮件已经发送。");
        } catch (MessagingException e) {
            logger.error("发送带附件的邮件时发生异常!", e);
        }

    }

    @Override
    public void sendInlineResourceEmail(String to, String subject, String content, String rscPath, String rscId) {
        MimeMessage message = mailSender.createMimeMessage();

        try {
            MimeMessageHelper helper = new MimeMessageHelper(message, true);
            helper.setFrom(from);
            helper.setTo(to);
            helper.setSubject(subject);
            helper.setText(content, true);

            FileSystemResource res = new FileSystemResource(new File(rscPath));

            //添加内联资源,一个id对应一个资源,最终通过id来找到该资源
            helper.addInline(rscId, res);//添加多个图片可以使用多条 <img src='cid:" + rscId + "' > 和 helper.addInline(rscId, res) 来实现

            mailSender.send(message);
            logger.info("嵌入静态资源的邮件已经发送。");
        } catch (MessagingException e) {
            logger.error("发送嵌入静态资源的邮件时发生异常!", e);
        }

    }

}


编写测试类


  • 需要将邮件服务注入进来
@Autowired
private EmailService emailService;


发送简单邮件


@Test
public void sendSimpleMail() throws Exception {
    emailService.sendSimpleEmail("[email protected]","this is simple mail"," hello LingDu");
}

5



发送带html的邮件


    @Test
    public void sendHtmlMail() throws Exception {
        String content="<html>\n" +
                "<body>\n" +
                "    <h3>hello world ! 这是一封Html邮件!</h3>\n" +
                "</body>\n" +
                "</html>";
        emailService.sendHtmlEmail("[email protected]","this is html mail",content);
    }

6



发送带附件的文件


@Test
public void sendAttachmentsMail() {
    String filePath="f:\\pikaqiu.png";
    emailService.sendAttachmentsEmail("[email protected]", "主题:带附件的邮件", "收到附件,请查收!", filePath);

}

7



发送带静态资源的文件


@Test
public void sendInlineResourceMail() {
    String rscId = "001";
    String content="<html><body>这是有图片的邮件:<img src=\'cid:" + rscId + "\' ></body></html>";
    String imgPath = "f:\\pikaqiu.png";

    emailService.sendInlineResourceEmail("[email protected]", "主题:这是有图片的邮件", content, imgPath, rscId);
}

8



知识扩充


发送模版邮件



有些时候我还还会收到固定格式的邮件,如:


尊敬的LingDu用户:

       恭喜您入住xxx平台VIP会员,您将享受xxx优惠福利,同时感谢您对xxx的关注与支持并欢迎您使用xx的产品与服务。
       ...

      这里假设用户名是经常变动的,如果每次发送邮件都需要手动拼接的话会不够优雅,并且每次模板的修改都需要改动代码的话也很不方便,因此对于这类邮件需求,都建议做成邮件模板来处理。模板的本质很简单,就是在模板中替换变化的参数,转换为html字符串即可,这里以thymeleaf为例来演示。



导入thymeleaf的包


<!-- 引入模板引擎. -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

注意:如果使用thymeleaf模版引擎,请将application.properties中的jsp配置去掉,否则会找不到页面

# 页面默认前缀目录
#spring.mvc.view.prefix=/WEB-INF/page/
# 响应页面默认后缀
#spring.mvc.view.suffix=.jsp


创建邮件模版


  • 在resorces/templates下创建email.html


<!DOCTYPE html>
<html lang="zh" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8"/>
        <title>Title</title>
    </head>
    <body>
        <h4 th:text="|尊敬的:${username} 用户:|"></h4><br /><br />

       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;恭喜您入住xxx平台VIP会员,您将享受xxx优惠福利,同时感谢您对xxx的关注与支持并欢迎您使用xx的产品与服务。<br />
       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;...
    </body>
</html>


注入模版引擎


@Autowired
private TemplateEngine templateEngine;


解析模板并发送


    //发送模版消息
    @Test
    public void sendTemplateMail() {
        //创建邮件正文
        Context context = new Context();
        context.setVariable("username", "LingDu");
        String emailContent = templateEngine.process("email", context);

        System.out.println(emailContent);
        emailService.sendHtmlEmail("[email protected]","主题:这是模板邮件",emailContent);
    }

注意:Context 类是在org.thymeleaf.context.Context包下的。



  • 这样就接收到固定格式的邮件了。

9



邮件服务注意事项


邮件发送失败


     因为各种原因,总会有邮件发送失败的情况,比如:邮件发送过于频繁、网络异常等。在出现这种情况的时候,我们一般会考虑重新重试发送邮件,会分为以下几个步骤来实现:


  • 1、接收到发送邮件请求,首先记录请求并且入库。

  • 2、调用邮件发送接口发送邮件,并且将发送结果记录入库。

  • 3、启动定时系统扫描时间段内,未发送成功并且重试次数小于3次的邮件,进行再次发送



异步发送


     很多时候邮件发送并不是我们主业务必须关注的结果,比如通知类、提醒类的业务可以允许延时或者失败。这个时候可以采用异步的方式来发送邮件,加快主交易执行速度,在实际项目中可以采用MQ发送邮件相关参数,监听到消息队列之后启动发送邮件。



工程结构图


10

猜你喜欢

转载自blog.csdn.net/gfd54gd5f46/article/details/77414560