如何使用 Apache POI 在 docx 中用 HTML 替换文本（标签）？答案

【问题标题】：How to replace text(tag) with HTML in docx using Apache POI?如何使用 Apache POI 在 docx 中用 HTML 替换文本（标签）？
【发布时间】：2019-05-20 15:32:30
【问题描述】：

我们将有一些模板 docx 文件，其中将有一些标签，如 ${content}。我需要用 HTML 替换这个标签。

为此，我想在 XWPFDocument 中使用 altChunk 元素。在How to add an altChunk element to a XWPFDocument using Apache POI 中回答之后，我可以将 altChunk 放在 docx 的末尾。

如何用它替换我的标签？或者我可以使用任何其他库，可能是 docx4j？

统一更新： 带有标签的模板 docx 文件由最终用户使用 MS Word 创建，如下所示：

【问题讨论】：

"如何用它替换我的标签？"取决于标签在哪里。根据 Office Open XML 规范，altChunk 只能出现在 IBody 元素中。因此，如果您的${content} 在文本运行中，则不能用altChunk 替换。只有当${content} 是它自己的IBodyElement 时，才能找到IBodyElement，创建XMLCursor，插入altChunk，然后删除IBodyElement。
@AxelRichter，如果这个标签是用MS Word写的，它是否被认为是IBodyElement？如果没有，您知道如何使用 MS Word 制作 IBodyElement 吗？请参阅我的更新。可能我不应该替换，可能我可以将它放在标签之后，然后删除带有标签的文本。有什么想法吗？
看起来好像是它自己的段落，所以它是IBodyElement。今晚将尝试提供解决方案（德国）。

标签： java html apache-poi docx

【解决方案1】：

如果“${content}”在它自己的IBodyElement 中，则通过找到IBodyElement、创建XmlCursor、插入altChunk、然后删除IBodyElement 来解决该要求有可能。

以下代码通过扩展How to add an altChunk element to a XWPFDocument using Apache POI 中的示例来演示这一点。它提供了一种用引用MyXWPFHtmlDocument 的altChunk 替换找到的包含特殊文本的IBodyElement 的方法。它使用XmlCursor 来获取文本正文中所需的位置。代码中注释了XmlCursor的用法。

模板.docx：

代码：

import java.io.*;

import org.apache.poi.*;
import org.apache.poi.ooxml.*;
import org.apache.poi.openxml4j.opc.*;

import org.apache.poi.xwpf.usermodel.*;

import org.apache.xmlbeans.XmlCursor;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTAltChunk;

public class WordInsertHTMLaltChunkInDocument {

 //a method for creating the htmlDoc /word/htmlDoc#.html in the *.docx ZIP archive  
 //String id will be htmlDoc#.
 private static MyXWPFHtmlDocument createHtmlDoc(XWPFDocument document, String id) throws Exception {
  OPCPackage oPCPackage = document.getPackage();
  PackagePartName partName = PackagingURIHelper.createPartName("/word/" + id + ".html");
  PackagePart part = oPCPackage.createPart(partName, "text/html");
  MyXWPFHtmlDocument myXWPFHtmlDocument = new MyXWPFHtmlDocument(part, id);
  document.addRelation(myXWPFHtmlDocument.getId(), new XWPFHtmlRelation(), myXWPFHtmlDocument);
  return myXWPFHtmlDocument;
 }

 //a method for replacing a IBodyElement containing a special text with CTAltChunk which
 //references MyXWPFHtmlDocument
 private static void replaceIBodyElementWithAltChunk(XWPFDocument document, String textToFind, 
                                                     MyXWPFHtmlDocument myXWPFHtmlDocument) throws Exception {
  int pos = 0;
  for (IBodyElement bodyElement : document.getBodyElements()) {
   if (bodyElement instanceof XWPFParagraph) {
    XWPFParagraph paragraph = (XWPFParagraph)bodyElement;
    String text = paragraph.getText();
    if (text != null && text.contains(textToFind)) {
     //create XmlCursor at this paragraph
     XmlCursor cursor = paragraph.getCTP().newCursor();
     cursor.toEndToken(); //now we are at end of the paragraph
     //there always must be a next start token. Either a p or at least sectPr.
     while(cursor.toNextToken() != org.apache.xmlbeans.XmlCursor.TokenType.START);
     //now we can insert the CTAltChunk here
     String uri = CTAltChunk.type.getName().getNamespaceURI();
     cursor.beginElement("altChunk", uri);
     cursor.toParent();
     CTAltChunk cTAltChunk = (CTAltChunk)cursor.getObject();
     //set the altChunk's Id to reference the given MyXWPFHtmlDocument
     cTAltChunk.setId(myXWPFHtmlDocument.getId());

     //now remove the found IBodyElement
     document.removeBodyElement(pos);

     break; //break for each loop
    }
   }
   pos++;
  }
 }

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

  XWPFDocument document = new XWPFDocument(new FileInputStream("template.docx"));

  MyXWPFHtmlDocument myXWPFHtmlDocument = createHtmlDoc(document, "htmlDoc1");
  myXWPFHtmlDocument.setHtml(myXWPFHtmlDocument.getHtml().replace("<body></body>",
   "<body><p>Simple <b>HTML</b> <i>formatted</i> <u>text</u></p></body>"));

  replaceIBodyElementWithAltChunk(document, "${content}", myXWPFHtmlDocument);

  FileOutputStream out = new FileOutputStream("result.docx");
  document.write(out);
  out.close();
  document.close();

 }

 //a wrapper class for the  htmlDoc /word/htmlDoc#.html in the *.docx ZIP archive
 //provides methods for manipulating the HTML
 //TODO: We should *not* using String methods for manipulating HTML!
 private static class MyXWPFHtmlDocument extends POIXMLDocumentPart {

  private String html;
  private String id;

  private MyXWPFHtmlDocument(PackagePart part, String id) throws Exception {
   super(part);
   this.html = "<!DOCTYPE html><html><head><style></style><title>HTML import</title></head><body></body>";
   this.id = id;
  }

  private String getId() {
   return id;
  }

  private String getHtml() {
   return html;
  }

  private void setHtml(String html) {
   this.html = html;
  }

  @Override
  protected void commit() throws IOException {
   PackagePart part = getPackagePart();
   OutputStream out = part.getOutputStream();
   Writer writer = new OutputStreamWriter(out, "UTF-8");
   writer.write(html);
   writer.close();
   out.close();
  }

 }

 //the XWPFRelation for /word/htmlDoc#.html
 private final static class XWPFHtmlRelation extends POIXMLRelation {
  private XWPFHtmlRelation() {
   super(
    "text/html", 
    "http://schemas.openxmlformats.org/officeDocument/2006/relationships/aFChunk", 
    "/word/htmlDoc#.html");
  }
 }
}

结果.docx：

【讨论】：

您的解决方案非常完美。我有另一个问题。据我了解，当打开 docx 文件时，AltChunks 由 MS Word 转换。有没有办法使用 Apache POI 来做到这一点？为此，我尝试使用 docx4j。将我的 docx 加载到 WordprocessingMLPackage，从中获取 MainDocumentPart 并使用方法 convertAltChunks()。但是当我使用 LibreOffice 打开它时，AltChunks 是不可见的。
@Max:"有没有什么方法可以使用 Apache POI 将altChunk 转换为原生的Word 文档部分？"：不，没有。 “我尝试过使用 docx4j”：这是另一个库。因此，如果您在使用 docx4j 库时遇到问题，请单独提出一个问题。