AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

用FreeMarker生成Word文档

2016-11-22 1702
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 顾名思义, Word文档, document 有文档的意思, archive 也有文档的意思。.doc, .docx, .xls, .xlsx 等文件全部都是ZIP格式的，将文件重命名为 xxx.zip 之后，就可以看到压缩文件的结构了。

顾名思义, Word文档, document 有文档的意思, archive 也有文档的意思。

.doc, .docx, .xls, .xlsx 等文件全部都是ZIP格式的，将文件重命名为 xxx.zip 之后，就可以看到压缩文件的结构了。

MS-Office 97-2003 格式的文档称为二进制文档,存储结构较大。如果使用POI解析, 则使用 HWPFDocument 等 H 起头的类来解析。

而 MS-Office 2007,2010,2013,2016 支持的 .docx 等以 x结尾的文件, 用POI 则对应于 XWPFDocument 等以 X 起头的类来解析。

当然, POI 主要用来生成Office文档, 或者从文档中提取数据。 对于 Excel 等的支持较为友好。 而对于Word文档的支持，则显得太简陋了。

POI 原来的意思是 简陋的模糊实现(Poor Obfuscation Implementation)

当然，也不是绝对, 对于 .doc 格式的文档,POI直接提供了支持。 请参考: 使用POI读写word doc文件, 以及 使用POI读写word docx文件 这一系列的文章。

所以本文不讨论 .doc 文档,这种二进制文档,使用 FreeMarker 处理起来, 应该也讨不了好。请参考上面提到的haohaoxuexi 的博客.

盐归正传, 2007以后的Word,支持多种格式。最常见的是 .docx, 我熟悉的还有一种, .xml 格式。

XML 格式的Word替换

先创建一个模板Word文档, 里面输入需要的内容.

Microsoft Word 程序直接提供两种格式的转换. 方法为: 文件菜单 -> 另存为 -> Word XML文档(.xml) -> 保存 即可。

在安装了 Office 2007 及以上的系统中, 双击这个新保存的XML，会自动用Word打开。

看到这里，相信你也大致知道怎么处理了.

默认生成的XML文档是不换行的, 但也可以手工换行. 对于 .xml 格式的word文档, 找出需要替换的内容, 使用 FreeMarker 标签来处理即可。

类似这样:

<w:t>${xxxName}</w:t>

对于表格需要关注的标签主要是:

表格: <w:tbl>
列集合: <w:tblGrid>
列: <w:gridCol>
行: <w:tr>
单元格: <w:tc>
文本: <w:t>

docx 格式的Word替换

既然 docx 文件就是 zip 格式的,那么我们就可以将其中重要的 document.xml 给替换，就可以生成一个新的 docx 文档了。

抽取后,自己使用FreeMarker修改其中的内容,比如if,循环(list)等:

处理步骤:

  1. 创建模板 Word 文件,保存为 .docx 文件

  2. 复制并重命名.docx文件为 .zip 文件(修改后缀名不会影响文件内容)

  3. 打开 ZIP 文件,将 word/document.xml 文件提取出来. 只有这个文件保存了文档内容, 其他的文件应该是样式等额外的信息。

  4. 将 word/document.xml 文件 制作成模板.

  5. 动态替换 .zip 文件中的word/document.xml为 FreeMarker 文件生成的内容, 保存到另外的地方即可。

部分实现代码:

1、freemarker 依赖:

pom.xml

    <dependency>
        <groupId>org.freemarker</groupId>
        <artifactId>freemarker</artifactId>
        <version>2.3.23</version>
    </dependency>

2、自定义的ZIP工具

ZipUtils.java

import java.io.*;
import java.util.zip.*;

