[スキーマチェックに関する質問]xsdによってxmlを検証し、複数エラーメッセージを返却値として受け取りたい

Question

はじめに

初めまして、エンジニア歴1年目で最近C#を触り始めたものです。
早速ですが、1週間ほど悩んで解決できないことがあるので質問させていただきます。

使用環境及び言語

Microsoft Visual Studio 2019でC#を使用しております。

実現したいこと

実現したいこととしましては下記になります。

1.xsdによるxmlの検証(これはおそらくできている)
2.エラーが出た場合、エラーメッセージをArrayList型に設定し、返却値として渡す（すべてのエラーを設定したい）

現在の状況

xsdによってxmlを検証し、コンソールにエラーメッセージを出すところまでは調べれば出てきたのですが、
・複数のエラーが起きた時に最初のエラーのみが表示される点
・実際にはコンソールに表示するのではなく、エラーメッセージをArrayList型に設定し返却値とする点
以上の二点が現在実装できていない状況です。

以下、現在のソースコードです。（xmlファイル、xsdファイルについては適当なものをローカルに保存し、ファイルパスを渡しています）

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

        private ArrayList xmlCheck(string xmlFilePath, string xsdFilePath)
        {
            //xsdファイルパスから型変換
            XmlTextReader reader = new XmlTextReader(xsdFilePath);
            XmlSchema xmlschema = XmlSchema.Read(reader, ValidationCallback);
            XmlSchemaSet schemaSet = new XmlSchemaSet();
            schemaSet.Add(xmlschema);

            // XMLファイルとXSDファイルを設定する。
            XmlDocument xmlDocument = new XmlDocument();
            xmlDocument.Schemas.Add(schemaSet);
            xmlDocument.Load(xmlFilePath);
            try{
                //スキーマチェック
                xmlDocument.Validate(ValidationEventHandler);
                
                //仮の返却値
                return null;
            
            //xsd等の規約に対する例外？（そもそも必要？）
            }catch(XmlSchemaValidationException ex)
            {
                 //エラーあり（true）を返却
                return ex;
            }
        }

        private void ValidationCallback(object sender, ValidationEventArgs e)
            {
                switch (e.Severity)
                {
                    case XmlSeverityType.Error:
                        Console.WriteLine("Error:" + e.Message);
                        break;
                    case XmlSeverityType.Warning:
                        Console.WriteLine("Warning:" + e.Message);
                        break;
                }
            }

        private void ValidationEventHandler(object sender, ValidationEventArgs e)
            {
                switch(e.Severity)
                {
                    case XmlSeverityType.Error:
                        //errorInfoList.Add(e.Message);

                        Console.WriteLine("Error:" + e.Message);
                        break;
                    case XmlSeverityType.Warning:
                        Console.WriteLine("Warning:" + e.Message);
                        break;
                }                   
            }

終わりに

以上が私の質問になります。解答だけでなく分かりにくい点や、もっと情報が欲しい場合等も対応したいと思うので、そういった指摘でもございましたら是非よろしくお願いします。

Comments

[Zuishin]

Validate は間違っているときに例外を起こします。例外が起きたらそれ以上の処理はできません。なので、この方法ですべてのエラーを列挙することはできません。

一つのエラーによって他の部分に問題が発生することがあるので、一つ一つ修正するのが良いと思います。それで賄いきれないくらいエラーがあまりに多く発生するようであれば、XML を使うという方法自体を見直す必要があるかもしれません。それが選べないのであれば、自分で構文チェッカを書くか、サードパーティーの構文チェッカを探す必要があるかもしれません。その場合、予算や使用目的なども書いておくと、情報があるかもしれません。

[k-y]

Zuishinさん ご解答ありがとうございます。

・XML を使うという方法自体を見直す必要があるかもしれません。→選べません…
・サードパーティーの構文チェッカを探す必要があるかもしれません。→調べてみます

ps:→思い付きですが、ノード毎に繰り返しValidate メソッド使用するのはどうかと思ったので試してみます。("Validate は間違っているときに例外を起こします。例外が起きたらそれ以上の処理はできません。なので、この方法ですべてのエラーを列挙することはできません。"とあることからダメそうですが)

