[Java工程实践] Maven使用

作者：wuxinliulei
链接：https://www.zhihu.com/question/20104186/answer/73797359
来源：知乎
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

1. 前言

Maven是apache的一个顶级项目，它的出现越来越影响着现在的众多的开源项目，不仅如此，很多公司的很多新项目都采用Maven提倡的方式进行管理。Maven正逐渐侵入我们原先的管理项目的习惯，对于团队的管理，项目的构建，都是一种质的飞跃。当然是我个人的一些项目经验而说的这话。如果原先的团队老大本身的管理非常科学，也有一套其他软件辅助项目的构建、打包、发布等等一系列机制保证。那么Maven可能对其并没有实质性的影响或者是质的飞跃。当然在此也并不是说咱们中国人做出来的项目就管理不善……只是说利用Maven帮助我们构建项目更科学、更有可维护性、更加模块化、模块功能更加职能单一、做出来的项目更加具有可复用性等等好处。当然笔者也是个刚学习Maven的人，我们一起来学习Maven到底为我们带来了什么好处。笔者邮箱已经给出，欢迎与笔者进行学术上的交流。

2. Maven的思想

本来想看完了实战整本，再写总结的，后来觉得还是先写出来吧。哪怕有什么不对的地方再纠正都不晚，就怕到时候看完了一点心得都没有，全忘了就太……所以先将学习的点点滴滴感受写下来，之后结合实例咱们可以反复的推敲。

目前笔者看到的Maven的主要功能是：项目构建；项目构建；项目依赖管理；软件项目持续集成；版本管理；项目的站点描述信息管理；

由此可以看出Maven最主要的体现在了哪2个词？——对了，“项目”和“管理”！加在一起就是项目管理。项目管理是一个很抽象的概念。项目管理既可以指技术上的管理手段，也可以指“以人为本”的非技术因素。诚然，无论是技术还是非技术，项目的成败最大的责任人其实就是项目经理。这里我们抛开人为因素不提，仅就技术上来说，Maven提供了一种思想让团队更科学的管理、构建项目。用配置文件的方式对项目的描述、名称、版本号、项目依赖等等信息进行描述。使之项目描述结构清晰，任何人接手的成本比较低。在项目构建时，利用Maven的“约定大于配置”的思想，可以比Ant脚本构建项目省去不少配置文件的内容。而且一个项目可能依赖于其他的项目和第三方的组件才能顺利完成，Maven提供了仓库的概念，让这些依赖项放进仓库中，项目想要从仓库中去取，其他项目组也需要，OK，从仓库中去取，不必每个人去开源项目的站点去苦苦搜寻了。如此人员的成本、软件维护的成本、沟通的成本、硬件的成本都降下来了。客户笑了、公司老板也笑了、项目经理笑了、团队里面的人员也笑了、Apache社区看到这么多人在用也笑了。给笔者的感觉，现在的开源东西越来越向“敏捷开发”、“极限编程”的方向靠拢。通过Maven辅助管理项目，更能发现项目中哪些模块是重复的轮子。

3. Maven安装使用

① maven是一款服务于java平台的自动化构建工具

make->Ant->Maven->Gradle

名字叫法：我们可以叫妹文也可以叫麦文，但是没有叫妈文的。

② 构建

构建定义：把动态的Web工程经过编译得到的编译结果部署到服务器上的整个过程。

编译：java源文件[.java]->编译->Classz字节码文件[.class]

部署：最终在sevlet容器中部署的不是动态web工程，而是编译后的文件

③ 构建的各个环节

  • 清理clean：将以前编译得到的旧文件class字节码文件删除
  • 编译compile：将java源程序编译成class字节码文件
  • 测试test：自动测试，自动调用junit程序
  • 报告report：测试程序执行的结果
  • 打包package：动态Web工程打War包，java工程打jar包
  • 安装install：Maven特定的概念-----将打包得到的文件复制到“仓库”中的指定位置
  • 部署deploy：将动态Web工程生成的war包复制到Servlet容器下，使其可以运行

