Maven 命令行打包和 pom.xml的常用配置

Myth丶恋晨 2022-03-21 12:24 498阅读 0赞

# maven 命令行打包 #

## mvn -v, --show-version ##

现在最新的maven版本是 3.6，我这里用的还是 2017 年下载的 3.1.1 版本（虽然有点过时，但是大版本不变，指令基本一样）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeTU1NWNoeQ_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][2019020115455940.png]

## mvn -h, --help ##

使用 help 命令可以看到 maven 命令的帮助文档，下面主要介绍两个常用的指令 —— D 和 P。  
![在这里插入图片描述][20190201150859161.png]

## mvn -D, --define <arg> ##

`mvn -DpropertyName=propertyValue clean package` 可以用来临时定义属性和值。如果 pom.xml 中已经有该属性，那么会替换掉 pom.xml 中的值。

如果需要定义多个变量，可以用空格分隔  
`mvn -DpropA=valueA -DpropB=valueB -DpropC=valueC clean package`

当然这个属性也可以直接在 pom.xml 文件下配置

<project>
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<android.sdk.path>C:\software\android\sdk</android.sdk.path>
    		<maven.test.skip>true</maven.test.skip>
    		<maven.javadoc.skip>true</maven.javadoc.skip>
    	</properties>
    </project>

## mvn -P, --activate-profiles <arg> ##

P 表示 Profiles 配置文件，需要在 <profile> 标签中指定 <id> 才能用 -P 使之生效。

假如 pom.xml 如下：

那么打包时执行 `mvn clean package -P prod` 将只激活 prod 环境的 profile 配置（也就是说此时 test 和 dev 的配置不会生效）

## mvn package 与 mvn install 的区别 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">命令</th> 
   <th align="left">含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">mvn clean</td> 
   <td align="left">删除 target 目录</td> 
  </tr> 
  <tr> 
   <td align="left">mvn package</td> 
   <td align="left">把 jar 打到本项目的 target 目录下</td> 
  </tr> 
  <tr> 
   <td align="left">mvn install</td> 
   <td align="left">把 jar 打到本项目的 target 目录下，之后再将它安装到本地的 maven 仓库中</td> 
  </tr> 
 </tbody> 
</table>

## mvn 打包插件的执行顺序 ##

我这里用的是 maven 3.1.1 打包 android 项目

--- maven-clean-plugin:2.5:clean (default-clean)
    --- maven-install-plugin:2.4:install (default-install)
    >>> maven-javadoc-plugin:2.6.1:javadoc (default-cli)
    <<< maven-javadoc-plugin:2.6.1:javadoc (default-cli)
    ---  maven-javadoc-plugin:2.6.1:javadoc (default-cli)
    --------------------------------------------------------------
    --- maven-clean-plugin:2.5:clean (default-clean)
    --- maven-resources-plugin:2.6:copy-resources (copy-src)
    --- android-maven-plugin:3.8.0:generate-sources (default-generate-sources)
    --- maven-resources-plugin:2.6:copy-resources (default-resources)
    --- maven-compiler-plugin:2.3.1:compile (default-compile)
    --- android-maven-plugin:3.8.0:proguard (default-proguard)
    --- maven-resources-plugin:2.6:testResources (default-testResources)
    --- maven-compiler-plugin:2.3.1:testCompile (default-testCompile)
    --- maven-surefire-plugin:2.14:test (default-test)
    --- maven-jar-plugin:2.6:jar (default-jar)
    --- android-maven-plugin:3.8.0:apklib (default-apklib)
    --- maven-install-plugin:2.3.1:install-file (custom-install)
    --- maven-antrun-plugin:1.3:run (to-lib-directory)
    >>> maven-javadoc-plugin:2.9:javadoc (default-cli)
    --- maven-resources-plugin:2.6:copy-resources (copy-src)
    --- android-maven-plugin:3.8.0:generate-sources (default-generate-sources)
    <<< maven-javadoc-plugin:2.9:javadoc (default-cli)
    ---  maven-javadoc-plugin:2.9:javadoc (default-cli)

### 插件说明 ###

<table> 
 <thead> 
  <tr> 
   <th align="left">插件</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">maven-clean-plugin</td> 
   <td align="left">删除已有target目录</td> 
  </tr> 
  <tr> 
   <td align="left">maven-resources-plugin</td> 
   <td align="left">复制和替换文件</td> 
  </tr> 
  <tr> 
   <td align="left">maven-compiler-plugin</td> 
   <td align="left">编译所有源文件生成class文件至target\classes目录下</td> 
  </tr> 
  <tr> 
   <td align="left">maven-surefire-plugin</td> 
   <td align="left">运行测试用例</td> 
  </tr> 
  <tr> 
   <td align="left">maven-jar-plugin</td> 
   <td align="left">对编译后生成的文件进行打包<br>包名称默认为：artifactId-version-SNAPSHOT.jar，保存在 target 目录下</td> 
  </tr> 
  <tr> 
   <td align="left">maven-javadoc-plugin</td> 
   <td align="left">生成文档</td> 
  </tr> 
  <tr> 
   <td align="left">android-maven-plugin</td> 
   <td align="left">生成、混淆 Android 的类文件（apklib是和aar差不多，都是将类和资源打在一起）</td> 
  </tr> 
 </tbody> 
</table>

## 实战 ##

### 案例一 ###

使用 mvn 打包，并跳过测试，然后生成文档，使用 dev 配置

@echo off
    mvn clean package -Dmaven.test.skip=true javadoc:javadoc -Pdev

### 案例二 ###

将模块A生成的 jar，复制到模块B的 libs 目录下。  
安装模块到 maven 仓库。

@echo off
    copy /y "moduleA/target/target.jar" "moduleB/libs/baseA.jar"
    call mvn install:install-file -Dfile=baseA.jar -DgroupId=com.example -DartifactId=baseA -Dversion=1.0.1 -Dpackaging=jar

默认情况下，cmd 的命令发起调用后就立即返回了。而 CALL 是一个调用外部批处理程序的指令，类似于函数调用的执行逻辑，它会一直等到函数执行结束才返回。

# pom.xml的常用配置 #

## denpendencyManagement 与 pluginManagement ##

denpendencyManagement是用于管理项目jar包依赖，pluginManagement是用于管理plugin。  
它们的作用是列出依赖的jar包或者plugin包，让子pom来决定是否引用。

## 对不同的配置赋予不同的属性 ##

<profiles>
    	<profile>
    		<id>dev</id>
    		<properties>
    			<mysql.url>http://localhost:3306</mysql.url>
    		</properties>
    		<activation>
    			<activeByDefault>true</activeByDefault>
    		</activation>
    	</profile>
    	<profile>
    		<id>prod</id>
    		<properties>
    			<mysql.url>http://192.168.1.10:3306</mysql.url>
    		</properties>
    	</profile>
    </profiles>

activation 元素用来指定激活条件。当没有指定条件，然后指定 activeByDefault 为 true 的时候，就表示没有指明 profile 的情况下默认激活。也就是说 `mvn package` 将使用 dev 的配置，而 `mvn package -P prod` 的时候使用的才是 prod 的配置。

## 根据不同配置使用不同的源文件 ##

<profiles>
    	<profile>
    		<id>dev</id>
    		<properties>  
             <debug.enable>true</debug.enable>  
            </properties> 
    		<plugin>
    			<artifactId>maven-resources-plugin</artifactId>
    			<version>2.6</version>
    			<executions>
    				<execution>
    					<id>copy-id</id>
    					<goals>
    						<goal>copy-goal</goal>
    					</goals>
    					<phase>validate</phase>
    					<configuration>
    						<outputDirectory>${basedir}/src/com/companyName/global/</outputDirectory>
    						<resources>
    							<directory>${basedir}/profiles/dev/</directory>
    							<filtering>true</filtering>
    							<includes>
    								<include>**/*.java</include>
    							</includes>
    						</resources>
    					</configuration>
    				</execution>
    			</executions>
    		</plugin>
    	</profile>
    </profiles>

然后在 profiles/dev 目录下新建 java 文件

（略）
    	private boolean isDebugEnable = ${debug.enable}
    	（略）

执行打包命令 `mvn clean package -DskipTests -Pdev`，就可以看到 /profiles/dev 目录下的 java 文件全部被复制到了 /src/com/companyName/global 目录下了，并且 isDebugEnable 的值也被替换了。

配置项说明：

*  parse 用来指明具体在 maven 的哪个生命周期执行该任务

**maven 的生命周期表**

<table> 
 <thead> 
  <tr> 
   <th align="left">生命周期阶段</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">validate</td> 
   <td align="left">验证项目是否正确，并且所有必要的信息可用于完成构建过程</td> 
  </tr> 
  <tr> 
   <td align="left">initialize</td> 
   <td align="left">建立初始化状态，例如设置属性</td> 
  </tr> 
  <tr> 
   <td align="left">generate-sources</td> 
   <td align="left">产生任何的源代码包含在编译阶段</td> 
  </tr> 
  <tr> 
   <td align="left">process-sources</td> 
   <td align="left">处理源代码，例如，过滤器值</td> 
  </tr> 
  <tr> 
   <td align="left">generate-resources</td> 
   <td align="left">包含在包中产生的资源</td> 
  </tr> 
  <tr> 
   <td align="left">process-resources</td> 
   <td align="left">复制和处理资源到目标目录，准备打包阶段</td> 
  </tr> 
  <tr> 
   <td align="left">compile</td> 
   <td align="left">编译该项目的源代码</td> 
  </tr> 
  <tr> 
   <td align="left">process-classes</td> 
   <td align="left">从编译生成的文件提交处理，例如：Java类的字节码增强/优化</td> 
  </tr> 
  <tr> 
   <td align="left">generate-test-sources</td> 
   <td align="left">生成任何测试的源代码包含在编译阶段</td> 
  </tr> 
  <tr> 
   <td align="left">process-test-sources</td> 
   <td align="left">处理测试源代码，例如，过滤器任何值</td> 
  </tr> 
  <tr> 
   <td align="left">test-compile</td> 
   <td align="left">编译测试源代码到测试目标目录</td> 
  </tr> 
  <tr> 
   <td align="left">process-test-classes</td> 
   <td align="left">处理测试代码文件编译生成的文件</td> 
  </tr> 
  <tr> 
   <td align="left">test</td> 
   <td align="left">运行测试使用合适的单元测试框架（JUnit）</td> 
  </tr> 
  <tr> 
   <td align="left">prepare-package</td> 
   <td align="left">执行必要的任何操作的实际打包之前准备一个包</td> 
  </tr> 
  <tr> 
   <td align="left">package</td> 
   <td align="left">提取编译后的代码，并在其分发格式打包，如JAR，WAR或EAR文件</td> 
  </tr> 
  <tr> 
   <td align="left">pre-integration-test</td> 
   <td align="left">完成执行集成测试之前所需操作。例如，设置所需的环境</td> 
  </tr> 
  <tr> 
   <td align="left">integration-test</td> 
   <td align="left">处理并在必要时部署软件包到集成测试可以运行的环境</td> 
  </tr> 
  <tr> 
   <td align="left">pre-integration-test</td> 
   <td align="left">完成集成测试已全部执行后所需操作。例如，清理环境</td> 
  </tr> 
  <tr> 
   <td align="left">verify</td> 
   <td align="left">运行任何检查，验证包是有效的，符合质量审核规定</td> 
  </tr> 
  <tr> 
   <td align="left">install</td> 
   <td align="left">将包安装到本地存储库，它可以用作当地其他项目的依赖</td> 
  </tr> 
  <tr> 
   <td align="left">deploy</td> 
   <td align="left">复制最终的包到远程仓库与其他开发者和项目共享</td> 
  </tr> 
 </tbody> 
</table>

*  inherited 用来指明 execution 是否传递到子 pom.xml 里
 *  filtering属性用来表示资源文件中的 “EL表达式占位符” 是否需要被替换，true为需要替换

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeTU1NWNoeQ_size_16_color_FFFFFF_t_70]: /images/20220321/9d76c71a873d444cb04d9c76a7a55a2d.png
[2019020115455940.png]: /images/20220321/2445e9c9357d49078d3509033d62fb78.png
[20190201150859161.png]: /images/20220321/8b5e80ca24da477488ca1f0de82eea15.png