public class ZipUtils {
    /**
     * 替换某个 item,不关闭任何输入输出流
     * @param zipInputStream zip文件的zip输入流
     * @param zipOutputStream 输出的zip输出流
     * @param itemName 要替换的 item 名称
     * @param itemInputStream 要替换的 item 的内容输入流
     */
    public static void replaceItem(ZipInputStream zipInputStream,
                   ZipOutputStream zipOutputStream,
                   String itemName,
                   InputStream itemInputStream
                   ){
    //
    if(null == zipInputStream){return;}
    if(null == zipOutputStream){return;}
    if(null == itemName){return;}
    if(null == itemInputStream){return;}
    //
    ZipEntry entryIn;
    try {
        while((entryIn = zipInputStream.getNextEntry())!=null)
        {
        String entryName =  entryIn.getName();
        ZipEntry entryOut = new ZipEntry(entryName);
        // 只使用 name
        zipOutputStream.putNextEntry(entryOut);
        // 缓冲区
        byte [] buf = new byte[8*1024];
        int len;

        if(entryName.equals(itemName)){
            // 使用替换流
            while((len = (itemInputStream.read(buf))) > 0) {
            zipOutputStream.write(buf, 0, len);
            }
        } else {
            // 输出普通Zip流
            while((len = (zipInputStream.read(buf))) > 0) {
            zipOutputStream.write(buf, 0, len);
            }
        }
        // 关闭此 entry
        zipOutputStream.closeEntry();
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
    }

    /**
     * 包装输入流
     */
    public static ZipInputStream wrapZipInputStream(InputStream inputStream){
    ZipInputStream zipInputStream = new ZipInputStream(inputStream);
    return zipInputStream;
    }

    /**
     * 包装输出流
     */
    public static ZipOutputStream wrapZipOutputStream(OutputStream outputStream){
    ZipOutputStream zipOutputStream = new ZipOutputStream(outputStream);
    return zipOutputStream;
    }
}

3、对Bean进行操作的相关工具方法

BeanUtils.java

import org.apache.commons.beanutils.BeanMap;
import java.util.*;

public class BeanUtils {
    /**
     * 将Bean对象转换成Map对象
     */
    public static Map<String, Object> toMap(Object obj) {
    Map<String, Object> map = new HashMap<String, Object>();
    if (obj == null) {
        return map;
    }

    if( obj instanceof Map) {
        map.putAll((Map)obj);
        return map;
    }
    BeanMap beanMap = new BeanMap(obj);
    Iterator<String> it = beanMap.keyIterator();
    while (it.hasNext()) {
        String name = it.next();
        Object value = beanMap.get(name);
        // 转换时会将类名也转换成属性，此处去掉
        if (value != null && !name.equals("class")) {
        map.put(name, value);
        }
    }
    return map;
    }
}

4、FreeMarker 辅助工具类

FreeMarkerHelper.java

import freemarker.template.*;

import java.io.*;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.zip.*;


public class FreeMarkerHelper {

    public static final String UTF_8 = "UTF-8";
    public static volatile String TEMPLATE_DEFAULT_DOCX = "asset/export_sample.docx";
    public static volatile String TEMPLATE_DEFAULT_XML = "asset/document.xml";
    public static String ENTRY_NAME = "word/document.xml";
    // 缓存的Template
    private static ConcurrentHashMap<String, Template> cachedTemplateMap = new ConcurrentHashMap<>();
    /**
     * FreeMarker 的全局配置量,只应该存在1份
     * 不需要重复创建 Configuration 实例； 
     * 它的代价很高，尤其是会丢失缓存(配置信息修改对多线程存在延迟)。
     * Configuration 实例就是应用级别的单例。
     */
    public static final Configuration cfg = new Configuration(Configuration.VERSION_2_3_23);
    private static final boolean hasInit = initConfiguration();

    private static boolean initConfiguration() {
    //
    cfg.setDefaultEncoding(UTF_8);
    cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
    //
    return true;
    }


    public static synchronized void parse2DocxAndClose(ExportVO bean, OutputStream outputStream){
    Map<String, Object> modelMap = new HashMap<>();
    if(null != bean){
        modelMap = BeanUtils.toMap(bean);
    }
    String templateURI = TEMPLATE_DEFAULT_XML;
    String docxTemplateURI = TEMPLATE_DEFAULT_DOCX;
    // 输出到 ByteArray(初始大小)
    ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream(16 * 1024);
    // 处理
    parse2OutputStream(modelMap, byteArrayOutputStream, templateURI);
    //
    byte[] byteArray = byteArrayOutputStream.toByteArray();
    // 特定项目的输入流
    ByteArrayInputStream itemInputStream = new ByteArrayInputStream(byteArray);
    //
    InputStream docxInputStream = FreeMarkerHelper.class.getClassLoader().getResourceAsStream(docxTemplateURI);
    //
    ZipInputStream zipInputStream = ZipUtils.wrapZipInputStream(docxInputStream);
    ZipOutputStream zipOutputStream = ZipUtils.wrapZipOutputStream(outputStream);
    //
    String itemname = ENTRY_NAME;
    //
    try{
        ZipUtils.replaceItem(zipInputStream, zipOutputStream, itemname, itemInputStream);
    } finally {
        close(itemInputStream);
        close(zipInputStream);
        close(zipOutputStream);
    }



    }

    private static void parse2OutputStream(Map<String, Object> modelMap, OutputStream outputStream, String templateURI){
    //
    if(null == modelMap){
        close(outputStream);
        return;
    }
    try {
        if(null != modelMap){
        // Writter 必须指定编码
        Writer out = new BufferedWriter(new OutputStreamWriter(outputStream, UTF_8));
        //
        Template temp = getTemplateByURI(templateURI);
        //
        temp.process(modelMap, out);
        }
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        close(outputStream);
    }
    }

    // 获取缓存
    private static Template getCachedTemplateByURI(String templateURI){
    //
    Template temp = cachedTemplateMap.get(templateURI);
    if(null == temp){
        temp = getTemplateByURI(templateURI);
    }
    //
    return temp;
    }
    // 获取缓存, 同步方法
    private static synchronized Template getTemplateByURI(String templateURI){
    //
    Template temp = cachedTemplateMap.get(templateURI);
    if(null != temp){
        return temp;
    }
    //
    String name = templateURI;//.substring(templateURI.lastIndexOf("/"));
    String sourceName = name;
    try {
        // reader 会自动被关闭
        InputStream inputStream = FreeMarkerHelper.class.getClassLoader().getResourceAsStream(templateURI);
        Reader reader = new InputStreamReader(inputStream, UTF_8);
        temp = new Template(name, sourceName, reader, cfg);
    } catch (Exception e) {
        e.printStackTrace();
    }
    //
    if(null != temp){
        cachedTemplateMap.put(templateURI, temp);
    }
    //
    return temp;
    }


    private static void close(InputStream inputStream){
    if (null != inputStream){
        try {
        inputStream.close();
        } catch (IOException e) {
        e.printStackTrace();
        }
    }
    }
    private static void close(OutputStream outputStream){
    if (null != outputStream){
        try {
        outputStream.flush();
        outputStream.close();
        } catch (IOException e) {
        e.printStackTrace();
        }
    }
    }
}

5. 导出模型

记得需要 getter 和 setter 方法

ExportVO.java

import java.util.*;

//导出VO
public class ExportVO {

    private String name;
    private Double xxxScore;
    private WordTableHeaderVO header;
    private List<WordTableRowVO> rows;

    public static ExportVO newInstance(){
    ExportVO exportVO = new ExportVO();
    return  exportVO;
    }
}

WordTableRowVO.java

import java.util.*;

//表格行信息,一个行就是一个 tr
public class WordTableRowVO {
    // 索引
    private int index = 0;
    // 单元格
    private List<WordTableCellVO> cells;
}

WordTableCellVO.java

//表格的单元格信息,一个单元格就是一个 td
public class WordTableCellVO {
    // 文本
    private String text;
}

WordTableHeaderVO.java

//表头信息,一个表头就是一个列 th
public class WordTableHeaderVO {
    // 列信息
    private List<WordTableColumnVO> columns;
}

WordTableColumnVO.java

//表头信息,一个表头就是一个列 th
public class WordTableColumnVO {
    // 宽度
    private int width;
    // 名称
    private String title;
}

6. 测试类

TestExport.java

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.junit.*;
import org.springframework.util.Assert;

import java.io.FileOutputStream;
import java.util.List;

public class TestExport {

private Log logger = LogFactory.getLog(this.getClass());

@Test
public  void testExportDocx(){
    String toPath = "/export_"+ System.currentTimeMillis() +".docx";
    ExportVO exportVO = getTestExportVO(); // ...
    //
    Assert.notNull(exportVO, "exportVO 不能为 null");
    //
    try {
        FileOutputStream fileOutputStream = new FileOutputStream(toPath);
        FreeMarkerHelper.parse2DocxAndClose(exportVO, fileOutputStream);
        logger.info("输出到" + toPath);
    } catch (Exception e) {
        logger.error(e);
    }
}
}

7、 其他资源

这些文件请自己制作

类路径下:

从 .docx 文件中提取出来的 word/document.xml 文件

asset/document.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<w:document ...>
<w:body><w:p ...>

...

<w:t>名称：</w:t></w:r><w:r ...>
<w:t>${name}</w:t></w:r><w:r ...>
<w:t>分类：</w:t></w:r><w:r ...>
<w:t>${categoryName}</w:t></w:r><w:r ...>
<w:t>类型</w:t></w:r><w:r ...>
<w:t>${typeName}</w:t></w:r><w:r ...></w:p>
<w:tbl><w:tblPr> ... </w:tblPr>
<w:tblGrid>
<#list header.columns as column>
<w:gridCol w:w="#{column.width}"/>
</#list>
</w:tblGrid>

<w:tr ...>
<#list header.columns as column>
<w:tc><w:tcPr><w:tcW w:w="0" w:type="auto"/>...<w:p><w:r>
<w:t>${(column.title)!""}</w:t></w:r></w:p>
</w:tc>
</#list>
</w:tr>

<#list rows as row>
<w:tr w:rsidR="005B02B4" ...>
<#list row.cells as cell>
<w:tc><w:tcPr><w:tcW w:w="0" w:type="auto"/>...<w:p><w:r>
<w:t>${(cell.text)!""}</w:t></w:r></w:p></w:tc>
</#list>
</w:tr>
</#list>

</w:tbl>
<w:p w:rsidR="00347318" ...><w:r ...>
<w:t>XXX题：</w:t></w:r>...
<w:t>${(xxxScore)!"1"}</w:t></w:r><w:r ...>
<w:t>YYY题：</w:t></w:r><w:r ...>
<w:t>${(yyyScore)!"1"}</w:t></w:r><w:r ...>
<w:t>备注：</w:t></w:r><w:r ...>
<w:t>${(xxxComment)!""}</w:t></w:r></w:p>

...

</w:body></w:document>

保存的 .docx 文件,当然,后缀名不重要,改为 xxx.zip 也行.

asset/export_sample.docx

此文件不需要处理,只是作为一个壳。。。
…
内容忽略
…

测试通过…

本文档GITHub地址: https://github.com/cncounter/translation/blob/master/tiemao_2016/22_xml_word_freemarker/xml_word_freemarker.md

日期: 2016年06月03日

作者: 铁锚: http://blog.csdn.net/renfufei

文章标签：
Java
数据格式
XML
缓存
铁锚
目录
相关文章
讓丄帝愛伱
|
Java
jsp页面中显示word/excel文档方法
jsp页面中显示word/excel文档方法
讓丄帝愛伱
152 0
游客tmj4hgt7bfvas
|
XML Java 数据格式
使用Java + Freemarker 导出word文档
使用Java + Freemarker 导出word文档
游客tmj4hgt7bfvas
639 0
赵广陆
|
XML 数据格式
Freemarker填充数据到word模板中
Freemarker填充数据到word模板中
赵广陆
130 1
逻辑峰
利用Freemarker动态生成PDF文档
利用Freemarker动态生成PDF文档
逻辑峰
335 0
pffkzc2qcmn6c
|
XML 数据格式
使用freemarker模板导出word文档
使用freemarker模板导出word文档
pffkzc2qcmn6c
470 0
使用freemarker模板导出word文档
陌然浅笑-支
|
XML Java 数据格式
POI解析Word2007并生成HTML内容标签
查阅一些资料后，经过不断地尝试和终于弄出想要的结果了。一些内容好多帖子都一样，实在看不出谁是原创，对于内容也给了一些灵感吧，那些都是实现读取之后又在转入另一个Word中，或者直接就把字符串内容拿出来。要么没有直接看到内容，要么与原Word中表格差异太大。 简单的读取就不阐述了，下面说一下我的吧，主要是读出来生成相应的<table></table>标签，便于使用和展示。但是并没有读取表格的详细样式配置。实际只需要读取内容以及单元格的跨行跨列即可。
陌然浅笑-支
434 1
POI解析Word2007并生成HTML内容标签
李子捌
|
Java 程序员 Apache
poi-tl—一个超级好用开源的Word模板引擎
poi-tl—一个超级好用开源的Word模板引擎
李子捌
1044 0
poi-tl—一个超级好用开源的Word模板引擎
jmcui
|
JSON Java 数据格式
Swagger文档转Word 文档
GitHub 地址：https://github.com/JMCuixy/SwaggerToWord 原创作品，转载请注明出处：http://www.cnblogs.com/jmcui/p/8298823.html 一、前言     为什么会产生这个需求呢？     我们公司作为乙方，老是被客户追着要一份API文档，当我们把一个 Swagger 文档地址丢给客户的时候。
jmcui
1491 0
技术小阿哥
|
XML Java 数据格式
使用Java模版引擎FreeMarker生成复杂的Word文档
技术小阿哥
3516 0
技术小美
|
Python
处理Word文档
技术小美
1626 0

热门文章

最新文章

  • 1
    天猫精灵开放平台-之小百科测评
  • 2
    语义检索系统：基于Milvus 搭建召回系统抽取向量进行检索，加速索引
  • 3
    3D立方体图片切换动画
  • 4
    模态对话框和非模态对话框
  • 5
    java03
  • 6
    冒泡排序
  • 7
    Windows XP客户端加域操作手册上
  • 8
    微信 6.5.1 for iOS发布 可以在朋友圈分享相册中的视频
  • 9
    Chapter 1: Creating the GUI Form and Adding Widgets
  • 10
    【Mockplus教程】帐号和购买
  • 1
    「Mac畅玩鸿蒙与硬件42」UI互动应用篇19 - 数字键盘应用
    34
  • 2
    赋能加速AI应用交付，F5 BIG-IP Next for Kubernetes方案解读
    29
  • 3
    RAG分块策略：主流方法（递归、jina-seg）+前沿推荐（Meta-chunking、Late chunking、SLM-SFT）
    25
  • 4
    Python学习的自我理解和想法（2）
    26
  • 5
    Transformer图解
    34
  • 6
    API安全专题：如何有效应对新型Bot攻击？
    17
  • 7
    Selenium IDE：Web自动化测试的得力助手
    31
  • 8
    《docker高级篇（大厂进阶）：5.Docker-compose容器编排》包括是什么能干嘛去哪下、Compose核心概念、Compose使用三个步骤、Compose常用命令、Compose编排微服务
    49
  • 9
    24/7全时守护：AI视频监控技术的深度实现与应用分享
    40
  • 10
    《docker高级篇（大厂进阶）：6.Docker轻量级可视化工具Portainer》
    25

    • 相关电子书

    更多
  • 低代码开发师（初级）实战教程
  • 冬季实战营第三期：MySQL数据库进阶实战
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    阿里云无影云电脑免费试用，最长可试用3个月