三、安装maven

① 当前系统是否配置JAVA_HOME的环境变量

② 下载maven，解压maven放在一个非中文无空格的路径下

③ 配置maven的相关环境变量

  • 在环境变量增加M2_HOME，路径是maven解压后的根目录
  • 在环境变量里的path中增加maven/bin的目录

④ 验证：maven -v 查看maven版本

看到版本信息，恭喜你已经OK了。

四、第一个maven

① 创建约定的目录结构（maven工程必须按照约定的目录结构创建）

根目录：工程名
|---src：源码
|---|---main:存放主程序
|---|---|---java：java源码文件
|---|---|---resource：存放框架的配置文件
|---|---test：存放测试程序
|---pop.xml：maven的核心配置文件

我们按照上面的文件夹目录结构手动创建一下，不用任何IDE环境（手动的其实最有助于我们理解maven）

文件内容如下

在src/main/java/com/hzg/maven目录下新建文件Hello.java，内容如下

package com.hzg.maven;
public class Hello {
　　public String sayHello(String name){
　　　　return "Hello "+name+"!";
　　}
}

POM文件内容：

<?xml version="1.0" ?>
<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>com.hzg.maven</groupId>
    <artifactId>Hello</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <name>Hello</name>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.0</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

② 常用maven命令

  • mvn clean：清理
  • mvn compile：编译主程序
  • mvn test-compile：编译测试程序
  • mvn test：执行测试
  • mvn package：打包
  • mvn install：安装

执行maven命令必须进入到pom.xml的目录中进行执行

进入到项目的pom.xml目录之后，就可以执行啦。

1、运行 mvn compile

OK，运行完毕，你在pom.xml配置的依赖的包已经导入到仓库了，问题来了，仓库默认的位置在哪？

仓库的默认位置：c:Usrs[登录当前系统的用户名].m2repository

刚才执行完compile之后，之前的文件夹发生了变化

我们发现Hello项目里里多了一个target文件夹。文件夹的内容为：

发现target里主要存放的就是编译后的字节码文件

2、运行mvn test-compile，target文件夹下面除了classes之外多了test-classes文件夹

3、运行mvn package，target文件夹下面又多了一个打好的jar包

4、运行mvn clean，发现整个target文件夹都没了。又回到了编译之前我们手动创建的文件夹

五、仓库和坐标

① pom.xml：Project Object Model 项目对象模型。它是maven的核心配置文件，所有的构建的配置都在这里设置。

② 坐标：使用下面的三个向量在仓库中唯一的定位一个maven工程

③ maven工程的坐标与仓库中路径的关系：

maven坐标和仓库对应的映射关系：[groupId][artifactId][version][artifactId]-[version].jar

去本地仓库看一下此目录：orgspringframeworkspring-core4.3.4.RELEASEspring-core-4.3.4.RELEASE.jar

果然是完全对应的（默认仓库地址上面说过了哦，不要说不知道在哪，没事下面我们再说一下仓库）

④ 仓库

仓库的分类：

1、本地仓库：当前电脑上的仓库，路径上已经说过了哦

2、远程仓库：

  • 私服：搭建在局域网中，一般公司都会有私服，私服一般使用nexus来搭建。具体搭建过程可以查询其他资料
  • 中央仓库：架设在Internet上，像刚才的springframework就是在中央仓库上

六、依赖

① maven解析依赖信息时会到本地仓库中取查找被依赖的jar包

  • 对于本地仓库中没有的会去中央仓库去查找maven坐标来获取jar包，获取到jar之后会下载到本地仓库
  • 对于中央仓库也找不到依赖的jar包的时候，就会编译失败了

② 如果依赖的是自己或者团队开发的maven工程，需要先使用install命令把被依赖的maven工程的jar包导入到本地仓库中

举例：现在我再创建第二个maven工程HelloFriend，其中用到了第一个Hello工程里类的sayHello(String name)方法。我们在给HelloFriend项目使用 mvn compile命令进行编译的时候，会提示缺少依赖Hello的jar包。怎么办呢？

