XML文書の妥当性検証 (RELAX NG, NVDL)

(2007.12.12 ページを分割。)

目次::

  1. XML文書を検証するとは
  2. いろいろなスキーマ
  3. ボヘミアン vs 貴族
  4. RELAX NG, DSDL
  5. REXML (Ruby) で RELAX NG
  6. RELAX NGの書き方
  7. NVDL

@ XML文書を検証するとは

アプリケーションプログラム同士がデータをやりとりするのにXMLを使うことがあります。

XMLデータ(XML文書)が適切かどうかチェックしなければなりませんが、いちいちプログラムを手書きするのは大変です。

XML文書が従うべき文法 -- 要素名や属性名、ある要素がどの要素・属性を含むことができるか -- を定めて、汎用の検証器に掛けるようにすれば、手間が減り、チェック漏れも防げます。

XML文書の文法をスキーマ(スキーマ文書)といいます。XML文書の妥当性検査は、スキーマ文書を用意して、そのスキーマに照らしてXML文書が逸脱していないかを検証します。

XML文書は、スキーマ文書の組に対して、「妥当」か「妥当ではない」のいずれかとなります。

HTMLを解釈するWebブラウザのような、処理プログラムが適宜おぎなって、解釈できるところまで処理する、ということは想定されていません。エラーを含むXML文書も受け入れたいときは、そもそもスキーマの方を修正すべきです。

@ いろいろなスキーマ

スキーマの書き方にもいくつかありますが、メジャーなものは次の3つです。

  • DTD
  • W3C XML Schema
  • RELAX NG

このほか、スキマトロン (Schematron) などもあります。

DTDはSGMLの頃から使われているもので、XML仕様の一部にもなっています。ただ、

  • 文法が複雑で、ツールを書くのが難しい
  • 直接の子しか定義できない。文脈によって制約を切り替えられない
  • 属性値として指定できるデータ型が少ない。例えば、HTMLのDTDでは、データ型がみんなCDATAになっています。
など、表現力が不足しています。

W3C XML SchemaはW3Cで開発されたものですが、複雑すぎると言われています。仕様は3部構成になっています。

RELAX NGについては後述。

スキーマの例

同じXML文書を対象として、スキーマを書いてみます。XML Schema Part 0: Primer Second Edition にあるサンプルです。

HTML
[POPUP]
  1. <?xml version="1.0"?>
  2. <purchaseOrder orderDate="1999-10-20">
  3. <shipTo country="US">
  4. <name>Alice Smith</name>
  5. <street>123 Maple Street</street>
  6. <city>Mill Valley</city>
  7. <state>CA</state>
  8. <zip>90952</zip>
  9. </shipTo>
  10. <billTo country="US">
  11. <name>Robert Smith</name>
  12. <street>8 Oak Avenue</street>
  13. <city>Old Town</city>
  14. <state>PA</state>
  15. <zip>95819</zip>
  16. </billTo>
  17. <comment>Hurry, my lawn is going wild</comment>
  18. <items>
  19. <item partNum="872-AA">
  20. <productName>Lawnmower</productName>
  21. <quantity>1</quantity>
  22. <USPrice>148.95</USPrice>
  23. <comment>Confirm this is electric</comment>
  24. </item>
  25. <item partNum="926-AA">
  26. <productName>Baby Monitor</productName>
  27. <quantity>1</quantity>
  28. <USPrice>39.98</USPrice>
  29. <shipDate>1999-05-21</shipDate>
  30. </item>
  31. </items>
  32. </purchaseOrder>

文章で仕様を書こうと思うと、

  1. ルート要素はpurchaseOrder
  2. purchaseOrderはshipToとbillTo、それにitemsを含む
  3. itemsはitemを複数含む
  4. itemは、productName...を含む
  5. ...
と、長々と書かなければいけませんし、条件を完全に書き下すのは困難です。

まず、W3C XML Schemaの例。XML Schema Part 0: Primer Second Edition の丸写しです。

