Maven使用入门

电玩女神 2022-08-06 05:17 102阅读 0赞

## 前言 ##

Jason Van Zyl，在 Java 十大风云人物排行榜上或许会看到他。  
这兄弟是干嘛的？  
他就是 Maven 的创始人，人们都尊称他为“Maven 他爸”。  
毋庸置疑，Jason 也是一个秃顶。James Gosling、Rod Johnson、Gavin King，你们可以告诉我为什么吗？  
您曾经是否会遇到这些问题：  
我们要开发一个 Java 项目，为了保证编译通过，我们会到处去寻找 jar 包。当编译通过了，在运行的时候，却发现 ClassNotFoundException，卧槽！还差 jar 包啊？再去找找吧。  
每个 Java 项目的目录结构都没有一个统一的标准，配置文件到处都是，单元测试代码到底应该放在哪里，没有一个权威的规范。  
可使用 Ant 做为项目构建工具，它可以自动化地完成编译、测试、打包等任务，确实为我们省了不少事儿，但编写 Ant 的 XML 脚本绝非是一件轻松的事情。  
有了 Maven，以上这一切都不再是问题了。  
Jason 就是 Java 开发规范的“救世主”！他给我们带来了一种全新的项目构建方式，让我们的开发工作更加高效。  
不仅如此，Jason 还是一名“野心家”，他不仅希望每个 Java 开发者都能使用他定义的规范，还要我们都从他家里去获取 jar 包（他家就是 Maven 中央仓库），我们只需告诉他，我们想要的 jar 包具体在什么位置即可（这个位置就是 Maven 坐标）。  
看来 Jason 要做的是两件事情：  
统一开发规范与工具  
统一管理 jar 包  
这两件事情他都做到了，而且还做了更多的事情。  
工欲善其事，必先利其器。咱们也来玩玩 Maven 这货吧！先得去下载一个。

## **1、编写POM** ##

POM(project object model ,项目对象模型)定义了项目的基本信息，用于描述项目如何构建，声明项目依赖等等。  
下面先为Hello World项目编写一个最简单的pom.xml。  
首先创建一个名为maven\_0的文件夹，在文件夹里面再创建一个pom.xml文件和src文件

#### Hello World的POM ####

<?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" 
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
 http://maven.apache.org/maven-v4_0_0.xsd"> 
 <modelVersion>4.0.0</modelVersion>
 <groupId>com.zhsi.maven</groupId>
 <artifactId>hello-world</artifactId>
 <version>1.0-SNAPSHOT</version>
 <name>Maven Hello World Project</name>
 </project>

project是所有pom.xml的根元素,它还声明了一些POM相关的命名空间及xsd元素,虽然这些属性不是必须的，但使用这些属性能够让第三方工具（如IDE中的XML编辑器）帮助  
我们快速编辑POM.

**<modelVersion>**：指定了当前POM模型的版本，对于Maven2及Maven3来说，它只能是4.0.0. 
groupId、artifactId、version这三个元素定义了一个项目的基本坐标。在Maven的世界，任何的jar、pom或者war都是以基于这些基本的坐标进行区分的 
**<groupId>**：定义了项目属于哪个组,这个组往往和所在的组织或公司存在关联。如果你的公司是mycom，有一个项目为myapp，那么groupId就应该是com.mycom.myapp 
**<artifactId>**：定义了当前Maven项目在组中唯一的ID 
**<version>**:指定了当前项目的版本为1.0-SNAPSHOT，SNAPSHOT意为快照，说明该项目还处于开发中，是不稳定的版本，随着项目的发展，version会不断更新，如升级为1.0、1.1-SNAPSHOT、1.1、2.0等等 
**<name>**：声明了一个对于用户更为友好的项目名称，虽然这不是必须的，但我还是推荐为每个POM声明name，以方便信息交流。

没有任何实际的Java代码，我们就能够定义一个Maven项目的POM，这体现了Maven的一大优点，它能让项目对象模型最大程度地与实际代码相独立，我们可以称之为解耦，  
或者正交性，这在很大程度上避免了Java代码和POM代码的相互影响。比如当项目需要升级版本时，只需要修改POM，而不需要更改Java代码；而在POM稳定之后，日常的Java代码开发工作基本不涉及POM的修改。

## 2、编写主代码 ##

项目的主代码和测试代码不同，项目的主代码会被打包到最终的构件中（如jar）,而测试代码只是在运行测试时用到，不会被打包。  
默认情况下，Maven假设项目主代码位于src/main/java目录，创建该目录，然后在该目录下创建文件com/zhsi/maven/HelloWorld.java,代码如下：

