CodeGym /コース /C# SELF /XML を XSD スキーマでバリデーションする

XML を XSD スキーマでバリデーションする

C# SELF
レベル 48, レッスン 4
使用可能

1. なぜXMLのバリデーションが必要か

XML は柔軟性が高いフォーマットで、時に柔軟すぎます。厳密な型付けされたデータとは違い、XMLはエラーに寛容なことがあり、タグの閉じ忘れや属性名の誤りがあっても、パース時にエラーになるか、まったく問題が検出されないことがあります。後者は特に厄介です。

XSD(XML Schema Definition)によるバリデーションは、XMLファイルが事前に定義された契約に完全に従っているかを確認する手段です:タグ名、順序、型、必須性や出現回数などを検証します。データの入国審査のようなもので、スキーマは「必要なフィールドがない、あるいは長さが違うならここを通しません」と教えてくれます。

バリデーションは企業システムや異なるシステム間のデータ交換、APIなど、歪んだ構造を「黙って受け入れたくない」場面で重要です。

XSD(XML Schema Definition)は、別のXMLドキュメントとして書かれ、対象のXMLの構造を形式化して記述します。XSDで、どのタグが許されるか、どれが必須か、属性や子要素の型、文字列のパターン、数値の制約、列挙されうる値などを定義します。

XML XSD(構造の記述)
<person age="23">Ivan</person>
<element name="person" ... />
<item price="1000"/>
<element name="item" type="..." />

XSD は JSON の世界での JSON Schema に似ています。

2. XSD とそれに対応する XML の例

XMLの例

<person age="23">
  <name>Ivan</name>
  <email>ivan@example.com</email>
</person>

XSDの例

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:element name="person">
     <xs:complexType>
       <xs:sequence>
         <xs:element name="name" type="xs:string"/>
         <xs:element name="email" type="xs:string" minOccurs="0"/>
       </xs:sequence>
       <xs:attribute name="age" type="xs:positiveInteger" use="required"/>
     </xs:complexType>
   </xs:element>
</xs:schema>

このスキーマが記述していること:

  • ルート要素は <person> です。
  • <person> の中には <name>(必須)と <email>(任意)が順に存在する必要があります。
  • <person> には正の整数の値を持つ age 属性が必須です。

3. .NETでXSDを使ったXMLのバリデーション

.NETでは定番のやり方として System.Xml と System.Xml.Schema 名前空間を使います。

作業の流れ:

  1. XMLファイルを読み込む
  2. XSDスキーマを読み込む
  3. スキーマをバリデーションに紐付ける
  4. バリデーションを実行し、発生したエラーを処理する

基本的な例は以下のとおりです:

using System;
using System.IO;
using System.Xml;
using System.Xml.Schema;

// 1. バリデーションエラーのハンドラ
void ValidationCallBack(object? sender, ValidationEventArgs e)
{
    Console.WriteLine($"バリデーションエラー: {e.Message}");
}

string xmlPath = "person.xml";
string xsdPath = "person.xsd";

// 2. スキーマを読み込む
XmlSchemaSet schemas = new XmlSchemaSet();
schemas.Add("", xsdPath);

XmlReaderSettings settings = new XmlReaderSettings();
settings.Schemas = schemas;
settings.ValidationType = ValidationType.Schema;
settings.ValidationEventHandler += ValidationCallBack;

// 3. 設定を使ってXMLを開く
using XmlReader reader = XmlReader.Create(xmlPath, settings);
while (reader.Read())
{
    // ドキュメントを通過するだけで、バリデーションは"オンザフライ"で行われる
}

Console.WriteLine("バリデーションが完了しました!");

補足説明:

  • すべてのバリデーションエラーはコールバック ValidationCallBack で捕捉されます。
  • エラーがなければドキュメントはスキーマに準拠しています(ValidationType.Schema)。
  • 不一致がある場合(age が欠けている、無効な email、余分なフィールドなど)はコンソールに表示されます。

エラーの種類とフィードバック

XSDバリデーションがエラーを出す理由はいろいろあります。よくあるケースとエラーメッセージ例:

  • 必須要素がない(デフォルトで minOccurs="1")
  • XSDに記述のない余分なタグがある
  • 属性の型が不正(age="abc" のように数値を期待しているのに文字列になっている)
  • 文字列がパターンに合致しない(<xs:pattern>で定義された場合)

典型的なエラー例:

バリデーションエラー: テキスト内容 'abc' を持つ要素 'age' は許可されていません。期待される型は 'xs:positiveInteger' です。

4. より複雑なXSD:型、列挙、パターン

XSDは許容されるデータを記述するための強力な言語構造です。いくつかの応用例を示します:

許容値の列挙

<xs:element name="gender">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:enumeration value="male"/>
      <xs:enumeration value="female"/>
      <xs:enumeration value="diverse"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

