記錄一次用Java生成word文檔的經驗

業務背景

最近接到一個需求需要將學員的基本信息生成word格式的內容，word的格式如下圖所示

開發的任務就是將學員的信息替換掉表格中的** 即可，感覺還蠻簡單的。

相信大家以前做的最多的是Java和Excel的轉換的功能比較多吧，我也是如此，之前也沒有做過word轉換的功能，所以此次接到這個任務我也是一樣，從網上找方法，在網上找了一些博客論壇大概有幾種方法可以嘗試。

幾種解決思路

1：Jacob是Java-COM Bridge的縮寫，它在Java與微軟的COM組件之間構建一座橋樑。使用Jacob自帶的DLL動態鏈接庫，並通過JNI的方式實現了在Java平臺上對COM程序的調用。DLL動態鏈接庫的生成需要windows平臺的支持。該方案只能在windows平臺實現，是其侷限性。

2：Apache POI包括一系列的API，它們可以操作基於MicroSoft OLE 2 Compound Document Format的各種格式文件，可以通過這些API在Java中讀寫Excel、Word等文件。他的excel處理很強大，對於word還侷限於讀取，目前只能實現一些簡單文件的操作，不能設置樣式。

3：Java2word是一個在java程序中調用 MS Office Word 文檔的組件(類庫)。該組件提供了一組簡單的接口，以便java程序調用他的服務操作Word 文檔。 這些服務包括： 打開文檔、新建文檔、查找文字、替換文字，插入文字、插入圖片、插入表格，在書籤處插入文字、插入圖片、插入表格等。填充數據到表格中讀取表格數據 ，1.1版增強的功能： 指定文本樣式，指定表格樣式。如此，則可動態排版word文檔。是一種不錯的解決方案。

4：iText是著名的開放源碼的站點sourceforge一個項目，是用於生成PDF文檔的一個java類庫。通過iText不僅可以生成PDF或rtf的文檔，而且可以將XML、Html文件轉化爲PDF文件。功能強大。

5：JSP輸出樣式，該方案實現簡單，但是處理樣式有點缺陷，簡單的導出可以使用。

6：用XML做就很簡單了。Word從2003開始支持XML格式，大致的思路是先用office2003或者2007編輯好word的樣式，然後另存爲xml，將xml翻譯爲FreeMarker模板，最後用java來解析FreeMarker模板並輸出Doc。經測試這樣方式生成的word文檔完全符合office標準，樣式、內容控制非常便利，打印也不會變形，生成的文檔和office中編輯文檔完全一樣。

綜合以上資料的參考，和網上的一些意見，最後我選擇了，第6種用xml做導出方案。

開發流程

替換word模板

對照上面發的那個word格式，將** 替換成變量名稱，比如用戶名稱用${userName}表示，全部替換後的格式如下圖所示

導出xml格式並重命名ftl格式

將上圖的word文件另存爲xml格式，並且重命名爲ftl結尾的文件

編寫Java代碼

項目需要引用到freemaker的jar包，在pom.xml配置文件中，添加下面的依賴

<!-- freemarker jar -->
		<dependency>
	     <groupId>org.freemarker</groupId>
	     <artifactId>freemarker</artifactId>
	     <version>2.3.20</version>
	 	</dependency>

將ftl模板文件複製到項目的指定路徑下

將freemaker的配置文件放到項目的指定目錄下

編寫WordUtil.java

package com.xyq.maventest.util;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
/***
 * 
* Project Name:maventest
* <p>生成word工具類<br> 
*
* @ClassName: WordUtil
* @date 2019年2月20日  下午5:50:49
*
* @author youqiang.xiong
* @version 1.0
* @since  
* @see
 */
public class WordUtil {  
      
    private Configuration configuration = null;  
    
    /****
     * 模板文件存放的目錄
     */
    private static final String  baseDir = "F:/study/GIT/maventest/src/main/resources/freemaker";
    /***
     * 模板文件名稱
     */
    private static final String  templateFile = "template.ftl";
    /***
     * word生成的輸出目錄
     */
    private static final String  outputDir = "F:/file/";
      
    public WordUtil(){  
        configuration = new Configuration();  
        configuration.setDefaultEncoding("UTF-8");  
    }  
      
    public static void main(String[] args) {  
        WordUtil test = new WordUtil();  
        test.createWord();  
    }  
     
