XML Validator

Що таке валідація XML?

XML-валідатор перевіряє, чи відповідає XML-документ структурним правилам специфікації XML 1.0 (Рекомендація W3C, п'яте видання). Щонайменше, цей XML-валідатор підтверджує, що документ є коректно сформованим: він має один кореневий елемент, всі теги правильно вкладені та закриті, значення атрибутів взяті в лапки, а зарезервовані символи використовують наперед визначені entity-посилання. Документ, що не відповідає будь-якій із цих вимог, змушуватиме XML-процесори генерувати помилки, а не мовчки повертати некоректний результат.

Важливо розрізняти коректну сформованість та валідність. Коректно сформований XML-документ задовольняє синтаксичні правила специфікації XML. Валідний XML-документ іде далі: він також відповідає обмеженням, визначеним у зовнішній схемі, наприклад DTD (Document Type Definition), XSD (XML Schema Definition) або схемі Relax NG. Цей інструмент перевіряє коректну сформованість — перший і найпоширеніший крок валідації. Без нього жодна подальша обробка неможлива.

Валідація XML виявляє помилки до того, як вони потраплять на продакшн. Незакриті теги, невідповідні імена елементів, неекрановані амперсанди та дублюючі атрибути — найпоширеніші помилки при ручному редагуванні XML. Процесори різних мов програмування обробляють ці помилки по-різному: деякі мовчки ігнорують їх, деякі повертають часткові результати, а деякі генерують винятки. Попередня перевірка XML у валідаторі усуває цю неоднозначність і дає чітку відповідь «пройдено/не пройдено» з деталями про місце помилки.

Навіщо використовувати онлайн XML Validator?

Раннє виявлення синтаксичних помилок XML запобігає каскадним збоям у застосунках, що обробляють XML-дані. Браузерний валідатор дає миттєвий зворотний зв'язок без встановлення CLI-інструментів або налаштування плагінів IDE.

Сценарії використання XML Validator

Правила коректної сформованості XML

Специфікація XML 1.0 визначає суворий набір синтаксичних правил. Документ повинен відповідати всім із них, щоб вважатися коректно сформованим. У таблиці нижче наведено кожне правило, його вимогу та коректний приклад. Більшість помилок валідації пов'язана з одним із цих правил.

Коректно сформований, валідний відносно DTD та валідний відносно схеми

Валідація XML має три рівні. Цей інструмент перевіряє перший (коректну сформованість), який є передумовою для двох інших.

Приклади коду

Валідуйте XML програмно різними мовами. Кожен приклад перевіряє коректну сформованість і повертає повідомлення про помилку, якщо документ некоректний.

function validateXML(xmlString) {
  const parser = new DOMParser()
  const doc = parser.parseFromString(xmlString, 'application/xml')
  const error = doc.querySelector('parsererror')
  if (error) {
    return { valid: false, message: error.textContent }
  }
  return { valid: true, message: 'Well-formed XML' }
}

validateXML('<root><item>hello</item></root>')
// → { valid: true, message: "Well-formed XML" }

validateXML('<root><item>hello</root>')
// → { valid: false, message: "Opening and ending tag mismatch..." }

import xml.etree.ElementTree as ET

def validate_xml(xml_string):
    try:
        ET.fromstring(xml_string)
        return True, "Well-formed XML"
    except ET.ParseError as e:
        return False, str(e)

valid, msg = validate_xml('<root><item>hello</item></root>')
# → (True, "Well-formed XML")

valid, msg = validate_xml('<root><item>hello</root>')
# → (False, "mismatched tag: line 1, column 27")

# With lxml — also supports XSD schema validation
from lxml import etree
schema = etree.XMLSchema(etree.parse('schema.xsd'))
doc = etree.fromstring(b'<root><item>hello</item></root>')
schema.validate(doc)  # → True or False

package main

import (
    "encoding/xml"
    "fmt"
    "strings"
)

func validateXML(raw string) error {
    decoder := xml.NewDecoder(strings.NewReader(raw))
    for {
        _, err := decoder.Token()
        if err != nil {
            if err.Error() == "EOF" {
                return nil
            }
            return err
        }
    }
}

func main() {
    err := validateXML("<root><item>hello</item></root>")
    fmt.Println(err) // → <nil>

    err = validateXML("<root><item>hello</root>")
    fmt.Println(err) // → XML syntax error: unexpected end element </root>
}

# Check well-formedness (part of libxml2, pre-installed on macOS/Linux)
xmllint --noout document.xml
# Exit code 0 = valid, non-zero = errors printed to stderr

# Validate against an XSD schema
xmllint --noout --schema schema.xsd document.xml

# Validate against a DTD
xmllint --noout --dtdvalid schema.dtd document.xml

# Validate from stdin
echo '<root><unclosed>' | xmllint --noout -
# → :1: parser error : Premature end of data in tag unclosed line 1

Часті запитання