Chuyển đổi phân đoạn chuỗi XML thành Nút tài liệu trong Java

Trong Java, làm thế nào bạn có thể chuyển đổi một Chuỗi đại diện cho một đoạn XML để chèn vào tài liệu XML?

ví dụ

String newNode =  "<node>value</node>"; // Convert this to XML

Sau đó, chèn nút này vào org.w3c.dom.Document làm nút con của một nút nhất định?

Element node =  DocumentBuilderFactory
    .newInstance()
    .newDocumentBuilder()
    .parse(new ByteArrayInputStream("<node>value</node>".getBytes()))
    .getDocumentElement();

Bạn có thể sử dụng phương thức nhập (hoặc áp dụng ) của tài liệu để thêm các đoạn XML:

  /**
   * @param docBuilder
   *          the parser
   * @param parent
   *          node to add fragment to
   * @param fragment
   *          a well formed XML fragment
   */
  public static void appendXmlFragment(
      DocumentBuilder docBuilder, Node parent,
      String fragment) throws IOException, SAXException {
    Document doc = parent.getOwnerDocument();
    Node fragmentNode = docBuilder.parse(
        new InputSource(new StringReader(fragment)))
        .getDocumentElement();
    fragmentNode = doc.importNode(fragmentNode, true);
    parent.appendChild(fragmentNode);
  }

Đối với những gì nó đáng giá, đây là một giải pháp tôi đã đưa ra bằng cách sử dụng thư viện dom4j . (Tôi đã kiểm tra xem nó có hoạt động không.)

Đọc phân đoạn XML thành một org.dom4j.Document(lưu ý: tất cả các lớp XML được sử dụng bên dưới là từ org.dom4j; xem Phụ lục):

  String newNode = "<node>value</node>"; // Convert this to XML
  SAXReader reader = new SAXReader();
  Document newNodeDocument = reader.read(new StringReader(newNode));

Sau đó lấy Tài liệu mà nút mới được chèn vào và Phần tử mẹ (sẽ là) từ đó. (Org.w3c.dom.Document của bạn sẽ cần được chuyển đổi thành org.dom4j.Document tại đây.) Với mục đích thử nghiệm, tôi đã tạo một tài liệu như thế này:

    Document originalDoc = 
      new SAXReader().read(new StringReader("<root><given></given></root>"));
    Element givenNode = originalDoc.getRootElement().element("given");

Thêm phần tử con mới rất đơn giản:

    givenNode.add(newNodeDocument.getRootElement());

Làm xong. Đầu ra originalDocbây giờ mang lại:

<?xml version="1.0" encoding="utf-8"?>

<root>
    <given>
        <node>value</node>
    </given>
</root>

Phụ lục : Vì câu hỏi của bạn nói về org.w3c.dom.Document, đây là cách chuyển đổi giữa câu hỏi đó và org.dom4j.Document.

// dom4j -> w3c
DOMWriter writer = new DOMWriter();
org.w3c.dom.Document w3cDoc = writer.write(dom4jDoc);

// w3c -> dom4j
DOMReader reader = new DOMReader();
Document dom4jDoc = reader.read(w3cDoc);

(Nếu bạn cần cả hai loại Documentthường xuyên, có thể hợp lý nếu đặt chúng trong các phương thức tiện ích gọn gàng, có thể trong một lớp được gọi XMLUtilshoặc một cái gì đó tương tự.)

Có thể có nhiều cách tốt hơn để làm điều này, ngay cả khi không có bất kỳ thư viện bên thứ ba nào. Nhưng trong số các giải pháp được trình bày cho đến nay, theo tôi đây là cách dễ nhất, ngay cả khi bạn cần thực hiện chuyển đổi dom4j <-> w3c.

Cập nhật (2011): trước khi thêm phụ thuộc dom4j vào mã của bạn, hãy lưu ý rằng nó không phải là một dự án được duy trì tích cực và cũng có một số vấn đề khác . Phiên bản cải tiến 2.0 đã có từ lâu nhưng chỉ có phiên bản alpha. Bạn có thể muốn xem xét một giải pháp thay thế, như XOM, để thay thế; đọc thêm trong câu hỏi được liên kết ở trên.

