Общие XMLConfiguration и схема проверки?

Question

Я использовал Apache Commons XMLConfiguration для моей конфигурации. Теперь мне нужна проверка на основе схемы. Но у меня есть проблемы, чтобы добавить мой xsd в конфигурацию XMLCon. XSD находится в файле jar приложения.

Если я использую методы из Java SE, проверка выполняется без проблем:

private void checkSchema(final Path path) 
        throws SAXException, ParserConfigurationException, IOException
{
    final URL urlXsd = getClass().getResource(ConfigMain.SCHEMA_RESOURCE_PATH);
    final SchemaFactory sf = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
    final Schema schema = sf.newSchema(urlXsd);
    final Validator validator = schema.newValidator();
    final DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
    final DocumentBuilder db = dbf.newDocumentBuilder(); 
    final Document doc = db.parse(path.toFile());
    validator.validate(new DOMSource(doc));
}

Но если я использую XMLConfiguration с DefaultEntityResolver, у меня ничего не получится.

xmlConfig = new XMLConfiguration();
final URL urlXsd = getClass().getResource(SCHEMA_RESOURCE_PATH);
resolver.registerEntityId("configuration", urlXsd);
xmlConfig.setEntityResolver(resolver);
xmlConfig.setSchemaValidation(true);

Я получаю следующее исключение:

Caused by: org.xml.sax.SAXParseException; systemId: file:/C:/.../config_default.xml; lineNumber: 2; columnNumber: 16; cvc-elt.1: Cannot find the declaration of element 'configuration'.

"конфигурация" является корневым элементом файла config_default.xml. Я думаю, что это означает, что он не может найти XSD.

Моя первая проблема: что я должен указать в первом параметре resolver.registerEntityId("configuration", urlXsd);? Какой публичный идентификатор схемы? Документация показывает только пример с открытым идентификатором DTD.

Вот сокращенная схема и xml -> xml:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
</configuration>

схема:

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"
<xs:element name="configuration">
</xs:element>
</xs:schema>

ОБНОВЛЕНИЕ: Мой тест основан на ответе банка:

package de.company.xmlschematest;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import javax.xml.XMLConstants;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.dom.DOMSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.XMLConfiguration;
import org.apache.commons.logging.LogFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.xml.sax.SAXException;

public class App
{
    private final XMLConfiguration xmlConfig = new XMLConfiguration();

    private static final Logger LOG = LoggerFactory.getLogger(App.class);
    private static final String CONFIG_FILENAME_DEFAULT = "config_default.xml";
    private static final String CONFIG_FILENAME_LOCAL = 
            "C:\\Data\\config_current.xml";
    private static final Path CONFIG_PATH_LOCAL = Paths.get(
            CONFIG_FILENAME_LOCAL);
    private static final String SCHEMA_FILENAME = "config_schema.xsd";
    /* package */ static final String SCHEMA_RESOURCE_PATH = "/" + SCHEMA_FILENAME;
    private static final String CONFIG_DEFAULT_RESOURCE_PATH = "/" + 
            CONFIG_FILENAME_DEFAULT;

    private static final org.apache.commons.logging.Log LOG_SEC = LogFactory.getLog(App.class);

    public App()
    {
        try
        {
            LOG_SEC.debug("JCL");

            xmlConfig.setLogger(LOG_SEC);

            final URL urlXsd = getClass().getResource(SCHEMA_RESOURCE_PATH);
            final SchemaFactory sf = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
            final Schema schema = sf.newSchema(urlXsd);
            final DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
            dbf.setSchema(schema);
            final DocumentBuilder db = dbf.newDocumentBuilder();

            xmlConfig.setDocumentBuilder(db);
            xmlConfig.setSchemaValidation(true);
        }
        catch (SAXException | ParserConfigurationException ex)
        {
            LOG.error("Loading error", ex);
        }
    }


