maven生命周期

Maven有三套相互独立的生命周期，请注意这里说的是“三套”，而且“相互独立”。

每个生命周期由一系列阶段组成；默认的构建生命周期包括 23 个阶段，这些是主要的构建生命周期。另一方面，clean 生命周期由 3 个阶段组成，而 site 生命周期由4个阶段组成。

这三套生命周期分别如下所示。

Clean Lifecycle

在进行真正的构建之前进行一些清理工作。清理上一次 build 产生的所有的文件(target/)

Clean生命周期一共包含了三个阶段：

pre-clean 执行一些需要在clean之前完成的工作
clean 移除所有上一次构建生成的文件
post-clean 执行一些需要在clean之后立刻完成的工作

Default Lifecycle

负责项目部署的主要生命周期，构建的核心部分，编译，测试，打包，部署等等。

Maven 阶段表示 Maven 构建生命周期中的各个阶段，每个阶段负责一个特定的任务，默认的包括以下这些黑体标粗阶段。

validate：检查构建所需的所有信息是否都可用
generate-sources
process-sources
generate-resources
process-resources 复制并处理资源文件，至目标目录，准备打包
compile：编译项目的源代码
process-classes
generate-test-sources
process-test-sources
generate-test-resources
process-test-resources 复制并处理资源文件，至目标测试目录
test-compile：编译测试源代码
process-test-classes
test：使用合适的单元测试框架运行测试。这些测试代码不会被打包或部署
prepare-package
package：接受编译好的代码，打包成可发布的格式，如 JAR
pre-integration-test
integration-test：集成测试
post-integration-test
verify
install：将包安装至本地仓库，以让其它项目依赖。
deploy：将最终的包复制到远程的仓库，以让其它开发人员与项目共享

那我们在Hello的项目中执行 mvn install 命令，通过日志看看中间经历了什么？

通过日志我们发现，其实执行mvn install，其中已经执行了compile 和 test 。

maven 中的阶段是有先后顺序只分的，当运行靠后的阶段时，前面的也会执行，但是也可以通过一些参数来跳过一些操作，最常见的就是 skipTests 。

总结：不论你要执行生命周期的哪一个阶段，maven都是从这个生命周期的开始执行

插件：每个阶段都有插件（plugin），看上面标红的。插件的职责就是执行它对应的命令。

Site Lifecycle

生成项目报告，站点，发布站点。

pre-site 执行一些需要在生成站点文档之前完成的工作
site 生成项目的站点文档
post-site 执行一些需要在生成站点文档之后完成的工作，并且为部署做准备
site-deploy 将生成的站点文档部署到特定的服务器上

maven goal

生命周期中会有阶段，阶段中会有一些列目标，每个目标负责一个特定的任务；当我们运行一个阶段时，默认会绑定到这个阶段的所有目标都按顺序执行。下面以 compile 为例：

以下是一些与之相关的阶段和默认目标:

compile:compile -> 编译器插件的编译目标绑定到编译阶段
compile:testCompile -> 被绑定到测试编译阶段

怎么去看特定阶段的目标和他的插件信息呢？mvn help:describe -Dcmd=PHASENAME，比如：

mvn help:describe -Dcmd=compile
[INFO] 'compile' is a phase corresponding to this plugin:
org.apache.maven.plugins:maven-compiler-plugin:3.1:compile

It is a part of the lifecycle for the POM packaging 'jar'. This lifecycle includes the following phases:
* validate: Not defined
* initialize: Not defined
* generate-sources: Not defined
* process-sources: Not defined
* generate-resources: Not defined
* process-resources: org.apache.maven.plugins:maven-resources-plugin:2.6:resources
* compile: org.apache.maven.plugins:maven-compiler-plugin:3.1:compile
* process-classes: Not defined
* generate-test-sources: Not defined
* process-test-sources: Not defined
* generate-test-resources: Not defined
* process-test-resources: org.apache.maven.plugins:maven-resources-plugin:2.6:testResources
* test-compile: org.apache.maven.plugins:maven-compiler-plugin:3.1:testCompile
* process-test-classes: Not defined
* test: org.apache.maven.plugins:maven-surefire-plugin:2.12.4:test
* prepare-package: Not defined
* package: org.apache.maven.plugins:maven-jar-plugin:2.4:jar
* pre-integration-test: Not defined
* integration-test: Not defined
* post-integration-test: Not defined
* verify: Not defined
* install: org.apache.maven.plugins:maven-install-plugin:2.4:install
* deploy: org.apache.maven.plugins:maven-deploy-plugin:2.7:deploy

Maven 常用插件

插件是Maven的核心功能，它允许在多个项目中重用通用的构建逻辑。插件可用于：

创建jar文件，
创建war文件，
编译代码，
单元测试代码，
创建项目文档等。

常用的插件有：

