URL для загрузки ресурсов из пути к классу в Java

Введение и базовая реализация

Во-первых, вам понадобится как минимум URLStreamHandler. Это фактически откроет соединение с заданным URL-адресом. Обратите внимание, что это просто называется Handler ; это позволяет указать java -Djava.protocol.handler.pkgs = org.my.protocols , и он будет автоматически выбран с использованием "простого" имени пакета в качестве поддерживаемого протокола (в данном случае " classpath ").

Использование

new URL("classpath:org/my/package/resource.extension").openConnection();

Код

package org.my.protocols.classpath;

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

/** A {@link URLStreamHandler} that handles resources on the classpath. */
public class Handler extends URLStreamHandler {
    /** The classloader to find resources from. */
    private final ClassLoader classLoader;

    public Handler() {
        this.classLoader = getClass().getClassLoader();
    }

    public Handler(ClassLoader classLoader) {
        this.classLoader = classLoader;
    }

    @Override
    protected URLConnection openConnection(URL u) throws IOException {
        final URL resourceUrl = classLoader.getResource(u.getPath());
        return resourceUrl.openConnection();
    }
}

Проблемы с запуском

Если вы похожи на меня, вы не хотите полагаться на свойство, установленное при запуске, чтобы добраться куда-нибудь (в моем В этом случае я предпочитаю оставлять свои опции открытыми, как Java WebStart - вот почему мне все это нужно).

Обходные пути / улучшения

Ручная спецификация обработчика кода

Если вы управляете кодом, вы можете выполнить

new URL(null, "classpath:some/package/resource.extension", new org.my.protocols.classpath.Handler(ClassLoader.getSystemClassLoader()))

, и это будет использовать ваш обработчик для открытия соединения.

Но опять же, это менее чем удовлетворительно , поскольку для этого вам не нужен URL - вы хотите это сделать, потому что некоторая библиотека, которую вы не можете (или не хотите) контролировать, хочет URL ...

Регистрация обработчика JVM

Окончательный вариант - зарегистрировать URLStreamHandlerFactory , который будет обрабатывать все URL-адреса в jvm:

package my.org.url;

import java.net.URLStreamHandler;
import java.net.URLStreamHandlerFactory;
import java.util.HashMap;
import java.util.Map;

class ConfigurableStreamHandlerFactory implements URLStreamHandlerFactory {
    private final Map<String, URLStreamHandler> protocolHandlers;

    public ConfigurableStreamHandlerFactory(String protocol, URLStreamHandler urlHandler) {
        protocolHandlers = new HashMap<String, URLStreamHandler>();
        addHandler(protocol, urlHandler);
    }

    public void addHandler(String protocol, URLStreamHandler urlHandler) {
        protocolHandlers.put(protocol, urlHandler);
    }

    public URLStreamHandler createURLStreamHandler(String protocol) {
        return protocolHandlers.get(protocol);
    }
}

Чтобы зарегистрировать обработчик, вызовите URL.setURLStreamHandlerFactory () с настроенной фабрикой. Затем введите новый URL ("путь к классам: org / my / package / resource.extension") , как в первом примере, и вперед.

Проблема регистрации обработчика JVM

Обратите внимание, что этот метод может быть вызван только один раз для каждой JVM, и обратите внимание, что Tomcat будет использовать этот метод для регистрации обработчика JNDI (AFAIK). Попробуйте Jetty (буду); в худшем случае вы можете сначала использовать этот метод, а затем он должен обойти вас!

Лицензия

Я передаю это в общественное достояние и прошу, если вы хотите изменить, запустите где-нибудь проект OSS и прокомментируйте здесь с подробностями. Лучшей реализацией было бы иметь URLStreamHandlerFactory , который использует ThreadLocal для хранения URLStreamHandler s для каждого Thread.currentThread (). GetContextClassLoader () [) . Я даже дам вам свои модификации и тестовые классы.