文字列長の制限

<xs:element name="code">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:length value="8"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

簡易的な email 用パターン

<xs:element name="email">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:pattern value="\w+@\w+\.\w+"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

独自の型を定義したり継承したり、入れ子要素を使ったりできるので、ほぼOOP的な設計が可能です。

5. 複雑なドキュメントのバリデーション

学習用アプリが学生リストをXMLでエクスポートすると仮定します。コードを増やしてみます。

XMLの例

<students>
  <student id="1">
    <name>Elena</name>
    <grade>5</grade>
  </student>
  <student id="2">
    <name>Alexey</name>
    <grade>4</grade>
  </student>
</students>

XSDスキーマ

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="students">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="student" maxOccurs="unbounded">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="name" type="xs:string"/>
              <xs:element name="grade">
                <xs:simpleType>
                  <xs:restriction base="xs:integer">
                    <xs:minInclusive value="1"/>
                    <xs:maxInclusive value="5"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
            </xs:sequence>
            <xs:attribute name="id" type="xs:integer" use="required"/>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

コードでのバリデーション(同様の手法):

// ファイルパス
string xmlPath = "students.xml";
string xsdPath = "students.xsd";

XmlSchemaSet schemas = new XmlSchemaSet();
schemas.Add("", xsdPath);

XmlReaderSettings settings = new XmlReaderSettings();
settings.Schemas = schemas;
settings.ValidationType = ValidationType.Schema;
settings.ValidationEventHandler += ValidationCallBack;

using XmlReader reader = XmlReader.Create(xmlPath, settings);
while (reader.Read()) { /* 前と同じ */ }

6. 役立つ注意点

XML内でスキーマを指定する方法(xsi:schemaLocation)

実務では、ルート要素に xsi:schemaLocation や xsi:noNamespaceSchemaLocation 属性が入っているXMLをよく見かけます:

<students xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="students.xsd">
    ...
</students>

これ自体が「自動的に」ファイルをバリデートするわけではありませんが、バリデータやエディタがスキーマを見つけるのに役立ちます。.NETのバリデーションでは必須ではありませんが、形式的には正しい指定です。

オンザフライバリデーションとメモリ内(XDocument)でのバリデーション

LINQ to XML(XDocument)を使っている場合、ファイルを使わずメモリ内のXMLドキュメントをバリデートすることもできます:

using System.Xml.Linq;
using System.Xml.Schema;

// スキーマの読み込み
XmlSchemaSet schema = new XmlSchemaSet();
schema.Add("", "students.xsd");

// XMLをメモリにロード
XDocument doc = XDocument.Load("students.xml");

// バリデーション
doc.Validate(schema,
    (o, e) => Console.WriteLine($"エラー: {e.Message}"),
    true // 警告もチェックする(多くの場合冗長かも)
);

この方法は、XMLをプログラムで生成・変更しているときに便利で、自分で作った変更がスキーマ違反の「XMLモンスター」を生んでいないか確認できます。

7. XSDでのXMLバリデーションでよくあるミス

ミス1:スキーマの追加を忘れるか、XSDへのパスが間違っている。
その結果、バリデーションがまったく実行されず、XMLファイルがバリデータの目をすり抜けてしまいます。パスは相対パスで指定されることが多く、アプリが想定外の場所を探していることがあります。テスト時は絶対パスを使うか、実行ファイルの近くにスキーマを置くと良いです。

ミス2:名前空間(namespace)が一致していない。
スキーマが名前空間を使っている場合、XmlSchemaSet.Add の第2引数に正しい名前空間を渡す必要があります。渡さないと、XML構造が正しくてもバリデーションに失敗します。名前空間がない場合は空文字列を渡してください。

ミス3:要素の順序が一致していない。
スキーマに <xs:sequence> があると要素の順序は重要です。正しい要素が間違った順序で並んでいるとエラーになります。

ミス4:XMLに複数の名前空間が指定されている。
ドキュメントが複数のnamespaceを使っていると、バリデーションで予期せぬ問題が発生することがあります。複数namespaceを扱う場合はスキーマの設定を慎重に行ってください。

ミス5:エラーの収集と保存をしていない。
コンソールにエラーを出すだけはデバッグには十分ですが、本番用途には向きません。エラーはリストに集めてユーザーにわかりやすい形で返すのが良いです。特に大量ファイルをチェックする場合(例:ウェブサーバー上)に重要です。

2
タスク
C# SELF, レベル 48, レッスン 4
ロック未解除
XML構造の拡張と複数ルールによるバリデーション
XML構造の拡張と複数ルールによるバリデーション
1
アンケート/クイズ
XMLデータの操作、レベル 48、レッスン 4
使用不可
XMLデータの操作
XMLシリアライズの設定
コメント
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION