根据XSD文件验证XML文件的最佳方法是什么?

时间:2008-08-19 04:59:05

标签: java xml validation xsd

我正在生成一些需要符合给我的xsd文件的xml文件。什么是验证它们符合的最佳方法?

12 个答案:

答案 0 :(得分:317)

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) {}

架构工厂常量是定义XSD的字符串http://www.w3.org/2001/XMLSchema。上面的代码针对URL http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd验证WAR部署描述符,但您可以轻松地对本地文件进行验证。

您不应该使用DOMParser来验证文档(除非您的目标是创建文档对象模型)。这将在解析文档时开始创建DOM对象 - 如果您不打算使用它们会浪费。

答案 1 :(得分:25)

以下是使用Xerces2的方法。这是一个教程,here(需要注册)。

原始归属:公然复制自here

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.");
     }
  }
}

答案 2 :(得分:20)

我们使用ant构建项目,因此我们可以使用schemavalidate任务来检查我们的配置文件:

<schemavalidate> 
    <fileset dir="${configdir}" includes="**/*.xml" />
</schemavalidate>

现在顽皮的配置文件将无法构建!

http://ant.apache.org/manual/Tasks/schemavalidate.html

答案 3 :(得分:11)

由于这是一个很受欢迎的问题,我将指出java也可以验证&#34;引用&#34; xsd&#39; s,例如,如果.xml文件本身使用xsi:SchemaLocationxsi:noNamespaceSchemaLocation(或xsi代表特定名称空间)ex指定标题中的XSD: / p>

<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文件&#34; map&#34;到.xml文件中声明的命名空间,因为它们声明了一个命名空间,如果与.xml文件中的命名空间匹配,那么你就是好的。但有时可以方便地使用自定义resolver ...

来自javadocs:&#34;如果在未指定URL,文件或源的情况下创建架构,则Java语言会创建一个查找正在验证的文档以查找应使用的架构的架构。例如:&#34;

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

这适用于多个名称空间等。 这种方法的问题在于xmlsns:xsi可能是一个网络位置,因此默认情况下它会在每次验证时都出现并点击网络,而不是最佳。

这是一个根据它引用的任何XSD验证XML文件的示例(即使它必须从网络中提取它们):

  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);
    }
  }

您可以避免从网络中提取引用的XSD,即使xml文件通过手动指定xsd(请参阅此处的其他答案)或使用&#34; XML来引用url's目录&#34; style resolver。 Spring显然也​​can intercept 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);

另请参阅here了解其他教程。

我认为默认是使用DOM解析,您可以使用SAX解析器执行类似的操作来验证as well saxReader.setEntityResolver(your_resolver_here);

答案 4 :(得分:5)

使用Java 7,您可以按照package description

中提供的文档进行操作
// parse an XML document into a DOM tree
DocumentBuilder parser = DocumentBuilderFactory.newInstance().newDocumentBuilder();
Document document = parser.parse(new File("instance.xml"));

// 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 DOMSource(document));
} catch (SAXException e) {
    // instance document is invalid!
}

答案 5 :(得分:3)

还有一个答案:既然你说你需要验证文件生成(写作),你可能想在写作时验证内容,而不是先写,然后回读进行验证。如果您使用基于SAX的编写器,您可以使用JDK API进行Xml验证:如果是这样,只需通过调用'Validator.validate(source,result)'来链接验证器,其中source来自您的编写器,结果是需要输出的地方。

或者,如果您使用Stax编写内容(或使用或可以使用stax的库),Woodstox也可以在使用XMLStreamWriter时直接支持验证。这是blog entry,显示了如何完成:

答案 6 :(得分:3)

如果你有Linux机器,你可以使用免费的命令行工具SAXCount。我发现这非常有用。

SAXCount -f -s -n my.xml

验证dtd和xsd。 5个50MB文件。

在debian squeeze中,它位于“libxerces-c-samples”包中。

dtd和xsd的定义必须在xml中!你不能单独配置它们。

答案 7 :(得分:2)

如果以编程方式生成XML文件,则可能需要查看XMLBeans 库。使用命令行工具,XMLBeans将基于XSD自动生成和打包一组Java对象。然后,您可以使用这些对象基于此模式构建XML文档。

它内置了对模式验证的支持,可以将Java对象转换为XML文档,反之亦然。

CastorJAXB是与XMLBeans类似的其他Java库。

答案 8 :(得分: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);

根据本地模式进行验证

Offline XML Validation with Java

答案 9 :(得分:0)

使用Woodstox,配置StAX解析器以针对您的架构进行验证并解析XML。

如果捕获到异常,则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();
}

注意:如果您需要验证多个文件,则应尝试重用XMLInputFactoryXMLValidationSchema以便最大化性能。

答案 10 :(得分:0)

您在寻找工具还是图书馆?

就图书馆而言,几乎事实上的标准是Xerces2,它同时具有C++Java版本。

但请注意,这是一个重量级的解决方案。但话说回来,针对XSD文件验证XML是一个相当沉重的权重问题。

至于为您执行此操作的工具,XMLFox似乎是一个不错的免费软件解决方案,但没有亲自使用它我无法肯定地说。

答案 11 :(得分:-3)

我只需要一次针对XSD验证XML,所以我尝试了XMLFox。我发现它非常令人困惑和奇怪。帮助说明似乎与界面不匹配。

我最终使用了LiquidXML Studio 2008(v6),它更易于使用并且更加直接熟悉(UI与我经常使用的Visual Basic 2008 Express非常相似)。缺点:验证功能不在免费版本中,所以我不得不使用30天的试用版。