前面寫了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 發送郵件的最後一篇了,希望對廣大小夥伴有用。