使用Freemarker匯出Word文件（包含圖片）程式碼實現及總結
阿新 • • 發佈：2018-12-16
本篇是關於利用FreeMarker匯出Word的實現步驟。採用FreeMarker非常的靈活，能夠按照自己指定的樣式設定並輸出內容，操作簡單方便，程式碼實現也容易。
下面是實現的效果圖：
下面是實現步驟：
1.新增FreeMarker需要的jar包（這裡用的是2.3.28版本，從網上的maven倉庫中獲取的）
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.28</version>
</dependency>2.然後製作需要匯出的Word模板。先利用office工具生成匯出怎樣的word樣式，如圖是我繪製的模板：
3.製作好了基本的樣式之後，然後另存為.xml格式文件，如：
4.開啟這個text.xml檔案，在相應的地方填入${xx}表示式：
5.填好後，使用其Notepad++或Sublime工具開啟檔案，能夠看到xml的內容如下：
如果有可能${}與 telephone 分離，則刪除分離後${}，然後在telephone上新增${}後儲存。另一種最安全的方式是：不刪除分離的${},先在telephone上新增${},儲存後，用word工具開啟test.xml，將原來分離的${}刪除即可。
6.成功修改後，將檔案重新命名為.ftl格式的檔案。然後將檔案放置在專案中或其他路徑。這裡我是將其拷貝至包中
7.接下來是程式碼層的實現
package com.myHelloWorld; import java.io.BufferedWriter; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException;import java.io.InputStream; import java.io.OutputStreamWriter; import java.io.Writer; import java.util.Map; import freemarker.core.ParseException; import freemarker.log.Logger; import freemarker.template.Configuration; import freemarker.template.MalformedTemplateNameException; import freemarker.template.Template; import freemarker.template.TemplateException; import freemarker.template.TemplateExceptionHandler; import freemarker.template.TemplateNotFoundException; import sun.misc.BASE64Encoder; /** * @Description 利用FreeMarker匯出Word * 2018年12月15日 下午10:23:40 * @Author Huang Xiaocong */ public class ExportMyWord { private Logger log = Logger.getLogger(ExportMyWord.class.toString()); private Configuration config = null; public ExportMyWord() { config = new Configuration(Configuration.VERSION_2_3_28); config.setDefaultEncoding("utf-8"); } /** * FreeMarker生成Word * @param dataMap 資料 * @param templateName 目標名 * @param saveFilePath 儲存檔案路徑的全路徑名（路徑+檔名） * @Author Huang Xiaocong 2018年12月15日 下午10:19:03 */ public void createWord(Map<String, Object> dataMap, String templateName, String saveFilePath) { //載入模板(路徑)資料 config.setClassForTemplateLoading(this.getClass(), ""); //設定異常處理器 這樣的話 即使沒有屬性也不會出錯 如：${list.name}...不會報錯 config.setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER); Template template = null; if(templateName.endsWith(".ftl")) { templateName = templateName.substring(0, templateName.indexOf(".ftl")); } try { template = config.getTemplate(templateName + ".ftl"); } catch (TemplateNotFoundException e) { log.error("模板檔案未找到", e); e.printStackTrace(); } catch (MalformedTemplateNameException e) { log.error("模板型別不正確", e); e.printStackTrace(); } catch (ParseException e) { log.error("解析模板出錯，請檢查模板格式", e); e.printStackTrace(); } catch (IOException e) { log.error("IO讀取失敗", e); e.printStackTrace(); } File outFile = new File(saveFilePath); if(!outFile.getParentFile().exists()) { outFile.getParentFile().mkdirs(); } Writer out = null; FileOutputStream fos = null; try { fos = new FileOutputStream(outFile); } catch (FileNotFoundException e) { log.error("輸出檔案時未找到檔案", e); e.printStackTrace(); } out = new BufferedWriter(new OutputStreamWriter(fos)); //將模板中的預先的程式碼替換為資料 try { template.process(dataMap, out); } catch (TemplateException e) { log.error("填充模板時異常", e); e.printStackTrace(); } catch (IOException e) { log.error("IO讀取時異常", e); e.printStackTrace(); } log.info("由模板檔案：" + templateName + ".ftl" + " 生成檔案 ：" + saveFilePath + " 成功！！"); try { out.close(); } catch (IOException e) { log.error("關閉Write物件出錯", e); e.printStackTrace(); } } /** * 獲得圖片的Base64編碼 * @param imgFile * @return * @Author Huang Xiaocong 2018年12月15日 下午10:15:10 */ public String getImageStr(String imgFile) { InputStream in = null; byte[] data = null; try { in = new FileInputStream(imgFile); } catch (FileNotFoundException e) { log.error("載入圖片未找到", e); e.printStackTrace(); } try { data = new byte[in.available()]; //注：FileInputStream.available()方法可以從輸入流中阻斷由下一個方法呼叫這個輸入流中讀取的剩餘位元組數 in.read(data); in.close(); } catch (IOException e) { log.error("IO操作圖片錯誤", e); e.printStackTrace(); } BASE64Encoder encoder = new BASE64Encoder(); return encoder.encode(data); } }
下面是測試類：
public static void main(String[] args) { ExportMyWord emw = new ExportMyWord(); Map<String, Object> dataMap = new HashMap<String, Object>(); dataMap.put("name", "黃xx"); dataMap.put("age", 26); dataMap.put("blog", "sun_flower火柴客"); dataMap.put("email", "[email protected]"); dataMap.put("gender", "男"); dataMap.put("imgheader", emw.getImageStr("D:\\picture\\23.jpg")); dataMap.put("telephone", "123456789101"); dataMap.put("address", "深圳"); dataMap.put("naturework", "全職"); dataMap.put("industry", "IT"); dataMap.put("aplication", "Java開發"); dataMap.put("time", "2013年-2017年"); dataMap.put("schoolname", "南昌大學"); dataMap.put("education", "本科"); dataMap.put("projectname", "電子證照xxxx"); dataMap.put("projecttime", "2017年3月"); dataMap.put("projectcontent", "我們除了有視、聽、味、嗅、觸這些外感系統之外，人類還有一個非常重要的內感系統，就是我們情緒和情感的世界。" + "這種感受是那樣地細膩、微妙、強烈、深沉；看不見、摸不著，說不清、道不明。..."); emw.createWord(dataMap, "test.ftl", "E:/簡歷.doc"); }
7.效果圖：
整個過程就是這樣。
對於需要多條記錄或迴圈的部分，只要在模板層的程式碼中新增標籤：
<#list></list>
這裡說下需要注意的點：
1.很多專案中採用的是Log4j或 Commons Logging日誌形式。而Freemarker自帶日誌型別，即：
若匯入的FreeMarker 2.3.x版本以下，可能回丟擲Freemarker模版快取問題：
Compiling FreeMarker template test.ftl[zh_CN,UTF-8,parsed] ....
Could not find template in cache
看官方解釋：
2.插入圖片的時候格外小心，因為可能匯出後是一堆圖片程式碼，那是因為模板未能識別這個圖片。說明匯出沒有問題，而是模板有問題。解決方案就是在原來的地方隨便插入一張圖片，然後在ftl中刪除圖片程式碼就可以了。