spring-boot-maven-plugin打包时排除provided依赖问题怎么解决

Spring Boot Maven Plugin 打包时排除 provided 依赖问题怎么解决

在使用 Spring Boot 进行项目开发时，我们通常会使用 spring-boot-maven-plugin 插件来打包项目。然而，在某些情况下，我们可能会遇到一个问题：在打包时，provided 范围的依赖被错误地包含在了最终的打包文件中。本文将详细探讨这个问题的原因，并提供几种解决方案。

1. 问题背景

在 Maven 项目中，依赖的范围（scope）决定了依赖在项目生命周期中的使用方式。常见的依赖范围包括：

• compile：默认范围，依赖在编译、测试和运行时都可用。
• provided：依赖在编译和测试时可用，但在运行时由 JDK 或容器提供。
• runtime：依赖在测试和运行时可用，但在编译时不可用。
• test：依赖仅在测试时可用。

在 Spring Boot 项目中，我们通常会将一些依赖标记为 provided，例如 Servlet API、Tomcat 等，因为这些依赖在运行时由应用服务器提供。然而，当我们使用 spring-boot-maven-plugin 插件打包项目时，这些 provided 依赖有时会被错误地包含在最终的打包文件中，导致运行时冲突或错误。

2. 问题原因

spring-boot-maven-plugin 插件默认会将所有依赖打包到最终的 JAR 或 WAR 文件中，包括 provided 范围的依赖。这是因为 Spring Boot 的设计目标是创建一个自包含的、可执行的 JAR 文件，因此它会将所有依赖打包在一起，以确保应用在任何环境下都能正常运行。

然而，在某些情况下，我们可能希望排除 provided 依赖，例如：

• 当我们将应用部署到应用服务器（如 Tomcat）时，应用服务器已经提供了这些依赖。
• 当我们希望减少打包文件的大小，避免不必要的依赖。

3. 解决方案

针对上述问题，我们可以通过以下几种方式来解决 spring-boot-maven-plugin 打包时排除 provided 依赖的问题。

3.1 使用 exclude 配置

spring-boot-maven-plugin 插件提供了一个 exclude 配置项，允许我们在打包时排除特定的依赖。我们可以在 pom.xml 文件中配置 exclude，如下所示：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <excludes>
                    <exclude>
                        <groupId>javax.servlet</groupId>
                        <artifactId>javax.servlet-api</artifactId>
                    </exclude>
                </excludes>
            </configuration>
        </plugin>
    </plugins>
</build>

在这个例子中，我们排除了 javax.servlet:javax.servlet-api 依赖。这样，在打包时，spring-boot-maven-plugin 将不会将这个依赖包含在最终的打包文件中。

3.2 使用 provided 范围的依赖

如果我们希望排除所有 provided 范围的依赖，而不仅仅是某个特定的依赖，我们可以使用 provided 范围的依赖。在 pom.xml 文件中，我们可以将依赖的范围设置为 provided，如下所示：

<dependencies>
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <scope>provided</scope>
    </dependency>
</dependencies>

这样，spring-boot-maven-plugin 在打包时会自动排除所有 provided 范围的依赖。

3.3 使用 spring-boot-maven-plugin 的 repackage 目标

spring-boot-maven-plugin 插件提供了一个 repackage 目标，允许我们在打包时重新打包项目。我们可以通过配置 repackage 目标来排除 provided 依赖，如下所示：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                    <configuration>
                        <excludeGroupIds>javax.servlet</excludeGroupIds>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

在这个例子中，我们使用 excludeGroupIds 配置项来排除 javax.servlet 组的所有依赖。这样，在打包时，spring-boot-maven-plugin 将不会将这些依赖包含在最终的打包文件中。

3.4 使用 maven-war-plugin 插件

如果我们打包的是 WAR 文件，而不是 JAR 文件，我们可以使用 maven-war-plugin 插件来排除 provided 依赖。maven-war-plugin 插件提供了一个 packagingExcludes 配置项，允许我们在打包时排除特定的依赖。我们可以在 pom.xml 文件中配置 packagingExcludes，如下所示：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-war-plugin</artifactId>
            <configuration>
                <packagingExcludes>WEB-INF/lib/javax.servlet-api-*.jar</packagingExcludes>
            </configuration>
        </plugin>
    </plugins>
</build>

在这个例子中，我们排除了 WEB-INF/lib/javax.servlet-api-*.jar 文件。这样，在打包时，maven-war-plugin 将不会将这个依赖包含在最终的 WAR 文件中。

3.5 使用 maven-dependency-plugin 插件

我们还可以使用 maven-dependency-plugin 插件来排除 provided 依赖。maven-dependency-plugin 插件提供了一个 copy-dependencies 目标，允许我们在打包时复制依赖。我们可以通过配置 copy-dependencies 目标来排除 provided 依赖，如下所示：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy-dependencies</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <excludeScope>provided</excludeScope>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

在这个例子中，我们使用 excludeScope 配置项来排除 provided 范围的依赖。这样，在打包时，maven-dependency-plugin 将不会复制这些依赖。

4. 总结

在使用 spring-boot-maven-plugin 插件打包 Spring Boot 项目时，provided 范围的依赖可能会被错误地包含在最终的打包文件中。为了解决这个问题，我们可以使用 exclude 配置、provided 范围的依赖、repackage 目标、maven-war-plugin 插件或 maven-dependency-plugin 插件来排除 provided 依赖。根据项目的具体需求，选择合适的解决方案，可以有效地避免运行时冲突或错误，并减少打包文件的大小。

通过本文的介绍，相信读者已经对如何解决 spring-boot-maven-plugin 打包时排除 provided 依赖问题有了更深入的了解。希望这些解决方案能够帮助你在实际项目中更好地管理和打包依赖。

亿速云「云服务器」，即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘，价格低至29元/月。点击查看>>