使用freemarker生成word,步驟詳解並奉上原始碼
1、 步驟
1、 用word編輯好模板
1、 普通字串替換為 ${string}
2、 表格迴圈用標籤
<#list userList as user>
姓名:${user.userName} , 性別:${user.sex}
</#list>
word模板原型如下圖:
最終生成的結果如下:
2、 將word模板另存為xml格式
選中 [ 僅儲存資料 ]
選擇 [ 保持wordML(K) ]
3、 將xml模板檔案字尾名改為.ftl
4、 編輯ftl檔案
搜尋關鍵字,補入 <#list userList as user> </#list>或其它freemarker標籤
如下圖:
2、 Java程式碼
package com.lun.utils;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.Map;
import freemarker.template.Configuration;
import freemarker.template.Template;
/**
* @Desc:word操作工具類
* @Author:張輪
* @Date:2014-1-22下午05:03:19
*/
public class WordUtil {
/**
* @Desc:生成word檔案
* @Author:張輪
* @Date:2014-1-22下午05:33:42
* @param dataMap word中需要展示的動態資料,用map集合來儲存
* @param templateName word模板名稱,例如:test.ftl
* @param filePath 檔案生成的目標路徑,例如:D:/wordFile/
* @param fileName 生成的檔名稱,例如:test.doc
*/
@SuppressWarnings("unchecked")
public static void createWord(Map dataMap,String templateName,String filePath,String fileName){
try {
//建立配置例項
Configuration configuration = new Configuration();
//設定編碼
configuration.setDefaultEncoding("UTF-8");
//ftl模板檔案統一放至 com.lun.template 包下面
configuration.setClassForTemplateLoading(WordUtil.class,"/com/lun/template/");
//獲取模板
Template template = configuration.getTemplate(templateName);
//輸出檔案
File outFile = new File(filePath+File.separator+fileName);
//如果輸出目標資料夾不存在,則建立
if (!outFile.getParentFile().exists()){
outFile.getParentFile().mkdirs();
}
//將模板和資料模型合併生成檔案
Writer out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(outFile),"UTF-8"));
//生成檔案
template.process(dataMap, out);
//關閉流
out.flush();
out.close();
} catch (Exception e) {
e.printStackTrace();
}
}
}
package com.lun.action;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.net.URLDecoder;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Random;
import org.apache.struts2.ServletActionContext;
import com.lun.utils.WordUtil;
import com.opensymphony.xwork2.ActionSupport;
/**
* @Desc:生成word
* @Author:張輪
* @Date:2014-1-22下午04:52:03
*/
@SuppressWarnings("serial")
public class WordAction extends ActionSupport{
private String filePath; //檔案路徑
private String fileName; //檔名稱
private String fileOnlyName; //檔案唯一名稱
/**
* @Desc:生成word文件
* @Author:張輪
* @Date:2014-1-22下午07:29:58
* @return
*/
public String createWord() {
/** 用於組裝word頁面需要的資料 */
Map<String, Object> dataMap = new HashMap<String, Object>();
/** 組裝資料 */
dataMap.put("userName","張三");
SimpleDateFormat sdf=new SimpleDateFormat("yyyy年MM月dd日");
dataMap.put("currDate",sdf.format(new Date()));
dataMap.put("content","這是其它內容這是其它內容這是其它內容這是其它內容這是其它內容這是其它內容這是其它內容這是其它內容這是其它內容這是其它內容這是其它內容這是其它內容這是其它內容");
List<Map<String, Object>> newsList=new ArrayList<Map<String,Object>>();
for(int i=1;i<=10;i++){
Map<String, Object> map=new HashMap<String, Object>();
map.put("title", "標題"+i);
map.put("content", "內容"+(i*2));
map.put("author", "作者"+(i*3));
newsList.add(map);
}
dataMap.put("newsList",newsList);
/** 檔名稱,唯一字串 */
Random r=new Random();
SimpleDateFormat sdf1=new SimpleDateFormat("yyyyMMdd_HHmmss_SSS");
StringBuffer sb=new StringBuffer();
sb.append(sdf1.format(new Date()));
sb.append("_");
sb.append(r.nextInt(100));
//檔案路徑
filePath=ServletActionContext.getServletContext().getRealPath("/")+"upload";
//檔案唯一名稱
fileOnlyName = "用freemarker匯出的Word文件_"+sb+".doc";
//檔名稱
fileName="用freemarker匯出的Word文件.doc";
/** 生成word */
WordUtil.createWord(dataMap, "news.ftl", filePath, fileOnlyName);
return "createWordSuccess";
}
/**
* @Desc:下載生成的word文件,入口,用來跳轉至struts XML配置
* @Author:張輪
* @Date:2014-1-22下午07:36:29
* @return
*/
public String dowloadWord() {
/** 先判斷檔案是否已生成 */
try {
//解決中文亂碼
filePath = URLDecoder.decode(filePath, "UTF-8");
fileOnlyName = URLDecoder.decode(fileOnlyName, "UTF-8");
fileName = URLDecoder.decode(fileName, "UTF-8");
//如果檔案不存在,則會跳入異常,然後可以進行異常處理
new FileInputStream(filePath + File.separator + fileOnlyName);
} catch (Exception e) {
e.printStackTrace();
return "error";
}
return "dowloadWord";
}
/**
* @Desc:下載生成的word文件
* 該方法是struts.xml檔案中的: <param name="inputName">wordFile</param> 中自動對應的get方法,該方法自動呼叫
* @Author:張輪
* @Date:2014-1-22下午07:36:29
* @return 返回最終生成的word文件 檔案流
*/
public InputStream getWordFile(){
try {
//解決中文亂碼
fileName = URLDecoder.decode(fileName, "UTF-8");
/** 返回最終生成的word檔案流 */
return new FileInputStream(filePath + File.separator + fileOnlyName);
} catch (Exception e) {
e.printStackTrace();
return null;
}
}
public String getFilePath() {
return filePath;
}
public void setFilePath(String filePath) {
this.filePath = filePath;
}
public String getFileName() {
return fileName;
}
public void setFileName(String fileName) {
this.fileName = fileName;
}
public String getFileOnlyName() {
return fileOnlyName;
}
public void setFileOnlyName(String fileOnlyName) {
this.fileOnlyName = fileOnlyName;
}
}
struts2配置檔案如下:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
<package name="word" namespace="/" extends="struts-default">
<action name="createWord" class="com.lun.action.WordAction" method="createWord">
<result name="createWordSuccess" type="redirectAction">
<param name="actionName">dowloadWord</param>
<param name="filePath">${filePath}</param>
<param name="fileOnlyName">${fileOnlyName}</param>
<param name="fileName">${fileName}</param>
<param name="encode">true</param>
</result>
</action>
<action name="dowloadWord" class="com.lun.action.WordAction" method="dowloadWord">
<result name="dowloadWord" type="stream">
<param name="contentDisposition">attachment;filename="${fileName}"</param>
<param name="inputName">wordFile</param>
<param name="encode">true</param>
</result>
<result name="error">/error.jsp</result>
</action>
</package>
</struts>
頁面呼叫如下:
<input type="button" onclick="javascript:window.location.href='createWord.action'" value="生成Word"/>
3、 注意
1、 編輯word模板時,${string} 標籤最好是手動一次性輸入完畢,或者使用記事本統一將整個${string}編輯好之後,貼上至word裡邊。
也就是說,不要在word裡首先打完 ${ } 之後,又從其它地方把 string 字串貼上至 { } 之間,這樣在 word 轉化為 xml時,解析會有問題,freemarker解析時,會報錯。
將${} 和 string 分開錄入word,另存為xml後,後果將如下:
2、 如果word裡有需要迴圈表格列,也就是橫向迴圈表格時,建議儘量改為迴圈行,縱向迴圈,這樣可以減少對 ftl 檔案的 list標籤插入,縮減工作量。