前言
之前有写过一篇文章Maven实战,介绍了Maven的一些基本概念,以及对于一个初学者而言的Maven基础知识,当时在我看来掌握了这些基本是够用的。
随着工作的深入,越来越感觉对于Maven的理解不够,很多时候使用Maven出了问题都无法很快地解决,因此打算深入地从搭建Maven工程开始学习一下Maven,这篇文章就将自己的学习历程记录下来和网友朋友们分享。
从搭建最简单的Maven项目开始
LZ使用的是MyEclipse,那么就是用MyEclipse搭建一个简单的Maven项目。第一步,new一个Maven Project:
点击next:
这里不推荐勾选"Create a simple project(skip archetype selection)",这样就可以使用很多Maven Archetype,也就是Maven原型,点击next:
看到这里出现了很多Maven推荐给开发者的原型,"org.apache.maven"开头的都是maven官方推荐的,选择一个简单的"maven-archetype-quickstart",接着就是填入一些基本信息:
这些信息填写比较自由,当然之后也会对Group Id、Artifact Id、Version、Package等再做解释,点击finish,MyEclipse就给我们生成好了一个Maven工程:
这就是"maven-archetype-quickstart"原型生成的标准目录结构,"src/main/java"用于编写Java代码、"src/test/java"用于编写测试类,看一下其中最重要的pom.xml:
4.0.0org.xrq.mvnstart hello-world 0.0.1-SNAPSHOTjarhello-worldhttp://maven.apache.orgUTF-8junit junit 4.10test
看到"maven-archetype-quickstart"原型给我们导入了一个junit的jar包,用于单元测试。注意一下,默认生成JUnit版本是3.8.1的,该版本的JUnit不支持注解,后面的单元测试是用的注解,因此把这里改成4.10的版本。
另外,还有个重点就是,最终打包出来的文件类型是一个jar包(packaging)。
OK,那接下来我们就开始编写Java代码以及测试类的代码。
编写主代码及编译
项目主代码和测试代码不同,项目的主代码会被打包到最终的构件中,而测试代码只在运行测试时用到,不会被打包。
生成的工程下,默认有一个App类,稍作修改:
public class App { public String sayHelloWorld() { return "Say Hello World!"; } public static void main( String[] args ) { System.out.println(new App().sayHelloWorld()); }}
代码写完,接着编译,由于Maven使用命令进行操作,因此进入控制台,进入工程目录,输入"mvn clean compile":
此时工程的变化是,在target下有编译好的App.java对应的App.class:
这条命令的意思是:
1、clean告诉Maven清理输出目录target/
2、compile告诉Maven编译项目主代码
从输出中可以看到Maven首先执行了clean:clean任务,删除target/目录;紧接着执行resources:resources任务(因为未定义项目资源,因此此项略过);最后执行compiler:compile任务,将项目主代码编译至target/classes目录。
要说一点,clean:clean、resources:resources、compiler:compile对应了一些Maven插件及插件目标,比如clean:clean是clean插件的clean目标,compiler:compile是compiler插件的compile目标,这在后面的文章中会说明。
编写测试代码及编译
为了保证项目结构清晰,主代码与测试代码应当分别位于独立的目录中。Maven项目中默认的主代码目录是src/main/java,相应地Maven项目中默认的测试代码目录是src/test/java,因此如果在编写测试用例之前没有该目录,应当首先创建该目录。
测试代码为:
public class AppTest { @Test public void testSayHelloWorld() { App app = new App(); String result = app.sayHelloWorld(); Assert.assertEquals(result, "Say Hello World!"); }}
用了JUnit,上面的pom.xml中依赖项,JUnit的scope是test,这表示JUnit的包只对测试目录是有效的,换句话说,在主目录下使用JUnit将会导致编译报错。
这里还有一个问题要特别说明,由于历史原因,Maven的核心插件之一compiler插件默认只支持编译Java1.3,这个版本并不支持JUnit,因此需要配置该插件使其支持Java5才可以使用JUnit。因此在pom.xml中加入一段:
org.apache.maven.plugins maven-compiler-plugin 1.51.5
这样就使得插件支持Java5编译。此时命令行中输入mvn clean test:
测试通过,没有问题。
打包
在项目编译、测试通过之后,就会进行一项操作,就是打包(package)。
同样,使用命令行操作,输入"mvn clean package",打包前会先编译、测试,这些信息就不截取了,只看打包的部分:
打包的名字是按照artifactId+version来的,如有需要也可以自定义,这个这里也不讲了。
打包完毕,再看一下工程目录:
多出了一个jar文件,这样就可以在别的地方使用这个jar文件了。
安装
上面生成的jar文件,可以直接复制到别的项目的CLASSPATH下供其他项目使用,那么如何让其他项目直接使用这个jar包呢?可以使用install。
在命令行中输入"mvn clean install",同样我只截取关键的部分:
看到生成的jar和pom被安装到本地仓库中了,只有当构建被下载到本地仓库之后,才能供其他Maven项目使用。这里也是同样道理,只有将Hello World的构件安装到本地仓库之后,其他Maven项目才能使用它。
Maven生命周期
上面的内容,包含了Mavan最主要的命令:mvn clean compile、mvn clean test、mvn clean package、mvn clean install。执行test之前,先执行compile、执行package之前先执行test、执行install之前先执行package,这就涉及到一个概念:Maven生命周期。
在Maven中有三套独立的生命周期:
- Clean Lifecycle:在进行真正的构建之前进行一些清理工作
- Default Lifecycle:构建的核心部分,编译、测试、打包、部署
- Site Lifecycle:生成项目报告、生成站点、发布站点
第一个和第三个比较简单也比较好理解,看一下Maven的最重要的Default生命周期,绝大部分工作都发生在这个生命周期中,在这个阶段中,比较重要和常用的阶段有:
- validate
- generate-sources
- process-sources
- generate-resources
- process-resources:复制并处理资源文件至目标目录,准备打包
- compile:编译项目源代码
- process-clases
- generate-test-sources
- procss-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:将最终的包复制到远程仓库,以便让其它开发人员与项目共享
基本上,只要根据名称我们就可以猜测出每个阶段的用途。要记住的是,任何一个阶段的时候,它前面的所有阶段都会被运行,这也就是为什么我们运行mvn clean install的时候,代码会被编译、测试、打包。
此外,Maven的插件机制是完全依赖Maven生命周期的,因此理解生命周期至关重要。