La prima volta che XML ha quasi rovinato il mio pomeriggio, è stata una risposta SOAP da un gateway di pagamento Una riga Undicimila caratteri Nessuna nuova riga, nessun rientro, solo un muro ininterrotto di parentesi angolari che il mio terminale ha avvolto in un mattone illeggibile Da qualche parte dentro c'era un singolo elemento sbagliato che causava una mancata corrispondenza della firma, e avrei dovuto trovarlo a occhio Ho costruito un sacco di cose da allora - plugin WordPress, API Laravel, il React tooling dietro [Toolz.dev] (/ - e posso dirti che un buon formattatore XML è una di quelle utilità silenziose che non apprezzi fino al momento in cui stai fissando un muro di tag con una scadenza alle spalle.
Questa guida è quella che vorrei avere quel pomeriggio Copre ciò che fa effettivamente un formattatore XML, perché abbellire e minimizzare sono due facce della stessa medaglia, la regola degli spazi bianchi che rende sicura la formattazione e la manciata di errori di convalida che rappresentano quasi ogni & quot; perché won't questo parse" momento. Puoi seguire nel browser il libero Formattatore XML - funziona interamente sulla tua macchina, quindi anche un payload di pagamento non lascia mai il tuo laptop.
tl; dr: Un formattatore XML riscrive un documento's spazi bianchi insignificanti - lo spazio fra tag - senza toccarne il significato Abbellisci aggiunge interruzioni di riga e indentazione in modo da poter leggere la gerarchia; minifica le strisce tutte in modo che il file sia il più piccolo possibile Un buon formattatore conserva i commenti, CDATA, la dichiarazione XML e l'ordine degli attributi, e convalida la buona forma (tag corrispondenti, elementi chiusi, sezioni terminate) lungo il percorso Lo fa no controlla il tuo documento rispetto a uno schema DTD o XSD: questo è un lavoro diverso.
Cosa fa effettivamente un formattatore XML?
Lo spazio bianco è il luogo in cui la formattazione diventa interessante, perché XML1.0 richiede che un parser passi ogni carattere all'interno di un elemento all'applicazione - motivo per cui un formattatore deve sapere cosa è sicuro toccare Al suo interno, un formattatore XML analizza il tuo documento in un albero di nodi - elementi, testo, commenti, sezioni CDATA, istruzioni di elaborazione - e quindi serializza quell'albero di nuovo con una spaziatura coerente Quel viaggio di andata e ritorno è l'intero trucco Poiché lo strumento comprende la struttura piuttosto che fare un "trova e sostituisci" cieco, può indentare un sistema profondamente annidato <order><items><item> concatenare correttamente, mettere ogni fratello sulla propria linea, e sapere che il testo all'interno <price>44.95</price> dovrebbe rimanere sulla stessa linea dei suoi tag piuttosto che estendersi su tre.
Il motivo per cui questo è importante si riduce a una regola sepolta nella specifica XML: la maggior parte degli spazi bianchi tra gli elementi lo è insignificante. Quando un parser legge <a>\n <b/>\n</a>, le novità e gli spazi intorno <b/> ci sono per gli esseri umani e non portano dati Un formattatore è permesso aggiungere, rimuovere o cambiare che spaziano liberamente Ciò che non deve mai toccare è significativo spazi bianchi: i caratteri all'interno di un nodo di testo come <note>Call me at 9am</note>, o qualsiasi cosa all'interno di un blocco CDATA - perché quel contenuto è dati reali Ogni decisione di formattazione il Formattatore XML fa sì che i flussi rispettino quella linea.
Quindi abbellire non è lanugine cosmetica Quando si reindenta quel mattone SOAP di undicimila caratteri, la gerarchia degli elementi diventa visibile, e improvvisamente il fuori posto <Amount> nodo tre livelli troppo profondo è ovvio Formattazione è uno strumento di debug tanto quanto una leggibilità.
Perché dovrei minimizzare XML invece di abbellirlo?
Abbellisci e minimizza sono lo stesso motore puntato in direzioni opposte Abbellisci aggiunge spazi bianchi per gli esseri umani; minify lo rimuove per le macchine Si raggiunge per minify quando le dimensioni o il trasporto è importante: ridurre un file di configurazione che viene spedito all'interno di un pacchetto di app mobili, tagliare un corpo di richiesta prima che passi su una connessione lenta o normalizzare un documento in modo che due versioni possano essere confrontate byte-per-byte senza che il rumore di rientro si intrometta.
Il risparmio è reale ma raramente drammatico XML's verbosità vive nei suoi nomi di tag ripetuti, non nel suo spazio bianco, quindi la minimizzazione in genere taglia da qualche parte tra il cinque e il venti per cento a seconda di quanto fortemente rientrato fosse l'originale Vale la pena averlo, ma se hai bisogno di una compressione seria, gzip sul filo fa molto di più - minifying e poi gzipping è l'approccio cintura-e-braces molte API usano.
Ecco il modello mentale che utilizzo quando decido in che modo puntare lo strumento:
| situazione | abbellire | minimizzare |
|---|---|---|
| Lettura o debug di una risposta a occhio | certo | no |
| Commissione di un file di configurazione al controllo della versione | Sì (diff puliti) | no |
| Spedizione di XML all'interno di un pacchetto di app o sulla rete | no | certo |
| Memorizzazione di molti piccoli documenti in una colonna di database | no | certo |
| Preparazione di un documento per un byte-for-byte diff | O, coerentemente | O, coerentemente |
| Consegnare XML a un altro sviluppatore | certo | no |
La disciplina chiave è la coerenza Se stai diffondendo due documenti, corri ambo attraverso la stessa modalità con le stesse opzioni prima - altrimenti si stanno confrontando gli stili di indentazione, non il contenuto.
In che modo la formattazione evita di modificare i miei dati?
Questa è l'ansia che ogni formattatore deve guadagnarsi da fare: & quot; se questo strumento riscrive il mio XML, come faccio a sapere che non ha rotto silenziosamente qualcosa?" La risposta onesta è che un formattatore ben costruito cambia sempre e solo lo spazio tra i tag e lascia quattro cose rigorosamente da sole.
Il primo è contenuto testo. I caratteri all'interno di un elemento vengono copiati alla lettera. Ciò include le entità: un letterale & soggiorni &non viene mai decodificato utilmente & (che produrrebbe XML non valido) o codificato due volte in &amp;. la Formattatore XML tratta il tuo testo come opaco, che è esattamente quello che vuoi.
Il secondo è Sezioni CDATA. un' <![CDATA[ ... ]]> il blocco esiste proprio per poter rilasciare contenuti grezzi e non evasi: uno snippet di JavaScript, un pezzo di HTML, una stringa piena di < e & - in un documento XML senza sfuggirgli Un formattatore emette quel contenuto esattamente come lo ha trovato, nessuna fuga, nessun rientro all'interno del blocco.
Il terzo è commenti e la dichiarazione. Commenti (<!-- ... -->), il <?xml version="1.0"?> dichiarazione, e qualsiasi istruzione di elaborazione sono conservati e posizionati in modo sensato È possibile scegliere di spogliare i commenti quando si desidera un file più snello, ma questa è la vostra decisione, non qualcosa che lo strumento fa dietro la schiena.
Il quarto è ordine e quotazione degli attributi. Per impostazione predefinita il formattatore mantiene i tuoi attributi nell'ordine in cui li hai scritti, con lo stile di citazione che hai usato, perché la specifica XML tratta l'ordine degli attributi come insignificante e non c'è motivo di agitarlo quando tu truffa vuoi un ordinamento canonico - per diff più puliti, o per confrontare due elementi che portano gli stessi attributi in ordini diversi - un & quot; ordina attributi& quot; opzione li mette in ordine alfabetico per te.
Poiché tutto questo funziona lato client in JavaScript, c'è anche un dividendo di privacy: un documento pieno di stringhe di connessione, identificatori interni o record dei clienti viene formattato sulla tua macchina e mai caricato Se ti interessa mantenere i dati di lavoro lontani da altre persone's server - e dovresti - vale la pena capire quel modello, e ne ho scritto di più nel guida alla privacy dei dati per gli strumenti online.
Quali errori XML rileva il formattatore?
Prima che un formattatore possa stampare qualcosa, deve analizzare il documento e l'analisi è il luogo in cui avviene la convalida utile. Questo è ben formato controllare - le regole strutturali a cui ogni documento XML deve obbedire - e secondo la mia esperienza tre errori rappresentano la stragrande maggioranza dei fallimenti.
Il più comune di gran lunga è un e commerciale nuda. Riserve XML & per avviare un'entità, quindi un raw & nel testo - il tipo che si intrufola attraverso un URL come ?a=1&b=2 o un nome di società come & quot; Marchi & amp; Spencer" - fa sì che il parser si aspetti un nome di entità e poi si strozzi quando non ne trova uno La soluzione è scrivere &, e un buon messaggio di errore ti punterà sulla linea in modo da non essere a caccia di ciechi.
Il secondo è un tag non corrispondente o non chiuso. Aprire a <div> e chiuderlo con </section>, o aprire a <span> e non chiuderlo mai affatto, e il documento non è più ben formato Il formattatore tiene traccia dello stack a elementi aperti mentre analizza, in modo che possa dirti esattamente quale tag si aspettava di vedere chiuso e quale ha effettivamente trovato Quel singolo messaggio - & quot; atteso </book> ma trovato </author> alla riga 14" - di solito è sufficiente per risolvere il problema in pochi secondi.
Il terzo è un sezione non terminata: un commento aperto con <!-- che non arriva mai -->, o un blocco CDATA che non raggiunge mai ]]>. Questi sono facili da creare quando si sta modificando manualmente ed eliminare un po 'troppo Ancora una volta, il formattatore riporta la riga in cui è iniziata la sezione in fuga.
Cosa fa il formattatore no fare è controllare il tuo documento rispetto a uno schema. La buona formalità chiede a & quot; è questo XML strutturalmente valido?& quot; La validità chiede a & quot; questo XML segue le regole di mio particolare tipo di documento - gli elementi giusti, nel giusto ordine, con i giusti tipi di dati - come definito da un DTD o XSD?" Quelli sono livelli separati Un documento può essere perfettamente ben formato ed essere ancora senza senso per lo scopo previsto La convalida dello schema ha bisogno dello schema, e questo è uno strumento diverso Il formattatore garantisce il primo livello, che è quello che ferma il crash del parser.
Come faccio a formattare XML nel mio editor o costruire pipeline?
Lo strumento browser è il percorso più veloce per un documento una tantum, ma vale la pena conoscere le alternative in modo da poter scegliere quella giusta per il lavoro.
La maggior parte degli editor formatta XML in modo nativo In VS Code, il comando & quot;Format Document" integrato (Shift+Alt+F) gestisce XML ed estensioni come Red Hat' s XML language server aggiunge la formattazione compatibile con lo schema in alto IntelliJ e i suoi fratelli si riformattano con Ctrl+Alt+L. Questi sono ideali quando il file è già aperto davanti a te.
Sulla riga di comando, xmllint --format file.xml (parte di libxml2, che viene fornito sulla maggior parte dei sistemi Unix) abbellisce e xmllint --noblanks file.xml ti porta vicino all'output minificato In un progetto Node, librerie come xml-formatter oppure prettier con lo slot del plugin XML in una fase di compilazione, gli sviluppatori Python raggiungono xml.dom.minidom.parseString(s).toprettyxml(), anche se attenzione, è noto per l'aggiunta di righe vuote extra attorno agli spazi bianchi esistenti.
Allora perché usare il Formattatore XML a tutti? tre motivi a cui continuo a tornare Non ha bisogno di installazione, nessuna configurazione e nessun progetto - si incolla e si va Mantiene i dati sulla tua macchina, il che conta quando l'XML è un vero payload piuttosto che un esempio giocattolo E si abbina naturalmente con gli strumenti vicini: una volta che il tuo XML è pulito e valido, convertendolo in JSON con il Convertitore da XML a JSON è un clic e il viaggio inverso JSON a XML utilizza le stesse convenzioni Se la tua giornata è per lo più JSON, il Formattatore JSON è l'equivalente di quel formato e l'intera famiglia è catalogata nel Toolkit per sviluppatori web.
Quando devo formattare rispetto alla conversione del mio XML?
Una domanda che ricevo da persone più recenti a questo: se JSON è più facile da leggere, perché formattare XML invece di limitarsi a convertirlo? la risposta è che formattazione e conversione risolvono problemi diversi.
Formato quando è necessario tenere L'XML - perché un endpoint SOAP lo richiede, perché un feed RSS o Atom è XML per definizione, perché il tuo file di configurazione, il tuo layout Android o il tuo Maven pom.xml semplicemente è XML e lo sarà sempre La formattazione rende quell'XML leggibile o compatto lasciandolo come XML Niente downstream deve cambiare.
Converti quando vuoi lavora con i dati in un formato diverso - inserire valori in un front-end JavaScript, caricare un feed in un sistema che parla JSON o normalizzare diverse fonti in un'unica forma La conversione cambia il formato e con essa parte della fedeltà: attributi XML, contenuto misto e ordinamento degli elementi non hanno equivalenti JSON puliti, quindi un convertitore fa scelte deliberate (gli attributi diventano chiavi prefissate, i tag ripetuti diventano array) che dovresti capire prima di fare affidamento su di essi.
La mia regola pratica: formattare prima, sempre Un documento pulito e convalidato è più facile da ragionare se il tuo prossimo passo è modificarlo, differirlo o convertirlo Formattazione è l'operazione economica, sicura e senza perdita di dati; la conversione è quella con perdita di dati che fai una volta che sai che la struttura è sana Le mappe del sito sono un bell'esempio di XML che formatti piuttosto che convertire - se ne stai costruendo uno, il dedicato generatore sitemap produce direttamente un output valido e ben formato.
Domande frequenti
Come formatto XML Online?
Incolla il tuo XML nel pannello di input, scegli Abbellisci, scegli una larghezza di indentazione e fai clic su Formato. Lo strumento analizza il documento, lo rientra e consente di copiare o scaricare il risultato. Tutta l'elaborazione avviene nel tuo browser - non viene caricato nulla.
Qual è la differenza tra abbellire e minimizzare l'XML?
La riduzione aggiunge interruzioni di riga e rientro in modo che la gerarchia degli elementi sia facile da leggere, il che è ideale per la modifica e il debug La riduzione al minimo rimuove tutti gli spazi bianchi tra i tag per produrre il file più piccolo possibile, ideale per l'archiviazione o l'invio in rete Entrambi preservano il significato di document' s; cambia solo l'insignificante spazio bianco.
La formattazione cambia il significato del mio XML?
no . Solo lo spazio bianco tra i tag viene alterato: gli elementi, gli attributi, il contenuto del testo, i commenti e i CDATA non sono modificati. Poiché vengono conservati uno spazio bianco significativo all'interno dei nodi di testo e dei CDATA, un documento ben formato si comporta in modo identico prima e dopo la formattazione.
Le sezioni dei commenti e dei cdata vengono conservate?
Sì. Commenti, sezioni CDATA, la dichiarazione XML e le istruzioni di elaborazione sono tutti mantenuti I commenti sono rientrati accanto agli elementi con cui si trovano e il contenuto CDATA viene emesso alla lettera senza alcuna fuga Puoi anche scegliere di eliminare i commenti se desideri un output più snello.
Questo strumento può convalidare il mio XML?
si. Prima della formattazione, il documento viene completamente analizzato e i problemi strutturali - un elemento non chiuso, un tag di chiusura che non corrisponde al suo tag di apertura, o un commento non terminato o una sezione CDATA - vengono segnalati con un numero di riga in modo da poterli correggere rapidamente. Verifica la buona forma, non la validità rispetto a uno schema DTD o XSD.
Perché il mio XML non riesce a formattare?
Quasi tutti i guasti sono errori di buona formatura I più comuni sono una e commerciale nuda nel testo (deve essere scritta come entità, o il parser la legge come inizio di un'entità), un tag di chiusura che non corrisponde all'elemento che chiude e un elemento che viene aperto ma mai chiuso Il messaggio di errore punta alla riga in modo da poter saltare direttamente ad esso.
È sicuro formattare XML che contiene dati sensibili?
si. Il parser viene eseguito interamente in JavaScript nel tuo browser: nessuna richiesta di rete trasporta i tuoi dati, non viene registrato o archiviato e lo strumento funziona offline una volta caricato. XML Holding chiavi API, stringhe di connessione o record dei clienti non lascia mai la macchina.
Posso convertire l'XML formattato in JSON in seguito?
si. Una volta che l'XML è pulito e valido, il convertitore da XML a JSON lo trasforma in JSON equivalente, mappando gli attributi in chiavi prefissate e tag ripetuti agli array. La formattazione in primo luogo rende la struttura ovvia, il che ti aiuta a capire come verrà mappato prima della conversione.
Scritto da Liton - costruttore di Toolz.dev, WP Adminify, e una lunga lista di progetti Laravel e React Ogni strumento qui menzionato viene eseguito gratuitamente e completamente nel tuo browser all'indirizzo [Toolz.dev](/.