maven-antrun-plugin，让用户在 Maven 项目中运行 Ant 任务。用户可以直接在该插件的配置以 Ant 的方式编写 Target，然后交给该插件的 run 目标去执行。在一些由 Ant 往 Maven 迁移的项目中，该插件尤其有用。此外当你发现需要编写一些自定义程度很高的任务，同时又觉得 Maven 不够灵活时，也可以以 Ant 的方式实现之。maven-antrun-plugin 的 run 目标通常与生命周期绑定运行。
maven-assembly-plugin，制作项目分发包，该分发包可能包含了项目的可执行文件、源代码、readme、平台脚本等等。maven-assembly-plugin 支持各种主流的格式如 zip、tar.gz、jar 和 war 等，具体打包哪些文件是高度可控的，例如用户可以按文件级别的粒度、文件集级别的粒度、模块级别的粒度、以及依赖级别的粒度控制打包，此外，包含和排除配置也是支持的。maven-assembly-plugin 要求用户使用一个名为assembly.xml的元数据文件来表述打包，它的 single 目标可以直接在命令行调用，也可以被绑定至生命周期。
maven-help-plugin，一个小巧的辅助工具，最简单的help:system可以打印所有可用的环境变量和 Java 系统属性。help:effective-pom和help:effective-settings最为有用，它们分别打印项目的有效 POM 和有效 settings，有效 POM 是指合并了所有父 POM（包括 Super POM）后的 XML，当你不确定 POM 的某些信息从何而来时，就可以查看有效 POM。
maven-javadoc-plugin，javadoc 插件，将源码的 javadoc 发布出去。

编写一个插件

编写一个插件大体可以分为以下几步：

step1：新建一个 maven-archetype-mojo

step2：添加一个 mojo 类

@Mojo(name = "build-glmapper", defaultPhase = LifecyclePhase.PACKAGE, threadSafe = true, requiresDependencyResolution = ResolutionScope.RUNTIME, requiresDependencyCollection = ResolutionScope.RUNTIME)
public class RepackageMojo extends AbstractMojo {
    public void execute() throws MojoExecutionException, MojoFailureException {
        getLog().info("this is a test case for mojo");
    }
}

step3：pom.xml 处理

pom 里面，首先是 packaging 不是 pom 也不是 jar，而是

1	<packaging>maven-plugin</packaging>

引入一些必要的依赖：

<dependency>
      <groupId>org.apache.maven</groupId>
      <artifactId>maven-archiver</artifactId>
  </dependency>
  <dependency>
    <groupId>org.apache.maven</groupId>
    <artifactId>maven-artifact</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.maven</groupId>
    <artifactId>maven-plugin-api</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.maven</groupId>
    <artifactId>maven-core</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.maven.plugin-tools</groupId>
    <artifactId>maven-plugin-annotations</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.maven.shared</groupId>
    <artifactId>maven-common-artifact-filters</artifactId>
</dependency>

引入打包插件的 plugin

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-plugin-plugin</artifactId>
            <version>3.5</version>
            <configuration>
                <mojoDependencies>
                	<!-- plugin 的名字 -->
                    <dependency>com.bridge.glmapper.boot:glmapper-plugin</dependency>
                </mojoDependencies>
            </configuration>

        </plugin>
    </plugins>
</build>

step4：install 你的插件 & 测试插件允许

引入的工程中通过 maven plugin 菜单也能看到：

这里有个小细节，就是执行插件的阶段，比如我们的插件名字是 glmapper-plugin，但是实际上执行时使用的是 glmapper，也就是当插件名满足：xxx-maven-plugin 或maven-xxx-plugin命名规则时，可以直接使用 xxx，即可。

Archetype

基本每个公司的项目都有一套模板，只要开新项目直接复制一份改改包名和一些配置就初始化了一个新项目。这种方式有点繁琐，有没有通过命令甚至是可视化的方式从一个模板项目初始化项目。Maven其实有提供这种能力，这就是基于原型（Archetype）的生成项目。

集成项目模板插件

首先需要在模板项目中集成Maven原型插件：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-archetype-plugin</artifactId>
    <version>3.2.0</version>
</plugin>

从项目生成模板

从项目生成模板只需要三步。

生成模板原型文件

Maven插件允许我们从已有项目生成一个模板项目。在项目根目录下执行mvn archetype:create-from-project命令即可将该项目生成一个项目模板，生成的项目原型被保存在路径target/generated-sources/archetype下。

但是这个存在一个问题，一些和项目模板源码无关的文件也会被加入模板中，比如IDEA中的.iml文件、.idea目录下的文件。这些“垃圾”文件需要在生成模板时被忽略。

maven-archetype-plugin提供了一个属性配置可以帮助我们实现该能力。在原始项目的根目录（或者你喜欢的其它目录）编写一个.properties文件：

# 原型的坐标 必须声明
archetype.groupId=cn.felord
# 最好按照约定以-archetype结尾
archetype.artifactId=template-archetype
archetype.version=1.0
# 需要忽略的文件夹和文件类型 英文逗号隔开
excludePatterns=**/.idea/**,**/*.iml

这时候执行生成的命令就需要指定该配置文件了：

1	mvn archetype:create-from-project -Darchetype.properties=./archetype.properties

注意：路径为配置文件和根目录的相对路径。

这样生成的原型就忽略掉那些无用的文件了。细心的同学会发现生成原型中的pom.xml的坐标变成了：

<groupId>cn.felord</groupId>
<artifactId>template-archetype</artifactId>
<version>1.0</version>
<packaging>maven-archetype</packaging>
<name>template-archetype</name>

rhb_blog

java-maven学习（四）——生命周期和常用插件