Định dạng XML

Vì sao thụt lề lại XML rủi ro hơn bạn tưởng

Khoảng trắng trong XML mặc định là có ý nghĩa, và đây là điều khiến nhiều người vấp phải. Không như JSON, nơi định dạng chẳng ảnh hưởng gì, một trình phân tích XML buộc phải báo các dấu cách và ký tự xuống dòng giữa các phần tử là nội dung văn bản — chính schema, nếu có, mới là thứ cho biết chúng có thể bị bỏ qua. Vì vậy, thụt lề lại một tài liệu thực sự làm thay đổi nó; với phần lớn file cấu hình và file dữ liệu thì chẳng có gì bị ảnh hưởng, còn với tài liệu có nội dung hỗn hợp — văn bản và phần tử nằm cạnh nhau, như trong XHTML hay DocBook — nó có thể làm thay đổi điều tài liệu muốn nói.

Do đó, việc định dạng ở đây không động đến những gì phải giữ nguyên. Một phần tử mang xml:space="preserve" giữ nguyên nội dung đúng như đã viết, vì thuộc tính này tồn tại chính là để nói điều đó. Các phần CDATA được giữ nguyên, không động chạm; chúng tồn tại để chứa văn bản không được diễn giải, và định dạng lại bên trong sẽ làm hỏng chúng. Tham chiếu entity vẫn giữ dạng tham chiếu thay vì bị mở rộng thành các ký tự mà chúng đại diện.

Namespace được giữ nguyên đúng như đã viết — tiền tố, phần khai báo và các phần tử gắn với chúng. Nghe có vẻ hiển nhiên nhưng không phải vậy: một công cụ định dạng chuẩn hóa tiền tố, hoặc chuyển phần khai báo đến chỗ nó cho là đúng, sẽ tạo ra một tài liệu tương đương về mặt kỹ thuật nhưng lại lỗi với những công cụ so khớp theo đúng chữ của tiền tố. Thứ tự thuộc tính cũng được giữ, dù XML coi nó là vô nghĩa, vì cùng một lý do — so sánh khác biệt với phiên bản trước đáng giá hơn sự gọn gàng.

Thứ được kiểm tra trong lúc định dạng là cú pháp (well-formedness): mọi thẻ đều được đóng, lồng nhau đúng, có một phần tử gốc, ký tự hợp lệ, dấu & và dấu ngoặc nhọn được thoát đúng cách. Đó là mức thấp hơn trong hai mức yêu cầu của XML. Một tài liệu có thể đúng cú pháp hoàn toàn mà vẫn không hợp lệ theo DTD hay schema quy định nó, và định dạng bao nhiêu cũng không cho thấy điều đó.

Khi bạn cần công cụ khác

xmllint --format in.xml làm cùng việc này trên dòng lệnh và đã được cài sẵn trên hầu hết hệ thống Unix; xmlstarlet fo --indent-tab cho bạn kiểm soát nhiều hơn với chính kiểu thụt lề. Cả hai đều xử lý được những file lớn hơn nhiều so với mức một trang web có thể giữ trong bộ nhớ.

Khi tài liệu cần được so sánh, ký số hoặc lưu trữ ở dạng chuẩn tắc, định dạng hoàn toàn là thao tác sai. Canonical XML — xmllint --c14n — tạo ra đúng một dạng chuẩn hóa mà hai tài liệu tương đương đều quy về, và đó là thứ chữ ký số trên XML dựa vào. Định dạng lại một tài liệu đã ký sẽ làm hỏng chữ ký của nó, và đó là cách học bài học này đắt giá nhất.