第十三篇：Spring Boot之邮件服务
发送邮件应该是网站的必备功能之一，什么注册验证，忘记密码或者是给用户发送营销信息。最早期的时候我们会使用JavaMail的相关API来编写发送邮件的相关代码，后来Spring推出了JavaMailSender更加简化了邮件发送的过程，再之后Spring Boot对此进行了封装就有了现在的spring-boot-starter-mail,本文主要介绍Spring Boot如何使用JavaMailSender来发送邮件。
构架工程
创建一个springboot工程，在其pom文件加入：
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-mailartifactId>
dependency>
添加邮箱配置
spring.mail.host=smtp.qq.com //邮箱服务器地址
spring.mail.port=587 //邮箱服务器端口
[email protected] //用户名
spring.mail.password=********* //密码
[email protected] //以谁来发送邮件
编写mailService
@Component
public class MailServiceImpl implements IMailService {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
@Autowired
private JavaMailSender mailSender;
@Resource
private TemplateEngine templateEngine;
@Value("${mail.fromMail.addr}")
private String mailFrom;
/**
* 发送简单邮件
*
* @param to
* @param subject
* @param content
*/
@Override
public void sendSimpleEmail(String to, String subject, String content) {
SimpleMailMessage message = new SimpleMailMessage();
message.setFrom(mailFrom);
message.setTo(to);
message.setSubject(subject);
message.setText(content);
try {
mailSender.send(message);
logger.info("简单邮件已经发送。");
} catch (MailException e) {
logger.error("发送简单邮件时发生异常！", e);
}
}
}
编写test类进行测试
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootMailApplicationTests {
@Autowired
private IMailService mailService;
@Test
public void sendSimpleEmail() {
mailService.sendSimpleEmail("[email protected]","test simple mail"," hello this is simple mail");
}
}
至此一个简单的文本发送就完成了。
发送html格式邮件
在MailService添加sendHtmlMail方法
/**
* 发送html邮件
*
* @param to
* @param subject
* @param content
*/
@Override
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(mailFrom);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, true);
mailSender.send(message);
logger.info("html邮件发送成功");
} catch (MessagingException e) {
logger.error("发送html邮件时发生异常！", e);
}
}
在测试类中构建html内容，测试发送
@Test
public void sendHtmlMail() {
String content="\n" +
"\n" +
" hello world ! 这是一封Html邮件!
\n" +
"\n" +
"";
mailService.sendHtmlMail("[email protected]","test simple mail",content);
}
发送带附件的邮件
在MailService添加sendFileMail方法
/**
* 发送带附件的邮件
*
* @param to
* @param subject
* @param content
* @param filepath
*/
@Override
public void sendFileMail(String to, String subject, String content, String filePath) {
MimeMessage message = mailSender.createMimeMessage();
try {
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(mailFrom);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, 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);
}
}
添加多个附件可以使用多条
helper.addAttachment(fileName, file)
在测试类中添加测试方法
@Test
public void sendFileMail() {
String filePath="E:\\Trs\\周报\\周报_6.docx";
mailService.sendFileMail("[email protected]", "主题：带附件的邮件", "有附件，请查收！", filePath);
}
发送带静态资源的邮件
邮件中的静态资源一般就是指图片，在MailService添加sendInlineResourceMail方法.
/**
* 发送带静态资源的邮件
* @param to
* @param subject
* @param content
* @param rscPath
* @param rscId
*/
@Override
public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId) {
MimeMessage message = mailSender.createMimeMessage();
try {
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(mailFrom);
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="这是有图片的邮件：![](\'cid:"</span)
+ rscId + "\' >";
String imgPath = "E:\\Job\\cloud.jpg";
mailService.sendInlineResourceMail("[email protected]", "主题：这是有图片的邮件", content, imgPath, rscId);
}
添加多个图片可以使用多条
和helper.addInline(rscId, res)来实现
到此所有的邮件发送服务已经完成了。
上面发送邮件的基础服务就这些了，但是如果我们要做成一个邮件系统的话还需要考虑以下几个问题：
我们会经常收到这样的邮件：
尊敬的jay用户：
尊敬的jay用户：
恭喜您注册成为xxx网的用户,，同时感谢您对xxx的关注与支持并欢迎您使用xx的产品与服务。
其中只有jay这个用户名在变化，其它邮件内容均不变，如果每次发送邮件都需要手动拼接的话会不够优雅，并且每次模板的修改都需要改动代码的话也很不方便，因此对于这类邮件需求，都建议做成邮件模板来处理。模板的本质很简单，就是在模板中替换变化的参数，转换为html字符串即可，这里以thymeleaf为例来演示。
pom中添加thymeleaf的依赖
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-thymeleafartifactId>
dependency>
在resorces/templates下创建templateMail.html
<html lang="zh" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8"/>
<title>Titletitle>
head>
<body>
您好,这是验证邮件,请点击下面的链接完成验证,<br/>
<a href="#" th:href="@{ http://www.chenjay.top/blog/authenticate/{id}(id=${id}) }">激活账号a>
body>
html>
解析模板并发送
在MailService添加sendFileMail方法
/**
* 发送模板邮件
*
* @param to
* @param subject
* @param template
* @param content
*/
@Override
public void sendTemplateMail(String to, String subject, String template, Context context) {
MimeMessage mimeMessage = mailSender.createMimeMessage();
try {
MimeMessage message = mailSender.createMimeMessage();
MimeMessageHelper messageHelper = new MimeMessageHelper(message);
String content = templateEngine.process(template, context);
messageHelper.setFrom(mailFrom);
messageHelper.setTo(to);
messageHelper.setSubject(subject);
messageHelper.setText(content, true);
mailSender.send(message);
logger.info("模板邮件发送成功");
} catch (MessagingException e) {
logger.error("发送模板邮件时发生异常！", e);
}
}
在测试类中添加测试方法
@Test
public void sendTemplateMail() {
String template = "mail/templateMail";
Context context = new Context();
context.setVariable("id", "006");
mailService.sendTemplateMail("[email protected]","模板邮件",template,context);
}
源码下载：https://github.com/chenjary/SpringBoot