第 4-10 课：使⽤ Spring Boot 开发邮件系统

最新推荐文章于 2021-07-05 14:37:36 发布

淹死的鱼pp

最新推荐文章于 2021-07-05 14:37:36 发布

阅读量1.7w

点赞数

分类专栏： Spring Boot 文章标签：邮件

本文链接：https://blog.csdn.net/qq_34227896/article/details/103914778

版权

Spring Boot 专栏收录该内容

44 篇文章 1 订阅

订阅专栏

电⼦邮件是在因特⽹上使⽤的⾮常多的⼀种应⽤，它可以⾮常⽅便的让相隔很远的⼈进⾏通信，主要特点是

操作简单、快捷。现在的电⼦邮件系统是以存储与转发的模型为基础，邮件服务器接收、转发、提交及存储

邮件，寄信⼈、收信⼈及他们的计算机都不⽤同时在线，寄信⼈和收信⼈只需在寄信或收信时简短的连线到

邮件服务器即可。

互联⽹发展到现在，邮件服务已经成为互联⽹企业中必备功能之⼀，应⽤场景⾮常⼴泛，⽐较常⻅的有：⽤

户注册、忘记密码、监控提醒、企业营销等。⼤多数互联⽹企业都会将邮件发送抽取为⼀个独⽴的微服务，

对外提供接⼝来⽀持各种类型的邮件发送。

本课内容将会从以下⼏部分来介绍如何开发⼀个邮件系统：

电⼦邮件的历史
发送邮件涉及到哪些协议
介绍⼀个完整的邮件发送流程
快速体验邮件发送流程
介绍如何开发⽂本、HTML、附件、图⽚的邮件
做⼀个邮件系统需要考虑的因素

邮件历史

关于整个邮件的发展历史，⽐如 “ 电⼦邮件的发展、世界的第⼀封电⼦邮件、中国的第⼀封电⼦邮件 ” 的资料

可点击链接查看，这⾥不作陈述。

⽤⼀张图来看看发送邮件过程中的协议使用：

实线代表 neo@126.com 发送邮件给 itclub@aa.com ；虚线代表 itclub@aa.com 发送邮件给

neo@126.com 。

邮件发送流程

发信⼈在⽤户代理上编辑邮件，并写清楚收件⼈的邮箱地址；
⽤户代理根据发信⼈编辑的信息，⽣成⼀封符合邮件格式的邮件；
⽤户代理把邮件发送到发信⼈的邮件服务器上，邮件服务器上⾯有⼀个缓冲队列，发送到邮件服务器上⾯的邮件都会加⼊到缓冲队列中，等待邮件服务器上的 SMTP 客户端进⾏发送；
发信⼈的邮件服务器使⽤ SMTP 协议把这封邮件发送到收件⼈的邮件服务器上；
收件⼈的邮件服务器收到邮件后，把这封邮件放到收件⼈在这个服务器上的信箱中；
收件⼈使⽤⽤户代理来收取邮件，⾸先⽤户代理使⽤ POP 3 协议来连接收件⼈所在的邮件服务器，身份验证成功后，⽤户代理就可以把邮件服务器上⾯的收件⼈邮箱⾥⾯的邮件读取出来，并展示给收件⼈。

这就是邮件发送的⼀个完整流程。

简单使⽤

最早期的时候使⽤ JavaMail 的相关 API 来开发，需要⾃⼰去封装消息体，代码量⽐较庞⼤；后来 Spring 推

出了 JavaMailSender 来简化邮件发送过程， JavaMailSender 提供了强⼤的邮件发送功能，可⽀持各种类型

的邮件发送。

现在 Spring Boot 在 JavaMailSender 的基础上⼜进⾏了封装，就有了现在的 spring-boot-starter-mail ，让邮

件发送流程更加简洁和完善。下⾯将介绍如何使⽤ Spring Boot 发送邮件。

pom 包配置

引⼊加 spring-boot-starter-mail 依赖包：

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

配置⽂件

在 application.properties 中添加邮箱配置，不同的邮箱参数稍有不同，下⾯列举⼏个常⽤邮箱配置。

163 邮箱配置：

spring.mail.host=smtp.163.com //邮箱服务器地址
spring.mail.username=xxx@oo.com //⽤户名
spring.mail.password=xxyyooo //密码
spring.mail.default-encoding=UTF-8
//超时时间，可选
spring.mail.properties.mail.smtp.connectiontimeout=5000 
spring.mail.properties.mail.smtp.timeout=3000
spring.mail.properties.mail.smtp.writetimeout=5000

126 邮箱配置：

spring.mail.host=smtp.126.com
spring.mail.username=yourEmail@126.com
spring.mail.password=yourPassword
spring.mail.default-encoding=UTF-8

