Преобразовать фрагмент XML строки в узел документа в Java

Question

Как в Java можно преобразовать строку, представляющую фрагмент XML, для вставки в документ XML?

например.

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

Затем вставьте этот узел в org.w3c.dom.Document как дочерний узел данного узла?

Answer 1

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

Answer 2

Вы можете использовать метод документа import (или accept ) для добавления фрагментов 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);
  }

Answer 3

Для чего стоит, вот решение, которое я придумал, используя библиотеку dom4j . (Я проверял, что это работает.)

Считайте фрагмент XML в org.dom4j.Document (примечание: все используемые ниже классы XML взяты из org.dom4j; см. Приложение):

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

Затем получите Документ, в который вставлен новый узел, и родительский Элемент (который будет) из него. (Ваш org.w3c.dom.Document необходимо преобразовать в org.dom4j.Document здесь.) Для целей тестирования я создал такой как:

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

Добавить новый дочерний элемент очень просто:

    givenNode.add(newNodeDocument.getRootElement());

Готово. Вывод originalDoc теперь дает:

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

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

Приложение : поскольку в вашем вопросе говорится о org.w3c.dom.Document, вот как можно конвертировать между этим и 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);

(Если вам регулярно требуются оба вида Document, возможно, имеет смысл поместить их в аккуратные служебные методы, возможно, в класс с именем XMLUtils или что-то в этом роде.)

Может быть, есть лучшие способы сделать это, даже без каких-либо сторонних библиотек. Но из представленных решений, на мой взгляд, это самый простой способ, даже если вам нужно выполнить преобразования dom4j <-> w3c.

Обновление (2011): перед добавлением зависимости dom4j в ваш код, обратите внимание, что это , а не активно поддерживаемый проект, и с некоторыми другими проблемами тоже, Усовершенствованная версия 2.0 работала целую вечность, но доступна только альфа-версия. Возможно, вы захотите рассмотреть альтернативу, например, XOM; читайте больше в вопросе, связанном выше.

Answer 4

/**
*
* 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;
}

Answer 5

Вот еще одно решение, использующее библиотеку XOM , которая конкурирует с моим dom4j-ответом . (Это часть моего квеста найти хорошую замену dom4j , где XOM был предложен как один из вариантов.)

Сначала прочитайте фрагмент XML в nu.xom.Document:

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

Затем получите Документ и Узел, под которым добавлен фрагмент. Опять же, для целей тестирования я создам Документ из строки:

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

Теперь добавить дочерний узел просто и похоже на dom4j (за исключением того, что XOM не позволяет вам добавить оригинальный корневой элемент, который уже принадлежит newNodeDocument):

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

Вывод документа дает правильный результат XML (и это очень просто с XOM: просто напечатайте строку, возвращаемую originalDoc.toXML()):

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

(Если вы хотите правильно отформатировать XML (с отступами и переводами строки), используйте Serializer; спасибо Петеру Штибрани за указание на это.)

Итак, по общему признанию, это не очень отличается от решения dom4j. :) Тем не менее, с XOM может быть немного приятнее работать, потому что API лучше документирован, и из-за его философии дизайна, есть один канонический способ сделать каждую вещь.

Приложение : Опять же, вот как конвертировать между org.w3c.dom.Document и nu.xom.Document. Используйте вспомогательные методы в классе DOMConverter 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

Answer 6

Если вы используете dom4j, вы можете просто сделать:

Документ документа = DocumentHelper.parseText (текст);

(dom4j теперь можно найти здесь: https://github.com/dom4j/dom4j)

Answer 7

Попробуйте jcabi-xml , с одним вкладышем:

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

Answer 8

... и если вы используете чисто XOM, что-то вроде этого:

    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 внутренне использует fakeRoot, чтобы сделать то же самое, поэтому он должен быть безопасным, если не совсем элегантным.