如何使用 Java 编辑 MS Word 文档？

Question

我确实有几个 Word 模板，我的要求是使用 Java 根据用户输入替换文档中的一些单词/占位符。我尝试了很多库，包括 docx4j 的 2-3 个版本，但没有任何效果，它们都没有做任何事情！

我知道以前有人问过这个问题，但我尝试了所有我知道的选项。那么，使用什么 java 库我可以“真正”替换/编辑这些模板？我更喜欢“易于使用/几行代码”的类型库。

我使用的是 Java 8，我的 MS Word 模板在 MS Word 2007 中。

更新

此代码是使用SO成员Joop Eggen提供的代码示例编写的

public Main() throws URISyntaxException, IOException, ParserConfigurationException, SAXException
    {
        URI docxUri = new URI("C:/Users/Yohan/Desktop/yohan.docx");
        Map<String, String> zipProperties = new HashMap<>();
        zipProperties.put("encoding", "UTF-8");

         FileSystem zipFS = FileSystems.newFileSystem(docxUri, zipProperties);

           Path documentXmlPath = zipFS.getPath("/word/document.xml");

            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();

            factory.setNamespaceAware(true);
            DocumentBuilder builder = factory.newDocumentBuilder();

            Document doc = builder.parse(Files.newInputStream(documentXmlPath));

            byte[] content = Files.readAllBytes(documentXmlPath);
            String xml = new String(content, StandardCharsets.UTF_8);
            //xml = xml.replace("#DATE#", "2014-09-24");
            xml = xml.replace("#NAME#", StringEscapeUtils.escapeXml("Sniper"));

            content = xml.getBytes(StandardCharsets.UTF_8);
            Files.write(documentXmlPath, content);
    }

但是这会返回以下错误

java.nio.file.ProviderNotFoundException: Provider "C" Not found

at: java.nio.file.FileSystems.newFileSystem(FileSystems.java:341) at java.nio.file.FileSystems.newFileSystem(FileSystems.java:341)

at java.nio.fileFileSystems.newFileSystem(FileSystems.java:276)

Answer 1

对于 docx（带有 XML 和其他文件的 zip），可以使用 java zip 文件系统和 XML 或文本处理。

URI docxUri = ,,, // "jar:file:/C:/... .docx"
Map<String, String> zipProperties = new HashMap<>();
zipProperties.put("encoding", "UTF-8");
try (FileSystem zipFS = FileSystems.newFileSystem(docxUri, zipProperties)) {
    Path documentXmlPath = zipFS.getPath("/word/document.xml");

使用 XML 时：

    DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();

    factory.setNamespaceAware(true);
    DocumentBuilder builder = factory.newDocumentBuilder();

    Document doc = builder.parse(Files.newInputStream(documentXmlPath));
    //Element root = doc.getDocumentElement();

然后您可以使用 XPath 来查找这些位置，并重新写回 XML。

你甚至可能不需要 XML，但可以替换占位符：

    byte[] content = Files.readAllBytes(documentXmlPath);
    String xml = new String(content, StandardCharsets.UTF_8);
    xml = xml.replace("#DATE#", "2014-09-24");
    xml = xml.replace("#NAME#", StringEscapeUtils.escapeXml("Sniper")));
    ...
    content = xml.getBytes(StandardCharsets.UTF_8);
    Files.delete(documentXmlPath);
    Files.write(documentXmlPath, content);

为了快速开发，将 .docx 的副本重命名为具有 .zip 文件扩展名的名称，然后检查文件。

File.write 应该已经应用了 StandardOpenOption.TRUNCATE_EXISTING，但我添加了Files.delete，因为发生了一些错误。见 cmets。

Answer 2

试试Apache POI。 POI 可以与 doc 和 docx 一起使用，但 docx 记录更多，因此对它的支持更好。

UPD：您可以使用XDocReport，它使用 POI。另外我推荐使用xlsx作为模板，因为它更适合more documented

Answer 3

我在这个问题上花了几天时间，直到我发现文件系统实例上的try-with-resources 出现了差异，它出现在 Joop Eggen 的 sn-p 中，但没有问题 sn-p:
@ 987654323@
如果没有这样的try-with-resources 块，FileSystem 资源将不会关闭（如Java tutorial 中所述），并且不会修改 word 文档。

Answer 4

退一步说，有大约 4 种不同的方法来编辑单词/占位符：

• MERGEFIELD 或 DOCPROPERTY 字段（如果您在 docx4j 中遇到此问题，那么您可能没有正确设置输入 docx）
• content control databinding
• 文档表面的变量替换（在 DOM/SAX 级别，或使用库）
• 用 XHTML 做东西，然后import that

在选择一个之前，你应该决定你是否还需要能够处理：

• 重复数据（例如添加表格行）
• 有条件的内容（例如，存在或不存在的整个段落）
• 添加图片

如果您需要这些，那么 MERGEFIELD 或 DOCPROPERTY 字段可能已不存在（尽管您也可以使用 IF 字段，如果您能找到支持它们的库）。并且添加图像会使 DOM/SAX 操作如其他答案之一所倡导的那样，更加混乱且容易出错。

需要考虑的其他事项是：

• 您的作者：他们的技术水平如何？这对创作 UI 意味着什么？
• 您提到的用于变量替换的“用户输入”是给定的，还是获得它是您正在解决的问题的一部分？

Answer 5

请尝试这个来编辑或替换文档中的单词

public class UpdateDocument {

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

        UpdateDocument obj = new UpdateDocument();

        obj.updateDocument(
                  "c:\\test\\template.docx",
                  "c:\\test\\output.docx",
                  "Piyush");
    }

    private void updateDocument(String input, String output, String name)
        throws IOException {

        try (XWPFDocument doc = new XWPFDocument(
                Files.newInputStream(Paths.get(input)))
        ) {

            List<XWPFParagraph> xwpfParagraphList = doc.getParagraphs();
            //Iterate over paragraph list and check for the replaceable text in each paragraph
            for (XWPFParagraph xwpfParagraph : xwpfParagraphList) {
                for (XWPFRun xwpfRun : xwpfParagraph.getRuns()) {
                    String docText = xwpfRun.getText(0);
                    //replacement and setting position
                    docText = docText.replace("${name}", name);
                    xwpfRun.setText(docText, 0);
                }
            }

            // save the docs
            try (FileOutputStream out = new FileOutputStream(output)) {
                doc.write(out);
            }

        }

    }

}