QQ 邮箱配置如下：

spring.mail.host=smtp.qq.com
spring.mail.username=ityouknow@qq.com
spring.mail.password=yourPassword
spring.mail.default-encoding=UTF-8

注意：测试时需要将 spring.mail.username 和 spring.mail.password 改成⾃⼰邮箱对应的登录名和密

码，这⾥的密码不是邮箱的登录密码，是开启 POP 3 之后设置的客户端授权密码。

这⾥以 126 邮件举例，有两个地⽅需要在邮箱中设置。

开启 POP 3 / SMTP 服务、IMAP/SMTP服务

图⽚下⽅会有 SMTP 等相关信息的配置提示。

开通设置客户端授权密码

设置客户端授权密码⼀般需求⼿机验证码验证。

⽂本邮件发送

Spring 已经帮我们内置了 JavaMailSender ，直接在项⽬中引⽤即可，封装⼀个 MailService 类来实现普通的

邮件发送⽅法。

@Component
public class MailServiceImpl implements MailService{
 private final Logger logger = LoggerFactory.getLogger(this.getClass());
 @Autowired
 private JavaMailSender mailSender;
 @Value("${spring.mail.username}")
 private String from;
 @Override
 public void sendSimpleMail(String to, String subject, String content) {
 SimpleMailMessage message = new SimpleMailMessage();
 message.setFrom(from);
 message.setTo(to);
 message.setSubject(subject);
 message.setText(content);
 try {
 mailSender.send(message);
 logger.info("简单邮件已经发送。");
 } catch (Exception e) {
 logger.error("发送简单邮件时发⽣异常！", e);
 }
 }
}

⽂本邮件抄送使⽤： message.copyTo(copyTo) 来实现。

from，即为邮件发送者，⼀般设置在配置⽂件中
to，邮件接收者，此参数可以为数组，同时发送多⼈
subject，邮件主题
content，邮件的主体

邮件发送者 from ⼀般采⽤固定的形式写到配置⽂件中。

编写 test 类进⾏测试

@RunWith(SpringRunner.class)
@Spring BootTest
public class MailServiceTest {
 @Autowired
 private MailService MailService;
 @Test
 public void testSimpleMail() throws Exception {
 mailService.sendSimpleMail("ityouknow@126.com","这是⼀封简单邮件","⼤家好，这是
我的第⼀封邮件！");
 }
}

稍微等待⼏秒，就可以在邮箱中找到此邮件内容了，⾄此⼀个简单的⽂本邮件发送就完成了。

富⽂本邮件

在⽇常使⽤的过程中，我们通常在邮件中加⼊图⽚或者附件来丰富邮件的内容，下⾯将介绍如何使⽤ Spring

Boot 来发送富⽂本邮件。

发送 HTML 格式邮件

邮件发送⽀持以 HTML 语法去构建⾃定义的邮件格式， Spring Boot ⽀持使⽤ HTML 发送邮件。

我们在 MailService 中添加⽀持 HTML 邮件发送的⽅法：

public void sendHtmlMail(String to, String subject, String content) {
 MimeMessage message = mailSender.createMimeMessage();
 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);
 }
}

富⽂本邮件抄送使⽤： helper.addCc(cc) 来实现。

和⽂本邮件发送代码对⽐，富⽂本邮件发送使⽤ MimeMessageHelper 类，该类⽀持发送复杂邮件模板，⽀

持⽂本、附件、 HTML 、图⽚等，接下来会⼀⼀使⽤到。

在测试类中构建 HTML 内容，测试发送：

@Test
public void testHtmlMail() throws Exception {
 String content="<html>\n" +
 "<body>\n" +
 " <h3>hello world ! 这是⼀封html邮件!</h3>\n" +
 "</body>\n" +
 "</html>";
 mailService.sendHtmlMail("ityouknow@126.com","这是⼀封HTML邮件",content);
}

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

由此发现发送 HTML 邮件，是需要拼接⼀段 HTML 的 String 字符串交给 MimeMessageHelper 来处理，最

后由邮件客户端负责渲染显示内容。

发送带附件的邮件

在 MailService 添加 sendAttachmentsMail ⽅法，发送带附件的邮件主要是使⽤ FileSystemResource 对⽂件

进⾏封装，再添加到 MimeMessageHelper 中。

public void sendAttachmentsMail(String to, String subject, String content, String 
filePath){
 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 file = new FileSystemResource(new File(filePath));
 String fileName = file.getFilename();
 helper.addAttachment(fileName, file);
 //helper.addAttachment("test"+fileName, file);
 mailSender.send(message);
 logger.info("带附件的邮件已经发送。");
 } catch (MessagingException e) {
 logger.error("发送带附件的邮件时发⽣异常！", e);
 }
}

