Spring Boot (十)：邮件服务
Spring Boot 仍然在狂速发展，才几个多月没有关注，现在看官网已经到 2.1.0.RELEASE 版本了。准备慢慢在写写 Spring Boot 相关的文章，本篇文章使用 Spring Boot 最新版本 2.1.0 进行开发。
发送邮件应该是网站的必备功能之一，什么注册验证，忘记密码或者是给用户发送营销信息。最早期的时候我们会使用 JavaMail 相关 api 来写发送邮件的相关代码，后来 Spring 推出了 JavaMailSender 更加简化了邮件发送的过程，在之后 Spring Boot 对此进行了封装就有了现在的 spring-boot-starter-mail , 本章文章的介绍主要来自于此包。
简单使用
1、pom 包配置
pom 包里面添加 spring-boot-starter-mail 包引用
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
</dependencies>
2、在 application.properties 中添加邮箱配置
spring.mail.host=smtp.qiye.163.com // 邮箱服务器地址
spring.mail.username=xxx@oo.com // 用户名
spring.mail.password=xxyyooo // 密码
spring.mail.default-encoding=UTF-8
mail.fromMail.addr=xxx@oo.com // 以谁来发送邮件
3、编写 mailService，这里只提出实现类。
@Component
public class MailServiceImpl implements MailService{
<span class="hljs-keyword">private</span> <span class="hljs-keyword">final</span> <span class="hljs-type">Logger</span> <span class="hljs-variable">logger</span> <span class="hljs-operator">=</span> LoggerFactory.getLogger(<span class="hljs-built_in">this</span>.getClass());
<span class="hljs-meta">@Autowired</span>
<span class="hljs-keyword">private</span> JavaMailSender mailSender;
<span class="hljs-meta">@Value("${mail.fromMail.addr}")</span>
<span class="hljs-keyword">private</span> String from;
<span class="hljs-meta">@Override</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">sendSimpleMail</span><span class="hljs-params">(String to, String subject, String content)</span> {
<span class="hljs-type">SimpleMailMessage</span> <span class="hljs-variable">message</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">SimpleMailMessage</span>();
message.setFrom(from);
message.setTo(to);
message.setSubject(subject);
message.setText(content);
<span class="hljs-keyword">try</span> {
mailSender.send(message);
logger.info(<span class="hljs-string">"简单邮件已经发送。"</span>);
} <span class="hljs-keyword">catch</span> (Exception e) {
logger.error(<span class="hljs-string">"发送简单邮件时发生异常！"</span>, e);
}
}
}
4、编写 test 类进行测试
@RunWith(SpringRunner.class)
@SpringBootTest
public class MailServiceTest {
<span class="hljs-meta">@Autowired</span>
<span class="hljs-keyword">private</span> MailService MailService;
<span class="hljs-meta">@Test</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">testSimpleMail</span><span class="hljs-params">()</span> <span class="hljs-keyword">throws</span> Exception {
MailService.sendSimpleMail(<span class="hljs-string">"ityouknow@126.com"</span>,<span class="hljs-string">"test simple mail"</span>,<span class="hljs-string">" hello this is simple mail"</span>);
}
}
至此一个简单的文本发送就完成了。
加点料
但是在正常使用的过程中，我们通常在邮件中加入图片或者附件来丰富邮件的内容，下面讲介绍如何使用 Spring Boot 来发送丰富的邮件。
发送 html 格式邮件
其它都不变在 MailService 添加 sendHtmlMail 方法.
public void sendHtmlMail(String to, String subject, String content) {
MimeMessage message = mailSender.createMimeMessage();
<span class="hljs-keyword">try</span> {
<span class="hljs-comment">//true表示需要创建一个multipart message</span>
<span class="hljs-type">MimeMessageHelper</span> <span class="hljs-variable">helper</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">MimeMessageHelper</span>(message, <span class="hljs-literal">true</span>);
helper.setFrom(from);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, <span class="hljs-literal">true</span>);
mailSender.send(message);
logger.info(<span class="hljs-string">"html邮件发送成功"</span>);
} <span class="hljs-keyword">catch</span> (MessagingException e) {
logger.error(<span class="hljs-string">"发送html邮件时发生异常！"</span>, e);
}
}
在测试类中构建 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","test simple mail",content);
}
发送带附件的邮件
在 MailService 添加 sendAttachmentsMail 方法.
public void sendAttachmentsMail(String to, String subject, String content, String filePath){
MimeMessage message = mailSender.createMimeMessage();
<span class="hljs-keyword">try</span> {
<span class="hljs-type">MimeMessageHelper</span> <span class="hljs-variable">helper</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">MimeMessageHelper</span>(message, <span class="hljs-literal">true</span>);
helper.setFrom(from);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, <span class="hljs-literal">true</span>);
<span class="hljs-type">FileSystemResource</span> <span class="hljs-variable">file</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">FileSystemResource</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">File</span>(filePath));
<span class="hljs-type">String</span> <span class="hljs-variable">fileName</span> <span class="hljs-operator">=</span> filePath.substring(filePath.lastIndexOf(File.separator));
helper.addAttachment(fileName, file);
mailSender.send(message);
logger.info(<span class="hljs-string">"带附件的邮件已经发送。"</span>);
} <span class="hljs-keyword">catch</span> (MessagingException e) {
logger.error(<span class="hljs-string">"发送带附件的邮件时发生异常！"</span>, e);
}
}
添加多个附件可以使用多条
helper.addAttachment(fileName, file)
在测试类中添加测试方法
@Test
public void sendAttachmentsMail() {
String filePath="e:\\tmp\\application.log";
mailService.sendAttachmentsMail("ityouknow@126.com", "主题：带附件的邮件", "有附件，请查收！", filePath);
}
发送带静态资源的邮件
邮件中的静态资源一般就是指图片，在 MailService 添加 sendAttachmentsMail 方法.
public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId){
MimeMessage message = mailSender.createMimeMessage();
<span class="hljs-keyword">try</span> {
<span class="hljs-type">MimeMessageHelper</span> <span class="hljs-variable">helper</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">MimeMessageHelper</span>(message, <span class="hljs-literal">true</span>);
helper.setFrom(from);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, <span class="hljs-literal">true</span>);
<span class="hljs-type">FileSystemResource</span> <span class="hljs-variable">res</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">FileSystemResource</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">File</span>(rscPath));
helper.addInline(rscId, res);
mailSender.send(message);
logger.info(<span class="hljs-string">"嵌入静态资源的邮件已经发送。"</span>);
} <span class="hljs-keyword">catch</span> (MessagingException e) {
logger.error(<span class="hljs-string">"发送嵌入静态资源的邮件时发生异常！"</span>, e);
}
}
在测试类中添加测试方法
@Test
public void sendInlineResourceMail() {
String rscId = "neo006";
String content="<html><body> 这是有图片的邮件：<img src=\'cid:" + rscId + "\' ></body></html>";
String imgPath = "C:\\Users\\summer\\Pictures\\favicon.png";
mailService.sendInlineResourceMail(<span class="hljs-string">"ityouknow@126.com"</span>, <span class="hljs-string">"主题：这是有图片的邮件"</span>, content, imgPath, rscId);
}
添加多个图片可以使用多条
<img src='cid:" + rscId + "' >和helper.addInline(rscId, res)来实现
到此所有的邮件发送服务已经完成了。
邮件系统
上面发送邮件的基础服务就这些了，但是如果我们要做成一个邮件系统的话还需要考虑以下几个问题：
邮件模板
我们会经常收到这样的邮件：
尊敬的neo用户：恭喜您注册成为xxx网的用户,，同时感谢您对xxx的关注与支持并欢迎您使用xx的产品与服务。 ...
其中只有 neo 这个用户名在变化，其它邮件内容均不变，如果每次发送邮件都需要手动拼接的话会不够优雅，并且每次模板的修改都需要改动代码的话也很不方便，因此对于这类邮件需求，都建议做成邮件模板来处理。模板的本质很简单，就是在模板中替换变化的参数，转换为 html 字符串即可，这里以thymeleaf为例来演示。
1、pom 中导入 thymeleaf 的包
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
**2、在 resorces/templates 下创建 emailTemplate.html **
<!DOCTYPE html>
<html lang="zh" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8"/>
<title>Title</title>
</head>
<body>
您好,这是验证邮件,请点击下面的链接完成验证,<br/>
<a href="#" th:href="@{http://www.ityouknow.com/neo/{id}(id=${id}) }">激活账号</a>
</body>
</html>
3、解析模板并发送
@Test
public void sendTemplateMail() {
// 创建邮件正文
Context context = new Context();
context.setVariable("id", "006");
String emailContent = templateEngine.process("emailTemplate", context);
mailService.sendHtmlMail(<span class="hljs-string">"ityouknow@126.com"</span>,<span class="hljs-string">"主题：这是模板邮件"</span>,emailContent);
}
发送失败
因为各种原因，总会有邮件发送失败的情况，比如：邮件发送过于频繁、网络异常等。在出现这种情况的时候，我们一般会考虑重新重试发送邮件，会分为以下几个步骤来实现：
- 1、接收到发送邮件请求，首先记录请求并且入库。
- 2、调用邮件发送接口发送邮件，并且将发送结果记录入库。
- 3、启动定时系统扫描时间段内，未发送成功并且重试次数小于 3 次的邮件，进行再次发送
异步发送
很多时候邮件发送并不是我们主业务必须关注的结果，比如通知类、提醒类的业务可以允许延时或者失败。这个时候可以采用异步的方式来发送邮件，加快主交易执行速度，在实际项目中可以采用 MQ 发送邮件相关参数，监听到消息队列之后启动发送邮件。
可以参考前期文章：Spring Boot(八)：RabbitMQ 详解 来实现。
文章内容已经升级到 Spring Boot 2.x