spring-boot-maven-plugin下WAR包排除JAR失效及协同方案咨询

我有一个打包为WAR文件的Spring Boot应用，运行在嵌入式Apache Tomcat上，引入了如下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
</dependency>

我希望从最终WAR包中排除Apache Tomcat相关JAR，因此用maven-war-plugin做了如下配置：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-war-plugin</artifactId>
    <version>3.3.2</version>
    <configuration>
        <packagingExcludes>WEB-INF/lib/tomcat-*.jar,WEB-INF/lib/spring-boot-starter-*.jar</packagingExcludes>
    </configuration>
</plugin>

注：我知道可以将依赖的scope设为provided来生成不含Tomcat JAR的WAR包，但需要频繁构建，不想每次修改scope。

原本这个配置能正常工作，但加入spring-boot-maven-plugin后，maven-war-plugin就失效了。

问题：有没有办法让spring-boot-maven-plugin和maven-war-plugin协同工作？

完整pom.xml内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.2</version>
        <relativePath/>
    </parent>
    <groupId>test.com</groupId>
    <artifactId>storage</artifactId>
    <version>1</version>
    <name>storage</name>
    <description>Storage API</description>
    <properties>
        <java.version>11</java.version>
        <maven.compiler.source>${java.version}</maven.compiler.source>
        <maven.compiler.target>${java.version}</maven.compiler.target>
    </properties>
    <packaging>war</packaging>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-ui</artifactId>
            <version>1.6.9</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.11.0</version>
        </dependency>
        <!-- Need Tomcat to run project from intellij, but I need to exclude tomcat jars from final war -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </dependency>
    </dependencies>
    <build>
        <finalName>storage</finalName>
        <plugins>
            <!--
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                 <! -- other config here
        </configuration>
    </plugin>
    -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>3.3.2</version>
                <configuration>
                    <packagingExcludes>WEB-INF/lib/tomcat-*.jar,WEB-INF/lib/spring-boot-starter-*.jar
                    </packagingExcludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

解决方案 #

spring-boot-maven-plugin的repackage目标会重新打包WAR文件，覆盖maven-war-plugin生成的包，这是导致排除规则失效的核心原因。以下是两种实用解决方式：

方式一：禁用spring-boot-maven-plugin的WAR重打包

在插件配置中添加<war>false</war>，让它仅处理JAR相关的重打包逻辑，不干预WAR文件生成：

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <executions>
        <execution>
            <goals>
                <goal>repackage</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <excludes>
            <exclude>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </exclude>
        </excludes>
        <war>false</war> <!-- 禁用WAR重打包逻辑 -->
    </configuration>
</plugin>

这种方式下，maven-war-plugin的排除规则会正常生效。

方式二：直接通过spring-boot-maven-plugin排除依赖

既然spring-boot-maven-plugin会最终重打包WAR，直接在它的配置里指定要排除的依赖即可，无需依赖maven-war-plugin的规则：

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <executions>
        <execution>
            <goals>
                <goal>repackage</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <excludes>
            <exclude>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </exclude>
            <!-- 排除Tomcat starter依赖 -->
            <exclude>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
            </exclude>
            <!-- 批量排除所有Tomcat官方依赖 -->
            <exclude>
                <groupId>org.apache.tomcat</groupId>
                <artifactId>*</artifactId>
            </exclude>
        </excludes>
    </configuration>
</plugin>

这种方式更直接，也能保证最终WAR包中不含指定的Tomcat相关依赖。

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