HTML
[POPUP]
  1. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  2. <xsd:element name="purchaseOrder" type="PurchaseOrderType"/>
  3. <xsd:element name="comment" type="xsd:string"/>
  4. <xsd:complexType name="PurchaseOrderType">
  5. <xsd:sequence>
  6. <xsd:element name="shipTo" type="USAddress"/>
  7. <xsd:element name="billTo" type="USAddress"/>
  8. <xsd:element ref="comment" minOccurs="0"/>
  9. <xsd:element name="items" type="Items"/>
  10. </xsd:sequence>
  11. <xsd:attribute name="orderDate" type="xsd:date"/>
  12. </xsd:complexType>
  13. <xsd:complexType name="USAddress">
  14. <xsd:sequence>
  15. <xsd:element name="name" type="xsd:string"/>
  16. <xsd:element name="street" type="xsd:string"/>
  17. <xsd:element name="city" type="xsd:string"/>
  18. <xsd:element name="state" type="xsd:string"/>
  19. <xsd:element name="zip" type="xsd:decimal"/>
  20. </xsd:sequence>
  21. <xsd:attribute name="country" type="xsd:NMTOKEN" fixed="US"/>
  22. </xsd:complexType>
  23. <xsd:complexType name="Items">
  24. <xsd:sequence>
  25. <xsd:element name="item" minOccurs="0" maxOccurs="unbounded">
  26. <xsd:complexType>
  27. <xsd:sequence>
  28. <xsd:element name="productName" type="xsd:string"/>
  29. <xsd:element name="quantity">
  30. <xsd:simpleType>
  31. <xsd:restriction base="xsd:positiveInteger">
  32. <xsd:maxExclusive value="100"/>
  33. </xsd:restriction>
  34. </xsd:simpleType>
  35. </xsd:element>
  36. <xsd:element name="USPrice" type="xsd:decimal"/>
  37. <xsd:element ref="comment" minOccurs="0"/>
  38. <xsd:element name="shipDate" type="xsd:date" minOccurs="0"/>
  39. </xsd:sequence>
  40. <xsd:attribute name="partNum" type="SKU" use="required"/>
  41. </xsd:complexType>
  42. </xsd:element>
  43. </xsd:sequence>
  44. </xsd:complexType>
  45. <!-- Stock Keeping Unit, a code for identifying products -->
  46. <xsd:simpleType name="SKU">
  47. <xsd:restriction base="xsd:string">
  48. <xsd:pattern value="\d{3}-[A-Z]{2}"/>
  49. </xsd:restriction>
  50. </xsd:simpleType>
  51. </xsd:schema>

要素の内容を型 (complexType) として定義します。例えば、shipTo要素の内容(子要素と属性)をUSAddress型として定義します。

データ型として、string, decimalなどが用意されていて、さらにmaxExclusiveやpatternで制約を加えることができます。

要素の出現回数は、minOccursやmaxOccursで制約を付けれます。

次は、RELAX NGです。

HTML
[POPUP]
  1. <grammar xmlns="http://relaxng.org/ns/structure/1.0"
  2. datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes" >
  3. <start>
  4. <element name="purchaseOrder">
  5. <attribute name="orderDate"><data type="date" /></attribute>
  6. <element name="shipTo"><ref name="USAddress" /></element>
  7. <element name="billTo"><ref name="USAddress" /></element>
  8. <optional><ref name="comment"/></optional>
  9. <element name="items">
  10. <oneOrMore>
  11. <element name="item">
  12. <attribute name="partNum">
  13. <data type="string">
  14. <param name="pattern">\d{3}-[A-Z]{2}</param>
  15. </data>
  16. </attribute>
  17. <element name="productName"><text /></element>
  18. <element name="quantity">
  19. <data type="positiveInteger">
  20. <param name="maxExclusive">100</param>
  21. </data>
  22. </element>
  23. <element name="USPrice"><data type="decimal" /></element>
  24. <optional><ref name="comment"/></optional>
  25. <optional>
  26. <element name="shipDate"><data type="date" /></element>
  27. </optional>
  28. </element>
  29. </oneOrMore>
  30. </element>
  31. </element>
  32. </start>
  33. <define name="USAddress">
  34. <attribute name="country"><data type="NMTOKEN" /></attribute>
  35. <element name="name"><text /></element>
  36. <element name="street"><text /></element>
  37. <element name="city"><text /></element>
  38. <element name="state"><text /></element>
  39. <element name="zip"><data type="decimal" /></element>
  40. </define>
  41. <define name="comment">
  42. <element name="comment"><text /></element>
  43. </define>
  44. </grammar>

