Java使用POI通过模板生成Word

最新推荐文章于 2025-08-21 12:12:44 发布
原创 最新推荐文章于 2025-08-21 12:12:44 发布 · 1.1w 阅读 · 69 ·
本内容遵循CC 4.0 BY-SA版权协议
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
标签
#java #poi #word
本文介绍了如何使用Java的POI库通过模板生成Word文档，详细讲解了POI操作Word的基本元素，如段落、表格、页眉页脚，并提供了读写Word的测试用例及实际案例。

Java使用POI通过模板生成Word

前言

最近工作需要用到，所以记录下来以便查找。

一、概述

POI读写word使用的核心类是XWPFDocument。一个XWPFDocument代表一个docx文档，其可以用来读docx文档，也可以用来写docx文档。

主要包含下面这几种对象：

  • XWPFParagraph：代表一个段落。
  • XWPFRun：代表具有相同属性的一段文本。
  • XWPFTable：代表一个表格。
  • XWPFTableRow：表格的一行。
  • XWPFTableCell：表格对应的一个单元格。

引用一段写的很好的结构说明：

原文：Poi之Word文档结构介绍

1、poi之word文档结构介绍之正文段落

一个文档包含多个段落，一个段落包含多个Runs，一个Runs包含多个Run，Run是文档的最小单元

获取所有段落：List<XWPFParagraph> paragraphs = word.getParagraphs();

获取一个段落中的所有Runs：List<XWPFRun> xwpfRuns = xwpfParagraph.getRuns();

获取一个Runs中的一个Run：XWPFRun run = xwpfRuns.get(index);

2、poi之word文档结构介绍之正文表格

一个文档包含多个表格，一个表格包含多行，一行包含多列（格），每一格的内容相当于一个完整的文档

获取所有表格：List<XWPFTable> xwpfTables = doc.getTables();

获取一个表格中的所有行：List<XWPFTableRow> xwpfTableRows = xwpfTable.getRows();

获取一行中的所有列：List<XWPFTableCell> xwpfTableCells = xwpfTableRow.getTableCells();

获取一格里的内容：List<XWPFParagraph> paragraphs = xwpfTableCell.getParagraphs();

之后和正文段落一样

注：

  1. 表格的一格相当于一个完整的docx文档，只是没有页眉和页脚。里面可以有表格，使用xwpfTableCell.getTables()获取。
  2. 在poi文档中段落和表格是完全分开的，如果在两个段落中有一个表格，在poi中是没办法确定表格在段落中间的。（当然除非你本来知道了，这句是废话）。只有文档的格式固定，才能正确的得到文档的结构

3、poi之word文档结构介绍之页眉：

一个文档可以有多个页眉(不知道怎么会有多个页眉。。。),页眉里面可以包含段落和表格

获取文档的页眉：List<XWPFHeader> headerList = doc.getHeaderList();

获取页眉里的所有段落：List<XWPFParagraph> paras = header.getParagraphs();

获取页眉里的所有表格：List<XWPFTable> tables = header.getTables();

之后就一样了

4、poi之word文档结构介绍之页脚：

页脚和页眉基本类似，可以获取表示页数的角标

二、用例测试

先使用代码去达到对word的读和写。

数据准备

编写一个word文档如下：

image-20210616172350172

源文件地址：

1- 读

/**
 * @Description 测试读取word文件
 * @Author hacah
 * @Date 2021/6/15 14:45
 */
public static void testReadWord() throws IOException {
    // 填写输入流
    XWPFDocument xwpfDocument = new XWPFDocument(new FileInputStream("E:\\OneDrive\\文档\\自我介绍.docx"));
    // 获取文本数据
    List<XWPFParagraph> paragraphs = xwpfDocument.getParagraphs();
    for (XWPFParagraph paragraph : paragraphs) {
        for (XWPFRun run : paragraph.getRuns()) {
            System.out.println(run.text());
        }
    }

    // 获取表格数据
    List<XWPFTable> tables = xwpfDocument.getTables();
    for (XWPFTable table : tables) {
        List<XWPFTableRow> rows = table.getRows();
        for (XWPFTableRow row : rows) {
            List<XWPFTableCell> tableCells = row.getTableCells();
            for (XWPFTableCell tableCell : tableCells) {
                List<XWPFParagraph> paragraphs1 = tableCell.getParagraphs();
                for (XWPFParagraph xwpfParagraph : paragraphs1) {
                    List<XWPFRun> runs = xwpfParagraph.getRuns();
                    for (XWPFRun run : runs) {
                        System.out.println(run);
                    }
                }
            }
        }
    }
}
public static void main(String[] args) throws IOException {
    testReadWord();
}

结果：

image-20210616173003505

2- 写

/**
 * @Description 测试使用模板写入数据，新建数据后的word
 * @author hacah
 * @Date 2021/6/15 15:09
 */
public static void testWriteWord() throws IOException {
    XWPFDocument xwpfDocument = new XWPFDocument(new FileInputStream("E:\\OneDrive\\文档\\自我介绍.docx"));
    FileOutputStream fileOutputStream = new FileOutputStream("E:\\OneDrive\\文档\\通过模板创建的数据.docx");

    // 获取第一段文件的第一个run
    XWPFRun xwpfRun = xwpfDocument.getParagraphs().get(0).getRuns().get(0);
    xwpfRun.setText("修改的数据");

    xwpfDocument.write(fileOutputStream);
    fileOutputStream.close();
}
public static void main(String[] args) throws IOException {
    testWriteWord();
}

结果：

image-20210616173147153

三、案例

使用未修改过的上文的原word的文件。对${}的数据进行替换，对空表格插入数据。

代码如下：

package com.hacah.word;

import org.apache.commons.codec.binary.StringUtils;
import org.apache.poi.util.StringUtil;
import org.apache.poi.xwpf.usermodel.*;

import java.io.*;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author Hacah
 * @className: templateToWord
 * @description: TODO 类描述
 * @date 2021/6/15 15:17
 */
public class templateToWord {

    /**
     * @param wordValue ${...} 带${}的变量
     * @param map       存储需要替换的数据
     * @return java.lang.String
     * @Description 有${}的值匹配出替换的数据，没有${}就返回原来的数据
     * @author hacah
     * @Date 2021/6/15 16:02
     */
    public static String matchesValue(String wordValue, Map<String, String> map) {
        for (String s : map.keySet()) {
            String s1 = new StringBuilder("${").append(s).append("}").toString();
            if (s1.equals(wordValue)) {
                wordValue = map.get(s);
            }
        }
        return wordValue;
    }

    /**
     * @return boolean
     * @Description 测试是否包含需要替换的数据
     * @author hacah
     * @Date 2021/6/15 15:30
     */
    public static boolean isReplacement(String text) {
        boolean check = false;
        if (text.contains("$")) {
            check = true;
        }
        return check;
    }
    
    /**
     * @Description 处理所有文段数据，除了表格
     * @param xwpfDocument
     * @param insertTextMap
     * @author hacah
     * @Date 2021/6/17 10:04
     */
    public static void handleParagraphs(XWPFDocument xwpfDocument, Map<String, String> insertTextMap) {
        for (XWPFParagraph paragraph : xwpfDocument.getParagraphs()) {
            String text = paragraph.getText();
            if (isReplacement(text)) {
                for (XWPFRun run : paragraph.getRuns()) {
                    // 判断带有${}的run
                    // System.out.println(run);
                    run.setText(matchesValue(run.text(), insertTextMap), 0);
                }
            }
        }

    }

