java根据模板，生成word文档，需要带目录

Question

请教大家一个问题，java根据模板，生成word文档，需要带目录，有什么好的办法吗？

Answer 1

引自免费微信小程序：皆我百晓生：

在Java中，基于模板生成带有目录的Word文档，可以采用Apache POI库这一强大工具。以下是一个详细的步骤指南及示例代码，帮助您实现所需功能：

步骤1：添加依赖

确保您的项目已包含Apache POI库。如果您使用的是Maven，将以下依赖项添加到pom.xml文件中：

<dependencies>
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi</artifactId>
        <version>5.2.3</version>
    </dependency>
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml</artifactId>
        <version>5.2.3</version>
    </dependency>
</dependencies>

步骤2：创建Word文档结构

按照模板设计文档结构，包括章节、子章节等，并为它们设置合适的标题样式（如Heading 1, Heading 2等）。这些标题样式将用于自动生成目录。

步骤3：编写Java代码

以下是一个完整的Java代码示例，展示如何基于模板生成带有目录的Word文档：

import org.apache.poi.xwpf.usermodel.*;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.*;

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

public class WordDocumentGenerator {

    public static void main(String[] args) throws IOException {
        String templatePath = "path/to/your/template.docx";
        String outputPath = "path/to/your/output.docx";

        generateWordDocumentWithTableOfContents(templatePath, outputPath);
    }

    private static void generateWordDocumentWithTableOfContents(String templatePath, String outputPath) throws IOException {
        // Load the template document
        XWPFDocument doc = new XWPFDocument(new FileInputStream(templatePath));

        // Generate table of contents (TOC)
        generateTableOfContents(doc);

        // Save the output document
        try (FileOutputStream out = new FileOutputStream(outputPath)) {
            doc.write(out);
        }
    }

    private static void generateTableOfContents(XWPFDocument doc) {
        // Define TOC settings
        CTOutline ctOutline = CTOutline.Factory.newInstance();
        CTSimpleField tocField = ctOutline.addNewSimpleField();
        tocField.setInstr("TOC \\o \"1-3\" \\h \\z \\u");

        // Add TOC to the document
        XWPFParagraph tocPara = doc.createParagraph();
        XWPFRun tocRun = tocPara.createRun();
        tocRun.setText("");
        tocPara.getCTP().addNewFldSimple().set(tocField);

        // Update fields in the document to ensure TOC is generated properly
        updateFields(doc);
    }

    private static void updateFields(XWPFDocument doc) {
        for (IBodyElement bodyElement : doc.getBodyElements()) {
            if (bodyElement instanceof XWPFParagraph) {
                XWPFParagraph paragraph = (XWPFParagraph) bodyElement;
                List<XWPFFieldRun> fieldRuns = paragraph.getFldRuns();

                for (XWPFFieldRun fieldRun : fieldRuns) {
                    fieldRun.updateFld();
                }
            }
        }
    }
}

解释说明：

1. generateWordDocumentWithTableOfContents方法用于加载模板文档、生成目录并保存输出文档。
2. generateTableOfContents方法负责在文档中插入一个TOC（Table Of Contents）字段。这里的CTSimpleField对象设置了TOC的格式化选项，例如\\o \"1-3\"表示显示级别1到3的标题，\\h表示页码与标题对齐，\\z表示不显示页码，\\u表示更新页码。您可以根据实际需求调整这些选项。
3. updateFields方法遍历文档中的所有段落，查找并更新所有字段（包括刚刚插入的TOC字段），确保目录信息正确生成。

注意事项：

• 确保模板文档中已应用了正确的标题样式（如Heading 1, Heading 2等），这些样式将被自动识别并包含在目录中。
• 运行上述代码后，打开生成的Word文档，可能需要手动更新域（通常通过右键点击目录区域选择“更新域”或按下F9键）以显示最新内容。

遵循以上步骤和示例代码，您应能成功使用Java根据模板生成带有目录的Word文档。如有任何问题，请随时提问。