diff --git a/demo-base/demo-base-email/README.md b/demo-base/demo-base-email/README.md
new file mode 100644
index 0000000..2b1b8fb
--- /dev/null
+++ b/demo-base/demo-base-email/README.md
@@ -0,0 +1,255 @@
+## spring-boot-demo-email
+
+> 此 demo 主要演示了 Spring Boot 如何整合邮件功能,包括发送简单文本邮件、HTML邮件(包括模板HTML邮件)、附件邮件、静态资源邮件。
+
+### 1.开发步骤
+
+#### 1.1.添加依赖
+
+```xml
+
+
@@ -30,7 +30,7 @@ public interface MailService {
* @param cc 抄送地址
* @throws MessagingException 邮件发送异常
*/
- void sendHtmlMail(String to, String subject, String content, String... cc) throws MessagingException;
+ void sendHtmlMail(String to, String subject, String content, String... cc) throws MessagingException, MessagingException;
/**
* 发送带附件的邮件
diff --git a/demo-email/src/main/java/com/xkcoding/email/service/impl/MailServiceImpl.java b/demo-base/demo-base-email/src/main/java/com/xkcoding/email/service/impl/MailServiceImpl.java
similarity index 75%
rename from demo-email/src/main/java/com/xkcoding/email/service/impl/MailServiceImpl.java
rename to demo-base/demo-base-email/src/main/java/com/xkcoding/email/service/impl/MailServiceImpl.java
index 59a8e13..ea343e9 100644
--- a/demo-email/src/main/java/com/xkcoding/email/service/impl/MailServiceImpl.java
+++ b/demo-base/demo-base-email/src/main/java/com/xkcoding/email/service/impl/MailServiceImpl.java
@@ -2,6 +2,8 @@ package com.xkcoding.email.service.impl;
import cn.hutool.core.util.ArrayUtil;
import com.xkcoding.email.service.MailService;
+import jakarta.mail.MessagingException;
+import jakarta.mail.internet.MimeMessage;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.FileSystemResource;
@@ -10,8 +12,6 @@ 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;
/**
@@ -26,7 +26,7 @@ import java.io.File;
public class MailServiceImpl implements MailService {
@Autowired
private JavaMailSender mailSender;
- @Value("${spring.mail.username}")
+ @Value("${spring.mail.from}")
private String from;
/**
@@ -57,20 +57,11 @@ public class MailServiceImpl implements MailService {
* @param subject 邮件主题
* @param content 邮件内容
* @param cc 抄送地址
- * @throws MessagingException 邮件发送异常
*/
@Override
public void sendHtmlMail(String to, String subject, String content, String... cc) throws MessagingException {
- MimeMessage message = mailSender.createMimeMessage();
- MimeMessageHelper helper = new MimeMessageHelper(message, true);
- helper.setFrom(from);
- helper.setTo(to);
- helper.setSubject(subject);
- helper.setText(content, true);
- if (ArrayUtil.isNotEmpty(cc)) {
- helper.setCc(cc);
- }
- mailSender.send(message);
+ MimeEmail mimeEmail = basicMimeEmailBuilder(to, subject, content, cc);
+ mailSender.send(mimeEmail.message());
}
/**
@@ -85,21 +76,14 @@ public class MailServiceImpl implements MailService {
*/
@Override
public void sendAttachmentsMail(String to, String subject, String content, String filePath, String... cc) throws MessagingException {
- MimeMessage message = mailSender.createMimeMessage();
+ MimeEmail mimeEmail = basicMimeEmailBuilder(to, subject, content, cc);
- MimeMessageHelper helper = new MimeMessageHelper(message, true);
- helper.setFrom(from);
- helper.setTo(to);
- helper.setSubject(subject);
- helper.setText(content, true);
- if (ArrayUtil.isNotEmpty(cc)) {
- helper.setCc(cc);
- }
+ MimeMessageHelper helper = mimeEmail.helper();
FileSystemResource file = new FileSystemResource(new File(filePath));
String fileName = filePath.substring(filePath.lastIndexOf(File.separator));
helper.addAttachment(fileName, file);
- mailSender.send(message);
+ mailSender.send(mimeEmail.message());
}
/**
@@ -114,9 +98,22 @@ public class MailServiceImpl implements MailService {
* @throws MessagingException 邮件发送异常
*/
@Override
- public void sendResourceMail(String to, String subject, String content, String rscPath, String rscId, String... cc) throws MessagingException {
- MimeMessage message = mailSender.createMimeMessage();
+ public void sendResourceMail(String to, String subject, String content, String rscPath, String rscId, String... cc)
+ throws MessagingException {
+ MimeEmail mimeEmail = basicMimeEmailBuilder(to, subject, content, cc);
+
+ MimeMessageHelper helper = mimeEmail.helper();
+ FileSystemResource res = new FileSystemResource(new File(rscPath));
+ helper.addInline(rscId, res);
+
+ mailSender.send(mimeEmail.message());
+ }
+ /**
+ * 富文本邮件构造器,抽取重复代码,返回一个 MimeEmail record
+ */
+ private MimeEmail basicMimeEmailBuilder(String to, String subject, String content, String... cc) throws MessagingException {
+ MimeMessage message = mailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(from);
helper.setTo(to);
@@ -125,9 +122,10 @@ public class MailServiceImpl implements MailService {
if (ArrayUtil.isNotEmpty(cc)) {
helper.setCc(cc);
}
- FileSystemResource res = new FileSystemResource(new File(rscPath));
- helper.addInline(rscId, res);
+ return new MimeEmail(message, helper);
+ }
+
+ private record MimeEmail(MimeMessage message, MimeMessageHelper helper) {
- mailSender.send(message);
}
}
diff --git a/demo-email/src/main/resources/application.yml b/demo-base/demo-base-email/src/main/resources/application.yml
similarity index 76%
rename from demo-email/src/main/resources/application.yml
rename to demo-base/demo-base-email/src/main/resources/application.yml
index 719815b..1c730b8 100644
--- a/demo-email/src/main/resources/application.yml
+++ b/demo-base/demo-base-email/src/main/resources/application.yml
@@ -2,9 +2,10 @@ spring:
mail:
host: smtp.mxhichina.com
port: 465
+ from: "SpringBootDemo测试<${spring.mail.username}>"
username: spring-boot-demo@xkcoding.com
- # 使用 jasypt 加密密码,使用com.xkcoding.email.PasswordTest.testGeneratePassword 生成加密密码,替换 ENC(加密密码)
- password: ENC(OT0qGOpXrr1Iog1W+fjOiIDCJdBjHyhy)
+ # 使用 jasypt 加密密码,使用com.xkcoding.email.PasswordTest.testGeneratePassword 生成加密密码,替换 ENC(加密密码)
+ password: ENC(aef0+nM5440HO7YFAo7iUz8ZHpkjZVlR0hNw3OI/QOPSkNhYRImE/Oy1LBgFKoB1OjqW0v4ZdM0xNS0eKxELfA==)
protocol: smtp
test-connection: true
default-encoding: UTF-8
diff --git a/demo-email/src/main/resources/email/test.html b/demo-base/demo-base-email/src/main/resources/email/test.html
similarity index 100%
rename from demo-email/src/main/resources/email/test.html
rename to demo-base/demo-base-email/src/main/resources/email/test.html
diff --git a/demo-base/demo-base-email/src/main/resources/static/xkcoding.png b/demo-base/demo-base-email/src/main/resources/static/xkcoding.png
new file mode 100644
index 0000000..b1e9d30
Binary files /dev/null and b/demo-base/demo-base-email/src/main/resources/static/xkcoding.png differ
diff --git a/demo-email/src/main/resources/templates/welcome.html b/demo-base/demo-base-email/src/main/resources/templates/welcome.html
similarity index 100%
rename from demo-email/src/main/resources/templates/welcome.html
rename to demo-base/demo-base-email/src/main/resources/templates/welcome.html
diff --git a/demo-base/demo-base-email/src/test/java/com/xkcoding/email/EmailApplicationTests.java b/demo-base/demo-base-email/src/test/java/com/xkcoding/email/EmailApplicationTests.java
new file mode 100644
index 0000000..75d643c
--- /dev/null
+++ b/demo-base/demo-base-email/src/test/java/com/xkcoding/email/EmailApplicationTests.java
@@ -0,0 +1,13 @@
+package com.xkcoding.email;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class EmailApplicationTests {
+
+ @Test
+ void contextLoads() {
+ }
+
+}
diff --git a/demo-email/src/test/java/com/xkcoding/email/PasswordTest.java b/demo-base/demo-base-email/src/test/java/com/xkcoding/email/PasswordTest.java
similarity index 83%
rename from demo-email/src/test/java/com/xkcoding/email/PasswordTest.java
rename to demo-base/demo-base-email/src/test/java/com/xkcoding/email/PasswordTest.java
index 3f119e9..9bd0957 100644
--- a/demo-email/src/test/java/com/xkcoding/email/PasswordTest.java
+++ b/demo-base/demo-base-email/src/test/java/com/xkcoding/email/PasswordTest.java
@@ -1,8 +1,9 @@
package com.xkcoding.email;
import org.jasypt.encryption.StringEncryptor;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
/**
*
@@ -12,7 +13,8 @@ import org.springframework.beans.factory.annotation.Autowired;
* @author yangkai.shen
* @date Created in 2019-08-27 16:15
*/
-public class PasswordTest extends SpringBootDemoEmailApplicationTests {
+@SpringBootTest
+class PasswordTest {
@Autowired
private StringEncryptor encryptor;
@@ -20,7 +22,7 @@ public class PasswordTest extends SpringBootDemoEmailApplicationTests {
* 生成加密密码
*/
@Test
- public void testGeneratePassword() {
+ void testGeneratePassword() {
// 你的邮箱密码
String password = "Just4Test!";
// 加密后的密码(注意:配置上去的时候需要加 ENC(加密密码))
diff --git a/demo-email/src/test/java/com/xkcoding/email/service/MailServiceTest.java b/demo-base/demo-base-email/src/test/java/com/xkcoding/email/service/MailServiceTest.java
similarity index 64%
rename from demo-email/src/test/java/com/xkcoding/email/service/MailServiceTest.java
rename to demo-base/demo-base-email/src/test/java/com/xkcoding/email/service/MailServiceTest.java
index b23d352..fba9a88 100644
--- a/demo-email/src/test/java/com/xkcoding/email/service/MailServiceTest.java
+++ b/demo-base/demo-base-email/src/test/java/com/xkcoding/email/service/MailServiceTest.java
@@ -1,15 +1,16 @@
package com.xkcoding.email.service;
import cn.hutool.core.io.resource.ResourceUtil;
-import com.xkcoding.email.SpringBootDemoEmailApplicationTests;
-import org.junit.Test;
+import com.xkcoding.email.EmailApplication;
+import jakarta.mail.MessagingException;
+import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContext;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.context.Context;
-import org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver;
+import org.thymeleaf.spring6.templateresolver.SpringResourceTemplateResolver;
-import javax.mail.MessagingException;
import java.net.URL;
/**
@@ -20,7 +21,8 @@ import java.net.URL;
* @author yangkai.shen
* @date Created in 2018-11-21 13:49
*/
-public class MailServiceTest extends SpringBootDemoEmailApplicationTests {
+@SpringBootTest(classes = EmailApplication.class)
+class MailServiceTest {
@Autowired
private MailService mailService;
@Autowired
@@ -37,19 +39,19 @@ public class MailServiceTest extends SpringBootDemoEmailApplicationTests {
}
/**
- * 测试HTML邮件
+ * 测试HTML邮件(使用 classpath://templates/ 下的模板)
*
* @throws MessagingException 邮件异常
*/
@Test
- public void sendHtmlMail() throws MessagingException {
- Context context = new Context();
- context.setVariable("project", "Spring Boot Demo");
- context.setVariable("author", "Yangkai.Shen");
- context.setVariable("url", "https://github.com/xkcoding/spring-boot-demo");
+ void sendHtmlMail1() throws MessagingException {
+ Context varContext = new Context();
+ varContext.setVariable("project", "Spring Boot Demo");
+ varContext.setVariable("author", "Yangkai.Shen");
+ varContext.setVariable("url", "https://github.com/xkcoding/spring-boot-demo");
- String emailTemplate = templateEngine.process("welcome", context);
- mailService.sendHtmlMail("237497819@qq.com", "这是一封模板HTML邮件", emailTemplate);
+ String emailTemplate = templateEngine.process("welcome", varContext);
+ mailService.sendHtmlMail("237497819@qq.com", "这是一封模板HTML邮件(templates目录)", emailTemplate);
}
/**
@@ -58,7 +60,7 @@ public class MailServiceTest extends SpringBootDemoEmailApplicationTests {
* @throws MessagingException 邮件异常
*/
@Test
- public void sendHtmlMail2() throws MessagingException {
+ void sendHtmlMail2() throws MessagingException {
SpringResourceTemplateResolver templateResolver = new SpringResourceTemplateResolver();
templateResolver.setApplicationContext(context);
@@ -68,13 +70,13 @@ public class MailServiceTest extends SpringBootDemoEmailApplicationTests {
templateEngine.setTemplateResolver(templateResolver);
- Context context = new Context();
- context.setVariable("project", "Spring Boot Demo");
- context.setVariable("author", "Yangkai.Shen");
- context.setVariable("url", "https://github.com/xkcoding/spring-boot-demo");
+ Context varContext = new Context();
+ varContext.setVariable("project", "Spring Boot Demo");
+ varContext.setVariable("author", "Yangkai.Shen");
+ varContext.setVariable("url", "https://github.com/xkcoding/spring-boot-demo");
- String emailTemplate = templateEngine.process("test", context);
- mailService.sendHtmlMail("237497819@qq.com", "这是一封模板HTML邮件", emailTemplate);
+ String emailTemplate = templateEngine.process("test", varContext);
+ mailService.sendHtmlMail("237497819@qq.com", "这是一封模板HTML邮件(自定义目录)", emailTemplate);
}
/**
@@ -83,7 +85,7 @@ public class MailServiceTest extends SpringBootDemoEmailApplicationTests {
* @throws MessagingException 邮件异常
*/
@Test
- public void sendAttachmentsMail() throws MessagingException {
+ void sendAttachmentsMail() throws MessagingException {
URL resource = ResourceUtil.getResource("static/xkcoding.png");
mailService.sendAttachmentsMail("237497819@qq.com", "这是一封带附件的邮件", "邮件中有附件,请注意查收!", resource.getPath());
}
@@ -94,7 +96,7 @@ public class MailServiceTest extends SpringBootDemoEmailApplicationTests {
* @throws MessagingException 邮件异常
*/
@Test
- public void sendResourceMail() throws MessagingException {
+ void sendResourceMail() throws MessagingException {
String rscId = "xkcoding";
String content = "";
URL resource = ResourceUtil.getResource("static/xkcoding.png");
diff --git a/demo-base/pom.xml b/demo-base/pom.xml
index 4df90f9..3b5fa19 100644
--- a/demo-base/pom.xml
+++ b/demo-base/pom.xml
@@ -23,6 +23,7 @@
- * 邮件接口 - *
- * - * @author yangkai.shen - * @date Created in 2018-11-21 11:16 - */ -public interface MailService { - /** - * 发送文本邮件 - * - * @param to 收件人地址 - * @param subject 邮件主题 - * @param content 邮件内容 - * @param cc 抄送地址 - */ - void sendSimpleMail(String to, String subject, String content, String... cc); - - /** - * 发送HTML邮件 - * - * @param to 收件人地址 - * @param subject 邮件主题 - * @param content 邮件内容 - * @param cc 抄送地址 - * @throws MessagingException 邮件发送异常 - */ - void sendHtmlMail(String to, String subject, String content, String... cc) throws MessagingException; - - /** - * 发送带附件的邮件 - * - * @param to 收件人地址 - * @param subject 邮件主题 - * @param content 邮件内容 - * @param filePath 附件地址 - * @param cc 抄送地址 - * @throws MessagingException 邮件发送异常 - */ - void sendAttachmentsMail(String to, String subject, String content, String filePath, String... cc) throws MessagingException; - - /** - * 发送正文中有静态资源的邮件 - * - * @param to 收件人地址 - * @param subject 邮件主题 - * @param content 邮件内容 - * @param rscPath 静态资源地址 - * @param rscId 静态资源id - * @param cc 抄送地址 - * @throws MessagingException 邮件发送异常 - */ - void sendResourceMail(String to, String subject, String content, String rscPath, String rscId, String... cc) throws MessagingException; - -} -``` - -## MailServiceImpl.java - -```java -/** - *- * 邮件接口 - *
- * - * @author yangkai.shen - * @date Created in 2018-11-21 13:49 - */ -@Service -public class MailServiceImpl implements MailService { - @Autowired - private JavaMailSender mailSender; - @Value("${spring.mail.username}") - private String from; - - /** - * 发送文本邮件 - * - * @param to 收件人地址 - * @param subject 邮件主题 - * @param content 邮件内容 - * @param cc 抄送地址 - */ - @Override - public void sendSimpleMail(String to, String subject, String content, String... cc) { - SimpleMailMessage message = new SimpleMailMessage(); - message.setFrom(from); - message.setTo(to); - message.setSubject(subject); - message.setText(content); - if (ArrayUtil.isNotEmpty(cc)) { - message.setCc(cc); - } - mailSender.send(message); - } - - /** - * 发送HTML邮件 - * - * @param to 收件人地址 - * @param subject 邮件主题 - * @param content 邮件内容 - * @param cc 抄送地址 - * @throws MessagingException 邮件发送异常 - */ - @Override - public void sendHtmlMail(String to, String subject, String content, String... cc) throws MessagingException { - MimeMessage message = mailSender.createMimeMessage(); - MimeMessageHelper helper = new MimeMessageHelper(message, true); - helper.setFrom(from); - helper.setTo(to); - helper.setSubject(subject); - helper.setText(content, true); - if (ArrayUtil.isNotEmpty(cc)) { - helper.setCc(cc); - } - mailSender.send(message); - } - - /** - * 发送带附件的邮件 - * - * @param to 收件人地址 - * @param subject 邮件主题 - * @param content 邮件内容 - * @param filePath 附件地址 - * @param cc 抄送地址 - * @throws MessagingException 邮件发送异常 - */ - @Override - public void sendAttachmentsMail(String to, String subject, String content, String filePath, String... cc) throws MessagingException { - MimeMessage message = mailSender.createMimeMessage(); - - MimeMessageHelper helper = new MimeMessageHelper(message, true); - helper.setFrom(from); - helper.setTo(to); - helper.setSubject(subject); - helper.setText(content, true); - if (ArrayUtil.isNotEmpty(cc)) { - helper.setCc(cc); - } - FileSystemResource file = new FileSystemResource(new File(filePath)); - String fileName = filePath.substring(filePath.lastIndexOf(File.separator)); - helper.addAttachment(fileName, file); - - mailSender.send(message); - } - - /** - * 发送正文中有静态资源的邮件 - * - * @param to 收件人地址 - * @param subject 邮件主题 - * @param content 邮件内容 - * @param rscPath 静态资源地址 - * @param rscId 静态资源id - * @param cc 抄送地址 - * @throws MessagingException 邮件发送异常 - */ - @Override - public void sendResourceMail(String to, String subject, String content, String rscPath, String rscId, String... cc) throws MessagingException { - MimeMessage message = mailSender.createMimeMessage(); - - MimeMessageHelper helper = new MimeMessageHelper(message, true); - helper.setFrom(from); - helper.setTo(to); - helper.setSubject(subject); - helper.setText(content, true); - if (ArrayUtil.isNotEmpty(cc)) { - helper.setCc(cc); - } - FileSystemResource res = new FileSystemResource(new File(rscPath)); - helper.addInline(rscId, res); - - mailSender.send(message); - } -} -``` - -## MailServiceTest.java - -```java -/** - *- * 邮件测试 - *
- * - * @author yangkai.shen - * @date Created in 2018-11-21 13:49 - */ -public class MailServiceTest extends SpringBootDemoEmailApplicationTests { - @Autowired - private MailService mailService; - @Autowired - private TemplateEngine templateEngine; - @Autowired - private ApplicationContext context; - - /** - * 测试简单邮件 - */ - @Test - public void sendSimpleMail() { - mailService.sendSimpleMail("237497819@qq.com", "这是一封简单邮件", "这是一封普通的SpringBoot测试邮件"); - } - - /** - * 测试HTML邮件 - * - * @throws MessagingException 邮件异常 - */ - @Test - public void sendHtmlMail() throws MessagingException { - Context context = new Context(); - context.setVariable("project", "Spring Boot Demo"); - context.setVariable("author", "Yangkai.Shen"); - context.setVariable("url", "https://github.com/xkcoding/spring-boot-demo"); - - String emailTemplate = templateEngine.process("welcome", context); - mailService.sendHtmlMail("237497819@qq.com", "这是一封模板HTML邮件", emailTemplate); - } - - /** - * 测试HTML邮件,自定义模板目录 - * - * @throws MessagingException 邮件异常 - */ - @Test - public void sendHtmlMail2() throws MessagingException { - - SpringResourceTemplateResolver templateResolver = new SpringResourceTemplateResolver(); - templateResolver.setApplicationContext(context); - templateResolver.setCacheable(false); - templateResolver.setPrefix("classpath:/email/"); - templateResolver.setSuffix(".html"); - - templateEngine.setTemplateResolver(templateResolver); - - Context context = new Context(); - context.setVariable("project", "Spring Boot Demo"); - context.setVariable("author", "Yangkai.Shen"); - context.setVariable("url", "https://github.com/xkcoding/spring-boot-demo"); - - String emailTemplate = templateEngine.process("test", context); - mailService.sendHtmlMail("237497819@qq.com", "这是一封模板HTML邮件", emailTemplate); - } - - /** - * 测试附件邮件 - * - * @throws MessagingException 邮件异常 - */ - @Test - public void sendAttachmentsMail() throws MessagingException { - URL resource = ResourceUtil.getResource("static/xkcoding.png"); - mailService.sendAttachmentsMail("237497819@qq.com", "这是一封带附件的邮件", "邮件中有附件,请注意查收!", resource.getPath()); - } - - /** - * 测试静态资源邮件 - * - * @throws MessagingException 邮件异常 - */ - @Test - public void sendResourceMail() throws MessagingException { - String rscId = "xkcoding"; - String content = "这是带静态资源的邮件