RELAX NGは、elementの中に子要素を書いていってもいいですし、defineとrefで括りだすこともできます。

datatypeLibrary属性でXML Schemaのデータ型を引用しています。ほかのライブラリを引用することもできます。引用したデータ型ライブラリは、data、param要素で使えます。

要素の数は、oneOrMore、optional などで指定します。

RELAX NGは、XML Schemaで指定できる、デフォルト値や固定値を指定することはできません。この点は後述します。

最後に、RELAX NG Compact Syntax で書いてみます。

grammar {
  start = 
    element purchaseOrder {
      attribute orderDate { xsd:date },
      element shipTo { USAddress },
      element billTo { USAddress },
      comment?,
      element items {
        element item {
          attribute partNum {
            xsd:string { pattern = "\d{3}-[A-Z]{2}" }
          },
          element productName { text },
          element quantity {
            xsd:positiveInteger { maxExclusive = "100" }
          },
          element USPrice { xsd:decimal },
          comment?,
          element shipDate { xsd:date }?
        }+
      }
    }

  USAddress = 
    attribute country { xsd:NMTOKEN },
    element name { text },
    element street { text },
    element city { text },
    element state { text },
    element zip { xsd:decimal }

  comment =
    element comment { text }
}

非常に簡潔です。短いですが、RELAX NGと内容は同一です。

@ ボヘミアン vs 貴族

DTD, W3C XML Schemaはスキーマにデフォルト値、固定値を含めることができます。一方、RELAX NGは含められません。

例えば、XML Schemaでは、次のように書いてデフォルト値を指定します。要素の内容のデフォルト値も指定できます。

HTML
[POPUP]
  1. <xsd:element name="comment" type="xsd:string" default="(comment space)"/>
  2. <xsd:attribute name="quantity" type="xsd:integer" default="1"/>

スキーマがデフォルト値などを持てるかどうかは、思想の問題です。

スキーマがデフォルト値などを持てる、ということは、スキーマの有無で処理すべきXML文書の値が変わることがある、ということになります。

スキーマにより付加される情報があることを明確にするため、検証後のXML文書のことをPSVI -- Post-Schema-Validation Infoset -- と言うことがあります。

XML Schemaを推進する立場は、XML文書は「常に」スキーマとセットで処理されるべきであり、データ(XML要素の内容、属性値)は型を持つべき、突き詰めると、スキーマのないXML文書は無効、整形式のXML文書は廃止すべき、です。この立場は時に「貴族」と呼ばれます。

一方、RELAX NGを推進する立場は、XML文書はスキーマと組み合わせてもいいし、XML文書単独で使ってもよい、というもので、整形式のXML文書も排除したりしません。この立場は「ボヘミアン」と呼ばれます。

適用分野によっても違うのでしょうが、Web界隈だと、XML文書をXPathなどでつまみ食いしたりすることが多く、いちいちスキーマを要求されては実用になりません。

@ RELAX NG, DSDL

歴史的には、W3C XML Schemaが開発されている(ドラフト段階)ときに、その複雑さを嫌って、RELAX (RELAX Core) とTREXが開発されました。その後、RELAX CoreとTREXを統合する形でRELAX NGは生まれました。

RELAX NGは標準化団体の一つOASISで標準化されました。現在は、Document Schema Definition Languages (DSDL) の1パートとして、ISO化されています。JIS化もされています。

2007.12現在、DSDLで標準化されているものは、

  • Part 2: Regular-grammar-based validation -- RELAX NG, Amendment 1 Compact Syntax; JIS X 4177-2 文書スキーマ定義言語 (DSDL) - 第2部: 正規文法に基づく妥当性検証 - RELAX NG
  • Part 3: Rule-based validation -- Schematron
  • Part 4: Namespace-based Validation Dispatching Language (NVDL)

このほか、次のパートの標準化が予定されています。

  • Part 1: Overview
  • Part 5: Data Type Library Language - DTLL
  • Part 6: Path-based integrity constraints
  • Part 7: Character Repertoire Description Language - CRDL
  • Part 8: Document Schema Renaming Language - DSRL
  • Part 9: Datatype- and Namespace-aware DTDs
  • Part 10: Validation Management

RELAX NGの仕様は、下記で参照できます。

