Maven使用教程三:maven的生命周期及插件机制详解
前言
今天这个算是学习Maven的一个收尾文章,里面内容不局限于标题中提到的,后面还加上了公司实际使用的根据profile配置项目环境以及公司现在用的archetype 模板等例子。
后面还会总结一个大的思维导图记录下自己学习的概括。
Maven的生命周期介绍
先来复习几个命令:
- mvn clean package:打包
- mvn clean install:安装到本地
- mven clean deploy:部署到远程仓库
mvn有三套完全独立的生命周期,clean、default和site
每套生命周期都会包含多个phase,每个phase又是由各种插件的goal来完成的。
phase可以理解为任务单元,生命周期是总任务,phase就是总任务分出来的一个个子任务,但是这些子任务是被规格化的,它可以同时被多个生命周期所包含,一个生命周期包含多个phase,phsse的执行时顺序的,一个phase可以绑定多个goal,至少一个。
goal是执行任务最小的单元,它可以绑定到任意的phase中,一个phase有一个或多个goal,goal也是按顺序执行的,一个phase被执行时,绑定到phase里的goal会按绑定的时间被顺序执行。
Maven的生命周期以及phase
clean的生命周期包含的phase如下:
- pre-clean
- clean
- post-clean
default的生命周期包含的phase如下:
- validate:校验这个项目的一些配置信息是否正确
- initialize:初始化构建状态,比如设置一些属性,或者创建一些目录
- generate-sources:自动生成一些源代码,然后包含在项目代码中一起编译
- process-sources:处理源代码,比如做一些占位符的替换
- generate-resources:生成资源文件,才是干的时我说的那些事情,主要是去处理各种xml、properties那种配置文件,去做一些配置文件里面占位符的替换
- process-resources:将资源文件拷贝到目标目录中,方便后面打包
- compile:编译项目的源代码
- process-classes:处理编译后的代码文件,比如对java class进行字节码增强
- generate-test-sources:自动化生成测试代码
- process-test-sources:处理测试代码,比如过滤一些占位符
- generate-test-resources:生成测试用的资源文件
- process-test-resources:拷贝测试用的资源文件到目标目录中
- test-compile:编译测试代码
- process-test-classes:对编译后的测试代码进行处理,比如进行字节码增强
- test:使用单元测试框架运行测试
- prepare-package:在打包之前进行准备工作,比如处理package的版本号
- package:将代码进行打包,比如jar包
- pre-integration-test:在集成测试之前进行准备工作,比如建立好需要的环境
- integration-test:将package部署到一个环境中以运行集成测试
- post-integration-test:在集成测试之后执行一些操作,比如清理测试环境
- verify:对package进行一些检查来确保质量过关
- install:将package安装到本地仓库中,这样开发人员自己在本地就可以使用了
- deploy:将package上传到远程仓库中,这样公司内其他开发人员也可以使用了
site生命周期的phase
- pre-site
- site
- post-site
- site-deploy
默认的phase和plugin
我们直接运行mvn clean package的时候,每个phase都是由插件goal来完成的,phase和plugin绑定的关系是什么了?
实际上,默认maven就绑定了一些plugin goal到phase上,比如:
类似于resources:resources这种格式,说的就是resources这个plugin的resources goal(resources功能,负责处理资源文件)
maven的命令行与生命周期
比如我们执行mvn clean package生命周期是什么样的?
clean是指的clean生命周期中的clean phase
package是指default生命周期中的package phase
此时就会执行clean生命周期中在clean phase之前的所有phase和clean phase(pre-clean、clean)
同事执行default生命周期中在package phase之前的所有phase和package phase
clean默认绑定的是clean:clean, clean plugin的clean goal,所以就会去执行clean插件的clean goal。
具体执行流程如下图:
maven中使用plugin实战
需求:项目中有mybatis 自动生成代码,希望执行某些maven命令可以自动根据指定的表设置 生成对应代码。
添加mybatis.generator的plugin,然后配置generate goal
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<configurationFile>mybatis-generator-config.xml</configurationFile>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql-connector.version}</version>
</dependency>
<dependency>
<groupId>com.wangmeng.game</groupId>
<artifactId>game-wangmeng-common</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
再看看mybatis-generator-config.xml配置的sql信息:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE generatorConfiguration PUBLIC
"-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
<generatorConfiguration>
<context id="context" targetRuntime="MyBatis3">
<plugin type="org.mybatis.plugin.PaginationPlugin">
</plugin>
<commentGenerator>
<property name="suppressAllComments" value="false"/>
<property name="suppressDate" value="true"/>
</commentGenerator>
<!-- 数据库的相关配置 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://ip:3306/db?useUnicode=true" userId="root"
password=""/>
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!-- 实体类生成的位置 -->
<javaModelGenerator targetPackage="com.wangmeng.game.league.entity"
targetProject="game-wangmeng-entity/src/main/java">
<property name="enableSubPackages" value="false"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- *Mapper.xml 文件的位置 -->
<sqlMapGenerator targetPackage="mapper" targetProject="game-wangmeng-dao/src/main/resources">
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<!-- Mapper 接口文件的位置 -->
<javaClientGenerator targetPackage="com.wangmeng.game.league.dao"
targetProject="game-wangmeng-dao/src/main/java"
type="XMLMAPPER">
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
<!-- 相关表的配置 -->
<table tableName="t_table" domainObjectName="TableEntity" enableCountByExample="true"
enableDeleteByExample="true"
enableSelectByExample="true"
enableUpdateByExample="true">
<generatedKey column="id" sqlStatement="MySql" identity="true"/>
</table>
</context>
</generatorConfiguration>
我们可以在idea maven中看到我们配置好的plugin了,然后点击执行即可:
plugin:mybatis-generator
goal:generate
利用profile区分不同环境
<profiles>
<profile>
<!--local env-->
<id>dev</id>
<properties>
<profiles.active>dev</profiles.active>
</properties>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
</profile>
<profile>
<!--test env-->
<id>test</id>
<properties>
<profiles.active>test</profiles.active>
</properties>
</profile>
<profile>
<!--UT env-->
<id>ut</id>
<properties>
<profiles.active>ut</profiles.active>
</properties>
</profile>
</profiles>
这里默认使用的是dev环境,通过<activation>
配置的。
maven版本管理和git之间的关系
一图流:
maven高阶:archetype模板
artchetype其实就是个maven项目模板
拿一个我们公司现在用的东西举例,当我们创建一个全新的项目时,不可能再重新new一个全新的maven项目了,公司其实早就为我们提供了项目生成的脚手架,只需要执行一段maven命令即可生成好一个全新的项目,项目结构在这里都是给定义好了的。
这样的好处一是方便我们创建项目,二是方便公司规范的执行和管理。
这里直接拿公司的一个artchetype的一个模板来演示(关键信息已经马赛克)
1,自己可以选择生成一个maven archetype quickstart或者maven archetype webapp项目
然后用mvn deploy 即可把archetype jar包上传到maven私服
2,使用自定义的maven archetype
公司里面是直接封装了一个bat可执行文件,执行方式为
cmd到CreateProject-latest.bat目录,执行命令CreateProject-latest.bat 项目名 包名,如CreateProject-latest.bat shop-report report 即可使用最新版本的脚手架生成工程 xx-spring-cloud-api-shop-report,包名为com.xx.report。把项目copy到你的喜欢的地址,再导入到eclipse或idea中即可。请手动添加gitignore。请修改父项目版本为最新的release版本。
CreateProject-latest.bat
echo on & color 0A
setlocal enabledelayedexpansion
if "%1"=="" goto BLANK
if "%2"=="" goto BLANK
set ProjectName=%1
set packageName=%2
set archetypeVersion=LATEST
mvn dependency:copy -Dartifact=com.xx:xx-archetype-springcloud-archetype:%archetypeVersion% -Dmdep.stripVerison=true & echo Y | mvn archetype:generate -DarchetypeCatalog=local -DarchetypeGroupId=com.tuhu -DarchetypeArtifactId=xx-archetype-springcloud-archetype -DarchetypeVersion=%archetypeVersion% -DgroupId=com.tuhu -DartifactId=%ProjectName% -Dversion=0.0.1-SNAPSHOT -Dpackage=com.xx.%packageName% & rd/s/q ${project.basedir} & rd/s/q %ProjectName%\.idea & ren %ProjectName% xx-spring-cloud-api-%ProjectName%
感兴趣的小伙伴可关注个人公众号:壹枝花算不算浪漫