添加多个附件可以使⽤多条 helper.addAttachment(fifileName, fifile) 。

在测试类中添加测试⽅法：

@Test
public void sendAttachmentsMail() {
 String filePath="e:\\temp\\fastdfs-client-java-5.0.0.jar";
 mailService.sendAttachmentsMail("ityouknow@126.com", "主题：带附件的邮件", "有附件
，请查收！", filePath);
}

附件可以是图⽚、压缩包、 Word 等任何⽂件，但是邮件⼚商⼀般都会对附件⼤⼩有限制，太⼤的附件

建议使⽤⽹盘上传后，在邮件中给出链接。

效果图如下：

发送带静态资源的邮件

邮件中的静态资源⼀般指图⽚，在 MailService 中添加 sendInlineResourceMail ⽅法：

public void sendInlineResourceMail(String to, String subject, String content, Stri
ng 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));
 helper.addInline(rscId, res);
 mailSender.send(message);
 logger.info("嵌⼊静态资源的邮件已经发送。");
 } catch (MessagingException e) {
 logger.error("发送嵌⼊静态资源的邮件时发⽣异常！", e);
 }
}

在测试类中添加测试⽅法：

@Test
public void sendInlineResourceMail() {
 String rscId = "neo006";
 String content="<html><body>这是有图⽚的邮件：<img src=\'cid:" + rscId + "\' ></b
ody></html>";
 String imgPath = "e:\\temp\\weixin.jpg";
 mailService.sendInlineResourceMail("ityouknow@126.com", "主题：这是有图⽚的邮件", 
content, imgPath, rscId);
}

添加多个图⽚可以使⽤多条 <img src='cid:"+ rscId +"' > 和 helper.addInline(rscId, res) 来实现。

效果图如下：

以上是邮件发送的基础服务，已演示⽀持各种类型邮件。

邮件系统

如果只是想在系统中做⼀个邮件⼯具类的话，以上的内容基本就可以满⾜要求了。若要做成⼀个邮件系统的

话还需要考虑以下⼏⽅⾯：

对外提供发送邮件的服务接⼝
固定格式邮件是否考虑使⽤模板
发送邮件时出现⽹络错误，是否考虑适当的重试机制
邮件系统是否考虑异步化，提升服务响应时间
是否开发邮件后台管理系统、开发出对应的管理软件、通过⻚⾯发送邮件、统计发送邮件成功率等数据。
常⻅异常处理措施

对外提供接⼝

作为⼀个独⽴的邮件系统，需要对外提供接⼝调⽤，我们以简单⽂本邮件为例做个演示。

⾸先需要定义个实例返回对象：

public class MailResult {
 private String rspCode;
 private String rspMsg;
 public MailResult() {
 this.rspCode = "00";
 this.rspMsg = "发送成功";
 }
 //省略 setter/getter
}

默认成功的返回码为： 00 ，返回消息为：发送成功。

创建⼀个 MailController 类对外提供 HTTP 请求接⼝。

@RestController
public class MailController {
 private final Logger logger = LoggerFactory.getLogger(this.getClass());
 @Resource
 private MailService mailService;
 @RequestMapping("/sendSimpleMail")
 public MailResult sendSimpleMail(String to, String subject, String content) {
 MailResult result=new MailResult();
 if(StringUtils.isEmpty(to) || !to.contains("@")){
 result.setRspCode("01");
 result.setRspCode("⼿机⼈邮件格式不正确");
 }
 if(StringUtils.isEmpty(content) ){
 result.setRspCode("03");
 result.setRspCode("邮件正⽂不能为空");
 }
 try {
 mailService.sendSimpleMail(to,subject,content);
 logger.info("简单邮件已经发送。");
 } catch (Exception e) {
 result.setRspCode("04");
 result.setRspCode("邮件发送出现异常");
 logger.error("sendSimpleMail Exception ", e);
 }
 return result;
 }
}

当外部请求过来时⾸先进⾏参数校验，如果参数有误返回请求；发送邮件出现异常时返回错误，正常情况下

返回 00 ；注意在 Service 层如果对异常信息进⾏了捕获的话，需要将异常信息抛到上层。

try {
 mailSender.send(message);
 logger.info("简单邮件已经发送。");
} catch (Exception e) {
 logger.error("发送简单邮件时发⽣异常！", e);
 throw e;
}

类似上述代码。

按照这个思路也可以提供发送带图⽚、带附件的邮件，同时也可以封装发送多⼈邮件、群发邮件等复杂情况。

邮件模板

通常我们使⽤邮件发送服务的时候，都会有⼀些固定的场景，如重置密码、注册确认等，给每个⽤户发送的

