SpringBoot集成邮件发送
背景：最近公司项目，需要一个预警发送短信和邮件的功能，下面记录一个简单的测试用例，提供给需要的小伙伴，仅供参考。
一、准备工作
因为你在项目中配置了邮箱的登录和发送邮件的功能，即为第三方登录，所以你需要将你的邮箱第三方登录的权限开启，开启的步骤入=如下图所示：
登录网易云邮箱的pc端，按照步骤走完，这里会有一个密钥，一定要记住了（在项目的配置文件需要用到），因为它关闭就找不到了，只能重新添加。
二、配置文件（application.yml）
此处只需要将mail对应的配置集成到你的项目配置文件就可以。
server: port: 8090 spring: datasource: username: xxxx password: ****** url: jdbc:mysql://***.**.**:3306/**?useSSL=false&serverTimezone=UTC driver-class-name: com.mysql.cj.jdbc.Driver mail: # 邮件服务地址 host: smtp.163.com # 端口,这里如果不是企业邮箱 ，推荐使用456 port: 465 # 编码格式 default-encoding: utf-8 # 用户名 username: xxxxxx@163.com # 授权码，开启邮箱第三方登录的授权码（密钥） password: ****** # 其它参数 properties: mail: smtp: # 如果是用 SSL 方式，需要配置如下属性,使用qq邮箱的话需要开启 ssl: enable: true required: true # 邮件接收时间的限制，单位毫秒 timeout: 10000 # 连接时间的限制，单位毫秒 connectiontimeout: 10000 # 邮件发送时间的限制，单位毫秒 writetimeout: 10000 mybatis: mapper-locations: classpath:com/xxx/mapper/*.xml configuration: map-underscore-to-camel-case: true logging: level: com: xxx: mapper: common: debug
三、pom依赖
进入maven repository https://mvnrepository.com/ 搜索 Spring Boot Starter Mail 找到对应的pom依赖，加入到自己的项目中。
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-mail --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> <version>2.3.3.RELEASE</version> </dependency>
四、核心代码
下面是根据不同的文件形式，提供了一些代码：
常量类：
package com.dongl.utils.constant; /** * 邮件发送常量类 * 目前只是为了测试 正常情况下需要 获取对应的信息 发送到具体的人员邮件账号 */ public class MailConstant { public static final String SENDER = "xxxxxx@163.com"; public static final String TO = "xxxxxx@qq.com"; public static final String SUBJECT = "测试邮件"; public static final String CONTENT = "测试内容"; }
实现类：
package com.dongl.service.serviceimpl; import com.dongl.service.MailService; import com.dongl.utils.constant.MailConstant; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; 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.Service; import javax.mail.MessagingException; import javax.mail.internet.MimeMessage; import java.io.File; import java.util.Map; /** * @author D-L * @date 2020-08-28 * @version 1.0 * 根据发送的邮件种类 提供不同的邮件发送方法 */ @Service public class MailServiceImpl implements MailService { Logger logger = LoggerFactory.getLogger(MailServiceImpl.class); @Autowired private JavaMailSender mailSender; /** * 发送普通邮件 * * @param to 收件人 * @param subject 主题 * @param content 内容 */ @Override public void sendSimpleMailMessge(String to, String subject, String content) { SimpleMailMessage message = new SimpleMailMessage(); message.setFrom(MailConstant.SENDER); message.setCc(MailConstant.SENDER); message.setTo(to); message.setSubject(subject); message.setText(content); try { mailSender.send(message); } catch (Exception e) { logger.error("发送简单邮件时发生异常!", e); } } /** * 发送 HTML 邮件 * * @param to 收件人 * @param subject 主题 * @param content 内容 */ @Override public void sendMimeMessge(String to, String subject, String content) { MimeMessage message = mailSender.createMimeMessage(); try { //true表示需要创建一个multipart message MimeMessageHelper helper = new MimeMessageHelper(message, true); helper.setFrom(MailConstant.SENDER); helper.setCc(MailConstant.SENDER); helper.setTo(to); helper.setSubject(subject); helper.setText(content, true); mailSender.send(message); } catch (MessagingException e) { logger.error("发送MimeMessge时发生异常！", e); } } /** * 发送带附件的邮件 * * @param to 收件人 * @param subject 主题 * @param content 内容 * @param filePath 附件路径 */ @Override public void sendMimeMessge(String to, String subject, String content, String filePath) { MimeMessage message = mailSender.createMimeMessage(); try { //true表示需要创建一个multipart message MimeMessageHelper helper = new MimeMessageHelper(message, true); helper.setFrom(MailConstant.SENDER); helper.setCc(MailConstant.SENDER); 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); mailSender.send(message); } catch (MessagingException e) { logger.error("发送带附件的MimeMessge时发生异常！", e); } } /** * 发送带静态文件的邮件 * * @param to 收件人 * @param subject 主题 * @param content 内容 * @param rscIdMap 需要替换的静态文件 */ @Override public void sendMimeMessge(String to, String subject, String content, Map<String, String> rscIdMap) { MimeMessage message = mailSender.createMimeMessage(); try { //true表示需要创建一个multipart message MimeMessageHelper helper = new MimeMessageHelper(message, true); helper.setFrom(MailConstant.SENDER); helper.setCc(MailConstant.SENDER); helper.setTo(to); helper.setSubject(subject); helper.setText(content, true); for (Map.Entry<String, String> entry : rscIdMap.entrySet()) { FileSystemResource file = new FileSystemResource(new File(entry.getValue())); helper.addInline(entry.getKey(), file); } mailSender.send(message); } catch (MessagingException e) { logger.error("发送带静态文件的MimeMessge时发生异常！", e); } } }
五、测试用例
你可以使用测试类进行验证，也可以自己创建controller，通过接口调用的方式来验证：
package com.dongl; import com.dongl.service.serviceimpl.MailServiceImpl; import com.dongl.utils.constant.MailConstant; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.util.ResourceUtils; import java.io.File; import java.io.FileNotFoundException; import java.util.HashMap; import java.util.Map; @SpringBootTest public class MailSenterTest { @Autowired private MailServiceImpl mailService; /** * 测试发送普通邮件 */ @Test public void sendSimpleMailMessage() { mailService.sendSimpleMailMessge(MailConstant.TO, MailConstant.SUBJECT, MailConstant.CONTENT); } /** * 测试发送html邮件 */ @Test public void sendHtmlMessage() { String htmlStr = "<h1>测试内容</h1>"; mailService.sendMimeMessge(MailConstant.TO, MailConstant.SUBJECT, htmlStr); } /** * 测试发送带附件的邮件 * @throws FileNotFoundException */ @Test public void sendAttachmentMessage() throws FileNotFoundException { File file = ResourceUtils.getFile("F:/dongl/Angular.pdf"); String filePath = file.getAbsolutePath(); mailService.sendMimeMessge(MailConstant.TO, MailConstant.SUBJECT, MailConstant.CONTENT, filePath); } /** * 测试发送带附件的邮件 * @throws FileNotFoundException */ @Test public void sendPicMessage() throws FileNotFoundException { String htmlStr = "<html><body>测试：图片1 <br> <img src=\'cid:pic1\'/> <br>图片2 <br> <img src=\'cid:pic2\'/></body></html>"; Map<String, String> rscIdMap = new HashMap<>(2); rscIdMap.put("pic1", ResourceUtils.getFile("F:/dongl/pic01.jpg").getAbsolutePath()); rscIdMap.put("pic2", ResourceUtils.getFile("F:/dongl/pic01.jpg").getAbsolutePath()); mailService.sendMimeMessge(MailConstant.TO, MailConstant.SUBJECT, htmlStr, rscIdMap); } }
【总结】本文只是的提供了简单的自己的测试用例 ，正常开发应该使用企业的邮箱账号，发送的内容及发送给谁 ，应该由具体的业务来支撑。