package com.zhsi.maven;
 public class HelloWorld 
 { 
 public String sayHello() 
 { 
 return "Hello Maven"; 
 } 
 public static void main(String[] args) 
 { 
 System.out.print( (new HelloWorld()).sayHello() ); 
 } 
 }

该Java类的包名是com.zhsi.maven,这与我们之前在POM中定义的groupId和artifactId相吻合，一般来说,项目中的Java类的包都应该基于项目的groupId和artifactId,这样更加清晰，更加符合逻辑，也方便搜索构件或者Java类
 代码编写完之后在项目根目录下运行命令 mvn clean compile, 得到如下输出：

[INFO]
    [INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ hello-world ---
    
    [INFO] Changes detected - recompiling the module!
    [WARNING] File encoding has not been set, using platform encoding GBK, i.e. buil
    d is platform dependent!
    [INFO] Compiling 1 source file to E:\Program\maven\maven_0\target\classes
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 0.657 s
    [INFO] Finished at: 2014-12-24T15:31:16+08:00
    [INFO] Final Memory: 9M/22M

clean告诉Maven清理输出目录target/，compile告诉Maven编译项目主代码,默认情况下Maven构建的所有输出都在target/目录中；  
接着执行resources:resources任务（未定义项目资源，暂且略过）；最后执行compiler:compile任务，将项目主代码编译至target/classes目录(编译好的类为com/zhsi/maven/HelloWorld.Class）。

这样，Maven在没有任何额外的配置的情况下就执行了项目的清理和编译任务，下面，编写一些单元测试代码并让Maven执行自动化测试。

## 3、编写测试代码 ##

为了使项目结构保持清晰，主代码与测试代码应该分别位于独立的目录中，上面讲过Maven项目中默认的主代码目录是src/main/java，对应地，Maven项目中默认的测试代码目录是src/test/java  
要使用Junit，我们首先需要为Hello World项目添加一个Junit依赖,在项目的POM.xml中添加下面的dependency

<dependencies> 
 <dependency> 
 <groupId>junit</groupId> 
 <artifactId>junit</artifactId> 
 <version>4.8</version> 
 <scope>test</scope> 
 </dependency> 
 </dependencies>

码中添加了dependencies元素，该元素下可以包含多个dependency元素以声明项目的依赖，这里我们添加了一个依赖——groupId是junit，artifactId是junit，version4.8。  
有了这段声明，Maven就能够自动下载junit-4.8.jar，Maven从哪里下载这个jar呢？在Maven之前，我们可以去JUnit的官网下载分发包。而现在有了Maven，它会自动访问中央仓库（http://repo1.maven.org/maven2/）  
配置侧是在依赖之后，接着就可以编写测试类，在src/test/java下面创建文件夹，代码内容如下：

package com.zhsi.maven;
 import static org.junit.Assert.assertEquals;
 import org.junit.Test;
 public class HelloWorldTest 
 { 
 @Test 
 public void testSayHello() 
 { 
 HelloWorld helloWorld = new HelloWorld(); 
 String result = helloWorld.sayHello(); 
 assertEquals( "Hello Maven", result ); 
 } 
 }

一个典型的单元测试包含三个步骤：一，准备测试类及数据；二，执行要测试的行为；三，检查结果。  
上述样例中，我们首先初始化了一个要测试的HelloWorld实例，接着执行该实例的sayHello()方法并保存结果到result变量中，最后使用JUnit框架的Assert类检查结果是否为我们期望的”Hello Maven”。  
在JUnit 3中，约定所有需要执行测试的方法都以test开头，这里我们使用了JUnit 4，但我们仍然遵循这一约定，在JUnit 4中，需要执行的测试方法都应该以@Test进行标注  
测试用例编写完毕之后就可以调用Maven执行测试，运行 **mvn clean test:**

-------------------------------------------------------
 T E S T S
 -------------------------------------------------------
 Running com.zhsi.maven.HelloWorldTest
 Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.025 sec
 
 Results :
 
 Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
 
 [INFO] ------------------------------------------------------------------------
 [INFO] BUILD SUCCESS
 [INFO] ------------------------------------------------------------------------
 [INFO] Total time: 1.215 s
 [INFO] Finished at: 2014-12-24T15:48:40+08:00
 [INFO] Final Memory: 11M/26M
 [INFO] ------------------------------------------------------------------------

运行完之后会生成target目录

arget目录下的surefire-reporte中会生成测试报告  
我们看到compiler:testCompile任务执行成功了，测试代码通过编译之后在target/test-classes下生成了二进制文件  
紧接着surefire:test任务运行测试，surefire是Maven世界中负责执行测试的插件，这里它运行测试用例HelloWorldTest，并且输出测试报告。

显示一共运行了多少测试，失败了多少，出错了多少，跳过了多少。显然，我们的测试通过了——BUILD SUCCESSFUL。

## 4、打包和运行 ##

将项目进行编译、测试之后，下一个重要步骤就是打包（package）。Hello World的POM中没有指定打包类型，使用默认打包类型jar，我们可以简单地执行命令 mvn clean package 进行打包，可以看到如下输出：

[INFO]
 [INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ hello-world ---
 [INFO] Building jar: E:\Program\maven\maven_0\target\hello-world-1.0-SNAPSHOT.jar
 [INFO]
 [INFO] --- maven-shade-plugin:1.2.1:shade (default) @ hello-world ---
 [INFO] Replacing original artifact with shaded artifact.
 [INFO] Replacing E:\Program\maven\maven_0\target\hello-world-1.0-SNAPSHOT.jar wi
 th E:\Program\maven\maven_0\target\hello-world-1.0-SNAPSHOT-shaded.jar
 [INFO] ------------------------------------------------------------------------
 [INFO] BUILD SUCCESS
 [INFO] ------------------------------------------------------------------------
 [INFO] Total time: 1.763 s
 [INFO] Finished at: 2014-12-24T15:52:12+08:00
 [INFO] Final Memory: 11M/28M
 [INFO] ------------------------------------------------------------------------

上面体验了Maven最主要的命令， **mvn clean compile**、 **mvn clean test**、 **mvn clean package**、 **mvn clean install**。  
执行test之前会先执行compile,执行package之前先执行test,install之前先执行package。

么样运行Hello World项目，HelloWorld类中有一个main方法，默认打包生成的jar是不能够直接运行的，因为带有main方法的类信息不会添加到  
manifest中,为了生成可执行的jar文件，需要借助于**maven-shade-plugin**，配置该插件如下：

<build>
 <plugins>
 <plugin> 
 <groupId>org.apache.maven.plugins</groupId> 
 <artifactId>maven-shade-plugin</artifactId> 
 <version>1.2.1</version> 
 <executions> 
 <execution> 
 <phase>package</phase> 
 <goals> 
 <goal>shade</goal> 
 </goals> 
 <configuration> 
 <transformers> 
 <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"> <mainClass>com.zhsi.maven.HelloWorld</mainClass> 
 </transformer> 
 </transformers> 
 </configuration> 
 </execution> 
 </executions> 
 </plugin> 
 </plugins>
 </build>

配置了mainClass为com.zhsi.maven.HelloWorld，现在执行mvn clean install ，构建完之后打开target目录.  
可以看到hello-world-1.0-SNAPSHOT.jar和original-hello-world-1.0-SNAPSHOT.jar，前者是带有Main-Class信息的可运行jar，后者是原始的jar  
现在在项目的根目录下执行该jar文件  
**E:\\Program\\maven\\maven\_0\\target>java -jar hello-world-1.0-SNAPSHOT.jar**  
看到输出结果  
**Hello Maven**  
  
上面介绍了POM,Maven项目结构，以及如何编译、测试、打包等。

## 4、在另一个项目中使用上面生成的jar包 ##

只需要在POM.xml文件中增加下面的依赖:

dependency>
 <groupId>com.zhsi.maven</groupId>
 <artifactId>hello-world</artifactId>
 <version>1.0-SNAPSHOT</version> 
 </dependency>

上面即为HelloWorld的坐标

## 5、使用Archetype生成项目骨架 ##

Hello World项目中有一些Maven的约定：在项目的根目录中放置pom.xml，在src/main/java中放置项目的主代码,在src/test/java中放置项目的测试代码.这样一步一步的展示时为了让maven初学者得到最实际的感受，我们称这些最基本的目录结构和pom.xml文件内容为项目的骨架。Maven提供了Archetype以帮助我们快速勾画出项目骨架。

还是以Hello World为例，我们使用maven archetype来创建该项目的骨架，离开当前的Maven项目目录  
如果是**Maven 3**:，简单的运行：  
**mvn archetype:generate**  
如果是**Maven 2**，最好运行如下命令：  
**mvn org.apache.maven.plugins:maven-archetype-plugin:2.0-alpha-5:generate**

很多资料会让你直接使用更为简单的 mvn archetype:generate 命令，但在Maven2中这是不安全的，因为该命令没有指定archetype插件的版本，于是Maven会自动去下载最新的版本，  
于是Maven会自动去下载最新的版本，进而可能得到不稳定的SNAPSHOT版本，导致运行失败。然而在Maven 3中，即使用户没有指定版本，Maven也只会解析最新的稳定版本，因此这是安全的  
我们实际上是在运行插件maven-archetype-plugin，注意冒号的分隔，其格式为 groupId:artifactId:version:goal ，  
org.apache.maven.plugins 是maven官方插件的groupId，maven-archetype-plugin 是archetype插件的artifactId，2.0-alpha-5 是目前该插件最新的稳定版，generate是我们要使用的插件目标。

Define value for groupId: : com.zhsi.maven 
 Define value for artifactId: : hello-world 
 Define value for version: 1.0-SNAPSHOT: : 
 Define value for package: com.zhsi.maven: : 
 Confirm properties configuration: 
 groupId: com.zhsi.maven 
 artifactId: hello-world 
 version: 1.0-SNAPSHOT 
 package: com.zhsi.maven 
 Y: : Y

Archetype插件将根据我们提供的信息创建项目骨架。在当前目录下，Archetype插件会创建一个名为hello-world（我们定义的artifactId）的子目录，从中可以看到项目的基本结构:  
 基本的pom.xml已经被创建，里面包含了必要的信息以及一个junit依赖；主代码目录src/main/java已经被创建，在该目录下还有一个Java类com.zhsi.maven.App，注意这里使用到了我们刚才定义的包名，而这个类也仅仅只有一个简单的输出Hello World!的main方法；测试代码目录src/test/java也被创建好了，并且包含了一个测试com.zhsi.maven.AppTest。Archetype可以帮助我们迅速地构建起项目的骨架，在前面的例子中，我们完全可以在Archetype生成的骨架的基础上开发Hello World项目以节省我们大量时间。

## ** 6、IDE的简单使用** ##

前面的都没有涉及IDE,一个简单的项目，使用最简单的编辑器也能很快完成，但对于一个稍微大一点的项目来说，没有IDE是不行的。

###  6.1、导入Maven项目 ###

击 File--Import--Maven---Existing Maven Projects---Next，选择要导入的Maven项目点击Finish就可以了，导入完成之后就可以在视图中看到  
 下面的结构：

![Center][]

这个目录中可以看到项目的依赖junit-4.8.jar，其实际位置志向了Maven本地仓库。

## **7、创建Maven项目** ##

点击File--New--Other,在弹出的对话框中选择Maven下的Maven下 Maven Project,  
在弹出的New Maven Project对话框中，我们使用默认的选项（不要选择Create a simple project选项，那样我们就能使用Maven Archetype），点击Next >，此时m2eclipse会提示我们选择一个Archetype，我们选择maven-archetype-quickstart，再点击Next >  
由于m2eclipse实际上是在使用maven-archetype-plugin插件创建项目，因此这个步骤与上一节我们使用archetype创建项目骨架类似，输入groupId,、artifactId、version、package（暂时我们不考虑Properties）,如下：

![Center 1][]  
![Center 2][]

点击Finish，Maven项目创建就完成了。

## **8、运行Maven命令** ##

在Maven项目或者pom.xml上点击，再选择Run As 就能看到常见的Maven命令。  
默认选项中如果没有我们想要执行的Maven命令怎么办?比如，默认带有mvn test,但是想要执行mvn clean test,很简单，选择Maven build，以自定义Maven 运行命令，在弹出对话框中的Goals一项中输入我们想要执行的命令，如clean test，设置一下Name，点击Run即可。并且，下一次我们选择Maven build，或者使用快捷键Alt + Shift + X, 快速执行Maven构建的时候，上次的配置直接就能在历史记录中找到。图3-5就是自定义Maven运行命令的界面：

![Center 3][]

至此，我完成了个简单的基于Maven的项目，了解了Mavend基本用法，后面将再进一步学习。

[Center]: /images/20220806/68ab8e0496984488abec47f6289b1015.png
[Center 1]: /images/20220806/2c968f23b6a64412b9d901b83530a5ce.png
[Center 2]: /images/20220806/62f402514f194f048848ce441c02b7b1.png
[Center 3]: /images/20220806/637d8a0ae85d4b069840d5075b64e84b.png