如何针对XSD文件验证XML文件?

我正在生成一些xml文件,需要符合xsd文件给我。我该如何验证它们是否一致?

331895 次浏览

下面是如何使用Xerces2来做到这一点。这是一个教程,在这里 (req。注册)。

原始属性:公然从在这里复制:

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

你是在找工具还是图书馆?

就库而言,事实上的标准是Xerces2,它有c++Java两个版本。

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

至于为你做这件事的工具,XMLFox似乎是一个不错的免费解决方案,但没有亲身使用过,我不能肯定。

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/XMLSchema,它定义了xsd。上面的代码针对URL http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd验证WAR部署描述符,但你也可以很容易地针对本地文件进行验证。

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

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

我最终使用了LiquidXML Studio 2008 (v6),它更容易使用,也更熟悉(UI与我经常使用的Visual Basic 2008 Express非常相似)。缺点:免费版没有验证功能,所以我不得不使用30天的试用期。

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

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

CastorJAXB是其他Java库,它们的作用与XMLBeans类似。

还有一个答案:既然你说你需要验证文件你是生成(写入),你可能想在写入时验证内容,而不是先写入,然后再读取验证。如果你使用的是基于sax的writer,你也可以使用JDK API进行Xml验证:如果是这样,只需调用' validator '来链接验证器。Validate (source, result)',其中source来自你的作者,result是输出需要去的地方。

或者,如果你使用Stax来写内容(或者使用或可以使用Stax的库),Woodstox也可以在使用XMLStreamWriter时直接支持验证。下面是一个博客条目说明如何做到这一点:

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

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

现在淘气的配置文件将失败我们的构建!

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

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

SAXCount -f -s -n my.xml

它对dtd和xsd进行验证。

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

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

使用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!
}

由于这是一个普遍的问题,我将指出java也可以验证“引用”;例如,如果.xml文件本身在头文件中指定了xsd,则使用xsi:schemaLocationxsi:noNamespaceSchemaLocation(或xsi用于特定的命名空间)前女友:

<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文件"map"到.xml文件中声明的名称空间,因为它们声明了一个名称空间,如果与.xml文件中的名称空间匹配,就没问题。但有时可以方便地使用自定义解析器

如果创建模式时没有指定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);

对于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
}
}

对在线模式进行验证

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验证

使用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,以最大限度地提高性能。