部署在Tomcat上的Spring WAR包无法读取META-INF目录下的pom.xml

问题根源 #

当Spring Boot应用以WAR包部署到Tomcat时，应用的classpath指向WEB-INF/classes和WEB-INF/lib目录，之前Jar包运行时的路径逻辑虽然理论上适用，但如果WAR打包时未正确生成META-INF/maven/{groupId}/{artifactId}/pom.xml，或者读取方式未适配Web容器环境，就会出现读取失败。

可行解决方案 #

1. 使用Spring的ResourceLoader读取（推荐）

利用Spring提供的ResourceLoader可以统一处理不同环境下的资源读取，自动适配classpath路径：

@Autowired
private ResourceLoader resourceLoader;

public void loadPomDependencies() throws IOException, XmlPullParserException {
    // 替换{groupId}和{artifactId}为你的项目实际值
    Resource pomResource = resourceLoader.getResource("classpath:META-INF/maven/{groupId}/{artifactId}/pom.xml");
    
    if (pomResource.exists()) {
        try (InputStream inputStream = pomResource.getInputStream()) {
            MavenXpp3Reader reader = new MavenXpp3Reader();
            Model pomModel = reader.read(new InputStreamReader(inputStream));
            // 从pomModel中获取依赖列表，例如：
            // List<Dependency> dependencies = pomModel.getDependencies();
        }
    } else {
        // 处理pom.xml不存在的情况
        throw new FileNotFoundException("pom.xml not found in classpath");
    }
}

2. 通过ServletContext读取Web应用内资源

如果是在Web层代码中，可以直接注入ServletContext来访问Web应用根目录下的资源：

@Autowired
private ServletContext servletContext;

public void readPom() throws IOException, XmlPullParserException {
    String pomPath = "/WEB-INF/classes/META-INF/maven/{groupId}/{artifactId}/pom.xml";
    try (InputStream is = servletContext.getResourceAsStream(pomPath)) {
        if (is != null) {
            MavenXpp3Reader reader = new MavenXpp3Reader();
            Model pomModel = reader.read(new InputStreamReader(is));
            // 处理依赖逻辑
        } else {
            throw new FileNotFoundException("pom.xml not found at path: " + pomPath);
        }
    }
}

3. 确认WAR包结构是否正确

先解压WAR包检查WEB-INF/classes/META-INF/maven/{groupId}/{artifactId}/目录下是否存在pom.xml。如果不存在，需要在项目pom.xml中配置maven-war-plugin确保生成Maven描述文件：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-war-plugin</artifactId>
            <version>3.3.2</version>
            <configuration>
                <!-- 确保生成META-INF/maven目录及pom.xml，默认值为true，若被修改需显式开启 -->
                <archive>
                    <addMavenDescriptor>true</addMavenDescriptor>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

4. 禁止使用硬编码绝对路径

不要使用/webapps/xyz#services/...这类绝对路径，Tomcat的部署目录可能被自定义配置修改，上下文路径也可能变化，硬编码路径会导致应用失去可移植性。

内容的提问来源于stack exchange，提问作者Joginder Pawan Kumar