    /**
     * @Description 通过word模板生成word的主方法
     * @param inputStream
     * @param outputStream
     * @param insertTextMap
     * @param addList
     * @author hacah
     * @Date 2021/6/17 10:03
     */
    public static void generateWord(InputStream inputStream, OutputStream outputStream, Map<String, String> insertTextMap, List<String[]> addList) throws IOException {
        //获取docx解析对象
        XWPFDocument xwpfDocument = new XWPFDocument(inputStream);

        // 处理所有文段数据，除了表格
        handleParagraphs(xwpfDocument, insertTextMap);
        // 处理表格数据
        handleTable(xwpfDocument, insertTextMap, addList);

        // 写出数据
        xwpfDocument.write(outputStream);
        outputStream.close();
    }
    
    /**
     * @Description 处理表格数据方法
     * @param xwpfDocument
     * @param insertTextMap
     * @param addList
     * @author hacah
     * @Date 2021/6/17 10:04
     */
    public static void handleTable(XWPFDocument xwpfDocument, Map<String, String> insertTextMap, List<String[]> addList) {
        List<XWPFTable> tables = xwpfDocument.getTables();
        for (XWPFTable table : tables) {
            List<XWPFTableRow> rows = table.getRows();
            if (rows.size() > 1) {
                if (isReplacement(table.getText())) {
                    // 替换数据
                    for (XWPFTableRow row : rows) {
                        List<XWPFTableCell> tableCells = row.getTableCells();
                        for (XWPFTableCell tableCell : tableCells) {
                            if (isReplacement(tableCell.getText())) {
                                // 替换数据
                                List<XWPFParagraph> paragraphs = tableCell.getParagraphs();
                                for (XWPFParagraph paragraph : paragraphs) {
                                    List<XWPFRun> runs = paragraph.getRuns();
                                    for (XWPFRun run : runs) {
                                        run.setText(matchesValue(tableCell.getText(), insertTextMap), 0);
                                    }
                                }
                            }
                        }
                    }
                } else {
                    // 插入数据
                    for (int i = 1; i < addList.size(); i++) {
                        XWPFTableRow row = table.createRow();
                    }
                    List<XWPFTableRow> rowList = table.getRows();
                    for (int i = 1; i < rowList.size(); i++) {
                        XWPFTableRow xwpfTableRow = rowList.get(i);
                        List<XWPFTableCell> tableCells = xwpfTableRow.getTableCells();
                        for (int j = 0; j < tableCells.size(); j++) {
                            XWPFTableCell xwpfTableCell = tableCells.get(j);
                            xwpfTableCell.setText(addList.get(i - 1)[j]);
                        }
                    }

                }


            }
        }
    }

    public static void main(String[] args) throws IOException {

        // 替换文本数据构建
        HashMap<String, String> insertTextMap = new HashMap<>(16);
        insertTextMap.put("like", "[爱好test]");
        insertTextMap.put("birthday", "[生日test]");
        insertTextMap.put("sex", "[性别test]");
        insertTextMap.put("name", "[姓名test]");
        insertTextMap.put("age", "[年龄test]");

        // 插入数据构建
        ArrayList<String[]> addList = new ArrayList<>();
        addList.add(new String[]{"【1插入电话】", "【2插入地址】", "【3插入邮箱】"});
        addList.add(new String[]{"【test插入电话2】", "【test插入地址2】", "【test插入邮箱2】"});

        // 设置模板输入和结果输出
        FileInputStream fileInputStream = new FileInputStream("E:\\OneDrive\\文档\\自我介绍.docx");
        FileOutputStream fileOutputStream = new FileOutputStream("E:\\OneDrive\\文档\\通过模板创建的数据.docx");
        // 生成word
        generateWord(fileInputStream, fileOutputStream, insertTextMap, addList);

    }
}

结果：

image-20210617100524291

参考或相关文章

https://www.iteye.com/blog/elim-2049110

https://www.jianshu.com/p/6603b1ea3ad1