[Zuishin]

スキーマがルートから指定しているのでなければできるかもしれませんが、無理じゃないかなと思います。

Answer 1

ちょっと制限があるかもしれませんが以下のようにする事で、複数個のXSDエラーを取得することができました。
~~ちょっとした制限っていうのは、XML側でXSDを指定していると多分だめだという事です。~~大丈夫そうでした。
やり方としては以下のようにXMLをXSD無しで、ロードした後Validationです。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Xml;
using System.Xml.Schema;
using System.Xml.XPath;

namespace XmlSchemaValidate {
    class Program {
        static void Main(string[] args) {
            // XMLファイルとXSDファイルを設定する。
            XmlDocument document = new XmlDocument();
            document.Load("test.xml");

            XmlTextReader reader = new XmlTextReader("test.xsd");
            XmlSchema xmlschema = XmlSchema.Read(reader, ValidationCallback);
            XmlSchemaSet schemaSet = new XmlSchemaSet();
            schemaSet.Add(xmlschema);
            document.Schemas.Add(schemaSet);

            try {
                ValidationEventHandler eventHandler = new ValidationEventHandler(ValidationEventHandler);
                document.Validate(eventHandler);
            } catch (Exception ex) {
                Console.WriteLine(ex.Message);
            }
            Console.Read();
        }
        static void ValidationEventHandler(object sender, ValidationEventArgs e) {
            switch (e.Severity) {
                case XmlSeverityType.Error:
                    Console.WriteLine("Error: {0}", e.Message);
                    break;
                case XmlSeverityType.Warning:
                    Console.WriteLine("Warning {0}", e.Message);
                    break;
            }
        }
        static void ValidationCallback(object sender, ValidationEventArgs e) {
            //こっちは動かない
        }
    }
}

XMLとXSDはここのものをちょっと変更しただけです。

<bookstore xmlns="http://www.contoso.com/books">
    <book genre="autobiography" publicationdate="1981-03-22">
        <title>The Autobiography of Benjamin Franklin</title>
        <author>
            <first-name>Benjamin</first-name>
            <last-name>Franklin</last-name>
        </author>
        <price>8.99</price>
    </book>
    <book genre="novel" publicationdate="1967-11-17" ISBN="0-201-63361-2">
        <title>The Confidence Man</title>
        <authorr>
            <first-name>Herman</first-name>
            <last-name>Melville</last-name>
        </authorr>
        <price>11.99</price>
    </book>
    <books genre="philosophy" publicationdate="1991-02-15" ISBN="1-861001-57-6">
        <title>The Gorgias</title>
        <author>
            <name>Plato</name>
        </author>
        <price>9.99</price>
    </books>
</bookstore>

<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.contoso.com/books" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="bookstore">
        <xs:complexType>
            <xs:sequence>
                <xs:element maxOccurs="unbounded" name="book">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="title" type="xs:string" />
                            <xs:element name="author">
                                <xs:complexType>
                                    <xs:sequence>
                                        <xs:element minOccurs="0" name="name" type="xs:string" />
                                        <xs:element minOccurs="0" name="first-name" type="xs:string" />
                                        <xs:element minOccurs="0" name="last-name" type="xs:string" />
                                    </xs:sequence>
                                </xs:complexType>
                            </xs:element>
                            <xs:element name="price" type="xs:decimal" />
                        </xs:sequence>
                        <xs:attribute name="genre" type="xs:string" use="required" />
                        <xs:attribute name="publicationdate" type="xs:date" use="required" />
                        <xs:attribute name="ISBN" type="xs:string" use="required" />
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

Comments

[k-y]

ありがとうございます。早速試してみます。因みに、リストにして返却する云々は解決しました。残りは複数エラーですね。
そこ辺りも含めて、今週に質問自体を更新します。

[k-y]

Console.WriteLine("Error:" + e.Message);→Console.WriteLine("Error: {0}", e.Message);
で複数エラーをコンソールに表示できるんですね。
ValidationEventHandlerでe.Messageをエラーリストに一つしか格納できないんですが、そこは自力で何とかできるかもなのでやってみます。ありがとうございました。