使用 Java 生成 Word 页码的指南

在现代软件开发中，生成文档并添加特定的格式、样式和内容是一个常见的需求，尤其是在企业环境中。通过使用 Apache POI 库，开发者可以很方便地在 Java 中创建和操作 Word 文档。本文将详细介绍如何使用 Apache POI 在 Word 文档中添加页码，并展示相应的代码示例。

Apache POI 简介

Apache POI 是一个流行的 Java 库，用于读写 Microsoft Office 格式的文件，包括 Excel、Word 和 PowerPoint。它的功能强大、易于使用，适合于需要动态生成文档的场景。在本文中，我们将专注于 Word 文档。

设置开发环境

在本示例中，确保您已经在项目中引入 Apache POI 库。您可以通过 Maven 或 Gradle 来进行依赖管理。

以下是 Maven 的依赖配置示例：

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

创建 Word 文档并添加页码

下面的代码示例展示了如何创建一个新的 Word 文档，并在每一页的底部添加页码。

import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFHeaderFooterPolicy;
import org.apache.poi.xwpf.usermodel.XWPFHeader;
import org.apache.poi.xwpf.usermodel.XWPFFooter;
import org.apache.poi.xwpf.usermodel.FooterPart;

import java.io.FileOutputStream;
import java.io.IOException;

public class WordPageNumberExample {
    public static void main(String[] args) {
        // 创建一个新的 Word 文档
        XWPFDocument document = new XWPFDocument();
        
        // 创建页脚
        XWPFHeaderFooterPolicy policy = document.getHeaderFooterPolicy();
        if (policy == null) {
            policy = document.createHeaderFooterPolicy();
        }
        
        // 添加页码到页脚
        XWPFFooter footer = policy.createFooter(XWPFHeaderFooterPolicy.DEFAULT);
        XWPFParagraph footerParagraph = footer.createParagraph(); 
        footerParagraph.setAlignment(ParagraphAlignment.CENTER);
        
        String pageNumber = "Page: ";
        footerParagraph.createRun().setText(pageNumber + "${PAGE} of ${NUMBERPAGES}");
        
        // 在文档中添加一些内容
        for (int i = 0; i < 10; i++) {
            XWPFParagraph paragraph = document.createParagraph();
            paragraph.createRun().setText("这是一段示例文本，当前是第 " + (i + 1) + " 页。");
            paragraph.createRun().addBreak();
        }

        // 保存文档
        try {
            FileOutputStream out = new FileOutputStream("example.docx");
            document.write(out);
            out.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

代码示例解析

  1. 创建文档：使用 XWPFDocument 类实例化一个新的 Word 文档。
  2. 创建页脚策略：通过 XWPFHeaderFooterPolicy 创建一个页脚政策，用于定义页眉和页脚的内容。
  3. 添加页码：在页脚中创建一个段落，并使用 createRun() 方法添加页码。页码使用了专有符号 ${PAGE} 和 ${NUMBERPAGES}，会自动填充当前页数和总页数。
  4. 添加文本：使用循环向文档中添加示例文本。
  5. 保存文件：最后，将文档保存到指定位置。

Mermaid 图表表示

下面的 ER 图表展示了 Word 文档结构与页码添加部分的关系：

erDiagram
    WORD_DOCUMENT {
        string title
        string author
    }
    FOOTER {
        string content
    }
    PAGE_NUMBER {
        int currentPage
        int totalPages
    }
    
    WORD_DOCUMENT ||--o{ FOOTER: contains
    FOOTER ||--o{ PAGE_NUMBER: includes

结论

通过上面的示例，我们可以看到，使用 Apache POI 库在 Java 中生成 Word 文档并添加页码是一个相对简单的过程。本文不仅包含了基础的代码示例，还通过 ER 图展示了文档结构与页码的关系。这为那些需要批量生成文档并标准化格式的开发者提供了一个很好的起点。

无论是生成报告、合同还是其他类型的文档，使用 Java 和 Apache POI 库可以帮助开发者更有效地完成工作。希望本文对您有所帮助，您可以根据业务需要进一步扩展和自定义功能！