Каков наилучший способ сверить XML-файл с XSD-файлом?
-
08-06-2019 - |
Вопрос
Я генерирую несколько xml-файлов, которые должны соответствовать xsd-файлу, который был мне предоставлен.Каков наилучший способ убедиться в их соответствии?
Решение
Библиотека среды выполнения Java поддерживает проверку подлинности.В последний раз, когда я проверял это, это был парсер Apache Xerces under the covers.Вероятно, вам следует использовать javax.xml.проверка.Валидатор.
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.Приведенный выше код проверяет дескриптор развертывания WAR на соответствие URL-адресу http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd
но вы могли бы так же легко выполнить проверку по локальному файлу.
Вам не следует использовать DOMParser для проверки документа (если только вашей целью в любом случае не является создание объектной модели документа).Это приведет к созданию объектов DOM по мере анализа документа - расточительно, если вы не собираетесь их использовать.
Другие советы
Вот как это сделать, используя 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.");
}
}
}
Мы создаем наш проект с помощью ant, поэтому мы можем использовать задачу schemavalidate для проверки наших конфигурационных файлов:
<schemavalidate>
<fileset dir="${configdir}" includes="**/*.xml" />
</schemavalidate>
Теперь непослушные конфигурационные файлы приведут к сбою нашей сборки!
Поскольку это популярный вопрос, я укажу, что java также может проверять соответствие "ссылкам" на xsd, например, если сам XML-файл указывает XSD в заголовке, используя xsi:SchemaLocation
или xsi: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 "сопоставляются" с пространствами имен, объявленными в файле .xml, потому что они объявляют пространство имен, и если оно совпадает с пространством имен в файле .xml, все в порядке.Но иногда удобно иметь возможность иметь собственный преобразователь...
Из javadocs:"Если вы создаете схему без указания URL, файла или источника, то язык Java создает схему, которая просматривает проверяемый документ, чтобы найти схему, которую он должен использовать.Например:"
SchemaFactory factory = SchemaFactory.newInstance("http://www.w3.org/2001/XMLSchema");
Schema schema = factory.newSchema();
и это работает для нескольких пространств имен и т.д.Проблема такого подхода заключается в том, что xmlsns:xsi
вероятно, это сетевое местоположение, поэтому по умолчанию оно будет выходить и попадать в сеть при каждой проверке, что не всегда оптимально.
Вот пример, который проверяет XML-файл на соответствие любым it-ссылкам 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);
}
}
Вы можете избежать извлечения XSD-файлов, на которые ссылаются ссылки, из сети, даже если файлы xml ссылаются на URL-адреса, указав xsd вручную (см. Некоторые Другие ответы здесь) или используя "каталог XML" распознаватель стилей.Весна, по-видимому, тоже может перехватить 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 parser, который проверяет также saxReader.setEntityResolver(your_resolver_here);
Используя Java 7, вы можете следовать документации, представленной в описание упаковки.
// 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! }
Если у вас есть Linux-машина, вы могли бы воспользоваться бесплатным инструментом командной строки SAXCount.Я нашел это очень полезным.
SAXCount -f -s -n my.xml
Он проверяет соответствие dtd и xsd.5 секунд для файла размером 50 МБ.
В debian squeeze он находится в пакете "libxerces-c-samples".
Определение dtd и xsd должно быть в xml!Вы не можете настроить их по отдельности.
Еще один ответ:поскольку вы сказали, что вам нужно проверить файлы, вы генерирующий (запись), возможно, вам захочется проверять содержимое во время записи, вместо того чтобы сначала записывать, а затем перечитывать для проверки.Вероятно, вы можете сделать это с помощью JDK API для проверки Xml, если используете SAX-based writer:если это так, просто создайте ссылку в validator, вызвав 'Validator.validate(источник, результат)', где источник поступает от вашего автора, а результат - это то, куда должен поступать вывод.
В качестве альтернативы, если вы используете Stax для написания контента (или библиотеку, которая использует или может использовать stax), Вудстокс может также напрямую поддерживать проверку при использовании XMLStreamWriter.Вот такой запись в блоге показываю, как это делается:
Если вы генерируете XML-файлы программно, возможно, вам захочется взглянуть на XMLBeans ( XMLBeans ) библиотека.Используя инструмент командной строки, XMLBeans автоматически сгенерирует и упакует набор объектов Java на основе XSD.Затем вы можете использовать эти объекты для создания XML-документа на основе этой схемы.
Он имеет встроенную поддержку проверки схемы и может преобразовывать объекты Java в XML-документ и наоборот.
Колесико и ДЖАКСБ существуют и другие библиотеки Java, которые служат той же цели, что и XMLBeans.
Вы ищете инструмент или библиотеку?
Что касается библиотек, то в значительной степени стандартом де-факто является Xerces2 который имеет и то, и другое C++ и Java Версии.
Однако имейте в виду, что это тяжеловесное решение.Но опять же, проверка XML на соответствие XSD-файлам - это довольно тяжелая проблема.
Что касается инструмента, который сделает это за вас, XMLFox кажется, это приличное бесплатное решение, но, не используя его лично, я не могу сказать наверняка.
С 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);
Проверка на соответствие локальным схемам
Мне пришлось проверить XML на соответствие XSD только один раз, поэтому я попробовал XMLFox.Я нахожу это очень запутанным и странным.Инструкции справки, похоже, не соответствовали интерфейсу.
В итоге я использовал LiquidXML Studio 2008 (версия 6), которая была намного проще в использовании и сразу стала более знакомой (пользовательский интерфейс очень похож на Visual Basic 2008 Express, которым я часто пользуюсь).Недостаток:возможности проверки нет в бесплатной версии, поэтому мне пришлось воспользоваться 30-дневной пробной версией.