    /**
     * @param args the command line arguments
     */
    public static void main(String[] args)
    {
        System.out.println("XmlSchemaTest started");
            final App app = new App();
            app.loadConfig();
            System.out.println("Finished");
    }

    private void loadConfig()
    {
        if(Files.exists(CONFIG_PATH_LOCAL))
        {
            try
            {
                xmlConfig.clear();
                LOG.debug("Loading config {}", CONFIG_PATH_LOCAL);
                xmlConfig.setFile(CONFIG_PATH_LOCAL.toFile());
                xmlConfig.refresh();

                LOG.info("Current config loaded");
            }
            catch (final ConfigurationException ex)
            {
                LOG.error("Loading of current config file has failed", ex);
                loadDefault();
            }
        }
        else
        {
            LOG.info("Local configuration is not available");
            loadDefault();
        }
    }

    private void loadDefault()
    {
        try
        {
            xmlConfig.clear();

            LOG.debug("Loading config " + CONFIG_FILENAME_DEFAULT);
            final File oldConfig = xmlConfig.getFile();

            xmlConfig.setURL(getClass().getResource(
                    CONFIG_DEFAULT_RESOURCE_PATH));
            if(oldConfig != null && oldConfig.exists())
            {
                oldConfig.delete();
            }

            xmlConfig.refresh();
            xmlConfig.save(CONFIG_FILENAME_LOCAL);            
            LOG.info("Default config loaded");
        }
        catch (final ConfigurationException ex)
        {
            throw new IllegalStateException("The default config file is "
                    + "not available", ex);
        }
    }
}

Теперь я проверил это с недопустимым XML, но я вижу только ошибку в выводе. Не было исключений.

XmlSchemaTest started
18:23:16.263 [main] DEBUG de.company.xmlschematest.App - JCL
18:23:16.325 [main] DEBUG de.company.xmlschematest.App - Loading config C:\Data\config_current.xml
18:23:16.327 [main] DEBUG o.a.c.c.ConfigurationUtils - ConfigurationUtils.locate(): base is C:\Data, name is config_current.xml
18:23:16.328 [main] DEBUG o.a.c.c.DefaultFileSystem - Could not locate file config_current.xml at C:\Data: unknown protocol: c
18:23:16.331 [main] DEBUG o.a.c.c.ConfigurationUtils - Loading configuration from the path C:\Data\config_current.xml
18:23:16.332 [main] DEBUG o.a.c.c.ConfigurationUtils - ConfigurationUtils.locate(): base is C:\Data, name is config_current.xml
18:23:16.332 [main] DEBUG o.a.c.c.DefaultFileSystem - Could not locate file config_current.xml at C:\Data: unknown protocol: c
18:23:16.332 [main] DEBUG o.a.c.c.ConfigurationUtils - Loading configuration from the path C:\Data\config_current.xml
[Error] config_current.xml:29:21: cvc-complex-type.2.4.a: Invalid content was found starting with element 'number'. One of '{name}' is expected
18:23:16.356 [main] INFO  de.company.xmlschematest.App - Current config loaded
Finished

Update - путь к xsd в xml: я думаю, что обработка, основанная на обратном вызове, не так хороша. Исходя из вашего первого предложения, я сделал тест с путем к xsd в xml. Но это работает только на след.

package de.company.xmlschematest;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import javax.xml.XMLConstants;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.dom.DOMSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.XMLConfiguration;
import org.apache.commons.logging.LogFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.xml.sax.SAXException;

/**
 *
 * @author RD3
 */
public class App
{
    private final XMLConfiguration xmlConfig = new XMLConfiguration();

