Maven完全指南 - 13. 插件机制

你最红
236 阅读4分钟

13. 插件机制

Maven 的插件机制是其核心之一，插件提供了构建、测试、打包、发布等功能，实现 Maven 项目生命周期的各个阶段。Maven 的插件机制允许用户扩展项目的构建流程，并且可以定制、配置插件来满足不同的构建需求。

插件是执行具体任务的组件，即使核心操作也是由插件完成，Maven 提供了许多内置插件用于完成这些核心操作，如 maven-compiler-plugin 等。

插件是以独立构件的形式存在的 Java 代码模块，负责执行特定的任务（如编译、测试、打包）。每个插件包含一个或多个目标 (goal)，每个目标可以在 Maven 构建生命周期的不同阶段执行。

Maven 有三种类型的生命周期，default、site、clean，每个生命周期包含多个阶段（phase）。插件可以绑定到这些构建阶段，并在执行时按阶段顺序被调用。

常用插件.png

常用插件列表：

  • maven-clean-plugin：清理项目的构建目录（默认是 target 目录），自动绑定到 clean 阶段。
  • maven-compiler-plugin：用于编译编译 Java 源代码。
  • maven-resources-plugin：将项目的资源文件（如 src/main/resources 下的配置文件、静态资源等）复制到构建输出目录（通常是 target/classes），以便在打包时包含这些资源。
  • maven-surefire-plugin：自动扫描并执行项目中的测试类，运行单元测试。
  • maven-jar-plugin：将项目打包成 JAR 文件，<finalName> 用于设置 JAR 文件的名称。
  • maven-war-plugin：打包 Web 应用项目为 WAR 文件。
  • maven-install-plugin：将构件安装到本地仓库，以供本地项目依赖。
  • maven-deploy-plugin：将构件发布到远程仓库，供其他项目依赖使用。
  • maven-site-plugin：生成项目站点，包含文档、测试报告等，可以自动生成项目的基本信息和依赖关系。。
  • maven-assembly-plugin：创建包含依赖的自定义打包格式，如 ZIP、TAR 文件。
  • maven-javadoc-plugin：生成项目的 Javadoc 文档。
  • maven-dependency-plugin：专门用于管理和处理项目的依赖关系，帮助开发者解析、分析、复制、解压以及管理项目的依赖。

13.1 插件目标

在 Maven 中，插件目标是 Maven 插件的基本构建块，是执行特定任务的具体指令，目标定义了插件在构建生命周期的某个阶段中执行的具体操作。每个插件可以包含一个或多个目标，每个目标实现不同的任务。例如，maven-compiler-plugin 插件中包含了两个目标 compile 和 testCompile，分别用于编译主代码和测试代码。

目标是插件执行任务的最小单元，它定义了某个特定任务或功能。目标只有绑定了生命周期阶段（phase）才会自动执行，否则需要使用命令行显示指定执行。

插件目标有两种执行方式：

  • 通过生命周期触发执行：Maven 中的每个构建生命周期阶段都绑定了默认插件目标，当触发生命周期阶段执行的时候就会使用对应绑定的目标执行具体的任务。
  • 直接在命令行调用执行：如果需要手动运行某个特定的插件目标而不依赖生命周期阶段，可以在命令行中直接调用目标，这样可以更灵活地运行某些特定任务。

goal1.png

goal2.png

13.2 目标绑定

插件目标绑定在 Maven 中起到了将插件目标与生命周期阶段关联的作用，这样在执行某个生命周期阶段时，Maven 可以自动执行绑定的插件目标，从而简化构建过程并确保必要的构建步骤得到执行。

Maven 中的常用插件通常与生命周期的标准阶段进行了默认绑定，确保在构建项目时自动执行各类任务。这些绑定通常满足大部分项目的需求，如果默认绑定无法满足项目需求的话，可以在<build>构建配置中进行手动绑定。

在 Maven 中，你可以通过 <executions> 元素将插件目标手动绑定到特定的生命周期阶段。手动绑定目标可以在默认绑定之外添加额外的插件目标执行，或在没有默认绑定的情况下将插件目标绑定到所需的阶段。

例如，假设我们要将 maven-dependency-plugin 的 copy-dependencies 目标手动绑定到 package 阶段，以便在打包时将所有依赖复制到目标目录中：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-dependency-plugin</artifactId>
      <version>3.1.2</version>
      <executions>
        <execution>
          <id>copy-dependencies</id> <!-- 唯一标识 -->
          <phase>package</phase> <!-- 绑定到的阶段 -->
          <goals>
            <goal>copy-dependencies</goal>
          </goals>
          <configuration>
            <outputDirectory>${project.build.directory}/libs</outputDirectory>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>
avatar
文章
阅读
粉丝