SpringBoot中使用Freemarker构建邮件模板

本文是vhr系列的第十三篇，项目地址：https://github.com/lenve/vhr

当邮件内容比较简单的时候，我们可能一行字符串就能表达所有意思了，但是大部分情况下，我们的邮件内容都比较复杂需要用HTML来组织邮件内容，而且HTML中的数据还要动态修改，这时，最好的解决方案莫过于Freemarker了。有的小伙伴看到Freemarker就疑惑了，你不是号称前后端分离么，怎么还用上Freemarker了？freemarker使用的最多的场景就是做页面模板，但是它不仅可以做HTML模板(大部分情况下它都扮演了这个角色)，还可以做XML、邮件等的模板，本文我们就来看看作为邮件模板，Freemarker要怎么使用。

引入依赖

第一步当然是引入freemarker依赖了，如下：

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
</dependency>
 
 

创建邮件模板

接下来就是根据我们想要的HTML样式，创建一个邮件模板,这个模板是一个ftl文件，如下：

<p>你好，${name}童鞋，欢迎加入XXX大家庭！您的入职信息如下：</p>
<table border="1" cellspacing="0">
    <tr><td><strong style="color: #F00">工号</strong></td><td>${workID}</td></tr>
    <tr><td><strong style="color: #F00">合同期限</strong></td><td>${contractTerm}年</td></tr>
    <tr><td><strong style="color: #F00">合同起始日期</strong></td><td>${beginContract?string("yyyy-MM-dd")}</td></tr>
    <tr><td><strong style="color: #F00">合同截至日期</strong></td><td>${endContract?string("yyyy-MM-dd")}</td></tr>
    <tr><td><strong style="color: #F00">所属部门</strong></td><td>${departmentName}</td></tr>
    <tr><td><strong style="color: #F00">职位</strong></td><td>${posName}</td></tr>
</table>
<p><strong style="color: #F00; font-size: 24px;">希望在未来的日子里，携手共进!</strong></p>
 
 

最终的显示效果如下：

这个样式小伙伴可以根据自己的需求灵活调整。有一个要注意的地方： 因为我已经前后端分离了，因此项目中的webapp目录对我来说已经无关紧要了，创建的意义不大，因此这个邮件模板我把它放在resources目录下的ftl目录下。

模板解析

有了模板，接下来我只需要向模板中传入数据，并将模板ftl解析为html即可，如下：

Configuration cfg = new Configuration(Configuration.VERSION_2_3_27);
cfg.setClassLoaderForTemplateLoading(ClassLoader.getSystemClassLoader(),"ftl");
Template emailTemplate = cfg.getTemplate("email.ftl");
StringWriter out = new StringWriter();
emailTemplate.process(employee,out);
 
 

不像在SSM框架中配置freemarker那样麻烦，这里就几行代码：

1.根据所使用的freemarker版本号创建一个Configuration对象
2.设置模板路径，模板路径的设置方法有好几个，我这里因为放在了resources目录下，因此使用了setClassLoaderForTemplateLoading方法
3.创建模板，通过process方法进行渲染，渲染后的html将放到out这个变量中，然后我们在邮件中直接将之发送出去即可。

OK，经过以上步骤，我们就顺利的生成了一封邮件。完整过程小伙伴可以star我们的vhr项目并仔细研究。

本系列其他文章：

1.SpringBoot+Vue前后端分离，使用SpringSecurity完美处理权限问题(一)
2.SpringBoot+Vue前后端分离，使用SpringSecurity完美处理权限问题(二)
3.SpringSecurity中密码加盐与SpringBoot中异常统一处理
4.axios请求封装和异常统一处理
5.权限管理模块中动态加载Vue组件
6.SpringBoot+Vue前后端分离，使用SpringSecurity完美处理权限问题(六)
7.vhr部门管理数据库设计与编程
8.使用MyBatis轻松实现递归查询与存储过程调用
9.ElementUI中tree控件踩坑记
10.SpringBoot中自定义参数绑定
11.SpringBoot中使用POI，快速实现Excel导入导出
12.SpringBoot中发送QQ邮件