RELAX NGは、生け垣オートマトンというモデルにもとづいて、XML文書に対するパターンをスキーマとして定義していきます。直感的には、文字列に対する正規表現パターンのようなものです。RELAX NGパターンがXML文書とマッチすれば妥当、マッチしなければ妥当でないという結果になります。

実装

Ruby 1.8に添付のXMLライブラリREXMLも、(だいぶ)制限があるものの、RELAX NGに対応しています。

このほか、

mono-xmltool
Fedora8でパッケージが用意されています。RELAX NG (XML構文), RELAX NG短縮構文, NVDL, XML Schema, DTDに対応しています。XSLTによるXML文書の変換も可能。
Sun Multi-Schema XML Validator (MSV)
RELAX NG, RELAX Namespace, RELAX Core, TREX, XML DTD, XML Schema Part 1のサブセットをサポート。
Jing
RELAX NG, RELAX NG Compact Syntax
Trang
多フォーマットスキーマ変換。RELAX NG, RELAX NG Compact Syntax, XML DTD, W3C XML Schema
SourceForge.net: RelaxNGCC
RELAX NG文法からJavaソースを生成。

この辺も参考になります。

Todd Ditchendorf’s Blog. » RELAX NG

@ REXML (Ruby) で RELAX NG

Ruby 1.8.6に添付されているREXMLは、DTDとRELAX NGを(一応)扱えるようになっています。RELAX NG短縮構文には対応していません。複数のスキーマを名前空間で切り替えて検証するNVDLにも対応していません。

RELAX NGでは、次のものは実装されていません。あまり本格的とは言えません。

data param include externalRef notAllowed anyName nsName except name

ラッパ

XML文書のなかで、スキーマでテキストを書けないことになっている場所に空白文字や改行が含まれると、検証エラーになってしまいます。

不便すぎるので、簡単なラッパを作ります。

Ruby
[POPUP]
  1. require 'rexml/document'
  2. require 'rexml/validation/relaxng'
  3. require 'rexml/parsers/sax2parser'
  4. # Ruby 1.8.6のREXMLのバリデータはXML文書の空白の扱いがまずいので、簡単にラップする。
  5. class WrapValidator
  6. def initialize v
  7. @validator = v
  8. end
  9. def receive event
  10. return if event[0] == :text && event[1].strip == ""
  11. @validator.receive event
  12. end
  13. end
  14. # RELAX NGのパターンを読ませる。
  15. validator = REXML::Validation::RelaxNG.new <<EOF
  16. <element name="addressBook" xmlns="http://relaxng.org/ns/structure/1.0">
  17. <zeroOrMore>
  18. <element name="card">
  19. <element name="name"><text/></element>
  20. <element name="email"><text/></element>
  21. </element>
  22. </zeroOrMore>
  23. </element>
  24. EOF
  25. wrapper = WrapValidator.new validator
  26. # XML文書を用意する。
  27. source = <<EOF
  28. <addressBook>
  29. <card>
  30. <name>John Smith</name>
  31. <email>js@example.com</email>
  32. </card>
  33. <card>
  34. <name>Fred Bloggs</name>
  35. <email>fb@example.net</email>
  36. </card>
  37. </addressBook>
  38. EOF
  39. # SAX2パーサに登録してみる。
  40. parser = REXML::Parsers::SAX2Parser.new source
  41. parser.add_listener wrapper
  42. # エラーなくパースできればOK
  43. parser.parse

@ RELAX NGの書き方

RELAX NGのチュートリアルがあります。これを見ながら、書き方を確認してみましょう。

まず、RELAX NGパターン;

HTML
[POPUP]
  1. <element name="addressBook" xmlns="http://relaxng.org/ns/structure/1.0">
  2. <zeroOrMore>
  3. <element name="card">
  4. <element name="name"><text/></element>
  5. <element name="email"><text/></element>
  6. </element>
  7. </zeroOrMore>
  8. </element>

主な要素は、

element 要素。nameで要素名を表す。属性、内容は子要素として書く。
zeroOrMore0回以上
oneOrMore1回以上
optionalあるかないか
choice 子としていくつかのパターンを取り、そのいずれか
group 要素をグループ化。choiceの子パターンとして使用
attribute属性。nameで属性名を表す。
empty elementの子として、空要素を明確にする。
ref 別に定義されたパターンへの参照。name属性で参照先を表す。
define refで参照される定義。
data 要素の内容、属性値のデータ型。param要素でさらに制約を加えられる。
list 空白文字で区切られた値

