Tomcat 9运行时动态添加REST端点可行性咨询

完全可以实现从JAR包动态加载类作为REST端点，无需在web.xml中硬编码所有URL映射。针对你的场景，以下是几种可行的实现方案：

一、基于Servlet 3.0+的动态Servlet注册 #

若你的Web容器支持Servlet 3.0及以上版本（如Tomcat 7+、Jetty 8+），可通过代码动态注册REST端点，无需修改web.xml：

1. 自定义ServletContainerInitializer
   在动态JAR包中创建实现ServletContainerInitializer的类，并在JAR的META-INF/services/javax.servlet.ServletContainerInitializer文件中写入该类的全限定名。容器启动时会自动执行该类的onStartup方法，在此完成动态注册：

   public class DynamicRestInitializer implements ServletContainerInitializer {
       @Override
       public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {
           // 从动态JAR加载REST端点类
           Class<?> restEndpointClass = loadDynamicClass("com.example.DynamicRestEndpoint");
           
           // 注册Servlet并绑定URL
           ServletRegistration.Dynamic registration = ctx.addServlet("DynamicRest", restEndpointClass);
           registration.addMapping("/dynamic-rest/*");
           registration.setLoadOnStartup(1);
       }
       
       private Class<?> loadDynamicClass(String className) {
           // 实现自定义类加载器加载外部JAR
           try {
               URL jarUrl = new URL("file:/path/to/your/dynamic.jar");
               URLClassLoader classLoader = new URLClassLoader(new URL[]{jarUrl}, getClass().getClassLoader());
               return classLoader.loadClass(className);
           } catch (Exception e) {
               throw new RuntimeException("加载动态类失败", e);
           }
       }
   }
   

2. 注意事项

   • 确保动态JAR的类加载器与Web应用类加载器兼容，避免类隔离导致的加载失败
   • 若为WAR部署，动态JAR可放置于WEB-INF/lib，或通过外部路径加载

二、基于JAX-RS的动态资源注册 #

如果你的REST实现基于JAX-RS（如Jersey、RESTEasy），可通过Application子类或运行时动态注册来加载JAR中的资源：

1. 扩展Application类实现启动时加载
   创建Application子类，在getClasses()方法中动态加载并返回JAR中的REST资源类：

   public class DynamicJaxRsApplication extends Application {
       @Override
       public Set<Class<?>> getClasses() {
           Set<Class<?>> resourceClasses = new HashSet<>();
           // 加载动态JAR中的资源类
           Class<?> dynamicResource = loadDynamicClass("com.example.DynamicResource");
           resourceClasses.add(dynamicResource);
           return resourceClasses;
       }
       
       private Class<?> loadDynamicClass(String className) {
           try {
               URL jarUrl = new URL("file:/path/to/dynamic-resource.jar");
               URLClassLoader classLoader = new URLClassLoader(new URL[]{jarUrl}, getClass().getClassLoader());
               return classLoader.loadClass(className);
           } catch (Exception e) {
               throw new RuntimeException(e);
           }
       }
   }
   

   仅需在web.xml中配置JAX-RS核心Servlet，无需硬编码每个资源的URL：

   <servlet>
       <servlet-name>JerseyServlet</servlet-name>
       <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
       <init-param>
           <param-name>javax.ws.rs.Application</param-name>
           <param-value>com.example.DynamicJaxRsApplication</param-value>
       </init-param>
       <load-on-startup>1</load-on-startup>
   </servlet>
   <servlet-mapping>
       <servlet-name>JerseyServlet</servlet-name>
       <url-pattern>/api/*</url-pattern>
   </servlet-mapping>
   

2. 运行时动态注册资源
   若需在应用运行时加载JAR并添加端点，可通过JAX-RS的ResourceConfig实现：

   // 获取Jersey的ResourceConfig实例
   ResourceConfig config = (ResourceConfig) servletContext.getAttribute(ResourceConfig.class.getName());
   // 加载动态资源类
   Class<?> dynamicResource = loadDynamicClass("com.example.DynamicResource");
   // 注册资源
   config.register(dynamicResource);
   

三、解决你的配置问题 #

你之前修改web.xml无效的核心原因是：web.xml是静态配置，无法感知动态加载的JAR类。解决方案如下：

• 移除web.xml中所有具体的REST URL映射（如/Timbrature2/*），仅保留核心Servlet的基础映射（如/api/*）
• 采用上述动态注册方案，让容器自动识别JAR中的REST类，JAX-RS会根据类上的@Path注解自动绑定URL，Servlet则需手动通过addMapping指定

关键注意事项 #

• 类加载器兼容性：动态加载的JAR类必须能被Web应用类加载器访问，避免ClassNotFoundException
• 容器版本支持：确认Web容器支持Servlet 3.0+或对应JAX-RS版本
• 文件权限：若加载外部路径的JAR，需确保容器拥有该路径的读取权限

内容的提问来源于stack exchange，提问作者Denis De Pauli