Maven学习笔记：Maven基本操作

---

Maven学习笔记

一、POM文件

Maven的核心是POM文件，里面定义了项目的基本信息，项目有哪些插件，导入了什么依赖等。
对于一个刚新建的Maven 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/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.example</groupId>
  <artifactId>hello-world</artifactId>
  <version>1.0-SNAPSHOT</version>
  <name>Maven Hello World Project</name>
</project>

目前来说这是最简单的pom.xml。下面就先简单介绍各标签的意义。
第一行是XML头，里面定义了当前xml文档的版本号和编码方式。
第二行是project元素，这是所有pom.xml元素的根元素，其他的元素比如定义依赖的dependencies，定义插件的plugins也都是project的子元素。

上面的例子中，project的子元素中最重要的就是groupId、artifactId和version。这三个元素确定了一个项目的基本坐标，所有maven项目都可以通过这三个坐标定位。

• groupId定义了这个项目属于哪一个组，这个往往和公司有关。比如google上有一个myapp的项目，那么groupId往往就是com.google.myapp。
• 一个组中有多个项目，artifactId定义了在一个组中唯一的一个项目。比如上面例子中的myapp的网页项目，artifactId=myapp-web。
• version则是指明了一个项目的版本。这个的取值有一些惯例。如果在版本号后面加上SNAPSHOT（快照），这是表明该版本还在开发中，是不稳定的版本。比如1.1-SNAPSHOT。

最后的name元素不是必须要有的，这个name相当于为项目取了一个别名，从名字上方便用户阅读。

二、maven的简单实用

1、清理编译Java项目

先建立一个基础的hello-world的maven项目。
按照maven项目的结构习惯，我们在helloworld文件夹下建立如下结构的文件。

其中，最底层的HelloWorld.java文件的内容是最简单的输出hello world。

package com.mvnbook.helloworld;
public class HelloWorld {
    public String sayHelloWorld() {
        return "Hello world";
    }
    public static void main(String[] args) {
        System.out.println(new HelloWorld().sayHelloWorld());
    }
}

Maven项目的默认结构就是如此，pom.xml放在根目录之下，与其同级的是src文件夹。
真正的Java项目代码是放在src/main/java之下。com/mvnbook/helloworld就是前面pom.xml中提到的groupId，这样的一致性便于快速了解项目结构。

下面开始使用maven来编译Java项目。

1. 先cd到该项目的根目录。
2. 输入指令mvn clean compile。就可得到下面的执行结果。

同时，项目的根目录会多出一个输出目录target

注意target/classes/HelloWorld.class。这就是Java的.class文件，说明该项目编译成功。

另外，mvn clean compile其实是执行了两个指令：mvn clean和mvn compile。前者是检查项目有没有已存在的target文件，如果有的话，就将这个文件删掉；后者则是执行编译指令。

到目前为止，maven就自动帮我们完成了清理项目和编译项目。

2、编写测试代码（导入依赖）

测试代码应该和主代码分开，按照maven项目的惯例，所有的测试代码应该放在test/java文件夹下。test文件夹在src目录下，与mian目录同级（如下所示）

在Java世界中，Kent Beck和Erich Gamma建立的Junit是事实上的单元测试标准。要使用Junit，就先要给项目导入该依赖。

导入依赖的方法如下

1. google搜索maven junit，进入第一个搜索页，然后选择一个版本后，复制其中的maven依赖包。
2. 然后将该依赖包代码放入pom.xml中project之下的dependencies元素之下
   

现在Junit依赖就导入到项目中，maven会自动帮我们下载junit-4.13.jar。这里记住，所有的依赖声明都是在dependencies元素之中。并且看依赖中也是有groupId，artifactId和version。前面提过这三个是Maven项目的基本坐标，Junit也不例外。
上面的依赖中海油一个元素为scope，其值为test。这个scope表明该依赖只对测试有效。如果不声明该scope，则依赖的作用范围是compile，是整个项目。主代码用到Junit会产生错误。

现在开始写一个简单的测试。
在test/java下简历一个.java文件，内容如下

package com.mvnbook.helloworld;
import static org.junit.Assert.assertEquals;
import org.junit.Test;
public class HelloWorldTest {
    @Test
    public void testSayHelloWorld() {
        HelloWorld helloWorld = new HelloWorld();
        System.out.println(helloWorld.sayHelloWorld());
    }
}

在JUnit中，所有执行测试方法默认test开头，并且测试方法要用@Test标注。

开始测试，输入mvn clean test指令即可。运行结果如下。

从上面看出，测试运行成功，成功输出Hello world，并且有统计测试的运行情况。

3、打包、安装和部署

项目经过编译、测试之后，下一个步骤就是打包（package）。POM中没有指定打包类型，默认打包类型就是jar文件。我们只需要简单执行mvn clean package即可完成打包。
执行命令后可以看出，该命令的执行后达成的效果是编译、测试、打包。
测试结束以后，可以看到关于打包的语句命令行
其中第三行Building jar：xxxx。xxx的路径就是项目打包成jar文件的路径。

自此，该项目就被我们打包好了。如果有需要的话，我们直接将该项目的jar文件放到别的项目的Classpath中让别的项目直接使用HelloWorld类。

问题是如何让别的项目能引用到这个jar包呢，答案就是install。

执行mvn clean install，可以看到下面的输出。

可以看出，在打包之后，maven将这个jar包放到了我的本地仓库（.m2）之中了。

之前说导入依赖的时候，依赖只有下载到了本地仓库之中我们的项目才可以使用。这里的打包也是同样的道理。我们将项目package之后生成一个jar，然后install将这个jar包放到了本地仓库中，这样我们的其他项目才可以使用到这个jar包。
上面的过程我们手动也可以完成，但是明显要慢很多。maven只需要输入一条指令即可完成。

最后再强调一下package、install、deploy的区别。

• package：项目经过编译、测试以后，将项目打包成jar包，将jar放在项目的target之下，并没有其他动作。
• install：在package的基础上，将生成的jar包放到本地私有仓库之中。
• deploy：在install的基础上，将jar包推送到远程私有仓库（非中央仓库）。