例えば、属性値を二つの値のいずれかに制約したいときは、

HTML
[POPUP]
  1. <attribute name="preferredFormat">
  2. <choice>
  3. <value>html</value>
  4. <value>text</value>
  5. </choice>
  6. </attribute>

要素の内容が空白で区切られた1個以上の実数、という制約は、

HTML
[POPUP]
  1. <element name="vector">
  2. <list>
  3. <oneOrMore>
  4. <data type="double"/>
  5. </oneOrMore>
  6. </list>
  7. </element>

RELAX NGでは、スキーマのelementの順序がそのままXML文書での要素の順序になります。どの順でもいい、というときはinterleaveで囲みます。

次のパターンは、nameとemailはどちらが先でもいいですが、ただ1回ずつ出現しなければなりません。

HTML
[POPUP]
  1. <element name="card">
  2. <interleave>
  3. <element name="name"><text/></element>
  4. <element name="email"><text/></element>
  5. </interleave>
  6. </element>

どのような順序でも、何回でも書けるようにするには、interleaveとzeroOrMoreを組み合わせます。例えば、次のパターンは、

HTML
[POPUP]
  1. <element name="head" xmlns="http://relaxng.org/ns/structure/1.0">
  2. <interleave>
  3. <element name="title"><text /></element>
  4. <zeroOrMore>
  5. <element name="meta">
  6. <attribute name="name"/>
  7. <attribute name="content"/>
  8. </element>
  9. </zeroOrMore>
  10. </interleave>
  11. </element>

次のXML文書にマッチします。zeroOrMoreで複数回書ける要素は、それぞれ出現順序がバラバラでもOK。

HTML
[POPUP]
  1. <head>
  2. <meta name="ROBOTS" content="NOODP"/>
  3. <title>foobar</title>
  4. <meta name="description" content="テスト"/>
  5. </head>

@ NVDL

XMLは、SGMLと違って、名前空間によって複数のスキーマに従う文書を書けるようになっています。

最近は実際に、一つのXML文書がいくつかのスキーマに従うXML片からなることも珍しくありません。例えば、SVGの中にXHTMLがある、Atomフィード文書にXHTMLが含まれる、など。

このようなXML文書を検証するためには、XML文書を切り分けて、AtomについてはAtomのスキーマ、XHTMLについてはXHTMLのスキーマで検証しなければなりません。

このような課題に対して開発されたのがNVDL (Namespace-based Validation Dispatching Language) です。

NVDLは、XML名前空間を基に、各スキーマにXML片を配分します。

次のNVDL文書と、

HTML
[POPUP]
  1. <rules xmlns="http://purl.oclc.org/dsdl/nvdl/ns/structure/1.0">
  2. <namespace ns="tag:hello-world">
  3. <validate schema="hello-world.rng" />
  4. </namespace>
  5. <namespace ns="tag:fuga">
  6. <validate schema="fuga.rng" />
  7. </namespace>
  8. </rules>

次の二つのRELAX NGパターンは、

HTML
[POPUP]
  1. <element name="a:root" xmlns="http://relaxng.org/ns/structure/1.0"
  2. xmlns:a="tag:hello-world">
  3. <element name="a:x"><text/></element>
  4. </element>
HTML
[POPUP]
  1. <element name="b:y" xmlns="http://relaxng.org/ns/structure/1.0"
  2. xmlns:b="tag:fuga">
  3. <text/>
  4. </element>

次のXML文書にマッチします。

HTML
[POPUP]
  1. <root xmlns="tag:hello-world">
  2. <x>
  3. <foo:y xmlns:foo="tag:fuga">123</foo:y>
  4. </x>
  5. </root>

tag:hello-world の要素xは内容がtextになっているにも関わらず、tag:fuga の要素yが書けることに注意してください。

リンク

International and National Standardization Status of DSDL DSDL(スキマトロン,NVDL,他)の国際および国内の標準化動向
NVDL Tutorial
An introduction to NVDL, ISO 19757-4
標準情報 TR X 0029:2000 XML正規言語記述 RELAX コア 解説