如何可靠地从类路径资源（在 jar 中）加载 XMLCatalog？

Question

下面是一些代码片段，表明我目前正在尝试什么，但它不可靠。主要我认为 因为您只能注册一次协议处理程序，有时其他库可能会先注册一次。

import org.apache.xerces.util.XMLCatalogResolver;



public static synchronized XMLCatalogResolver getResolver() {
        String c[] = {"classpath:xml-catalog.xml"};
        if (cr==null) {

            log.debug("Registering new protcol handler for classpath");
            ConfigurableStreamHandlerFactory configurableStreamHandlerFactory = new ConfigurableStreamHandlerFactory("classpath", new org.fao.oek.protocols.classpath.Handler(XsdUtils.class.getClassLoader()));
            configurableStreamHandlerFactory.addHandler("http", new sun.net.www.protocol.http.Handler());


            URL.setURLStreamHandlerFactory(configurableStreamHandlerFactory);

            log.debug("Creating new catalog resolver");

        cr = new XMLCatalogResolver(c);

        }
        return cr;
    }

xml-catalog.xml 包含：

<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
<group  prefer="public"  xml:base="classpath:org/me/myapp/xsd/" >  
  <uri name="http://www.w3.org/XML/1998/namespace" uri="xml.xsd"/>
  <uri name="http://www.w3.org/1999/xlink" uri="xlink.xsd" />
  <uri name="http://www.w3.org/2001/XMLSchema" uri="XMLSchema.xsd" />
  <uri name="http://purl.org/dc/elements/1.1/" uri="dc.xsd" />
  <uri name="http://www.loc.gov/mods/v3"  uri="mods-3.3.xsd" />
 </group>
</catalog>

显然 - xsd 文件存在于类路径中的正确位置。

Answer 1

解析器使用以下最少的代码集正常运行：

public class XsdUtils {
    static {
        System.setProperty("java.protocol.handler.pkgs", "org.fao.oek.protocols");
    }

    private static XMLCatalogResolver cr;

    public static synchronized XMLCatalogResolver getResolver() {
        if (cr == null) {
            cr = new XMLCatalogResolver(new String[] { "classpath:xml-catalog.xml" });
        }
        return cr;
    }

    public static void main(String[] args) throws MalformedURLException, IOException {
        XMLCatalogResolver resolver = getResolver();
        URL url0 = new URL("classpath:xml-catalog.xml");
        URL url1 = new URL(resolver.resolveURI("http://www.loc.gov/mods/v3"));
        url0.openConnection();
        url1.openConnection();
    }
}

您也可以指定 java.protocol.handler.pkgs 作为 JVM 参数：

java -Djava.protocol.handler.pkgs=org.fao.oek.protocols ...

Handler 类的实现如下：

package org.fao.oek.protocols.classpath;

import java.io.IOException;
import java.net.URL;
import java.net.URLConnection;

public class Handler extends java.net.URLStreamHandler {
    @Override
    protected URLConnection openConnection(URL u) throws IOException {
        String resource = u.getPath();
        if (!resource.startsWith("/")) resource = "/" + resource;
        System.out.println(getClass().getResource(resource));
        return getClass().getResource(resource).openConnection();
    }
}

在请求资源时使用正斜杠 ("/") 很重要，正如以下 Stack Overflow 问题所回答的那样："open resource with relative path in java."

注意XsdUtils 中的main 方法。当 xml-catalog.xml 和 mods-3.3.xsd 在类路径上但不在 JAR 中时，程序的输出是：

file:/workspace/8412798/target/classes/xml-catalog.xml
file:/workspace/8412798/target/classes/org/me/myapp/xsd/mods-3.3.xsd

当文件在 JAR 中时程序的输出是：

jar:file:/workspace/8412798/target/stackoverflow.jar!/xml-catalog.xml
jar:file:/workspace/8412798/target/stackoverflow.jar!/org/me/myapp/xsd/mods-3.3.xsd

关于原问题中的这段代码：

new org.fao.oek.protocols.classpath.Handler(XsdUtils.class.getClassLoader())

您的Handler 不需要特定的类加载器，除非您已将应用程序配置为使用特殊的类加载器，例如从URLClassLoader 扩展而来的类加载器。

"A New Era for Java Protocol Handlers" 是关于协议处理程序的好资源。

只是为了让一切都完整，下面的类使用XsdUtils.getResolver() 来解析XML。它根据XMLCatalogResolver 中指定的模式进行验证：

public class SampleParser {
    public static void main(String[] args) throws Exception {
        String xml = "<?xml version=\"1.0\"?>" + //
                "<mods ID=\"id\" version=\"3.3\" xmlns=\"http://www.loc.gov/mods/v3\">" + //
                "<titleInfo></titleInfo>" + //
                "</mods>";
        ByteArrayInputStream is = new ByteArrayInputStream(xml.getBytes());
        XMLReader parser = XMLReaderFactory.createXMLReader(org.apache.xerces.parsers.SAXParser.class.getName());
        parser.setFeature("http://xml.org/sax/features/validation", true);
        parser.setFeature("http://apache.org/xml/features/validation/schema", true);
        parser.setFeature("http://apache.org/xml/features/validation/schema-full-checking", true);
        parser.setProperty("http://apache.org/xml/properties/internal/entity-resolver", XsdUtils.getResolver());
        parser.setErrorHandler(new ErrorHandler() {
            @Override
            public void error(SAXParseException exception) throws SAXException {
                System.out.println("error: " + exception);
            }

            @Override
            public void fatalError(SAXParseException exception) throws SAXException {
                System.out.println("fatalError: " + exception);
            }

            @Override
            public void warning(SAXParseException exception) throws SAXException {
                System.out.println("warning: " + exception);
            }
        });
        parser.parse(new InputSource(is));
    }
}