到第一个maven工程中执行 mvn install后，你再去看一下本地仓库，你会发现有了Hello项目的jar包。一旦本地仓库有了依赖的maven工程的jar包后，你再到HelloFriend项目中使用 mvn compile命令的时候，可以成功编译

③ 依赖范围

scope就是依赖的范围

1、compile，默认值，适用于所有阶段（开发、测试、部署、运行），本jar会一直存在所有阶段。

2、provided，只在开发、测试阶段使用，目的是不让Servlet容器和你本地仓库的jar包冲突 。如servlet.jar。

3、runtime，只在运行时使用，如JDBC驱动，适用运行和测试阶段。

4、test，只在测试时使用，用于编译和运行测试代码。不会随项目发布。

5、system，类似provided，需要显式提供包含依赖的jar，Maven不会在Repository中查找它。

七、继承与聚合

即使是长期从事 Maven 工作的开发人员也不能完全掌握聚合（多模块）和 Parent 继承的关系，在使用多模块时，子模块总要指定聚合的 pom 为 <parent>。由于在大多数示例中都是这么写的，所以很难让人搞懂这两者的具体作用和关系。

实际上在 Maven 中聚合（多模块）和继承是两回事，两者不存在直接联系。

pom文档地址：https://maven.apache.org/pom.html Maven 完全参考：http://books.sonatype.com/mvnref-book/reference/index.html

继承

继承是 Maven 中很强大的一种功能，继承可以使得子POM可以获得 parent 中的各项配置，可以对子pom进行统一的配置和依赖管理。父POM中的大多数元素都能被子POM继承，这些元素包含：

  • groupId
  • version
  • description
  • url
  • inceptionYear
  • organization
  • licenses
  • developers
  • contributors
  • mailingLists
  • scm
  • issueManagement
  • ciManagement
  • properties
  • dependencyManagement
  • dependencies
  • repositories
  • pluginRepositories
  • build
    • plugin executions with matching ids
    • plugin configuration
    • etc.
  • reporting
  • profiles

注意下面的元素，这些都是不能被继承的。

  • artifactId
  • name
  • prerequisites

想要添加 parent，只需要像下面这样写。

<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
                      https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>my-parent</artifactId>
    <version>2.0</version>
    <relativePath>../my-parent</relativePath>
  </parent>

  <artifactId>my-project</artifactId></project>123456789101112131415

其中relativePath元素不是必须的，指定后会优先从指定的位置查找父pom。

聚合（或多模块）

具有模块的项目被称为多模块或聚合项目。模块是此POM列出并作为一组执行的项目。通过一个pom打包的项目可以将它们列为模块来聚合成一组项目进行构建，这些模块名是这些项目的相对目录。

<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
                      https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>org.codehaus.mojo</groupId>
  <artifactId>my-parent</artifactId>
  <version>2.0</version>
  <packaging>pom</packaging>

  <modules>
    <module>my-project</module>
    <module>another-project</module>
  </modules></project>12345678910111213141516

在列出模块时，不需要自己考虑模块间依赖关系，即POM给出的模块排序并不重要。Maven将对模块进行拓扑排序，使得依赖关系始终在依赖模块之前构建。

聚合 VS 父POM

虽然聚合通常伴随着父POM的继承关系，但是这两者不是必须同时存在的，从上面两者的介绍可以看出来，这两者的都有不同的作用，他们的作用不依赖于另一个的配置。

父POM是为了抽取统一的配置信息和依赖版本控制，方便子POM直接引用，简化子POM的配置。聚合（多模块）则是为了方便一组项目进行统一的操作而作为一个大的整体，所以要真正根据这两者不同的作用来使用，不必为了聚合而继承同一个父POM，也不比为了继承父POM而设计成多模块。

posted on 2020-05-05 17:28  ym65536  阅读(186)  评论(0)  编辑  收藏  举报