Đây là một giải pháp khác, sử dụng thư viện XOM , cạnh tranh với câu trả lời dom4j của tôi . (Đây là một phần trong nhiệm vụ của tôi để tìm một sự thay thế dom4j tốt trong đó XOM được đề xuất như một tùy chọn.)

Trước tiên, hãy đọc đoạn XML thành nu.xom.Document:

String newNode = "<node>value</node>"; // Convert this to XML
Document newNodeDocument = new Builder().build(newNode, "");

Sau đó, lấy Tài liệu và Nút theo đó phân đoạn được thêm vào. Một lần nữa, vì mục đích thử nghiệm, tôi sẽ tạo Tài liệu từ một chuỗi:

Document originalDoc = new Builder().build("<root><given></given></root>", "");
Element givenNode = originalDoc.getRootElement().getFirstChildElement("given");

Bây giờ, việc thêm nút con rất đơn giản và tương tự như với dom4j (ngoại trừ việc XOM không cho phép bạn thêm phần tử gốc ban đầu đã thuộc về newNodeDocument):

givenNode.appendChild(newNodeDocument.getRootElement().copy());

Việc xuất tài liệu sẽ mang lại kết quả chính xác XML (và rất dễ dàng với XOM: chỉ cần in chuỗi được trả về originalDoc.toXML()):

<?xml version="1.0"?>
<root><given><node>value</node></given></root>

(Nếu bạn muốn định dạng XML độc đáo (với thụt lề và dòng), hãy sử dụng a Serializer; cảm ơn Peter Štibraný đã chỉ ra điều này.)

Vì vậy, phải thừa nhận rằng điều này không khác lắm so với giải pháp dom4j. :) Tuy nhiên, XOM có thể tốt hơn một chút để làm việc, vì API được ghi chép tốt hơn và vì triết lý thiết kế của nó mà có một cách kinh điển để thực hiện mỗi việc.

Phụ lục : Một lần nữa, đây là cách chuyển đổi giữa org.w3c.dom.Documentvà nu.xom.Document. Sử dụng các phương thức trợ giúp trong DOMConverterlớp của XOM :

// w3c -> xom
Document xomDoc = DOMConverter.convert(w3cDoc);

// xom -> w3c
org.w3c.dom.Document w3cDoc = DOMConverter.convert(xomDoc, domImplementation);  
// You can get a DOMImplementation instance e.g. from DOMImplementationRegistry

/**
*
* Convert a string to a Document Object
*
* @param xml The xml to convert
* @return A document Object
* @throws IOException
* @throws SAXException
* @throws ParserConfigurationException
*/
public static Document string2Document(String xml) throws IOException, SAXException, ParserConfigurationException {

    if (xml == null)
    return null;

    return inputStream2Document(new ByteArrayInputStream(xml.getBytes()));

}


/**
* Convert an inputStream to a Document Object
* @param inputStream The inputstream to convert
* @return a Document Object
* @throws IOException
* @throws SAXException
* @throws ParserConfigurationException
*/
public static Document inputStream2Document(InputStream inputStream) throws IOException, SAXException, ParserConfigurationException {
    DocumentBuilderFactory newInstance = DocumentBuilderFactory.newInstance();
    newInstance.setNamespaceAware(true);
    Document parse = newInstance.newDocumentBuilder().parse(inputStream);
    return parse;
}

Nếu bạn đang sử dụng dom4j, bạn chỉ có thể làm:

Tài liệu tài liệu = DocumentHelper.parseText (văn bản);

(dom4j hiện được tìm thấy tại đây: https://github.com/dom4j/dom4j )

... và nếu bạn đang sử dụng hoàn toàn XOM, một cái gì đó như thế này:

    String xml = "<fakeRoot>" + xml + "</fakeRoot>";
    Document doc = new Builder( false ).build( xml, null );
    Nodes children = doc.getRootElement().removeChildren();
    for( int ix = 0; ix < children.size(); ix++ ) {
        otherDocumentElement.appendChild( children.get( ix ) );
    }

XOM sử dụng fakeRoot bên trong để làm khá nhiều điều tương tự, vì vậy nó sẽ an toàn, nếu không muốn nói là chính xác.

Hãy thử jcabi-xml , với một lớp lót:

Node node = new XMLDocument("<node>value</node>").node();