java maven插件 maven插件详解

转载

技术领航探索者 2024-02-29 09:59:43

文章标签 java maven插件 maven java junit 测试类 文章分类 Java 后端开发

Maven插件是扩展Maven功能的方式之一，它可以帮助我们更轻松地管理依赖性、构建应用程序、运行测试和部署应用程序等。maven插件实在是太多了，我这里也介绍不完，仅仅以我使用过的也比较实用的给大家介绍一下，希望对大家有点帮助。

首先maven本身自带了许多插件，比如清理插件，打包插件 Maven打包及其相关插件和高级特性，部署插件等等，这些我们直接略过了。

测试插件

maven-surefire-plugin

Surefire插件用于运行单元测试，而Failsafe插件用于运行集成测试。这两个插件都可以自动地查找测试类并运行测试方法。

使用Maven测试插件非常简单。只需要在项目的pom.xml文件中添加插件配置即可。例如，要使用Surefire插件运行单元测试，可以添加以下配置：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-surefire-plugin</artifactId>
      <version>3.0.0-M5</version>
      <configuration>
        <!-- 配置测试类文件所在的目录 -->
        <testSourceDirectory>src/test/java</testSourceDirectory>
        <!-- 配置测试类的匹配规则 -->
        <includes>
          <include>**/*Test.java</include>
        </includes>
      </configuration>
    </plugin>
  </plugins>
</build>
复制代码

在上面的配置中，我们指定了测试类文件所在的目录和测试类的匹配规则。这样，当我们运行mvn test命令时，Surefire插件就会自动查找符合规则的测试类，并运行其中的测试方法。

public class MyTest {
    @Test
    public void testAddition() {
        int result = 2 + 2;
        assertEquals(4, result);
    }

    @Test
    public void testSubtraction() {
        int result = 5 - 3;
        assertEquals(2, result);
    }
}
复制代码

在上面的测试类中，testAddition()和testSubtraction()方法分别测试了加法和减法的正确性。这些测试方法使用了JUnit的@Test注解来标记，在运行测试时会自动执行

运行结果如下：

java maven插件 maven插件详解_测试类_02

maven-failsafe-plugin

Maven Failsafe插件是Maven提供的一个测试插件，用于运行集成测试。与Maven Surefire插件不同，Maven Failsafe插件用于运行需要依赖外部环境、例如数据库或网络等的测试。

与Surefire插件类似，Failsafe插件会自动查找和执行符合命名规则的测试类和测试方法。默认情况下，Failsafe插件会查找以IT结尾的测试类，并运行其中以test开头的所有方法。

例如，下面是一个简单的集成测试类

public class IntegrationTest {
    @Test
    public void testDatabaseConnection() throws SQLException {
        // 测试数据库连接
        Connection conn = DriverManager.getConnection("jdbc:mysql://localhost:3306/test", "root", "password");
        assertFalse(conn.isClosed());
    }

    @Test
    public void testWebService() throws IOException {
        // 测试Web服务
        URL url = new URL("http://localhost:8080/hello");
        HttpURLConnection con = (HttpURLConnection) url.openConnection();
        con.setRequestMethod("GET");
        int status = con.getResponseCode();
        assertEquals(200, status);
    }
}
复制代码

在上面的测试类中，我们编写了两个测试方法，分别测试数据库连接和Web服务。这些测试方法依赖于外部环境，例如MySQL数据库和运行中的Web服务。

要在Maven项目中使用Failsafe插件，需要在项目的pom.xml文件中添加以下插件配置

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-failsafe-plugin</artifactId>
      <version>3.0.0-M5</version>
      <executions>
        <execution>
          <id>integration-test</id>
          <goals>
            <goal>integration-test</goal>
          </goals>
        </execution>
        <execution>
          <id>verify</id>
          <goals>
            <goal>verify</goal>
          </goals>
        </execution>
      </executions>
      <configuration>
        <!-- 配置测试类文件所在的目录 -->
        <testSourceDirectory>src/test/java</testSourceDirectory>
        <!-- 配置测试类的匹配规则 -->
        <includes>
          <include>**/*Test.java</include>
        </includes>
      </configuration>
    </plugin>
  </plugins>
</build>
复制代码

在上面的插件配置中，我们指定了测试类文件所在的目录和测试类的匹配规则。此外，我们还定义了两个执行阶段：integration-test和verify。执行mvn verify命令时，Failsafe插件会自动运行集成测试，并输出测试结果。

