Μορφοποίηση και εσοχή XML

Η μορφοποίηση XML (ονομάζεται επίσης μορφοποίηση XML, εσοχή XML ή όμορφη εκτύπωση) αποτελείται από αναδιοργανώστε ένα συμπαγές ή ελαχιστοποιημένο έγγραφο XML σε μια δομή με εσοχή, ευανάγνωστη γραμμή προς γραμμή. Η καλά διαμορφωμένη XML βελτιώνει την αναγνωσιμότητα από τον άνθρωπο, κάτι που είναι απαραίτητο κατά την ανάγνωση μια απάντηση SOAP, περιηγηθείτε σε μια ροή RSS ή επιθεωρήστε τα περιεχόμενα ενός αρχείου διαμόρφωσης.

Συγκεκριμένα, διαμορφώνουμε την XML μας για τέσσερις βασικούς λόγους:

• Εντοπισμός σφαλμάτων: εντοπίστε γρήγορα μια μη κλειστή ετικέτα, ένα χαρακτηριστικό που λείπει ή μια ασυνεπή δομή.
• Μη αυτόματη ενοποίηση: αντιγράψτε καθαρά ένα τμήμα σε ένα αρχείο διαμόρφωσης χωρίς να σπάσετε την υπάρχουσα εσοχή.
• Επισκόπηση κώδικα: συγκρίνετε δύο εκδόσεις ενός εγγράφου XML σε μια διαφορά Git που γίνεται αναγνώσιμη όταν κάθε ετικέτα βρίσκεται στη δική της γραμμή.
• Τεκμηρίωση και παραδείγματα: Η μορφοποιημένη XML είναι πολύ πιο εκπαιδευτική σε ένα τεχνικό έγγραφο ή στο README.

Η XML παραμένει πανταχού παρούσα στο οικοσύστημα λογισμικού. Εδώ είναι οι μορφές στις οποίες οι προγραμματιστές πιο συχνά χρησιμοποιούν έναν μορφοποιητή XML:

• Αποκρίσεις SOAP: Οι φάκελοι που επιστρέφονται από τις υπηρεσίες ιστού SOAP συνήθως φτάνουν ελαχιστοποιημένοι.
• Ροές δεδομένων RSS και Atom: για επιθεώρηση ή έλεγχο μιας ροής διανομής.
Ρυθμίσεις
• Spring, Maven (pom.xml), Ant, Ivy: αρχεία έκδοσης Java και εξαρτήσεων.
• AndroidManifest.xml και άλλους πόρους XML ενός έργου Android.
• Αρχεία SVG: Ένα διανυσματικό γραφικό που εξάγεται από λογισμικό σχεδιασμού συχνά συμπιέζεται σε μία γραμμή.
• Εξαγωγές ηλεκτρονικού εμπορίου: ροές προϊόντων Αγορών Google, εξαγωγές Magento, Shopify ή PrestaShop.
• Έγγραφα OOXML: Τα αρχεία .docx, .xlsx και .pptx είναι αρχεία ZIP που περιέχουν αρχεία XML που συχνά πρέπει να ελέγχονται.
• Χάρτες ιστοτόπου XML: το sitemap.xml εξυπηρετείται στις μηχανές αναζήτησης.

Ένας μορφοποιητής XML δεν προσθέτει απλά κενά τυχαία. Εκτελεί δύο βήματα:

1. Ανάλυση: το έγγραφο διαβάζεται και στη συνέχεια μετατρέπεται σε δέντρο DOM (Document Object Model). Αυτό το βήμα επιβεβαιώνει επίσης ότι το XML είναι καλά διαμορφωμένο (σωστά ένθετες ετικέτες, χαρακτηριστικά σε εισαγωγικά, ένα μόνο ριζικό στοιχείο).
2. Σειριοποίηση με εσοχή: Το δέντρο DOM εκπέμπεται εκ νέου ως κείμενο με αλλαγές γραμμής μεταξύ στοιχείων και εσοχή ανάλογη με το βάθος στο δέντρο.

Αυτή η προσέγγιση δέντρου διασφαλίζει ότι η λογική δομή του εγγράφου παραμένει αυστηρά πανομοιότυπη: τροποποιούνται μόνο ασήμαντα κενά μεταξύ των ετικετών. Ενότητες CDATA, σχόλια και οι οδηγίες επεξεργασίας διατηρούνται. Πιο προηγμένοι μετασχηματισμοί (XSLT) ή ερωτήματα (XPath) λειτουργούν σε αυτό το ίδιο δέντρο DOM.

Η διαδικασία είναι σκόπιμα απλή:

1. Επικολλήστε το έγγραφό σας XML στο πλαίσιο κειμένου ή ανεβάστε ένα αρχείο .xml.
2. Επικύρωση της φόρμας: το έγγραφο αναλύεται και δημιουργείται αυτόματα εσοχή.
3. Το μορφοποιημένο αποτέλεσμα εμφανίζεται στην περιοχή εξόδου. Σε περίπτωση σφάλματος ανάλυσης, ένα μήνυμα υποδεικνύει τη φύση και την κατά προσέγγιση θέση του προβλήματος.
4. Αντιγράψτε το αποτέλεσμα με το ειδικό κουμπί ή κατεβάστε το για να το ενσωματώσετε απευθείας στο έργο σας.

Μερικές συμβάσεις που πρέπει να ακολουθήσετε για την παραγωγή καθαρού και ανθεκτικού XML:

• Εσοχή: 2 ή 4 κενά ανάλογα με τη σύμβαση της ομάδας σας. Παραμείνετε συνεπείς σε όλο το έργο.
• Αλλαγές γραμμής: ένα στοιχείο ανά γραμμή, το οποίο κάνει τις διαφοροποιήσεις Git να μπορούν να χρησιμοποιηθούν.
• Ενότητες CDATA: ένας καλός μορφοποιητής διατηρεί τα μπλοκ στο σύνολό τους χωρίς να επανατοποθετεί το περιεχόμενό τους, το οποίο αντιμετωπίζεται ως απλό κείμενο.
• Κωδικοποίηση: δηλώνετε πάντα την κωδικοποίηση στην πρώτη γραμμή με . Το UTF-8 είναι το de facto πρότυπο.
• Χαρακτηριστικά: Εάν ένα στοιχείο έχει πολλά χαρακτηριστικά, ορισμένες ομάδες τα αναδιπλώνουν για αναγνωσιμότητα. Διαφορετικά, παραμένουν στην ίδια γραμμή με την αρχική ετικέτα.
• Σχόλια: Το πρέπει να διατηρηθεί ως έχει από τον εκπαιδευτή.

Εδώ είναι ένα συγκεκριμένο παράδειγμα μιας συμπαγούς XML που διακοσμείται από τον μορφοποιητή.

Πριν από (μονή γραμμή, δυσανάγνωστη):

valval2

Μετά (μορφοποίηση με 2 κενά):

  val
  val2

Η λογική δομή είναι αυστηρά πανομοιότυπη: αλλάζει μόνο η οπτική διάταξη.

Ένα έγγραφο XML plus volumineux après formatage μοιάζει με ceci :

  
    John Doe
    johndoe@example.com
    <διεύθυνση>
      123 Main St
      Springfield
      IL
      62704
      ΗΠΑ
    
    <Αριθμοί τηλεφώνου>
      555-1234
      555-5678
    
    
      true
      σκοτεινό
    
    2024-06-14T09:30:00Z