¿Cómo mantener el espacio en blanco antes del elemento del documento al analizar con Java?

Question

En mi solicitud, alterar una parte de los archivos XML, que comienzan así:

<?xml version="1.0" encoding="UTF-8"?> 
<!-- $Id: version control yadda-yadda $ --> 

<myElement> 
... 

Nota de la línea en blanco antes <myElement>. Después de cargar, la alteración y el ahorro, el resultado está lejos de ser agradable:

<?xml version="1.0" encoding="UTF-8"?> 
<!-- $Id: version control yadda-yadda $ --><myElement> 
... 

descubrí que el espacio en blanco (una nueva línea) entre el comentario y el nodo de documento no está representado en el DOM en absoluto. El siguiente código autónomo reproduce el problema de manera confiable:

String source = 
    "<?xml version=\"1.0\" encoding=\"UTF-16\"?>\n<!-- foo -->\n<empty/>"; 
byte[] sourceBytes = source.getBytes("UTF-16"); 

DocumentBuilder builder = 
    DocumentBuilderFactory.newInstance().newDocumentBuilder(); 
Document doc = 
    builder.parse(new ByteInputStream(sourceBytes, sourceBytes.length)); 

DOMImplementationLS domImplementation = 
    (DOMImplementationLS) doc.getImplementation(); 
LSSerializer lsSerializer = domImplementation.createLSSerializer(); 
System.out.println(lsSerializer.writeToString(doc)); 

// output: <?xml version="1.0" encoding="UTF-16"?>\n<!-- foo --><empty/> 

¿Alguien tiene una idea de cómo evitar esto? Básicamente, quiero que la salida sea la misma que la entrada. (Sé que la declaración xml se regenerará porque no forma parte del DOM, pero eso no es un problema aquí).

Answer 1

La raíz del problema es que la norma DOM Level 3 no puede representar los nodos de texto como hijo de un documento sin romper la especificación. El espacio en blanco se eliminará por cualquier analizador compatible.

Document -- 
    Element (maximum of one), 
    ProcessingInstruction, 
    Comment, 
    DocumentType (maximum of one) 

Si necesita una solución compatible con los estándares y el objetivo es mejorar la legibilidad en lugar de 100% la reproducción, buscaría en su mecanismo de salida.

Answer 2

En general, los espacios en blanco se consideran irrelevantes en XML y, por lo tanto, no se conservan cuando se analiza un archivo XML . La mayoría de las bibliotecas que generan XML tienen una opción para producirlo con un buen formato y las sangrías correctas, pero siempre será bastante genérico. No "tiene una línea adicional a la derecha aquí".

Answer 3

¿Por qué quieres evitar esto?

El espacio en blanco fuera de las etiquetas/elementos se define como insignificante por la especificación. Simplemente no existe, en lo que respecta al infoset, que está representado por su DOM.

En consecuencia, al serializar el DOM nuevamente, no estará allí.

Si está en proceso de desarrollar algo que dependa de esta línea en blanco ... No lo haga.

Answer 4

Tuve el mismo problema. Mi solución fue escribir mi propio analizador XML: DecentXML

Característica principal: puede conservar al 100% la entrada original, el espacio en blanco, las entidades, todo. No le molestará con los detalles, pero si su código necesita generar XML como este:

<element 
    attr="some complex value" 
    /> 

entonces usted puede.

Answer 5

Estoy de acuerdo con Kris y Tomalak, la línea en blanco no es relevante desde el punto de vista XML. Si su aplicación necesita producir una línea en blanco en el resultado, le sugiero que revise la necesidad de ese requisito.

De todos modos, si aún desea que aparezca esa línea en blanco, le sugiero que descargue el código fuente del analizador XML que está utilizando y modifique ese comportamiento. Pero tenga en cuenta que esto no es XML estándar y que no será compatible con otras aplicaciones.

• Jdom Source
• Dom4j Source Comprobar org.dom4j.io.DOMWriter