這篇文章,主要介紹如何使用Java+Freemarker模板引擎,根據(jù)XML模板文件生成Word文檔。
目錄
一、導(dǎo)出Word文檔
1.1、基礎(chǔ)知識
1.2、制作模板文件
1.3、代碼實(shí)現(xiàn)
(1)引入依賴
(2)創(chuàng)建Freemarker工具類
(3)測試案例代碼
(4)運(yùn)行效果
一、導(dǎo)出Word文檔
1.1、基礎(chǔ)知識
Word文件有兩種后綴格式,分別是:doc和docx,doc是Word2003之前使用的,docx是Word2007之后使用的,可以說docx是對doc的擴(kuò)展和優(yōu)化。docx的響應(yīng)速度、性能、占用空間都比doc更好,另外docx本質(zhì)上是一個zip格式的壓縮文件,底層是基于OOXML組織數(shù)據(jù)的,也就是說,docx底層其實(shí)就是使用XML組成的一系列文件,然后使用程序渲染XML文件,最終就是我們看到的Word文件樣式啦。
我這篇文章中使用的Word模板文件就是利用docx后綴的,核心思想是將docx文件轉(zhuǎn)換成對應(yīng)的XML文件,然后修改XML文件中的內(nèi)容,將其改成Freemarker模板引擎中的占位符,之后通過Freemarker渲染程序?qū)⒄嘉环鎿Q成實(shí)際的數(shù)據(jù),并且將替換之后的模板文件轉(zhuǎn)換成docx文檔,這樣就實(shí)現(xiàn)了根據(jù)模板文件生成Word文檔啦。
- 注意:freemarker中的占位符是${},例如:這里使用的是【${name}】的形式,那么傳遞的數(shù)據(jù)中就需要有一個叫做【name】的字段。
1.2、制作模板文件
首先創(chuàng)建一個docx后綴的Word文件,文件中的內(nèi)容你自己根據(jù)實(shí)際需求編寫就可以啦,我創(chuàng)建的docx文件內(nèi)容如下所示:
內(nèi)容編輯完成之后,將其另存為XML文件,如下圖所示:
導(dǎo)出XML文件之后,打開這個文件,此時你會看到里面都是XML標(biāo)簽,首先格式化一下,這樣看起來會舒服些,可以檢查一下你的占位符內(nèi)容是否滿足freemarker語法。因?yàn)橛行r候,我們導(dǎo)出的XML文件中,可能會將【${xxx}】分隔成兩行,從而導(dǎo)致占位符失效,所以有時候需要手動修改一下占位符。導(dǎo)出的Word XML文件內(nèi)容大致如下所示:
替換完成之后,我們的Word模板文件就做好啦,這個XML文件就是我們最終需要的Word模板文件,后面需要使用到。
1.3、代碼實(shí)現(xiàn)
(1)引入依賴
如果是SpringBoot的工程,SpringBoot已經(jīng)給我們提供了freemarker的啟動器,這使得我們可以快速的集成freemarker,如下:
<!-- 引入 freemarker 依賴 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
如果是普通的Java工程,可以引入下面的依賴:
<!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
(2)創(chuàng)建Freemarker工具類
引入freemarker依賴之后,就可以使用Freemarker編寫一個工具類,專門用于處理文件的導(dǎo)出和數(shù)據(jù)渲染。
package com.gitcode.demo.util;
import freemarker.template.Configuration;
import freemarker.template.Template;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.OutputStreamWriter;
import java.nio.charset.StandardCharsets;
import java.util.Map;
/**
* @version 1.0.0
* @Date: 2023/8/4 15:05
* @Author ZhuYouBin
* @Description: Freemarker 工具類
*/
public class FreemarkerUtil {
/**
* 使用 Freemarker 生成 Word 文件
* @param templateName 模板文件路徑名稱
* @param fileName 生成的文件路徑以及名稱
* @param dataModel 填充的數(shù)據(jù)對象
*/
public static void exportWord(String templateName, String fileName, Map<String, Object> dataModel) {
generateFile(templateName, fileName, dataModel);
}
/**
* 使用 Freemarker 生成指定文件
* @param templateName 模板文件路徑名稱
* @param fileName 生成的文件路徑以及名稱
* @param dataModel 填充的數(shù)據(jù)對象
*/
private static void generateFile(String templateName, String fileName, Map<String, Object> dataModel) {
try {
// 1、創(chuàng)建配置對象
Configuration config = new Configuration(Configuration.VERSION_2_3_30);
config.setDefaultEncoding("utf-8");
config.setClassForTemplateLoading(FreemarkerUtil.class, "/templates");
// 2、獲取模板文件
Template template = config.getTemplate(templateName);
// 3、創(chuàng)建生成的文件對象
File file = new File(fileName);
FileOutputStream fos = new FileOutputStream(file);
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(fos, StandardCharsets.UTF_8));
// 4、渲染模板文件
template.process(dataModel, writer);
// 5、關(guān)閉流
writer.close();
} catch (Exception e) {
e.printStackTrace();
}
}
}
(3)測試案例代碼
package com.gitcode.demo.word;
import com.gitcode.demo.util.FreemarkerUtil;
import java.util.HashMap;
import java.util.Map;
/**
* @version 1.0.0
* @Date: 2023/8/4 15:26
* @Author ZhuYouBin
* @Description: 使用 Freemarker 導(dǎo)出 Word 文件
*/
public class ExportWordDemo {
public static void main(String[] args) {
String templateName = "freemarker模板文件.xml";
String fileName = "導(dǎo)出的word文檔.docx";
Map<String, Object> dataModel = new HashMap<>();
dataModel.put("name", "張三");
dataModel.put("sex", "男");
dataModel.put("age", "20");
dataModel.put("address", "xxx地址yyy號");
// 執(zhí)行導(dǎo)出
FreemarkerUtil.exportWord(templateName, fileName, dataModel);
}
}
(4)運(yùn)行效果
運(yùn)行測試案例的代碼,然后在工程目錄下,就可以看到生成的Word文檔,內(nèi)容如下所示:
上面的模板文件只是簡單的文本,你也可以添加表格、圖片等內(nèi)容到模板文件里面,可以使用Freemarker中的循環(huán)標(biāo)簽實(shí)現(xiàn)表格數(shù)據(jù)的自動添加,圖片內(nèi)容是采用base64編碼,所以需要讀取圖片將其轉(zhuǎn)換成base64編碼之后,再渲染到XML文件中,后面的文章在介紹表格和圖片的模板導(dǎo)出。
到此,F(xiàn)reemarker導(dǎo)出Word文檔就介紹完啦。文章來源:http://www.zghlxwxcb.cn/news/detail-637317.html
綜上,這篇文章結(jié)束了,主要介紹如何使用Java+Freemarker模板引擎,根據(jù)XML模板文件生成Word文檔。文章來源地址http://www.zghlxwxcb.cn/news/detail-637317.html
到了這里,關(guān)于【導(dǎo)出Word】如何使用Java+Freemarker模板引擎,根據(jù)XML模板文件生成Word文檔(只含文本內(nèi)容的模板)的文章就介紹完了。如果您還想了解更多內(nèi)容,請?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!