    /*****
     * 
    * Project Name: maventest
    * <p>轉換成word<br> 
    *
    * @author youqiang.xiong
    * @date 2019年2月21日  上午11:22:03
    * @version v1.0
    * @since
     */
    public void createWord(){  
        Map<String,Object> dataMap=new HashMap<String,Object>();  
        //構造參數
        getData(dataMap);  
        
        configuration.setClassForTemplateLoading(this.getClass(), "");//模板文件所在路徑
        Template t=null;  
        try {  
        	configuration.setDirectoryForTemplateLoading(new File(baseDir));
        	t = configuration.getTemplate(templateFile);
        } catch (IOException e) {  
            e.printStackTrace();  
        }  
        File outFile = new File(outputDir+Math.random()*10000+".doc"); //導出文件
        Writer out = null;  
        try {  
            out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(outFile)));  
        } catch (FileNotFoundException e1) {  
            e1.printStackTrace();  
        }  
           
        try {  
            t.process(dataMap, out); //將填充數據填入模板文件並輸出到目標文件 
            System.out.println("生成成功...");
        } catch (TemplateException e) {  
            e.printStackTrace();  
        } catch (IOException e) {  
            e.printStackTrace();  
        }  
    }  
  
    /****
     * 
    * Project Name: maventest
    * <p>初始化數據map <br> 
    *
    * @author youqiang.xiong
    * @date 2019年2月21日  上午11:26:34
    * @version v1.0
    * @since 
    * @param dataMap
    * 		封裝數據的map
     */
    private void getData(Map<String, Object> dataMap) {  
        dataMap.put("userName", "劉德華");  
        dataMap.put("sex", "男");  
        dataMap.put("nation", "漢族");  
        dataMap.put("birthday", "1985-02-26");   
        dataMap.put("nationPlace", "春日部");  
        dataMap.put("politicalStatus", "黨員");  
        dataMap.put("graduationSchool", "雙葉幼稚園");  
        dataMap.put("lastBackground", "幼稚園");  
        dataMap.put("graduationMajor", "玩泥沙");  
        dataMap.put("workUnit", "NASA");  
        dataMap.put("business", "煮菜的");  
        dataMap.put("postalAddress", "lc");  
        dataMap.put("postalcode", "lc");  
        dataMap.put("mobile", "18898416969");  
        dataMap.put("admissionTicket", "lc");  
        dataMap.put("enterSchoolTime", "lc");  
        dataMap.put("emergencyContact", "lc");  
        dataMap.put("readingInstrouction", "lc");  
        dataMap.put("year", "2019");  
        dataMap.put("month", "02");  
        dataMap.put("day", "20");  
     
    }  
}

運行main方法，拋出如下異常：

freemarker.core.ParseException: Parsing error in template "template.ftl" in line 3, column 11570:
Encountered "<", but was expecting one of:
    <STRING_LITERAL>
    <RAW_STRING>
    "false"
    "true"
    <INTEGER>
    <DECIMAL>
    "."
    "+"
    "-"
    "!"
    "["
    "("
    "{"
    <ID>
	at freemarker.core.FMParser.generateParseException(FMParser.java:4672)
	at freemarker.core.FMParser.jj_consume_token(FMParser.java:4543)
	at freemarker.core.FMParser.UnaryExpression(FMParser.java:340)
	at freemarker.core.FMParser.MultiplicativeExpression(FMParser.java:452)
	at freemarker.core.FMParser.AdditiveExpression(FMParser.java:402)
	at freemarker.core.FMParser.RangeExpression(FMParser.java:573)
	at freemarker.core.FMParser.RelationalExpression(FMParser.java:528)
	at freemarker.core.FMParser.EqualityExpression(FMParser.java:493)
	at freemarker.core.FMParser.AndExpression(FMParser.java:602)
	at freemarker.core.FMParser.OrExpression(FMParser.java:625)
	at freemarker.core.FMParser.Expression(FMParser.java:238)
	at freemarker.core.FMParser.StringOutput(FMParser.java:1076)
	at freemarker.core.FMParser.Content(FMParser.java:2550)
	at freemarker.core.FMParser.OptionalBlock(FMParser.java:2761)
	at freemarker.core.FMParser.Root(FMParser.java:2933)
	at freemarker.template.Template.<init>(Template.java:193)
	at freemarker.cache.TemplateCache.loadTemplate(TemplateCache.java:419)
	at freemarker.cache.TemplateCache.getTemplate(TemplateCache.java:330)
	at freemarker.cache.TemplateCache.getTemplate(TemplateCache.java:205)
	at freemarker.template.Configuration.getTemplate(Configuration.java:740)
	at freemarker.template.Configuration.getTemplate(Configuration.java:665)
	at com.xyq.maventest.util.WordUtil.createWord(WordUtil.java:75)
	at com.xyq.maventest.util.WordUtil.main(WordUtil.java:53)
Exception in thread "main" java.lang.NullPointerException
	at com.xyq.maventest.util.WordUtil.createWord(WordUtil.java:88)
	at com.xyq.maventest.util.WordUtil.main(WordUtil.java:53)

這個錯誤估計很人都有遇到過，起初我並不知道報錯提示的是什麼原因，大概猜測應該是ftl模板出錯了，但是又不知道爲什麼會報錯，初步懷疑是不是word編寫的變量${}格式書寫有誤？ 後來返回修改word的變量格式逐步縮小問題原因所在，經過反覆試驗才發現，word轉換成xml格式的時候，如果文檔中有${}特殊符號的時候，轉換成xml格式會出現錯位的情況，如下所示：

因爲我對word生成xml這個機制並不是很瞭解，由於時間原因，也沒有深究這裏的根本原因，於是原因找到了，是生成ftl模板的時候格式有問題。那麼既然${}符合會被解析錯誤的話，那可以換一種思路，將word中的符合全部不需要，只留變量即可，如下所示：

然後重新生成xml文件，修改文件後綴ftl，打開模板文件，將模板文件複製到notepad++文件編輯器打開，
然後一個個將變量替換成${}即可，比如講userName 替換成 ${userName} 即可

一個個變量替換完畢後，將模板文件覆蓋原有的內容，重新運行WordUtil.java ，運行成功。並且在指定目錄下會生成一個新的word文件，打開word文件如下圖所示：

至此用Java生成word的功能已經完成，大家可以根據各自所需修改word模板即可。