Java中使用poi+poi-tl实现根据模板导出word文档
BADAO_LIUMANG_QIZHI的博客
03-01 5662
上面讲的是Excel的导出，如果是需要根据word文档的模板，比如根据数据库中数据或者其它数据源循环根据模板填充数据，可填充文字、图片、表格、图表等数据。
Java开发者必看：用poi-tl动态生成Word合同模板（含图片插入技巧）
最新发布
weixin_33686714的博客
04-01 375
本文详细介绍了Java开发者如何使用poi-tl库动态生成Word合同模板，包括图片插入技巧和Word转PDF的全流程实现。通过实战案例和代码示例，帮助开发者高效处理企业级合同自动化需求，提升文档生成效率与准确性。
poi模板操作word两种实现方式
songyilianblog的博客
07-09 4062
两种方式实现poi自由插入文字，图片，解析上传excel模板在word中生成table
poi实现word模板填充数据输出pdf
qq_41307221的博客
03-02 2172
poi实现word模板填充数据输出pdf
java基于POI根据word模板生成word文档并下载
Mr_hwt_123的博客
11-13 2970
前言：项目中通常会需要导出合同，导出周报等需求等。本文是基于poi技术，实现通过填充word模板生成word文件并支持下载。word模板数据填充是采用的占位符方式，其中数据采用key-value接口，推荐采用HashMap。
Java使用poi-tl1.9.1生成Word文档的几个小技巧
夜郎King的博客
07-18 2万+
本文将简单介绍poi-tl的相关知识，通过一个实际的案例实践，充分介绍如何利用poi-tl进行目标文档的生成，同时分享几个不同的office版本如何进行图表生成的解决方案
java根据word模板生成word文档_根据Word模板生成Word文件 (JAVA POI)
weixin_29802189的博客
02-16 2087
需求通过提前准备的word模板，渲染填充数据，生成新的加工好的word文件。(也试过使用Freemarker渲染数据，但是有个很大的弊端：使用Freemarker渲染的后文件会变大)用法POI的Maven依赖org.apache.poipoi3.8需要将模板参数设置成如下格式, 另存为word文档即可 直接放代码，仅供参考import com.cloudlead.common.worker.cli...
使用java Apache poi 根据word模板生成word报表
u012775558的博客
03-24 3万+
使用java Apache poi 根据word模板生成word报表 使用poi读取word模板，替换word中的{text}标签，并根据自定义标签循环生成表格或表格中的行。 代码示例下载：https://download.csdn.net/download/u012775558/10306308 注意，仅支持docx格式的word文件，大概是word2010及以后版本，doc格式不支持。 ...
java poi-tl 根据模板生成word、合并多个word文档
theScoreONE的博客
02-20 3167
java poi-tl 根据模板生成word、合并多个word文档
使用Java POI库模板快速生成Word文档
weixin_28895791的博客
08-21 1302
Java POI库是一个开源的Java库，能够用来读写Microsoft Office格式的文件，尤其在处理文档（DOC和DOCX格式）和电子表格（XLS和XLSX格式）方面功能强大。其主要优势在于提供了跨平台的支持和对原有文档格式的无缝兼容，这使得Java程序可以方便地创建和编辑各种办公文档。模板是文档处理中的重要元素，它定义了文档的布局、格式和样式。使用模板可以快速创建具有统一风格的文档，从而提高工作效率。
java word模板poi生成文件_利用poi读取word模板文件生成新的word文档
weixin_30041067的博客
02-26 1114
利用poi读取word模板文件生成新的word文档利用poi读取word模板文件，并回填逻辑数据，生成并导出需要的word文档源码。解决模板读取异常问题，提供wordUtils工具类(各种功能实现) 第一步： 项目结构见下图： 第二步： 前端界面见下第三步： 模板样式第四步： 输出结果核心代码如下：package com.word.poi.demo.controller;import com.w...
Java操作Word文档，根据模板生成文件
SongZhengxing_的博客
05-23 4824
官方文档：https://deepoove.com/poi-tl/poi-tl（poi template language）是Word模板引擎，使用模板和数据创建很棒的Word文档。在文档的任何地方做任何事情（）是poi-tl的星辰大海。方案移植性功能性易用性Poi-tlJava跨平台Word模板引擎，基于Apache POI，提供更友好的API低代码，准备文档模板和数据即可Apache POIJava跨平台Apache项目，封装了常见的文档操作，也可以操作底层XML结构。
java 根据word模板生成word文件
niligea的博客
05-31 2802
Java可以使用Apache POI库来生成Word文件，并且也可以使用freemarker等模板引擎来实现根据Word模板生成Word文件的功能。CTRL+f9生成域------》鼠标右键编辑域------》选择邮件合并-----》在域代码后面加上英文${跟代码内的一致}。的Word模板，然后准备了一些数据，利用Freemarker模板引擎将数据填充到模板中，最后生成了一个名为xxx。//其中key为word模板中的域名，value是需要替换的值。//将需要替换的数据数据添加到上下文中。
Java POI 生成Word文档
热门推荐
seawaterzhou的博客
01-09 6万+
在开发中有时候我们需要导出MS word文档。最近因为需要做一个生成word文件的功能。就将这块拿出来和大家分享。       生成word文件和我们写word文档是相同的概念，只不过在这里我们换成了用代码来操作。下面的例子中主要有添加页眉，页脚，正文(段落，表格)。在正文中，段落包含文字字体和背景的设置。表格主要是数据的填充和样式(有无边框)。这里写的例子给出的内容只是Java POI 方式生...
JAVA根据Word模板生成word文件
yueguanyun的专栏
12-11 1370
本次要做一个小工具，读取excel数据，然后生成word文件。二、工具类 WordUtils。
Java 操作 Office：POI 之 word 生成
程序员架构进阶
08-06 1748
一 背景 最近在项目开发中，有数据导出到word的需求。这就涉及代码生成word文档的操作，且有格式要求。 大家用word做过简历的都有了解，做简历时，会使用表格、图片、文字等元素。而且表格也可能有嵌套、合并单元格，以及插入图片到单元格的操作。该怎么做？ 二 Java操作Office方案 百度一下Java Office操作，或者再直接一点搜索Java word，就比较容易搜到iText、POI等组件。在文章 Java导出word的几种方式 这篇文章中，提到了包括Jacob、Apache POI、J..
java word模板 变量,Java-POI替换Word模板文档中的变量，生成Word文档
weixin_39783149的博客
03-13 1291
第一步：在项目中导入POI的jar包，以及相关的jar包。所需的jar包列表： 下载地址：http://download.csdn.net/download/qq_34908167/10046670第二步：建立util工具类。public class DocxUtil{/*** @Description: 将t中的字段转换成替换模板需要的数据${字段}-->字段值* 在word模板...
apache poi使用例_使用java Apache poi 根据word模板生成word报表例子
weixin_39883286的博客
12-21 234
【实例简介】使用java Apache poi 根据word模板生成word报表仅支持docx格式的word文件，大概是word2010及以后版本，doc格式不支持。使用说明：https://blog.csdn.net/u012775558/article/details/79678701【实例截图】【核心代码】使用javaApachepoi根据word模板生成word报表例子└── wordTe...
java通过poi-tl模板引擎生成表格（Word）
qq_45731464的博客
07-30 1万+
java通过poi-tl生成表格以及源码分析依赖模板如何动态生成表格参考文档及分析代码 最近导出的word文件要求是越来越多了，而且对样式也做了很多要求，今天参考文档学习了一下普通表格构建表格、动态构建word表格的方法。 依赖 <dependency> <groupId>com.deepoove</groupId> <artifactId>poi-tl</artifactId>
Java poi-tl 使用 word 模板 生成 word
ling_zhi_xin的博客
07-06 1714
poi-tl是一款基于Java的Word模板引擎，通过模板标签和数据模型快速生成Word文档。它支持跨平台使用，提供简单友好的API，只需准备模板文档和JSON数据即可渲染输出。主要特点包括：支持文本、图片、表格等多种元素；保留模板样式；标签可出现在文档任意位置；输出方式灵活。相比Apache POI、Freemarker等方案，poi-tl在功能性、易用性和移植性方面表现更优，是Java生态中处理Word文档的高效工具。
评论 13
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值