如何在web.xml中配置多个Servlet？Java Web多模块配置指南

在 Java Web 应用中，通常只有一个 web.xml（部署描述符文件），但可以通过以下两种方式实现“多配置”效果：

方案 1：使用 web-fragment.xml（Servlet 3.0+ 推荐）

Servlet 3.0 规范允许通过 web-fragment.xml 将配置分散到多个模块中。
步骤：

1. 在 JAR 文件中创建配置
   在模块的 META-INF/ 目录下添加 web-fragment.xml格式与 web.xml 相同。

   <!-- META-INF/web-fragment.xml -->
   <web-fragment xmlns="http://xmlns.jcp.org/xml/ns/javaee"
                version="4.0">
       <servlet>
           <servlet-name>ModuleServlet</servlet-name>
           <servlet-class>com.example.ModuleServlet</servlet-class>
       </servlet>
       <servlet-mapping>
           <servlet-name>ModuleServlet</servlet-name>
           <url-pattern>/module</url-pattern>
       </servlet-mapping>
   </web-fragment>

2. 主应用整合
   将包含 web-fragment.xml 的 JAR 文件放入 WEB-INF/lib/ 目录,容器会自动合并配置。

3. 控制加载顺序（可选）
   在主 web.xml 中指定顺序：

   <web-app ...>
       <absolute-ordering>
           <name>fragment-module1</name> <!-- 对应 web-fragment 中 <name> 标签 -->
           <name>fragment-module2</name>
       </absolute-ordering>
   </web-app>

方案 2：手动合并配置（不推荐）

如果需要显式合并多个 XML 文件，可在构建阶段或运行时处理：

1. 构建工具合并
   使用 Maven/Ant 在打包时合并多个 XML 文件为一个 web.xml。
   示例（Maven 插件）：

   <plugin>
       <groupId>org.codehaus.mojo</groupId>
       <artifactId>xml-maven-plugin</artifactId>
       <executions>
           <execution>
               <id>merge-web-xml</id>
               <phase>process-resources</phase>
               <goals><goal>transform</goal></goals>
               <configuration>
                   <transformationSets>
                       <transformationSet>
                           <dir>src/main/web-configs</dir>
                           <includes><include>*.xml</include></includes>
                           <stylesheet>src/main/resources/merge.xsl</stylesheet>
                           <outputDir>${project.build.directory}/webapp/WEB-INF</outputDir>
                           <outputFile>web.xml</outputFile>
                       </transformationSet>
                   </transformationSets>
               </configuration>
           </execution>
       </executions>
   </plugin>

   编写 XSLT 文件 (merge.xsl) 合并多个 XML 文件。

2. 编程式配置（Servlet 3.0+）
   放弃 XML，改用注解或 ServletContainerInitializer：

   public class CustomInitializer implements ServletContainerInitializer {
       @Override
       public void onStartup(Set<Class<?>> c, ServletContext ctx) {
           // 动态注册 Servlet
           ServletRegistration.Dynamic servlet = ctx.addServlet("DynamicServlet", DynamicServlet.class);
           servlet.addMapping("/dynamic");
       }
   }

   在 META-INF/services/javax.servlet.ServletContainerInitializer 文件中注册实现类。

关键注意事项

1. 冲突解决

   

   • 如果多个配置定义相同 <servlet-name>,后加载的会覆盖前者。
   • 使用 <absolute-ordering> 明确控制 web-fragment 加载顺序。

2. 版本兼容性
   web-fragment.xml 需 Servlet 3.0+ 容器（Tomcat 7+、Jetty 8+ 等）。

3. 元数据优先级
   web.xml > web-fragment.xml > 注解（可通过 metadata-complete="true" 禁用注解扫描）。

选择 web-fragment.xml 是标准化的模块化配置方案,而编程式初始化更适合需要动态控制的场景。