    private static final Logger LOG = LoggerFactory.getLogger(App.class);
    private static final String CONFIG_FILENAME_DEFAULT = "config_default.xml";
    private static final String CONFIG_FILENAME_LOCAL = 
            "C:\\Data\\config_current.xml";
    private static final Path CONFIG_PATH_LOCAL = Paths.get(
            CONFIG_FILENAME_LOCAL);
    private static final String SCHEMA_FILENAME = "config_schema.xsd";
    /* package */ static final String SCHEMA_RESOURCE_PATH = "/" + SCHEMA_FILENAME;
    private static final String CONFIG_DEFAULT_RESOURCE_PATH = "/" + 
            CONFIG_FILENAME_DEFAULT;

    private static final org.apache.commons.logging.Log LOG_SEC = LogFactory.getLog(App.class);

    public App()
    {
        LOG_SEC.debug("JCL");

        xmlConfig.setLogger(LOG_SEC);
        xmlConfig.setSchemaValidation(true);
    }


    /**
     * @param args the command line arguments
     */
    public static void main(String[] args)
    {
        System.out.println("XmlSchemaTest started");
            final App app = new App();
            app.loadConfig();
            System.out.println("Finished");
    }

    private void loadConfig()
    {
        if(Files.exists(CONFIG_PATH_LOCAL))
        {
            try
            {
                xmlConfig.clear();
                LOG.debug("Loading config {}", CONFIG_PATH_LOCAL);
                xmlConfig.setFile(CONFIG_PATH_LOCAL.toFile());
                xmlConfig.refresh();

                LOG.info("Current config loaded");
            }
            catch (final ConfigurationException ex)
            {
                LOG.error("Loading of current config file has failed", ex);
                loadDefault();
            }
        }
        else
        {
            LOG.info("Local configuration is not available");
            loadDefault();
        }
    }

    private void loadDefault()
    {
        try
        {
            xmlConfig.clear();

            LOG.debug("Loading config " + CONFIG_FILENAME_DEFAULT);
            final File oldConfig = xmlConfig.getFile();

            xmlConfig.setURL(getClass().getResource(
                    CONFIG_DEFAULT_RESOURCE_PATH));
            if(oldConfig != null && oldConfig.exists())
            {
                oldConfig.delete();
            }

            xmlConfig.refresh();
            xmlConfig.save(CONFIG_FILENAME_LOCAL);            
            LOG.info("Default config loaded");
        }
        catch (final ConfigurationException ex)
        {
            throw new IllegalStateException("The default config file is "
                    + "not available", ex);
        }
    }
}

Первый запуск работает правильно. Он берет xsd из jar на основе xsi:noNamespaceSchemaLocation="config_schema.xsd". Затем записывает конфигурацию по умолчанию из загруженного из jar в локальную файловую систему. Я проверил записанный файл и не могу найти странные мысли. Затем я делаю второй запуск примера приложения, но теперь я получаю следующие ошибки:

XmlSchemaTest started
10:49:58.730 [main] DEBUG de.company.xmlschematest.App - JCL
10:49:58.738 [main] DEBUG de.company.xmlschematest.App - Loading config C:\Data\config_current.xml
10:49:58.740 [main] DEBUG o.a.c.c.ConfigurationUtils - ConfigurationUtils.locate(): base is C:\Data, name is config_current.xml
10:49:58.741 [main] DEBUG o.a.c.c.DefaultFileSystem - Could not locate file config_current.xml at C:\Data: unknown protocol: c
10:49:58.744 [main] DEBUG o.a.c.c.ConfigurationUtils - Loading configuration from the path C:\Data\config_current.xml
10:49:58.745 [main] DEBUG o.a.c.c.ConfigurationUtils - ConfigurationUtils.locate(): base is C:\Data, name is config_current.xml
10:49:58.745 [main] DEBUG o.a.c.c.DefaultFileSystem - Could not locate file config_current.xml at C:\Data: unknown protocol: c
10:49:58.746 [main] DEBUG o.a.c.c.ConfigurationUtils - Loading configuration from the path C:\Data\config_current.xml
10:49:58.795 [main] ERROR de.company.xmlschematest.App - Loading of current config file has failed
org.apache.commons.configuration.ConfigurationException: Error parsing file:/C:/Data/config_current.xml
    at org.apache.commons.configuration.XMLConfiguration.load(XMLConfiguration.java:1014) ~[commons-configuration-1.10.jar:1.10]
    at org.apache.commons.configuration.XMLConfiguration.load(XMLConfiguration.java:972) ~[commons-configuration-1.10.jar:1.10]
    at org.apache.commons.configuration.XMLConfiguration$XMLFileConfigurationDelegate.load(XMLConfiguration.java:1647) ~[commons-configuration-1.10.jar:1.10]
    at org.apache.commons.configuration.AbstractFileConfiguration.load(AbstractFileConfiguration.java:324) ~[commons-configuration-1.10.jar:1.10]
    at org.apache.commons.configuration.AbstractFileConfiguration.load(AbstractFileConfiguration.java:261) ~[commons-configuration-1.10.jar:1.10]
    at org.apache.commons.configuration.AbstractFileConfiguration.load(AbstractFileConfiguration.java:238) ~[commons-configuration-1.10.jar:1.10]
    at org.apache.commons.configuration.AbstractFileConfiguration.refresh(AbstractFileConfiguration.java:889) ~[commons-configuration-1.10.jar:1.10]
    at org.apache.commons.configuration.AbstractHierarchicalFileConfiguration.refresh(AbstractHierarchicalFileConfiguration.java:335) ~[commons-configuration-1.10.jar:1.10]
    at de.company.xmlschematest.App.loadConfig(App.java:110) [classes/:na]
    at de.company.xmlschematest.App.main(App.java:68) [classes/:na]
Caused by: org.xml.sax.SAXParseException: cvc-elt.1: Cannot find the declaration of element 'configuration'.
    at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.createSAXParseException(ErrorHandlerWrapper.java:203) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.error(ErrorHandlerWrapper.java:134) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java:437) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java:368) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java:325) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.handleStartElement(XMLSchemaValidator.java:1906) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.startElement(XMLSchemaValidator.java:746) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.XMLNSDocumentScannerImpl.scanStartElement(XMLNSDocumentScannerImpl.java:379) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.XMLNSDocumentScannerImpl$NSContentDriver.scanRootElementHook(XMLNSDocumentScannerImpl.java:605) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl$FragmentContentDriver.next(XMLDocumentFragmentScannerImpl.java:3138) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl$PrologDriver.next(XMLDocumentScannerImpl.java:880) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl.next(XMLDocumentScannerImpl.java:606) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.XMLNSDocumentScannerImpl.next(XMLNSDocumentScannerImpl.java:117) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl.scanDocument(XMLDocumentFragmentScannerImpl.java:510) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:848) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:777) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.parsers.XMLParser.parse(XMLParser.java:141) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.parsers.DOMParser.parse(DOMParser.java:243) ~[na:1.8.0_31]
    at com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderImpl.parse(DocumentBuilderImpl.java:348) ~[na:1.8.0_31]
    at org.apache.commons.configuration.XMLConfiguration.load(XMLConfiguration.java:1006) ~[commons-configuration-1.10.jar:1.10]
    ... 9 common frames omitted
10:49:58.796 [main] DEBUG de.company.xmlschematest.App - Loading config config_default.xml
10:49:58.862 [main] INFO  de.company.xmlschematest.App - Default config loaded
Finished

Он не может найти xsd, но путь в xml-файле правильный и такой же, как и при первом запуске. Почему он может найти xsd в первом развлечении, а не во втором?

Второй вопрос, это все возможные выходные данные журнала из XMLConfiguration?

Обновление 3: я снова проверил и вижу, если я помещаю xsd в локальную файловую систему, то второй запуск не вызывает проблем. Я думаю, что проблема заключается в относительном поиске xsd, когда путь определен в xml.

Можно ли загрузить xml из локальной файловой системы и проверить с помощью схемы, расположенной в файле jar? Я ищу решение без обратного вызова и прямой обработки исключений по вызову load() или refresh().

