XSDファイルに対してXMLファイルを検証する最良の方法は何ですか?


263

私に与えられたxsdファイルに準拠する必要があるいくつかのxmlファイルを生成しています。それらが準拠していることを確認する最良の方法は何ですか?

回答:


336

Javaランタイムライブラリは検証をサポートしています。前回チェックしたのは、これが内部のApache Xercesパーサーでした。おそらくjavax.xml.validation.Validatorを使用する必要があります。

import javax.xml.XMLConstants;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.*;
import java.net.URL;
import org.xml.sax.SAXException;
//import java.io.File; // if you use File
import java.io.IOException;
...
URL schemaFile = new URL("http://host:port/filename.xsd");
// webapp example xsd: 
// URL schemaFile = new URL("http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd");
// local file example:
// File schemaFile = new File("/location/to/localfile.xsd"); // etc.
Source xmlFile = new StreamSource(new File("web.xml"));
SchemaFactory schemaFactory = SchemaFactory
    .newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
try {
  Schema schema = schemaFactory.newSchema(schemaFile);
  Validator validator = schema.newValidator();
  validator.validate(xmlFile);
  System.out.println(xmlFile.getSystemId() + " is valid");
} catch (SAXException e) {
  System.out.println(xmlFile.getSystemId() + " is NOT valid reason:" + e);
} catch (IOException e) {}

スキーマファクトリ定数は、http://www.w3.org/2001/XMLSchemaXSDを定義する文字列です。上記のコードは、URLに対してWARデプロイメント記述子を検証しますhttp://java.sun.com/xml/ns/j2ee/web-app_2_4.xsdが、ローカルファイルに対しても同様に簡単に検証できます。

DOMParserを使用してドキュメントを検証しないでください(とにかくドキュメントオブジェクトモデルを作成することが目的でない場合)。これにより、ドキュメントを解析するときにDOMオブジェクトの作成が開始されます-使用しない場合は無駄になります。


この例では、DOMまたはSAXパーサーを使用していますか?どちらへの参照も表示されないので、どのパーサーを使用しているかをどのように確認しますか?
ziggy

1
@ziggy-これはJAXP実装の実装詳細です。SunのJDK 6はStreamSourceで SAXパーサーを使用します。この場合、JAXP実装 DOMパーサーを合法的に使用できますが、その必要はありません。検証のためにDOMパーサーを明示的に使用する場合、DOMツリーを確実にインスタンス化します。
McDowell

上記でErrorHandlerを使用するにはどうすればよいですか?ErrorHandlerを作成し、それをバリデーターに関連付けるケースですか?つまり、このSOの質問の例のように、validator.SetErrorHandler()です。stackoverflow.com/ questions/ 4864681/…
ziggy

実行、制御フローではなく、例外的な状況でのみ使用されるべきではありませんか?
マイク2013

このコードは致命的なエラーのみをキャッチしませんか?致命的でないもの(構造的でないものなど)をキャッチできるようにしたい場合は、ErrorHandlerを使用する必要があると思います。
マットフォーサイス2014年

25

Xerces2を使用してこれを行う方法は次のとおりです。このためのチュートリアルはこちら(サインアップが必要)。

元の帰属:ここから露骨にコピー:

import org.apache.xerces.parsers.DOMParser;
import java.io.File;
import org.w3c.dom.Document;

public class SchemaTest {
  public static void main (String args[]) {
      File docFile = new File("memory.xml");
      try {
        DOMParser parser = new DOMParser();
        parser.setFeature("http://xml.org/sax/features/validation", true);
        parser.setProperty(
             "http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation", 
             "memory.xsd");
        ErrorChecker errors = new ErrorChecker();
        parser.setErrorHandler(errors);
        parser.parse("memory.xml");
     } catch (Exception e) {
        System.out.print("Problem parsing the file.");
     }
  }
}

9
SAXパーサーはより効率的です。DOMパーサーはDOMオブジェクトを作成します。この場合の無駄な操作。
McDowell

問題は、XSDに対してXMLを検証することです。この回答では、さらに進んで、不要なParserオブジェクトを取得していますか?
ウェスラー、2015年

"ErrorChecker cannor resolved to a type" ..インポートがありませんか?
Alex


13

これは人気のある質問なので、たとえば、.xmlファイル自体がヘッダーでXSDを指定している場合、xsi:SchemaLocationまたはxsi:noNamespaceSchemaLocation(または特定の名前空間の場合はxsi)exを使用すると、javaが「参照される」xsdに対しても検証できることを指摘します。

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

