使用Java FreeMarker导出Word文档


前言

最近在一个项目中遇到要将列表中的数据导出为word的问题,通常情况下,对列表中的数据都导出为Excel格式的文件,这样易于对数据的操作,而且有更为成熟的解决方案,在公司内部的应用框架中更是做到了“一键导出”Excel的强大功能。可是这次的客户更熟悉和喜欢word的操作,所以还是必须得做导出word的功能。

关于导出word的实现,网上也有不少的解决方案,但大多都是通过Apache POI包去实现对word的读写等操作,POI操作较为复杂,且将各种文档样式都混进Java代码中,不仅臃肿可读性差,一旦客户需要更改一点点文档样式又得去改动Java代码,维护性差,而且对于更为复杂文档样式,用代码写起来更是“难受”。所以只得另寻其他的解决方案。偶然间看到了使用Java最有名的模板引擎FreeMarker来导出word的方案,通过模板去维护导出的文档,做到了文档样式和数据内容的分离,实现简单易于维护,感觉非常不错。自己也先做了个小示例确定方案不错之后再将其应用到业务系统中。还好自己以前使用过FreeMarker,对其语法还是比较熟悉,如果不熟悉请参考这里的一篇博客。

FreeMarker是一个用Java语言编写的模板引擎,它基于模板来生成文本输出。FreeMarker与Web容器无关,即在Web运行时,它并不知道Servlet或HTTP。它不仅可以用作表现层的实现技术,而且还可以用于生成XML,JSP或Java 等。

实现思路

需要导出的word文档是事先准备好的一个模板,文档数据所在的位置则必须按FreeMarker模板语法的占位符(如:${xxx})填充,然后将word文档保存(最好另存为,原模板也最后保留,便于以后修改)为xml格式的文件,然后使用文本编辑器打开检查并修改不合法或书写更好的FreeMarker语法。最后在后台服务端使用FreeMarker相关的包和类读取模板,返回模板所需的数据变量,输出word文件即可。

导出word功能示例

1、创建word模板

先创建你需要导出具体格式和样式的模板,数据用FreeMarker语法的占位符占据,如下图,红色圈住的部分则是占位符。

word模板

2、另存并编辑xml文件

创建好word模板之后,需要将word另存为xml格式的文件,这样易于查看和编辑为符合FreeMarker模板语法的xml文件,保证导出word数据的准确性,具体FreeMaker语法网上有很多,这里就不细说了。如下面两图中的对上图“散数据”和列表数据的的语法规则:

散数据的模板语法

循环列表中的数据语法

3、编写代码导出word

将修改好的xml文件放到项目工程中或者你的某一操作系统路径中(如下图),通过Java代码读取到该xml文件,然后构造相应的业务数据,通过FreeMarker将数据输出为word格式的文件即可。

test.xml存放目录结构

WordUtil类,是对word文档的一些常用操作。

package com.blinkfox.util;

import freemarker.template.Configuration;  
import freemarker.template.Template;  
import java.io.File;  
import java.io.IOException;  
import java.io.Writer;  
import java.util.Map;

/**
 * Created by blinkfox on 15-11-19.
 */
public class WordUtil {

    private Configuration configuration = null;

    /**
     * 构造方法
     */
    public WordUtil() {
        try {
            configuration = new Configuration();
            configuration.setDefaultEncoding("UTF-8");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 根据类路径获取模板
     * @param templatePath
     * @param templateName
     * @return
     * @throws IOException
     */
    private Template getTemplate(String templatePath, String templateName) throws IOException {
        configuration.setDirectoryForTemplateLoading(new File(templatePath));
        Template t = configuration.getTemplate(templateName);
        t.setEncoding("UTF-8");
        return t;
    }

    /**
     * 生成word文档
     * @param templatePath
     * @param templateName
     * @param dataMap
     * @param out
     */
    public void write(String templatePath, String templateName,
        Map<String, Object> dataMap, Writer out) {
        try {
            Template t = getTemplate(templatePath, templateName);
            t.process(dataMap, out);
            out.close();
        } catch (Exception e) {
            System.out.println(e.getMessage());
            e.printStackTrace();
        }
    }

}

ExportWordTest类就是我们实现导出word的具体类了,代码如下:

package com.blinkfox.test;

import com.blinkfox.util.WordUtil;  
import com.jfinal.kit.PathKit;  
import java.io.FileOutputStream;  
import java.io.OutputStreamWriter;  
import java.io.Writer;  
import java.util.ArrayList;  
import java.util.HashMap;  
import java.util.List;  
import java.util.Map;

/**
 * Created by blinkfox on 15-11-19.
 */
public class ExportWordTest {

    /**
     * 构造测试数据
     * @return
     */
    public static Map<String, Object> createDatas() {
        Map<String, Object> testMap = new HashMap<String, Object>();
//      构造散数据
        testMap.put("author", "闪烁之狐");
        testMap.put("date", "2015-11-20");

//      构造列表循环数据存放在ArrayList集合中
        List<Map<String, String>> list = new ArrayList<Map<String, String>>();
        for (int i = 0; i < 5; i++) {
            Map<String, String> map = new HashMap<String, String>();
            map.put("xh", (i + 1) + "");
            map.put("name", "张三" + i);
            map.put("phone", "1381111222" + i);
            list.add(map);
        }
        testMap.put("datas", list);

        return testMap;
    }

    /**
     * @param args
     */
    public static void main(String[] args) {
        Map<String, Object> testMap = createDatas();
        WordUtil handler = new WordUtil();
        Writer out = null;
        try {
//          生成test.doc的word文件到某文件路径下
            FileOutputStream fos = new FileOutputStream("/home/blinkfox/文档/test.doc");
            out = new OutputStreamWriter(fos, "UTF-8");
            String templatePath = PathKit.getRootClassPath() + "/template/";
            handler.write(templatePath, "test.xml", testMap, out);
            System.out.println("导出成功!");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

4、导出word结果

在ExportWordTest类中执行main方法就可以在你导出word文件的路径中找到导出的文件啦,打开word文件如下图:

导出的word文档

大功告成,这就是通过FreeMarker导出Word文档的基本使用方法啦!



转载请注明:闪烁之狐 » 使用Java FreeMarker导出Word文档

分享到:
主题颜色面板