当前位置：首页 > article >正文

Maven 如何配置忽略单元测试

article 2024/12/2 6:32:05

在使用 Maven 进行项目构建时，有时您可能希望跳过测试阶段。

这在确保代码更改不影响测试结果或需要快速部署项目的情况下特别有用。

Maven 提供了多种方法来在构建过程中跳过测试。

为什么跳过测试？

加速构建：对于具有大量测试用例的大项目来说，跳过测试可以显著减少构建时间。
专注于构建过程：有时候，您只是想检查项目是否能成功编译，而无需运行测试。
快速部署：当部署快照版本或者进行紧急修复时，跳过测试可以加快整个流程。

使用 Maven 跳过测试

1. 通过命令行选项

Maven 支持几种命令行选项来跳过测试：

-DskipTests：此选项会跳过测试的编译和执行。
```
mvn install -DskipTests
```
-Dmaven.test.skip=true：此选项不仅跳过测试的编译和执行，还会跳过依赖于测试类的相关插件。
```
mvn install -Dmaven.test.skip=true
```

2. 配置 pom.xml 文件

您也可以直接在 pom.xml 中配置默认跳过测试：

使用 skipTests 属性
在 pom.xml 中添加如下属性：

<properties>
    <skipTests>true</skipTests>
</properties>

使用 maven.test.skip 属性
或者，在 pom.xml 中设置：

<properties>
    <maven.test.skip>true</maven.test.skip>
</properties>

3. 对特定阶段跳过测试

您可以通过配置 maven-surefire-plugin 或 maven-failsafe-plugin 来为特定阶段跳过测试。

这两个插件在 Maven 项目中分别用于处理单元测试和集成测试（或称端到端测试）。

下面是关于如何配置这些插件以跳过测试的详细说明。

配置 maven-surefire-plugin

maven-surefire-plugin 主要用来运行项目的单元测试。如果您希望在构建过程中跳过这些测试，可以在项目的 pom.xml 文件中对这个插件进行如下配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M9</version> <!-- 请使用最新版本 -->
            <configuration>
                <skipTests>true</skipTests> <!-- 跳过所有单元测试 -->
                <!-- 或者使用更具体的控制 -->
                <!-- <includes>
                    <include>**/*Test.java</include>
                </includes>
                <excludes>
                    <exclude>**/SpecificTest.java</exclude>
                </excludes> -->
            </configuration>
        </plugin>
    </plugins>
</build>

<skipTests>true</skipTests>：这会完全跳过所有单元测试。
如果您想要更细粒度地控制哪些测试被跳过，可以使用 <includes> 和 <excludes> 标签来指定包含或排除的测试类模式。

配置 maven-failsafe-plugin

maven-failsafe-plugin 通常用于执行集成测试，这些测试可能需要更多的上下文环境设置。对于跳过集成测试，可以这样配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-failsafe-plugin</artifactId>
            <version>3.0.0-M9</version> <!-- 请使用最新版本 -->
            <configuration>
                <skipITs>true</skipITs> <!-- 跳过所有集成测试 -->
                <!-- 同样，也可以使用 includes/excludes 来精细控制 -->
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>integration-test</goal>
                        <goal>verify</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

<skipITs>true</skipITs>：此配置项用于跳过所有集成测试。
您同样可以通过 <includes> 和 <excludes> 标签来选择性地跳过某些测试。

注意事项

确保使用适合您项目的 Maven 插件版本。
在开发环境中频繁跳过测试可能会导致潜在问题未能及时发现，因此建议仅在必要时使用这些配置，并确保在生产部署前彻底测试代码。
除了直接在 pom.xml 中设置外，您还可以利用命令行参数如 -DskipTests 或 -Dmaven.test.skip=true 来临时跳过测试，这在 CI/CD 流程中特别有用。

示例项目配置

以下是一个完整的 pom.xml 示例，其中包含了跳过测试的配置：

<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>myapp</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <skipTests>true</skipTests>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <version>5.9.3</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-engine</artifactId>
            <version>5.9.3</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>3.0.0-M9</version>
                <configuration>
                    <skipTests>true</skipTests>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>