我正在生成一些XML文件,这些文件需要与提供给我的xsd文件一致。验证其符合性的最佳方法是什么?
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对象-如果您不打算使用它们,那将很浪费。
根据在线模式进行验证
这里是使用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.");
}
}
}
我们使用ant构建我们的项目,因此我们可以使用schemavalidate任务来检查我们的配置文件:
<schemavalidate>
<fileset dir="${configdir}" includes="**/*.xml" />
</schemavalidate>
现在顽皮的配置文件将使我们的构建失败!
由于这是一个很普遍的问题,我会指出java也可以针对“引用”的xsd进行验证,例如,如果.xml文件本身在标头中使用xsi:SchemaLocation
或xsi:noNamespaceSchemaLocation
(或xsi对于特定的名称空间)ex:
<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文件中的名称空间匹配,则表示好。但是有时可以方便地使用自定义resolver ...
来自javadocs:“如果在创建模式时未指定URL,文件或源,则Java语言会创建一种语言,该语言会在正在验证的文档中查找以找到其应使用的模式。例如:“
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文件引用的是url,也可以通过手动指定xsd(请参见此处的其他答案)或使用“ XML目录” 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解析,您可以使用与验证as well saxReader.setEntityResolver(your_resolver_here);
]的SAX解析器类似的操作>
使用Java 7,您可以阅读package description中提供的文档。
[如果您有Linux机器,则可以使用免费的命令行工具SAXCount。我觉得这很有用。
另一个答案:由于您说过需要验证正在生成的文件(正在写入),因此您可能想在编写时验证内容,而不是先编写然后回读以进行验证。如果使用基于SAX的writer,则可以使用JDK API进行Xml验证,如果这样做,则可以通过调用“ Validator.validate(source,result)”链接到Validator中,其中source来自您的writer,结果是需要输出的位置。