С наилучшими пожеланиями,

Answer 1

Первый параметр resolver.registerEntityId() публичный идентификатор, используемый для сопоставления с конкретным URL-адресом объекта. Я сомневаюсь, что "конфигурация" является правильным значением для использования здесь. Тем не менее, я думаю, что здесь есть некоторая путаница, и вам даже не нужно беспокоиться о преобразователе сущностей в вашем случае.

Скажем, у вас есть mySchema.xsd:

<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="configuration">
    </xs:element>
</xs:schema>

Допустим, что mySchema.xml находится в банке в mypackage.stackru пакет и эта банка находится в C:\path\to\myJar.jar (так как вы, кажется, используете Windows). Сделайте ваш config_default.xml похожим на:

<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:noNamespaceSchemaLocation="jar:file:/C:/path/to/myJar.jar!/mypackage/stackru/mySchema.xsd">
</configuration>

Тогда вы сможете просто загрузить config_default.xml, который будет ссылаться на mySchema.xsd для проверки.

Использование конфигурации Commons v1.10:

XMLConfiguration config = new XMLConfiguration();
config.setFileName("config_default.xml");
config.setSchemaValidation(true);

// This will throw a ConfigurationException if the XML document does not
// conform to its Schema.
config.load();

Примечание: следующее оказалось не относящимся к вопросу аскера, но я оставляю его здесь для справки.

Если вы хотите программно установить файл схемы, вы можете сделать это, установив XMLConfiguration"s DocumentBuilder,

import java.io.File;

import javax.xml.XMLConstants;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;

import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.XMLConfiguration;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;

public class CommonsConfigTester {

    public static void main(String[] args) {
        XMLConfiguration config = new XMLConfiguration();
        config.setFileName("config_default.xml");
        config.setSchemaValidation(true);

        try {        
            Schema schema = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI).newSchema(new File("mySchema.xsd"));
            DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance();
            docBuilderFactory.setSchema(schema);
            DocumentBuilder docBuilder = docBuilderFactory.newDocumentBuilder();
            //if you want an exception to be thrown when there is invalid xml document,
            //you need to set your own ErrorHandler because the default
            //behavior is to just print an error message.
            docBuilder.setErrorHandler(new ErrorHandler() {
                @Override
                public void warning(SAXParseException exception) throws SAXException {
                    throw exception;
                }

                @Override
                public void error(SAXParseException exception) throws SAXException {
                    throw exception;
                }

                @Override
                public void fatalError(SAXParseException exception)  throws SAXException {
                    throw exception;
                }  
            });
            config.setDocumentBuilder(docBuilder);
            config.load();
        } catch (ConfigurationException | ParserConfigurationException | SAXException e) {
            //handle exception
            e.printStackTrace();
        }
    }
}

Answer 2

Решение - для моего случая:

Я сделал собственный EntityResolver, который расширяет DefaultEntityResolver:

private static class LocalSchemaResolver extends DefaultEntityResolver
    {
        @Override
        public InputSource resolveEntity(final String publicId
                , final String systemId) throws SAXException
        {
            if(systemId.endsWith(SCHEMA_FILENAME))
            {
                final InputStream stream = getClass().getResourceAsStream(SCHEMA_RESOURCE_PATH);
                if(stream != null)
                {
                    final InputSource source = new InputSource(stream);
                    source.setPublicId(publicId);
                    source.setSystemId(systemId);

                    return source;
                }
                else
                {
                    throw new SAXException("Schema '" + SCHEMA_FILENAME 
                            + "' is not available");
                }
            }
            return super.resolveEntity(publicId, systemId);
        }
    }

что карты следующие

xsi:noNamespaceSchemaLocation="config_schema.xsd"

к относительному пути в файле JAR. Я не могу использовать абсолютный путь к JAR, как в последнем примере dbank в моем случае.