اعتبارسنجی XML

اعتبارسنجی XML چیست؟

یک اعتبارسنج XML بررسی می‌کند که آیا یک سند XML از قوانین ساختاری تعریف‌شده در مشخصات XML 1.0 (توصیه‌نامه W3C، ویرایش پنجم) پیروی می‌کند. در حداقل سطح، این اعتبارسنج XML تأیید می‌کند که سند خوش‌فرم است: یک عنصر ریشه واحد دارد، همه تگ‌ها به‌درستی تودرتو و بسته شده‌اند، مقادیر ویژگی‌ها در نقل‌قول قرار دارند، و کاراکترهای رزروشده از موجودیت‌های از پیش تعریف‌شده استفاده می‌کنند. سندی که هر یک از این بررسی‌ها را رد کند، باعث می‌شود تجزیه‌گرهای XML به‌جای اینکه بی‌سروصدا خروجی نادرست تولید کنند، خطا بدهند.

تمایز بین خوش‌فرمی و اعتبار اهمیت دارد. یک سند XML خوش‌فرم قوانین سینتکس خود مشخصات XML را برآورده می‌کند. یک سند XML معتبر فراتر می‌رود: همچنین با محدودیت‌های تعریف‌شده در یک طرح‌واره خارجی، مانند DTD (تعریف نوع سند)، XSD (تعریف طرح‌واره XML) یا طرح‌واره Relax NG مطابقت دارد. این ابزار خوش‌فرمی را بررسی می‌کند که اولین و رایج‌ترین مرحله اعتبارسنجی است. بدون آن، هیچ‌چیز در پایین‌دست نمی‌تواند ادامه یابد.

اعتبارسنجی XML خطاها را پیش از رسیدن به محیط تولید شناسایی می‌کند. تگ‌های نبسته، نام عناصر ناهمخوان، &‌های escape‌نشده، و ویژگی‌های تکراری از رایج‌ترین اشتباهات در XML دستی‌ویرایش‌شده هستند. تجزیه‌گرها در زبان‌های مختلف این خطاها را متفاوت مدیریت می‌کنند: برخی بی‌صدا شکست می‌خورند، برخی نتایج جزئی برمی‌گردانند، و برخی استثنا می‌اندازند. بررسی XML با یک اعتبارسنج این ابهام را برطرف می‌کند و یک پاسخ روشن قبول/رد با جزئیات مکان خطا ارائه می‌دهد.

چرا از اعتبارسنج XML آنلاین استفاده کنیم؟

شناسایی زودهنگام خطاهای سینتکس XML از خرابی‌های زنجیره‌ای در برنامه‌هایی که داده XML مصرف می‌کنند جلوگیری می‌کند. یک اعتبارسنج مبتنی بر مرورگر بازخورد فوری می‌دهد بدون نیاز به نصب ابزارهای خط‌فرمان یا پیکربندی افزونه‌های IDE.

موارد استفاده اعتبارسنج XML

قوانین خوش‌فرمی 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

سوالات متداول