前面写了3篇 Spring Boot 发送邮件的博客,详情可查看下边的连接;
Spring Boot发送邮件一——最简单的邮件
Spring Boot发送邮件二——带附件和内容有图片的邮件
Spring Boot发送邮件三——Thymeleaf做模板的邮件
这篇写 Spring Boot 和前端模板 Freemarker 配合使用发送一封邮件
Freemarker 做模板发送邮件
- 1.在pom.xml中加入 Thymeleaf 的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
- 2.在
src/resources/templates
创建 mail.ftlh文件
创建.ftlh
结尾的页面,为什么要以.ftlh
结尾呢,有的版本是.ftl
,这个时候连按两次Shirft
在搜索框里,输入 Freemarker 就能看见相关配置,有一个FreeMarkerProperties
文件有如下代码,Spring Boot 自动化配置以这个.ftlh
结尾的文件
public class FreeMarkerProperties extends AbstractTemplateViewResolverProperties {
public static final String DEFAULT_TEMPLATE_LOADER_PATH = "classpath:/templates/";
public static final String DEFAULT_PREFIX = "";
public static final String DEFAULT_SUFFIX = ".ftlh";//默认以ftlh结尾
private Map<String, String> settings = new HashMap();
private String[] templateLoaderPath = new String[]{"classpath:/templates/"};
private boolean preferFileSystemAccess = true;
public FreeMarkerProperties() {
super("", ".ftlh");
}
其实除了文件扩展名叫.ftlh
之外,它的内容基本就是一个 HTML 文件,配合类似 JSP 的 EL 表达式的写法,看代码
- 3. HTML 代码,很简单,不多说:
<!DOCTYPE html>
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1>freemarker</h1>
<div>
欢迎<span>${username}</span>加入xxx大家庭
</div>
您的入职信息如下
<table border="1">
<tr>
<td>职位</td>
<td>${position}</td>
</tr>
<tr>
<td>职称</td>
<td>${joblevel}</td>
</tr>
<tr>
<td>薪水</td>
<td>${salary}</td>
</tr>
<tr>
<td>部门</td>
<td>${dept}</td>
</tr>
</table>
<div style="color: #ff5d9b;font-size: 20px;" >
希望在未来日子里,携手共进
</div>
</body>
</html>
- 4.后端代码
@SpringBootTest
class MailApplicationTests {
@Autowired
JavaMailSender javaMailSender;//邮件发送
@Autowired
FreeMarkerConfigurer configuration;//Spring 模板引擎
@Test
public void test5() throws MessagingException, IOException, TemplateException {
MimeMessage msg = javaMailSender.createMimeMessage();//创建模拟的消息
MimeMessageHelper helper = new MimeMessageHelper(msg, true);//创建模拟的消息工具
helper.setFrom("[email protected]");//发件人
helper.setSentDate(new Date());//发送日期
helper.setSubject("这是测试主题(freemarker)");//发送主题
Template template = configuration.getConfiguration().getTemplate("mail.ftlh");
Map<String, Object> map = new HashMap<>();
map.put("username", "javaboy");
map.put("position", "Java工程师");
map.put("dept", "产品研发部");
map.put("salary", 9999);
map.put("joblevel", "高级工程师");
StringWriter writer = new StringWriter();
template.process(map, writer);
helper.setText(writer.toString(), true);//内容是否设置成html,true代表是
helper.setTo("[email protected]");//收件人
javaMailSender.send(msg);//发送
}
与之前的发送内容有图片的邮件相比,步骤几乎也是一样的,只不过发送内容多 Spring Boot提供的模板引擎Template .process()
来生成字符串内容的步骤,然后再放入MimeMessageHelper.setText()
方法中;而且第二个参数需要传入 IO 作用的 Writer
对象,作用是把mail.ftlh
内容和Map
数据结合后,生成字符串写入此 Writer 中,再调用toString()
转成字符串;下面着重看一下 FreeMarkerConfigurer
这个类,源码在 FreeMarkerServletWebConfiguration
中是自动注入的:
@Bean
@ConditionalOnMissingBean({FreeMarkerConfig.class})
FreeMarkerConfigurer freeMarkerConfigurer() {
FreeMarkerConfigurer configurer = new FreeMarkerConfigurer();
this.applyProperties(configurer);
return configurer;
}
configuration.getConfiguration().getTemplate("mail.ftlh")
可以生成指定 .ftlh
文件下的模板对象,为后来进一步处理调用.process
方法生成 HTML 的字符串提供方便。
- 5.好了代码写完,执行@Test方法后,查看 139 邮箱结果
结束
这样一份基于 Freemark 的、可以修改模板的邮件就完成了,也是Spring Boot 发送邮件的最后一篇了,希望对广大小伙伴有用。