またはSchemaLocation(常に名前空間からxsdへのマッピングのリスト)

<document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:SchemaLocation="http://www.example.com/my_namespace http://www.example.com/document.xsd">
  ...

他の回答もここで機能します。.xsdファイルは、.xmlファイルで宣言された名前空間に「マッピング」され、名前空間が宣言されているためです。.xmlファイルの名前空間と一致する場合は問題ありません。しかし、カスタムリゾルバを使用できると便利な場合があります ...

javadocsから:「URL、ファイル、またはソースを指定せずにスキーマを作成すると、Java言語は、検証されるドキュメントを調べて、使用するスキーマを見つけるスキーマを作成します。次に例を示します。」

SchemaFactory factory = SchemaFactory.newInstance("http://www.w3.org/2001/XMLSchema");
Schema schema = factory.newSchema();

これは複数の名前空間などで機能します。このアプローチの問題xmlsns:xsiは、おそらくネットワークの場所であるため、デフォルトでは、すべての検証でネットワークにアクセスし、常に最適であるとは限りません。

以下は、XMLファイルを、それが参照するXSD(ネットワークからプルする必要がある場合でも)に対して検証する例です。

  public static void verifyValidatesInternalXsd(String filename) throws Exception {
    InputStream xmlStream = new new FileInputStream(filename);
    DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
    factory.setValidating(true);
    factory.setNamespaceAware(true);
    factory.setAttribute("http://java.sun.com/xml/jaxp/properties/schemaLanguage",
                 "http://www.w3.org/2001/XMLSchema");
    DocumentBuilder builder = factory.newDocumentBuilder();
    builder.setErrorHandler(new RaiseOnErrorHandler());
    builder.parse(new InputSource(xmlStream));
    xmlStream.close();
  }

  public static class RaiseOnErrorHandler implements ErrorHandler {
    public void warning(SAXParseException e) throws SAXException {
      throw new RuntimeException(e);
    }
    public void error(SAXParseException e) throws SAXException {
      throw new RuntimeException(e);
    }
    public void fatalError(SAXParseException e) throws SAXException {
      throw new RuntimeException(e);
    }
  }

xmlファイルがURLを参照している場合でも、xsdを手動で指定するか(他の回答を参照)、または「XMLカタログ」スタイルのリゾルバーを使用することで、ネットワークから参照されているXSDをプルしないようにすることができます。Spring は、URLリクエストを傍受して、検証用のローカルファイルを提供することできます。または、setResourceResolver使用して独自に設定することもできます。

Source xmlFile = new StreamSource(xmlFileLocation);
SchemaFactory schemaFactory = SchemaFactory
                                .newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
Schema schema = schemaFactory.newSchema();
Validator validator = schema.newValidator();
validator.setResourceResolver(new LSResourceResolver() {
  @Override
  public LSInput resolveResource(String type, String namespaceURI,
                                 String publicId, String systemId, String baseURI) {
    InputSource is = new InputSource(
                           getClass().getResourceAsStream(
                          "some_local_file_in_the_jar.xsd"));
                          // or lookup by URI, etc...
    return new Input(is); // for class Input see 
                          // https://stackoverflow.com/a/2342859/32453
  }
});
validator.validate(xmlFile);

別のチュートリアルについては、こちらご覧ください。

デフォルトではDOM解析を使用すると思います。検証している SAXパーサーでも同様のことができます saxReader.setEntityResolver(your_resolver_here);


私にとっては機能しません。schemaFactoryに設定しない限り、resolveResource()メソッドは呼び出されません。
tomasb 2018

ダンノ、私のために働いています。それを介して設定していることを確認しますがsetResourceResolver、それ以上に、おそらく新しい質問を開くかもしれません...
rogerdpack '25 / 07/25

6

Java 7を使用すると、パッケージの説明で提供されるドキュメントに従うことができます。

// create a SchemaFactory capable of understanding WXS schemas
SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);

// load a WXS schema, represented by a Schema instance
Source schemaFile = new StreamSource(new File("mySchema.xsd"));
Schema schema = factory.newSchema(schemaFile);

// create a Validator instance, which can be used to validate an instance document
Validator validator = schema.newValidator();

