La primera vez que XML casi arruinó mi tarde, fue una respuesta SOAP de una pasarela de pago. Una línea. Once mil caracteres. Sin líneas nuevas, sin sangría, solo una pared ininterrumpida de corchetes angulares que mi terminal envolvió en un ladrillo ilegible. En algún lugar había un único elemento incorrecto que causaba una falta de coincidencia de firma, y se suponía que debía encontrarlo a simple vista. He creado muchas cosas desde entonces: complementos de WordPress, API de Laravel, las herramientas React detrás de [Toolz.dev] (/ - y puedo decirles que un buen formateador XML es una de esas utilidades silenciosas que no aprecian hasta el momento en que miran una pared de etiquetas con una fecha límite detrás.
Esta guía es la que desearía tener esa tarde. Cubre lo que realmente hace un formateador XML, por qué embellecer y minificar son dos caras de la misma moneda, la regla de los espacios en blanco que hace que el formato sea seguro y el puñado de errores de validación que explican casi todos los "por qué ganó 't este análisis" momento. Puedes seguir en el navegador con el gratis Formateador XML - funciona completamente en su máquina, por lo que incluso una carga útil de pago nunca sale de su computadora portátil.
TL;Dr: Un formateador XML reescribe un documento 's espacio en blanco insignificante - el espacio en medio de etiquetas, sin tocar su significado. Beautify agrega saltos de línea y sangrías para que puedas leer la jerarquía; minify lo elimina todo para que el archivo sea lo más pequeño posible. Un buen formateador conserva los comentarios, CDATA, la declaración XML y el orden de los atributos, y valida el buen formato (etiquetas coincidentes, elementos cerrados, secciones terminadas) a lo largo del camino. Lo hace no compare su documento con un esquema DTD o XSD; ese es un trabajo diferente.
¿qué hace realmente un formateador XML?
Los espacios en blanco son donde el formato se vuelve interesante, porque XML 1.0 requiere que un analizador pase cada carácter dentro de un elemento a la aplicación, razón por la cual un formateador debe saber qué es seguro tocar. En esencia, un formateador XML analiza su documento en un árbol de nodos (elementos, texto, comentarios, secciones CDATA, instrucciones de procesamiento) y luego serializa ese árbol con un espaciado constante. Ese viaje de ida y vuelta es todo un truco. Debido a que la herramienta comprende la estructura en lugar de realizar una búsqueda y reemplazo ciego, puede marcar un anidado profundo <order><items><item> encadena correctamente, pon a cada hermano en su propia línea y debes saber que el texto que contiene <price>44.95</price> debería permanecer en la misma línea que sus etiquetas en lugar de extenderse a lo largo de tres.
La razón por la que esto importa se reduce a una regla enterrada en la especificación XML: la mayoría de los espacios en blanco entre elementos lo son insignificante. Cuando un analizador lee <a>\n <b/>\n</a>, las nuevas líneas y espacios alrededor <b/> están ahí para los humanos y no contienen datos. Un formateador puede agregar, eliminar o cambiar ese espacio en blanco libremente. Lo que nunca debe tocar es significativo espacios en blanco: los caracteres dentro de un nodo de texto como <note>Call me at 9am</note>, o cualquier cosa dentro de un bloque CDATA, porque ese contenido son datos reales. Cada decisión de formato el Formateador XML se deriva de respetar esa línea.
Así que embellecer no es una tontería cosmética. Cuando vuelves a sangrar ese ladrillo SOAP de once mil caracteres, la jerarquía de elementos se vuelve visible y, de repente, se extravía <Amount> el nodo tres niveles demasiado profundo es obvio. El formato es tanto una herramienta de depuración como de legibilidad.
¿por qué minificaría XML en lugar de embellecerlo?
Beautify y minify son el mismo motor que apunta en direcciones opuestas. Beautify agrega espacios en blanco para humanos; minify lo elimina para máquinas. Busca minify cuando el tamaño o el transporte importan: reducir un archivo de configuración que se envía dentro de un paquete de aplicaciones móviles, recortar un cuerpo de solicitud antes de que pase por una conexión lenta o normalizar un documento para que se puedan comparar dos versiones byte por byte sin que el ruido de sangría se interponga en el camino.
El ahorro es real pero rara vez dramático. La verbosidad de XML' vive en sus nombres de etiquetas repetidos, no en sus espacios en blanco, por lo que la minificación generalmente recorta entre cinco y veinte por ciento dependiendo de cuán dentado estaba el original. Vale la pena tenerlo, pero si necesita una compresión seria, hacer gzip en el cable hace mucho más, minificando y luego gzipping es el enfoque de cinturón y tirantes que utilizan muchas API.
Aquí está el modelo mental que utilizo a la hora de decidir de qué manera señalar la herramienta:
| colocación | embellecerse | minificar |
|---|---|---|
| Leer o depurar una respuesta a simple vista | sí | prohibido |
| Confirmar un archivo de configuración al control de versiones | Sí (diferencias limpias) | prohibido |
| Envío de XML dentro de un paquete de aplicaciones o a través de la red | prohibido | sí |
| Almacenar muchos documentos pequeños en una columna de base de datos | prohibido | sí |
| Preparar un documento para una diferencia byte por byte | Cualquiera de los dos, consistentemente | Cualquiera de los dos, consistentemente |
| Entregando XML a otro desarrollador | sí | prohibido |
La disciplina clave es la coherencia. Si estás diferenciando dos documentos, corre a la vez primero, a través del mismo modo con las mismas opciones; de lo contrario, está comparando estilos de sangría, no contenido.
¿cómo evita el formato cambiar mis datos?
Ésta es la ansiedad que todo formateador tiene por ganar: " Si esta herramienta reescribe mi XML, ¿cómo sé que no rompió algo silenciosamente? " La respuesta honesta es que un formateador bien construido solo cambia los espacios en blanco entre etiquetas y deja cuatro cosas estrictamente solas.
El primero es contenido del texto. Los caracteres dentro de un elemento se copian palabra por palabra. Eso incluye entidades, un literal & se queda &, nunca se decodifica de manera útil & (lo que produciría XML no válido) o codificado dos veces &amp;. los Formateador XML trata tu texto como opaco, que es exactamente lo que quieres.
El segundo es Secciones CDATA. un <![CDATA[ ... ]]> el bloque existe precisamente para que pueda eliminar contenido sin formato y sin escape: un fragmento de JavaScript, un fragmento de HTML, una cadena llena de < y & - en un documento XML sin escapar de él. Un formateador emite ese contenido exactamente como lo encontró, sin escapar, sin volver a sangrar dentro del bloque.
El tercero es comentarios y la declaración. Comentarii (<!-- ... -->), el <?xml version="1.0"?> la declaración y las instrucciones de procesamiento se conservan y colocan con sensatez. Puede optar por eliminar comentarios cuando desee un archivo más sencillo, pero esa es su decisión, no algo que la herramienta haga a sus espaldas.
El cuarto es orden de atributos y cotización. De forma predeterminada, el formateador mantiene sus atributos en el orden en que los escribió, con el estilo de cotización que utilizó, porque la especificación XML trata el orden de los atributos como insignificante y no hay razón para cambiarlo. Cuando tú tener el origen quiere un orden canónico, para diferencias más limpias, o comparar dos elementos que llevan los mismos atributos en diferentes órdenes: "ordenar atributos" La opción los pone en orden alfabético para usted.
Debido a que todo esto se ejecuta en el lado del cliente en JavaScript, también existe un dividendo de privacidad: un documento lleno de cadenas de conexión, identificadores internos o registros de clientes se formatea en su propia máquina y nunca se carga. Si le importa mantener los datos de trabajo fuera de otras personas 's servidores - y usted debería - vale la pena entender ese modelo, y escribí más sobre él en el guía de privacidad de datos para herramientas en línea.
¿qué errores XML detecta el formateador?
Antes de que un formateador pueda imprimir algo, tiene que analizar el documento y el análisis es donde ocurre la validación útil. Esto es bien formado la verificación (las reglas estructurales que todo documento XML debe obedecer) y, en mi experiencia, tres errores explican la inmensa mayoría de los fracasos.
El más común con diferencia es un ampersand desnudo. Reservas XML & para iniciar una entidad, entonces una cruda & en texto, del tipo que se cuela a través de una URL ?a=1&b=2 o el nombre de una empresa como "Marcas y amplificador; Spencer" - hace que el analizador espere el nombre de una entidad y luego se ahogue cuando no la encuentra. La solución es escribir &, y un buen mensaje de error te señalará la línea para que no estés cazando a ciegas.
El segundo es un etiqueta no coincidente o no cerrada. Deschide un <div> y ciérralo con </section>, sau deschide un <span> y nunca lo cierres en absoluto, y el documento ya no está bien formado. El formateador rastrea la pila de elementos abiertos a medida que analiza, para que pueda indicarle exactamente qué etiqueta esperaba ver cerrada y cuál encontró realmente. Ese único mensaje - " esperado </book> pero encontrado </author> en la línea 14" - suele ser suficiente para solucionar el problema en segundos.
El tercero es un sección sin terminar: un comentario abierto con <!-- eso nunca llega -->, o un bloque CDATA que nunca llega ]]>. Estos son fáciles de crear cuando se edita a mano y se eliminan demasiado. Nuevamente, el formateador informa la línea donde comenzó la sección desbocada.
Qué hace el formateador no lo que hace es comparar su documento con un esquema. La buena formación pregunta a " ¿Es este XML estructuralmente válido?" La validez pregunta a " ¿Este XML sigue las reglas de mi particular tipo de documento: los elementos correctos, en el orden correcto, con los tipos de datos correctos, según lo define un DTD o XSD?" Esas son capas separadas. Un documento puede estar perfectamente bien formado y seguir siendo una tontería para el propósito previsto. La validación del esquema necesita el esquema, y esa es una herramienta diferente. El formateador garantiza la primera capa, que es la que evita que su analizador falle.
¿cómo formateo XML en mi editor o canal de compilación?
La herramienta del navegador es la ruta más rápida para un documento único, pero vale la pena conocer las alternativas para poder elegir la adecuada para el trabajo.
La mayoría de los editores formatean XML de forma nativa. En VS Code, el "Formato Documento" El comando (Shift+Alt+F) maneja XML y extensiones como Red Hat's El servidor de lenguaje XML agrega formato compatible con esquemas en la parte superior. IntelliJ y sus hermanos se reformatean con Ctrl+Alt+L. Estos son ideales cuando el archivo ya está abierto frente a usted.
En la línea de comando, xmllint --format file.xml (parte de libxml2, que se envía en la mayoría de los sistemas Unix) embellece y xmllint --noblanks file.xml le acerca a la salida minificada. En un proyecto de nodo, a las bibliotecas les gusta xml-formatter investigaciones operacionales prettier con la ranura del complemento XML en un paso de compilación. Los desarrolladores de Python buscan xml.dom.minidom.parseString(s).toprettyxml(), aunque tenga cuidado, es conocido por agregar líneas en blanco adicionales alrededor de los espacios en blanco existentes.
Entonces, ¿por qué utilizar el Formateador XML ¿en absoluto? Tres razones a las que sigo volviendo. No necesita instalación, configuración ni proyecto: pegas y listo. Mantiene los datos en su máquina, lo cual importa cuando el XML es una carga útil real en lugar de un ejemplo de juguete. Y se combina naturalmente con las herramientas vecinas: una vez que su XML está limpio y válido, convirtiéndolo a JSON con Convertidor XML a JSON es un clic y el recorrido inverso JSON a XML utiliza las mismas convenciones. Si su día es principalmente JSON, el Formateador JSON es el equivalente a ese formato, y toda la familia está catalogada en el Kit de herramientas para desarrolladores web.
¿cuándo debo formatear versus convertir mi XML?
Una pregunta que recibo de personas más recientes sobre esto: si JSON es más fácil de leer, ¿por qué formatear XML en lugar de simplemente convertirlo? La respuesta es que formatear y convertir resuelve diferentes problemas.
Formatee cuando lo necesite mantener el XML, porque un punto final SOAP lo exige, porque un RSS o fuente Atom es XML por definición, porque su archivo de configuración, su diseño de Android o su Maven pom.xml simplemente es XML y siempre lo será. El formato hace que ese XML sea legible o compacto y lo deja como XML. Nada en sentido descendente tiene que cambiar.
Convierte cuando quieras trabaja con los datos en un formato diferente - extraer valores en una interfaz de JavaScript, cargar una fuente en un sistema que habla JSON o normalizar varias fuentes en una forma. La conversión cambia el formato y, con ella, parte de la fidelidad: los atributos XML, el contenido mixto y el orden de elementos no tienen equivalentes JSON limpios, por lo que un convertidor toma decisiones deliberadas (los atributos se convierten en claves con prefijo, las etiquetas repetidas se convierten en matrices) que usted debe comprender antes de confiar en ellos.
Mi regla general: formatear primero, siempre. Un documento limpio y validado es más fácil de razonar sobre si su siguiente paso es editarlo, diferenciarlo o convertirlo. El formato es la operación barata, segura y sin pérdidas; La conversión es la que se pierde una vez que se sabe que la estructura es sólida. Sitemaps es un buen ejemplo de XML que formatea en lugar de convertir; si está construyendo uno, el dedicado generador de mapas de sitio produce directamente resultados válidos y bien formados.
Preguntas frecuentes
¿Cómo formateo XML en línea?
Pegue su XML en el panel de entrada, elija Embellecer, elija un ancho de sangría y haga clic en Formato. La herramienta analiza el documento, lo reintegra y le permite copiar o descargar el resultado. Todo el procesamiento ocurre en su navegador, no se carga nada.
¿Cuál es la diferencia entre embellecer y minificar XML?
El embellecimiento agrega saltos de línea y sangría para que la jerarquía de elementos sea fácil de leer, lo cual es ideal para editar y depurar. Minifying elimina todos los espacios en blanco entre etiquetas para producir el archivo más pequeño posible, que es ideal para almacenamiento o envío a través de la red. Ambos conservan el significado del documento 's; sólo los insignificantes cambios en los espacios en blanco.
¿El formato cambia el significado de mi XML?
prohibido . Solo se altera el espacio en blanco entre las etiquetas: los elementos, los atributos, el contenido del texto, los comentarios y los datos no se modifican. Debido a que se conservan espacios en blanco significativos dentro de los nodos de texto y CDATA, un documento bien formado se comporta de manera idéntica antes y después del formato.
¿Se conservan las secciones de comentarios y cdata?
Sí. Se conservan los comentarios, las secciones CDATA, la declaración XML y las instrucciones de procesamiento. Los comentarios están sangrados junto con los elementos con los que se encuentran y el contenido CDATA se emite palabra por palabra sin que se escape. También puede optar por eliminar comentarios si desea una salida más sencilla.
¿Puede esta herramienta validar mi XML?
Sí. Antes de formatear, el documento se analiza completamente y los problemas estructurales (un elemento no cerrado, una etiqueta de cierre que no coincide con su etiqueta de apertura o una sección de comentarios o CDATA no terminada) se informan con un número de línea para que pueda solucionarlos rápidamente. Comprueba la buena forma, no la validez con un esquema DTD o XSD.
¿Por qué mi XML no se puede formatear?
Casi todos los fallos son errores de buena forma. Los más comunes son un simple signo comercial en el texto (debe escribirse como una entidad, o el analizador lo lee como el comienzo de una entidad), una etiqueta de cierre que no coincide con el elemento que cierra y un elemento que se abre pero nunca se cierra. El mensaje de error apunta a la línea para que pueda saltar directamente a ella.
¿Es seguro formatear XML que contiene datos confidenciales?
Sí. El analizador se ejecuta completamente en JavaScript en su navegador: ninguna solicitud de red transporta sus datos, no se registra ni se almacena nada, y la herramienta funciona sin conexión una vez cargada. XML conteniendo claves API, cadenas de conexión o registros de clientes nunca sale de su máquina.
¿puedo convertir el XML formateado a JSON después?
Sí. Una vez que el XML es limpio y válido, el XML to JSON Converter lo convierte en JSON equivalente, asignando atributos a claves prefijadas y etiquetas repetidas a matrices. El formato primero hace que la estructura sea obvia, lo que lo ayuda a comprender cómo se asignará antes de convertir.
Escrito por Liton, creador de Toolz.dev, WP Adminify y una larga lista de proyectos de Laravel y React. Cada herramienta mencionada aquí se ejecuta de forma gratuita y completa en su navegador en [Toolz.dev](/.
