java使用freemaker 导出word 包含分页，表格循环，word改xml格式化

在平时项目开发中，相信或多或少的都遇到过word导出的需求，这里整理一个比较全面的java word导出方法，希望可以跟大家一起交流学习。

• 创建word模板

• 1.1 新建一个word模板，并修改字段

  

  1. 2 将word文件另存为xml 格式，打开xml 格式文件，你会发现你刚刚编写的会变成这样。
     
     这里推荐一个比较好用的编辑器 sublime 具体教程可以参考这一篇sublime

     安装好之后，修改刚刚的xml文件。
     
     把需要更改的变量都替换成${xxx}.改完后，把xml文档重命名成后缀为.ftl 的freemaker文件。

     1.3 列表和分页
     分页标签为 <w:p><w:r><w:br w:type="page"/></w:r></w:p>
     在word xml 格式中，<w:body></w:body> 表示的就是整个文本内容。我这里的业务需求是不同的类型的内容分页打印，既然<w:body></w:body> 表示整个文本内容，那么就可以在模板中写多个<w:body></w:body> ，不同的分类显示不同的word模板内容。我这里分了三类，就有三个不同的分页。
     
     列表循环
     如果你的模板中包含表格, 找到 <w:tbl></w:tbl> 标签，使用<#list></#list>指令 循环你的list<对象> 数据，然后使用 ${} 取到相应的值。
     
     自此，ftl 模板部分全部写完，将ftl 文件放入你电脑的某个位置，接下来可以开开心心的写java代码部分。

2.java后台编写

思路 ：1.编写读取ftl 模板以及参数的方法
2.查询你需要填入word的数据，放入map。注意map的key一定要跟你在ftl文件中填写的字段对应。
话不多说，直接上代码。

package cn.ys.common.utils;

import java.io.BufferedWriter;
import java.io.ByteArrayOutputStream;
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.PrintWriter;
import java.io.Writer;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.lang.StringUtils;
import org.apache.poi.POIXMLDocument;
import org.apache.poi.POIXMLTextExtractor;
import org.apache.poi.hwpf.HWPFDocument;
import org.apache.poi.hwpf.usermodel.Range;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.xwpf.extractor.XWPFWordExtractor;
import org.apache.poi.xwpf.usermodel.XWPFDocument;

import sun.misc.BASE64Encoder;
import cn.ys.common.web.HtmlMessage;

import com.google.common.collect.Maps;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;

public class WordUtils {

	private WordUtils() {
		throw new AssertionError();
	}
	/**
	 *
	 * @param templateFolder 你的ftl文件位置
	 * @param ftlFile  你的ftl 文件名
	 * @param map  需要渲染 数据
	 * @param localPath  生成word文档的位置    
	 * @param title  word文档名
	 * @return
	 * @throws IOException
	 */
	public static String exportWord(String templateFolder, String ftlFile, Map map, String localPath, String title) throws IOException {
		Configuration configuration = new Configuration();
		configuration.setDefaultEncoding("utf-8");
		configuration.setClassicCompatible(true);
		configuration.setDirectoryForTemplateLoading(new File(templateFolder)); //读取ftl 模板位置

		try {
			String datePath = DateUtils.getNowTime("yyyy/MM/dd");
			//使用时间为文件夹生成word生成的位置
			String path = localPath + "/word/" + datePath; 
			//定义word文档名称
			String fileName = title + ".doc";  
			//创建文件夹
			File outFile = new File(path + "/" + fileName);
			if (!outFile.getParentFile().exists()) {
				outFile.getParentFile().mkdirs();
			}
			//读取 模板内容
			Template template = configuration.getTemplate(ftlFile, "utf-8");

			Writer out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(outFile), "UTF-8"));

			template.process(map, out);

			out.flush();
			out.close();
			
			return path + "/" + fileName;
		} catch (TemplateException e) {
			e.printStackTrace();
		}
		return "";
	}


}

自此，你的doc文件实际上已经生成在你指定的文件夹了。 接下来如果让他能够使用文浏览器下载，只需要去读取你本地的这个文件就行。`

  @SuppressWarnings("unchecked")
    @RequestMapping(value = "/word/download/{id}")
    public void exportSupplier(@PathVariable("id") Integer gysbaId, HttpServletResponse response, HttpServletRequest request) {
        try {
 				//  注意这里的参数，根据你自己业务出入，参数说明上面已经注明！
                String downLoadPath = WordUtils.exportWord(templateFolder,ftlName,map,root,title);
                String fileName = map.get("message").toString();

                File file = new File(downLoadPath);
                InputStream inputStream;
                inputStream = new BufferedInputStream(new FileInputStream(file));
                byte[] buffer = new byte[inputStream.available()];
                inputStream.read(buffer);
                inputStream.close();

                response.reset();

                String userAgent = request.getHeader("user-agent").toLowerCase();
                if (userAgent.contains("msie") || userAgent.contains("like gecko")) {
                    fileName = URLEncoder.encode(fileName, "UTF-8");
                } else {
                    fileName = new String(fileName.getBytes("UTF-8"), "iso-8859-1");
                }

                response.setHeader("Content-disposition", String.format("attachment; filename=\"%s\"", fileName));

                response.addHeader("Content-Length", "" + file.length());

                response.setContentType("application/x-download");
                os.write(buffer);// 输出文件
                os.flush();
                os.close();
         
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

好的，大功告成！如果发现有什么问题，希望各位大佬指出，共同学习。

love & peace