内容可能只有⼩部分是变化的。因此，很多时候我们会使⽤模板引擎来为各类邮件设置成模板，这样只需要

在发送时去替换变化部分的参数即可。

我们会经常收到这样的邮件：

尊敬的 neo ⽤户：
 
 恭喜您注册成为 xxx ⽹的⽤户，同时感谢您对 xxx 的关注与⽀持并欢迎您使⽤ xxx 的产品与服务。
 ……

邮件正⽂只有 neo 这个⽤户名在变化，邮件其他内容均不变，如果每次发送邮件都需拼接 HTML 代码，程序

不够优雅，并且每次邮件正⽂有变化都需修改代码⾮常不⽅便。因此对于这类邮件，建议做成邮件模板来处

理，模板的本质很简单，就是在模板中替换变化的参数，转换为 HTML 字符串即可，这⾥以 Thymeleaf 为例

来演示。

Thymeleaf 是 Spring 官⽅推荐的前端模板引擎，类似 Velocity 、 FreeMarker 等模板引擎，相较与其他的模板

引擎， Thymeleaf 具有开箱即⽤的特性。它提供标准和 Spring 标准两种⽅⾔，可以直接套⽤模板实现

JSTL 、 OGNL 表达式效果，避免每天套模板、改 JSTL 、改标签的困扰。 Thymeleaf 在有没有⽹络的环境下

皆可运⾏，即它可以让美⼯在浏览器中查看⻚⾯的静态效果，也可以让程序员在服务器中查看带数据的动态

⻚⾯效果。

下⾯来演示使⽤ Thymeleaf 制作邮件模板。

（1）添加依赖包

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

（2）在 resorces/templates 下创建 emailTemplate.html

emailTemplate.html ⽂件内容即为邮件的正⽂内容模板。

<!DOCTYPE html>
<html lang="zh" xmlns:th="http://www.thymeleaf.org">
 <head>
 <meta charset="UTF-8"/>
 <title>邮件模板</title>
 </head>
 <body>
 您好，感谢您的注册，这是⼀封验证邮件，请点击下⾯的链接完成注册，感谢您的⽀持<br/>
 <a href="#" th:href="@{http://www.ityouknow.com/register/{id}(id=${id}) }"
>激活账号</a>
 </body>
</html>

我们发现上述的模板中只有 id 是⼀个动态的值，在发送过程中会根据传⼊的 id 值来替换链接中的 {id} 。

（3）解析模板并发送

@Test
public void sendTemplateMail() {
 //创建邮件正⽂
 Context context = new Context();
 //设置模板需要替换的参数
 context.setVariable("id", "006");
 //使⽤ templateEngine 替换掉动态参数⽣产出最后的 HTML 内容
 String emailContent = templateEngine.process("emailTemplate", context);
 //最后调⽤ sendHtmlMail 发送邮件
 mailService.sendHtmlMail("ityouknow@126.com","主题：这是模板邮件",emailContent);
}

我们发现最后调⽤的还是 sendHtmlMail 的⽅法，邮件模板的作⽤只是处理 HTML ⽣成的部分，通过

Thymeleaf 模板引擎解析固定的模板，再根据参数来动态替换其中的变量，最后通过前⾯的 HTML 发送的⽅

法发送邮件。

效果图如下：

单击 “ 激活账号 ” 跳转的链接： http://www.ityouknow.com/register/006 。

发送失败

因为各种原因，总会有邮件发送失败的情况，如邮件发送过于频繁、⽹络异常等。在出现这种情况的时候，

我们⼀般会考虑重新重试发送邮件，会分为以下⼏个步骤来实现：

接收到发送邮件请求，⾸先记录请求并且⼊库；
调⽤邮件发送接⼝发送邮件，并且将发送结果记录⼊库；
启动定时系统扫描时间段内，未发送成功并且重试次数⼩于 3 次的邮件，进⾏再次发送；
重新发送邮件的时间，建议以 2 的次⽅间隔时间，如 2、4、8、16…。

下⾯是⼀些常⻅的错误返回码。

421 HL:ICC 该 IP 同时并发连接数过⼤，超过了⽹易的限制，被临时禁⽌连接。
451 Requested mail action not taken: too much fail authentication 登录失败次数过多，被临时禁⽌登录，请检查密码与帐号验证设置。
553 authentication is required，密码配置不正确。
554 DT:SPM 发送的邮件内容包含了未被许可的信息，或被系统识别为垃圾邮件，请检查是否有⽤户发送病毒或者垃圾邮件。
550 Invalid User 请求的⽤户不存在。
554 MI:STC 发件⼈当天内累计邮件数量超过限制，当天不再接收该发件⼈的投信。