Spring Boot ：邮件服务

时间 2019-11-17

原文原文链接

简单使用

一、pom 包配置

pom 包里面添加 spring-boot-starter-mail 包引用html

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

二、在 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 //以谁来发送邮件

三、编写 mailService，这里只提出实现类。

@Component public class MailServiceImpl implements MailService{ private final Logger logger = LoggerFactory.getLogger(this.getClass()); @Autowired private JavaMailSender mailSender; @Value("${mail.fromMail.addr}") 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); } } }

四、编写 test 类进行测试

@RunWith(SpringRunner.class) @SpringBootTest public class MailServiceTest { @Autowired private MailService MailService; @Test public void testSimpleMail() throws Exception { MailService.sendSimpleMail("ityouknow@126.com","test simple mail"," hello this is simple mail"); } }

至此一个简单的文本发送就完成了。java

加点料

可是在正常使用的过程当中，咱们一般在邮件中加入图片或者附件来丰富邮件的内容，下面讲介绍如何使用 Spring Boot 来发送丰富的邮件。spring

发送 html 格式邮件

其它都不变在 MailService 添加 sendHtmlMail 方法.服务器

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); } }

在测试类中构建 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(); 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 = 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)app

在测试类中添加测试方法异步

@Test public void sendAttachmentsMail() { String filePath="e:\\tmp\\application.log"; mailService.sendAttachmentsMail("ityouknow@126.com", "主题：带附件的邮件", "有附件，请查收！", filePath); }

发送带静态资源的邮件

邮件中的静态资源通常就是指图片，在 MailService 添加 sendAttachmentsMail 方法.ide

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(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); } }

在测试类中添加测试方法spring-boot

@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("ityouknow@126.com", "主题：这是有图片的邮件", content, imgPath, rscId); }

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

到此全部的邮件发送服务已经完成了。

邮件系统

上面发送邮件的基础服务就这些了，可是若是咱们要作成一个邮件系统的话还须要考虑如下几个问题：

邮件模板

咱们会常常收到这样的邮件：

尊敬的neo用户：
              
          恭喜您注册成为xxx网的用户,，同时感谢您对xxx的关注与支持并欢迎您使用xx的产品与服务。
          ...

其中只有 neo 这个用户名在变化，其它邮件内容均不变，若是每次发送邮件都须要手动拼接的话会不够优雅，而且每次模板的修改都须要改动代码的话也很不方便，所以对于这类邮件需求，都建议作成邮件模板来处理。模板的本质很简单，就是在模板中替换变化的参数，转换为 html 字符串便可，这里以thymeleaf为例来演示。

一、pom 中导入 thymeleaf 的包

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

二、在 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>

三、解析模板并发送

@Test public void sendTemplateMail() { //建立邮件正文 Context context = new Context(); context.setVariable("id", "006"); String emailContent = templateEngine.process("emailTemplate", context); mailService.sendHtmlMail("ityouknow@126.com","主题：这是模板邮件",emailContent); }

发送失败

由于各类缘由，总会有邮件发送失败的状况，好比：邮件发送过于频繁、网络异常等。在出现这种状况的时候，咱们通常会考虑从新重试发送邮件，会分为如下几个步骤来实现：

一、接收到发送邮件请求，首先记录请求而且入库。
二、调用邮件发送接口发送邮件，而且将发送结果记录入库。
三、启动定时系统扫描时间段内，未发送成功而且重试次数小于3次的邮件，进行再次发送

异步发送

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