如何在Tomcat/WildFly等应用服务器中注册自定义URLStreamHandlerProvider？

针对Tomcat、WildFly等应用服务器中无法通过常规方式注册URLStreamHandlerProvider的问题，以下是可行的解决方案：

通用Servlet容器方案（需全局JVM参数支持） #

通过Servlet上下文监听器结合反射实现注册，但需突破Java 17的模块访问限制：

1. 实现ServletContextListener，在应用启动时手动向URL的handlers表添加自定义处理器：

public class CustomURLHandlerListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent event) {
        try {
            // 反射获取URL的handlers静态字段
            Field handlersField = URL.class.getDeclaredField("handlers");
            handlersField.setAccessible(true);
            Hashtable<String, URLStreamHandler> handlers = (Hashtable<String, URLStreamHandler>) handlersField.get(null);
            // 注册自定义协议的处理器（示例为"myproto"协议）
            handlers.put("myproto", new MyCustomURLStreamHandler());
        } catch (NoSuchFieldException | IllegalAccessException e) {
            throw new RuntimeException("注册URL处理器失败", e);
        }
    }
}

2. 在web.xml中注册该监听器：

<listener>
    <listener-class>com.example.CustomURLHandlerListener</listener-class>
</listener>

3. 给应用服务器添加启动参数，开放模块访问权限：

--add-opens java.base/java.net=ALL-UNNAMED

Tomcat专属方案 #

方案1：扫描Web应用内的服务配置 #

在Web应用的WEB-INF/classes/META-INF/services/下创建java.net.URLStreamHandlerProvider文件，写入你的实现类全限定名，然后修改应用的META-INF/context.xml，配置Tomcat扫描应用内的服务配置：

<Context>
    <JarScanner scanAllDirectories="true" />
</Context>

方案2：全局类加载路径部署 #

将包含URLStreamHandlerProvider实现及服务配置的JAR包放入Tomcat的CATALINA_HOME/lib目录，Tomcat启动时会通过系统类加载器扫描并注册该处理器（此方案对所有Web应用生效）。

WildFly专属方案 #

利用WildFly的模块系统实现应用级别的注册：

1. 将URLStreamHandlerProvider实现打包成JAR，创建WildFly模块：
   • 在WildFly的modules/com/example/urlhandler/main/目录下放入JAR包，新建module.xml：

<module xmlns="urn:jboss:module:1.3" name="com.example.urlhandler">
    <resources>
        <resource-root path="custom-url-handler.jar"/>
    </resources>
    <dependencies>
        <module name="java.base"/>
    </dependencies>
    <services>
        <service provider="java.net.URLStreamHandlerProvider"/>
    </services>
</module>

2. 在Web应用的WEB-INF/jboss-deployment-structure.xml中依赖该模块：

<jboss-deployment-structure>
    <deployment>
        <dependencies>
            <module name="com.example.urlhandler" export="true"/>
        </dependencies>
    </deployment>
</jboss-deployment-structure>

部署应用时，WildFly会加载该模块并自动注册对应的URL处理器。

内容的提问来源于stack exchange，提问作者Horcrux7