Maven Failsafe插件是一个非常有用的工具，它可以帮助我们测试依赖外部环境的代码，并验证项目在真实环境下的可靠性和稳定性。

代码检查插件

arch-unit-maven-plugin

ArchUnit是一个用于Java代码架构自动化检测的开源框架，可以帮助开发者在编译期间自动化地检查代码的结构和规范。使用Maven ArchUnit插件，需要在项目的pom.xml文件中添加以下插件配置：

<plugin>
  <groupId>com.societegenerale.commons</groupId>
  <artifactId>arch-unit-maven-plugin</artifactId>
  <version>2.7.2</version>
  <configuration>
    <!-- 需压排出的包路径 -->
    <excludedPaths>
      <excludedPath>my/package/to/exclude</excludedPath>
    </excludedPaths>

    <rules>
      <configurableRules>
        <configurableRule>
          <!--<rule>com.tngtech.archunit.library.GeneralCodingRules</rule>-->
          <rule>com.poe4j.archunit.rules.ArchunitBootRule</rule>
          <applyOn>
            <packageName>com.wisesoft</packageName>
            <scope>main</scope>
          </applyOn>
        </configurableRule>
      </configurableRules>
			<dependencies>
        <dependency>
          <groupId>com.example</groupId>
          <artifactId>my-archunit-tests</artifactId>
          <version>1.0.0-SNAPSHOT</version>
          <scope>test</scope>
        </dependency>
      </dependencies>
    </rules>
  </configuration>
</plugin>
复制代码

需要注意的是，这段代码中的标签指定了要应用的规则类。如果要使用ArchUnit框架提供的预定义规则，可以使用类似com.tngtech.archunit.library.GeneralCodingRules这样的规则类。如果要使用自定义规则，需要提供自定义规则类的全限定名。

此外，标签中的和分别指定了应用规则的包名和范围。可以根据需要修改这些配置来适应不同的项目和规则需求。

在上面的插件配置中，我们指定了ArchUnit Maven插件的版本号和执行阶段。此外，我们还添加了一个依赖项，即ArchUnit测试的项目。在这个例子中，我们假设ArchUnit测试的项目是my-archunit-tests，版本号为1.0.0-SNAPSHOT。

一旦配置完毕，就可以在Maven构建过程中运行ArchUnit测试了。例如，要运行ArchUnit测试，可以使用以下命令：

mvn clean test
复制代码

当项目编译项目时，ArchUnit会在测试阶段自动运行ArchUnit测试。如果有测试失败或出现错误，Maven会将相关信息输出到控制台上，帮助你找到问题所在。

总的来说，Maven ArchUnit插件是一个非常有用的工具，它可以帮助我们自动化测试Java代码的结构和规范，并提高代码的可维护性和稳定性。

maven-pmd-plugin

Maven PMD插件是一个用于代码静态分析的Maven插件，它可以帮助开发者自动化地检查代码中的潜在问题和错误。PMD是一款流行的Java代码静态分析工具，它可以检测代码中的常见问题，例如未使用的变量、空的代码块、代码重复等。

使用Maven PMD插件，需要在项目的pom.xml文件中添加以下插件配置：

<build>
  
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pmd-plugin</artifactId>
      <version>3.15.0</version>
      <executions>
        <execution>
          <phase>verify</phase>
          <goals>
            <goal>pmd</goal>
          </goals>
        </execution>
      </executions>
      <configuration>
        <!-- 配置检查规则 -->
        <rulesets>
          <ruleset>/rulesets/java/basic.xml</ruleset>
          <ruleset>/rulesets/java/braces.xml</ruleset>
          <ruleset>/rulesets/java/strings.xml</ruleset>
        </rulesets>
        <!-- 配置结果输出格式 -->
        <format>xml</format>
        <targetJdk>1.8</targetJdk>
      </configuration>
    </plugin>
  </plugins>
</build>
复制代码

在上面的插件配置中，我们指定了Maven PMD插件的版本号、执行阶段和配置信息。在这个例子中，我们将PMD检查阶段定义为verify，并指定了要使用的检查规则和结果输出格式。此外，我们还指定了目标JDK版本为1.8。

在运行Maven构建命令时，PMD插件会自动检查代码，并输出检查结果。例如，要运行PMD检查，可以使用以下命令：