我正在尝试注册自定义 URLStreamHandler 以通用方式处理对 Amazon S3 URL 的请求。处理程序的实现看起来很像 S3-URLStreamHandler (github) .我没有将我的 Handler 类放入 sun.net.www.protocol.s3 包中，而是使用了自定义包 com.github.dpr.protocol。 s3。为了让 Java 获取这个包，我在 URL class 的文档之后提供了系统属性 -Djava.protocol.handler.pkgs="com.github.dpr.protocol" .但是，如果我尝试处理像 s3://my.bucket/some-awesome-file.txt 这样的 s3-URL，我会得到一个 MalformedURLException:

Caused by: java.net.MalformedURLException: unknown protocol: s3
    at java.net.URL.<init>(URL.java:600)
    at java.net.URL.<init>(URL.java:490)
    at java.net.URL.<init>(URL.java:439)
    at java.net.URI.toURL(URI.java:1089)
    ...

我的应用程序是一个基于 Spring 的 Web 应用程序，目前在 tomcat 中运行，但不应混杂任何有关底层应用程序容器的知识。

我已经调试了相应的代码，发现我的 URLStreamHandler 无法初始化，因为用于加载类的类加载器不知道它。这是来自 java.net.URL (jdk 1.8.0_92) 的相应代码:

1174: try {
1175:   cls = Class.forName(clsName);
1176: } catch (ClassNotFoundException e) {
1177:   ClassLoader cl = ClassLoader.getSystemClassLoader();
1178:   if (cl != null) {
1179:     cls = cl.loadClass(clsName);
1180:   }
1181: }

java.net.URL 类(Class.forName 使用)的类加载器为null 表示引导类加载器和系统类加载器不知道我的类。如果我在那里放置一个断点并尝试使用当前线程的类加载器加载我的处理程序类，它工作正常。那是我的类显然在那里并且在应用程序的类路径中，但是 Java 使用“错误的”类加载器来查找处理程序。

我知道 this question on SOF , 但我不能注册自定义 URLStreamHandlerFactory 因为 tomcat 在应用程序启动时注册它自己的工厂 (org.apache.naming.resources.DirContextURLStreamHandlerFactory) 并且必须只有一个工厂为单个 JVM 注册。 Tomcat 的 DirContextURLStreamHandlerFactory 允许添加可用于处理自定义协议(protocol)的用户工厂，但我不想在我的应用程序代码中添加对 Tomcat 的依赖，因为应用程序应该在不同的容器中运行。

有没有办法以独立于容器的方式为自定义 URL 注册处理程序？

2017 年 1 月 25 日更新:
我给出了不同的选项@Nicolas Filotto 提议尝试一下:

选项 1 - 使用反射设置自定义 URLStreamHandlerFactory
此选项按预期工作。但是通过使用反射，它引入了对 java.net.URL 类内部工作的紧密依赖。幸运的是，Oracle 并不太急于解决基本 Java 类中的便利性问题 - 实际上是 this related bug report开放了将近 14 年(Sun/Oracle 的伟大作品)- 这可以很容易地进行单元测试。

选项 2 - 将处理程序 JAR 放入 {JAVA_HOME}/jre/lib/ext
此选项也适用。但是，仅将处理程序 jar 添加为系统扩展并不能解决问题——当然。还需要添加处理程序的所有依赖项。由于这些类对于使用此 Java 安装的所有应用程序都是可见的，因此由于类路径中同一库的不同版本，这可能会导致不良影响。

选项 3 - 将处理程序 JAR 放入 {CATALINA_HOME}/lib
这是行不通的。根据Tomcat's classloader documentation放入此目录的资源将使用 Tomcat 的 Common 类加载器加载。 java.net.URL 不会使用此类加载器来查找协议(protocol)处理程序。

考虑到这些选项，我将继续使用反射变体。所有选项都不是很好，但至少第一个可以轻松测试并且不需要任何部署逻辑。但是我稍微调整了代码以使用与 java.net.URL 相同的锁定对象进行同步:

public static void registerFactory() throws Exception  {
  final Field factoryField = URL.class.getDeclaredField("factory");
  factoryField.setAccessible(true);
  final Field lockField = URL.class.getDeclaredField("streamHandlerLock");
  lockField.setAccessible(true);
  
  // use same lock as in java.net.URL.setURLStreamHandlerFactory
  synchronized (lockField.get(null)) {
    final URLStreamHandlerFactory urlStreamHandlerFactory = (URLStreamHandlerFactory) factoryField.get(null);
    // Reset the value to prevent Error due to a factory already defined
    factoryField.set(null, null);
    URL.setURLStreamHandlerFactory(new AmazonS3UrlStreamHandlerFactory(urlStreamHandlerFactory));
  }
}

最佳答案

你可以:

1。使用装饰器

设置自定义 URLStreamHandlerFactory 的一种方法可能是使用 URLStreamHandlerFactory 类型的装饰器来包装可能具有的 URLStreamHandlerFactory已经定义(在这种情况下由 tomcat 定义)。棘手的部分是您需要使用反射(这很棘手)来获取和重置可能定义的当前 factory。

这是装饰器的伪代码:

public class S3URLStreamHandlerFactory implements URLStreamHandlerFactory {

    // The wrapped URLStreamHandlerFactory's instance
    private final Optional<URLStreamHandlerFactory> delegate;

    /**
     * Used in case there is no existing URLStreamHandlerFactory defined
     */
    public S3URLStreamHandlerFactory() {
        this(null);
    }

    /**
     * Used in case there is an existing URLStreamHandlerFactory defined
     */
    public S3URLStreamHandlerFactory(final URLStreamHandlerFactory delegate) {
        this.delegate = Optional.ofNullable(delegate);
    }

    @Override
    public URLStreamHandler createURLStreamHandler(final String protocol) {
        if ("s3".equals(protocol)) {
            return // my S3 URLStreamHandler;
        }
        // It is not the s3 protocol so we delegate it to the wrapped 
        // URLStreamHandlerFactory
        return delegate.map(factory -> factory.createURLStreamHandler(protocol))
            .orElse(null);
    }
}

下面是定义它的代码:

// Retrieve the field "factory" of the class URL that store the 
// URLStreamHandlerFactory used
Field factoryField = URL.class.getDeclaredField("factory");
// It is a package protected field so we need to make it accessible
factoryField.setAccessible(true);
// Get the current value
URLStreamHandlerFactory urlStreamHandlerFactory 
    = (URLStreamHandlerFactory) factoryField.get(null);
if (urlStreamHandlerFactory == null) {
    // No factory has been defined so far so we set the custom one
    URL.setURLStreamHandlerFactory(new S3URLStreamHandlerFactory());
} else {
    // Retrieve the field "streamHandlerLock" of the class URL that
    // is the lock used to synchronize access to the protocol handlers 
    Field lockField = URL.class.getDeclaredField("streamHandlerLock");
    // It is a private field so we need to make it accessible
    lockField.setAccessible(true);
    // Use the same lock to reset the factory
    synchronized (lockField.get(null)) {
        // Reset the value to prevent Error due to a factory already defined
        factoryField.set(null, null);
        // Set our custom factory and wrap the current one into it
        URL.setURLStreamHandlerFactory(
            new S3URLStreamHandlerFactory(urlStreamHandlerFactory)
        );
    }
}

注意:从 Java 9 开始，您需要将 --add-opens java.base/java.net=myModuleName 添加到您的启动命令中以允许深入对包 java.net 的反射，其中包含模块 myModuleName 中的类 URL 否则调用 setAccessible(true)将引发 RuntimeException。

2。将其部署为扩展

应避免此 ClassLoder 问题的另一种方法是将您的自定义 URLStreamHandler 移动到专用 jar 中并将其部署在 ${JAVA-HOME}/jre/lib/ext 作为 installed extension (及其所有依赖项)这样它将在扩展 ClassLoader 中可用，这样您的类将在层次结构中足够高的 ClassLoader 中定义以供查看。

关于java - 在 Spring Web 应用程序 (Tomcat) 中注册自定义 URLStreamHandler，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/41696088/