// validate the DOM tree
try {
    validator.validate(new StreamSource(new File("instance.xml"));
} catch (SAXException e) {
    // instance document is invalid!
}

2
「Java 7.の使用」 これは実際にはJava 5に含まれていました。
Andrew Thompson

4
これは基本的に受け入れられた答えと同じです。ただし、このソリューションは、XMLが解析するDOMを不必要に構築するため、少し効率が悪いようですparser.parse(new File("instance.xml"))。はをvalidator受け入れるためSource、次のことができますvalidator.validate(new StreamSource(new File("instance.xml")))
アルベルト

このように機能すると、xmlファイルの最初のエラーでSAXExceptionがスローされ、検証が停止します。しかし、私はすべての(!)エラーを知りたいのです。代わりにErrorHandler(ErrorHandlerを実装する独自のクラス)を使用すると、すべてのエラーが認識されますが、validator.validateのtry-catch-blockは例外をスローしません。validateを呼び出すクラスでエラーを認識する方法-私のバリデーターの方法?ご協力いただきありがとうございます!
mrbela 2015年

「エラー」(検証エラーなど)と「致命的なエラー」(整形式エラー)があります。通常、1つの致命的なエラーにより解析が停止します。しかし、検証エラーはそれを止めません:あなたは明示的に例外を投げなければなりません。したがって、ErrorHandler検証を行う必要があるかどうかを指定する必要があります。
Ludovic Kuty 2017年

1
お奨めは認めますが、コードは受け入れられた回答よりも見やすく、読みやすくなっています。
時計じかけ

3

Linux-Machineを使用している場合は、無料のコマンドラインツールSAXCountを使用できます。私はこれがとても便利だと思いました。

SAXCount -f -s -n my.xml

dtdおよびxsdに対して検証します。50MBファイルの場合は5秒。

debian squeezeでは、「libxerces-c-samples」パッケージにあります。

dtdとxsdの定義はxml内にある必要があります!それらを個別に構成することはできません。


2
これにより、vimからの単純なXML検証が可能になります(:!SAXCount -f -n -s%)
Shane

4
または、由緒あるxmllintを使用するxmllint --schema phone.xsd phone.xml(13renの回答から)
rogerdpack '19

3

もう1つの答え:生成するファイルを検証する必要があると言ったので(書き込み)、最初に書き込んでから検証のために読み戻すのではなく、書き込み中にコンテンツを検証することができます。SAXベースのライターを使用している場合、Xml検証用のJDK APIを使用しておそらくそれを行うことができます。その場合、「Validator.validate(source、result)」を呼び出してバリデーターにリンクするだけで、ソースはライターから取得され、結果は出力を行う必要がある場所。

あるいは、コンテンツを書き込むためにStaxを使用する場合(またはstaxを使用するか使用できるライブラリ)、WoodstoxはXMLStreamWriterを使用するときの検証を直接サポートすることもできます。ここだブログエントリそれがどのように行われるかを示すには:


StaxMan様、きれいにインデントするXMLStreamWriterはありますか?それが標準の実装にないことに驚いた。また、それは多くの利用を得ていますか?私はそれが正しい方法だと思いますが、それにほとんど関心がないようです。
13ren 2009年

ただStaxMate(それはてXMLStreamWriterではありません)について、ここであなたのポストを見つけました:stackoverflow.com/questions/290326/stax-xml-formatting-in-java/...
13ren

ええ、StaxMateはそれを行うことができます。コンテンツを書き込むために内部的にXMLStreamWriterを使用するため、そのようにバリデーターを接続することもできます。
StaxMan 2010

2

プログラムでXMLファイルを生成している場合は、XMLBeansライブラリを確認することをお勧めします。コマンドラインツールを使用すると、XMLBeanはXSDに基づいて一連のJavaオブジェクトを自動的に生成してパッケージ化します。次に、これらのオブジェクトを使用して、このスキーマに基づいてXMLドキュメントを構築できます。

スキーマ検証のサポートが組み込まれており、JavaオブジェクトをXMLドキュメントに、またはその逆に変換できます。

CastorJAXBは、XMLBeansと同様の目的を果たす他のJavaライブラリです。


1

JAXBでは、以下のコードを使用できます。

    @Test
public void testCheckXmlIsValidAgainstSchema() {
    logger.info("Validating an XML file against the latest schema...");

    MyValidationEventCollector vec = new MyValidationEventCollector();

    validateXmlAgainstSchema(vec, inputXmlFileName, inputXmlSchemaName, inputXmlRootClass);

    assertThat(vec.getValidationErrors().isEmpty(), is(expectedValidationResult));
}

private void validateXmlAgainstSchema(final MyValidationEventCollector vec, final String xmlFileName, final String xsdSchemaName, final Class<?> rootClass) {
    try (InputStream xmlFileIs = Thread.currentThread().getContextClassLoader().getResourceAsStream(xmlFileName);) {
        final JAXBContext jContext = JAXBContext.newInstance(rootClass);
        // Unmarshal the data from InputStream
        final Unmarshaller unmarshaller = jContext.createUnmarshaller();

        final SchemaFactory sf = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
        final InputStream schemaAsStream = Thread.currentThread().getContextClassLoader().getResourceAsStream(xsdSchemaName);
        unmarshaller.setSchema(sf.newSchema(new StreamSource(schemaAsStream)));

        unmarshaller.setEventHandler(vec);

        unmarshaller.unmarshal(new StreamSource(xmlFileIs), rootClass).getValue(); // The Document class is the root object in the XML file you want to validate

        for (String validationError : vec.getValidationErrors()) {
            logger.trace(validationError);
        }
    } catch (final Exception e) {
        logger.error("The validation of the XML file " + xmlFileName + " failed: ", e);
    }
}

class MyValidationEventCollector implements ValidationEventHandler {
    private final List<String> validationErrors;

    public MyValidationEventCollector() {
        validationErrors = new ArrayList<>();
    }

    public List<String> getValidationErrors() {
        return Collections.unmodifiableList(validationErrors);
    }

    @Override
    public boolean handleEvent(final ValidationEvent event) {
        String pattern = "line {0}, column {1}, error message {2}";
        String errorMessage = MessageFormat.format(pattern, event.getLocator().getLineNumber(), event.getLocator().getColumnNumber(),
                event.getMessage());
        if (event.getSeverity() == ValidationEvent.FATAL_ERROR) {
            validationErrors.add(errorMessage);
        }
        return true; // you collect the validation errors in a List and handle them later
    }
}

0

ツールまたはライブラリをお探しですか?

ライブラリに関する限り、事実上の標準は、C ++Javaの両方のバージョンを備えたXerces2です。

ただし、注意が必要です。これは重いソリューションです。しかし、やはり、XSDファイルに対してXMLを検証することは、かなり重い問題です。

これを行うためのツールとしては、XMLFoxはまともなフリーウェアソリューションのようですが、個人的に使用したことがないので、確かには言えません。


0

オンラインスキーマに対して検証する

Source xmlFile = new StreamSource(Thread.currentThread().getContextClassLoader().getResourceAsStream("your.xml"));
SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
Schema schema = factory.newSchema(Thread.currentThread().getContextClassLoader().getResource("your.xsd"));
Validator validator = schema.newValidator();
validator.validate(xmlFile);

ローカルスキーマに対して検証する

JavaによるオフラインXML検証


0

Woodstoxを使用して、スキーマに対して検証し、XMLを解析するようにStAXパーサーを構成します。

例外がキャッチされた場合、XMLは無効です。それ以外の場合は有効です。

// create the XSD schema from your schema file
XMLValidationSchemaFactory schemaFactory = XMLValidationSchemaFactory.newInstance(XMLValidationSchema.SCHEMA_ID_W3C_SCHEMA);
XMLValidationSchema validationSchema = schemaFactory.createSchema(schemaInputStream);

// create the XML reader for your XML file
WstxInputFactory inputFactory = new WstxInputFactory();
XMLStreamReader2 xmlReader = (XMLStreamReader2) inputFactory.createXMLStreamReader(xmlInputStream);

try {
    // configure the reader to validate against the schema
    xmlReader.validateAgainst(validationSchema);

    // parse the XML
    while (xmlReader.hasNext()) {
        xmlReader.next();
    }

    // no exceptions, the XML is valid

} catch (XMLStreamException e) {

    // exceptions, the XML is not valid

} finally {
    xmlReader.close();
}

:複数のファイルを検証する必要がある場合は、パフォーマンスを最大化するためにXMLInputFactoryおよびを再利用してみてくださいXMLValidationSchema


-3

XSDに対してXMLを1回だけ検証する必要があったので、XMLFoxを試しました。私はそれが非常に混乱し、奇妙であることがわかりました。ヘルプの説明がインターフェースと一致していないようです。

私は結局、より使いやすく、すぐに使い慣れたLiquidXML Studio 2008(v6)を使用しました(UIは、頻繁に使用するVisual Basic 2008 Expressに非常に似ています)。欠点:検証機能は無料バージョンにはないため、30日間の試用版を使用する必要がありました。


1
問題はJavaですが、この答えはそうではありません。:-(
james.garriss

公平を期すために、質問には「java」という単語は表示されず、タグのみが表示されます。私はその質問ではなく、返事をします。
Mark Storer 2018

ジェームズとマークに感謝します。研ぎ澄ましてください!
Knom
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.