Maven功能简介与入门

Maven功能简介与入门

前言

本文对Maven提供概念上的简单介绍。告诉读者使用Maven的目的是什么，以及Maven适合做什么。并介绍在IDEA开发环境下创建Maven工程。这让读者能避免复杂的安装过程，直接能够接触Maven工程。文章在最后说明了新建的Maven工程的几个参数，并简单介绍了Maven的坐标这一概念。

自动化构建工具简介

准确的说Maven是一个项目管理工具，自动构建只是是它的其中一个功能。不过为了快速上手，所以只说明Maven自动构建的功能。在往下继续之前，有个概念需要知道——什么是构建工具？如果不知道是无法体会使用Maven的场景和目的。本章将说明构建工具是什么，以及使用构建工具的目的。

下文中出现的构建工具如果没有特别说明均是指自动构建工具

什么是构建工具

构建工具指能自动化地把源代码生成可执行程序的程序。

一个源代码要成为可执行程序大致上包括编译、连接两道大工序（凡事都有万一，脚本语言就不需要编译，不过这不是重点）。常见的编译工具包括C语言的gcc，Java的javac。虽然gcc、javac也可以完成链接工作，但是你需要多输入一些命令。实际上只要不怕麻烦，编译工具就可以完成从源代码到可执行程序的工作。那肯定会有这么个疑问，既然有了编译工具，为什么还需要构建工具。其实编译工具和构建工具的区别就在这一个自动化上，自动化工具就是省时省力。

为什么需要构建工具

为了能够说明问题，本节列举了3个场景。在每个场景都呈现了是否使用构建工具的情况，从而对使用构建工具的优越性进行说明。

1. 小明同学从网上copy了一份代码想要赶紧让代码运行起来看看能不能用

   • 小明用javac编译这些代码，可是他不知道各个源代码文件之间的依赖关系。这些代码文件有的是实现测试功能的、有的是资源文件、有的是源代码。只能先把源代码的依赖关系弄懂才能编译。一套流程做下来，代码是能运行了，可是这个代码实现的功能好像和自己想要的有些差别，而且花了不少时间。小明濒临崩溃，只想打人。
   • 小明copy的这个代码里面有个构建工具的配置文件，这个配置文件里已经写了该怎么构建这些代码。于是小明把构建工具安装在电脑上，只是输了一行命令就把这些代码构建成可执行程序了。虽然这个程序实现的功能和自己想要的有一些区别，但是花的时间很少。小明像个渣男一样很快就copy了一份新的代码下来运行。尽管找了4-5份代码，但是总归是找到能用的代码了。

2. 小明同学做了一个挺大的项目，.java文件的数量有接近十个，代码可能有bug会需要反复编译

   • 用javac编写了数十行命令，终于能够跑了。然后运行起来发现有bug，只能重来，反反复复了好多次，花了不少时间。
   • 把大约30行的构建工具的配置写好之后，仅仅打了一两行命令就完成了构建。就算发现了bug，改完源代码也可以快速完成构建。

3. 小明同学做了一个项目，里面需要使用不少的第三方依赖jar包（比如数据库连接驱动）

   • 上百度找了个数据库连接驱动。输入关键词以后进入了几个词条，找到所需要的的特定版本的jar包下载到电脑上，经过一些配置能够正常运行。

   • 在构建工具的中央仓库找到这个第三方jar包的依赖项该怎么写，然后在构建工具的配置文件写上。仅仅这么做就可以让构建工具自动去寻找相应的jar包了。

     小明粘贴的描述依赖项的代码

    <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.47</version>
    </dependency>
   

这三个场景中可以看出，构建工具适合在的代码构建过程繁杂，依赖项目繁多的场景下使用。使用构建工具就是为了能够省时省力地构建和管理项目。

Maven项目创建（IntelliJ IDEA）

在Java的生态圈内常见的构建工具有3种Ant、Maven还有Gradle。事实上Maven并不是这三种工具中最好的，但是一定是这三种工具中最容易找到资料的。

在这一章里面文章会呈现如何在集成开发环境IntelliJ IDEA中使用Maven。IDEA在安装时捆绑了Maven，可以很快的构建一个Maven项目。对于给新手入门来说，使用集成开发环境作为接触新工具的渠道可以少走很多弯路。也会减少很多写出错误命令行的挫败感。

本章分别介绍了两种创建Maven工程的方法

1. 通过添加框架支持的方式创建Maven工程。
2. 通过新建工程的方式创建Maven工程

Maven介绍

Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the pom.xml declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.

Maven是一个项目开发管理和理解工具。基于项目对象模型的概念：构建、依赖关系管理、文档创建、站点发布和分发发布都由pom.xml声明性文件控制。Maven可以通过插件进行扩展，以利用许多其他开发工具进行报告或构建过程。

–Apache Maven Project

Maven通过项目对象模型（project object model）管理项目，Maven的配置都写在pom.xml文件内。看到这里读者应该很容易可以明白为什么配置文件命名为pom了，但是读者应该理解不了Maven能做些什么。

从这段引文中可以知道Maven能够完成构建、依赖关系管理、文档创建、站点发布和分发发布这些工作。通常来说，最开始使用Maven的原因就是为了让Maven完成构建和依赖关系管理这两个工作。上文曾经提到的3个适合使用构建工具的场景。这三个场景的其实就是项目构建和依赖关系管理的问题，使用Maven可以很轻松的解决这些问题。这也是读者为什么现在花了宝贵的时间在看这篇文章的原因。

使用IDEA创建Maven工程

使用IDEA创建Maven工程很简单，本节将介绍通过新建工程的方式创建Maven工程。

1. 创建项目

2.选择创建Maven项目

3.填写坐标和版本

参数的解释

GroudId：组织名称

ArtifactId：项目名称

Version：版本

这三个参数是Maven中坐标概念的重要组成部分。对于刚开始使用Maven的用户来说，这三个参数随意填写并不会有什么影响。所以这部分的参数脸滚键盘输入也是可以的。

4.项目创建完成

项目的结构

.(这个是项目根目录)
├── enterMavenproject.iml（IDEA创建的模块配置文件）
├── pom.xml（Maven项目的配置文件）
└── src
    ├── main（存放源代码的目录）
    │   ├── java（存放java代码的目录）
    │   └── resources（存放资源文件的目录）
    └── test（存放单元测试用例的目录）
        └── java（测试java源代码的测试用例）

添加Maven框架支持创建Maven项目

本节将会从创建一个普通的Java项目开始，介绍如何使Java项目转变为Maven工程。

1.添加框架支持

右击项目的根目录图标在显示的菜单中选择Add Framework Support

2.选择添加Maven支持
3.添加Maven工程完成

这将会在原来的src目录下添加这样的目录

src
 ├── main
 │   ├── java
 │   └── resources
 └── test
     └── java

pom.xml的简短说明

本节将会以上节创建的Maven工程的pom.xml文件为例，简单的说明刚刚创建的pom.xml文件中节点的作用。

pom.xml文件

Maven将项目建模为项目对象模型进行管理，对于一个项目的描述全部会写在pom.xml中。

这是上节IDEA自动生成的pom.xml文件

<?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>cn.jmu.yiban</groupId>
    <artifactId>enter-maven-project</artifactId>
    <version>1.0-SNAPSHOT</version>

</project>

Maven的pom.xml文件使用xml描述一个项目。pom.xml是一个根节点为project，拥有数个子节点的xml文件。虽然目前只有四个子节点，但随着项目变得复杂，这个文件也会变的复杂。

Maven坐标

既然Maven的目的是为能够构建和管理项目那么首要解决的问题就是如何唯一标识一个项目，在这么一个问题背景下Maven的解决方案就是坐标这个概念。

Maven的坐标唯一标识了一个工程，这样才可能可以在成千上万的项目中明确地指代这个项目。

Maven的坐标包括以下5个部分，这是很简略的说法。当然，Maven的坐标概念详细来说不止这些，只是对于刚开始使用Maven的读者来说，这可以过后再讲。

标签名	说明
groupId（必填）	Maven项目依附的实际项目名称
artifactId（必填）	Maven项目模块的名称
version（必填）	Maven项目的版本
packaging	打包类型
classifier	进一步区分Maven项目

使用Maven添加依赖

在成功创建一个Maven工程之后我们就可以用Maven做些事情了，比如添加依赖。我们以添加Google Guava工具的过程为例子讲解应该如何寻找一个依赖。

事前准备

由于Maven的服务器架设在境外，导入依赖的速度比较慢，所以需要先设置代理仓库。常见的设置代理方式有两种：

1. 全局配置
2. 单项目配置

两种方式具体如何实现不做详细说明，为了省事笔者使用单项目配置的方式。你需要在pom.xml添加这样的xml节点

    <repositories>
        <repository>
            <id>central</id>
            <name>aliyun maven</name>
            <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
            <layout>default</layout>
            <!-- 是否开启发布版构件下载 -->
            <releases>
                <enabled>true</enabled>
            </releases>
            <!-- 是否开启快照版构件下载 -->
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

寻找依赖

为了添加guava的依赖，你需要知道guava的Maven坐标是什么。也就是groupId、artifactId、version这三个字段。不推荐使用百度找坐标。尽管如此，当你使用“guava maven依赖”这样的关键字去搜索确实能从一些博客里找到这个依赖的坐标但是这不是正确方法（添加个依赖都能水一篇文，我真是服了）。推荐去Maven仓库找这个坐标。选了一个最新的版本，它的坐标是这样的。把这段写到pom.xml里面。

<!-- https://mvnrepository.com/artifact/com.google.guava/guava -->
<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>28.2-jre</version>
</dependency>

最后pom.xml的内容是这样的

<?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>cn.jmu.yiban</groupId>
    <artifactId>enter-maven-project</artifactId>
    <version>1.0-SNAPSHOT</version>

    <repositories>
        <repository>
            <id>central</id>
            <name>aliyun maven</name>
            <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
            <layout>default</layout>
            <!-- 是否开启发布版构件下载 -->
            <releases>
                <enabled>true</enabled>
            </releases>
            <!-- 是否开启快照版构件下载 -->
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

    <dependencies>
        <!-- https://mvnrepository.com/artifact/com.google.guava/guava -->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>28.2-jre</version>
        </dependency>
    </dependencies>
</project>

依赖加载完成

运行一段测试代码检验是否成功导入Guava依赖

import com.google.common.base.Stopwatch;

import java.util.concurrent.TimeUnit;

public class GuavaTest {
    public static void main(String[] args) {
        Stopwatch stopwatch = Stopwatch.createStarted();
        for (int i = 0; i < 100000; i++) {
            System.out.println(i);
        }
        long nanos = stopwatch.elapsed(TimeUnit.MILLISECONDS);
        System.out.println("Complete in " + nanos + " MILLISECONDS");
    }
}

总结

通过这篇文章，读者应该了解了为什么需要使用构建工具。简单的说明了pom.xml的结构，还有Maven坐标这个概念。同时，也知道了如何使用IDEA新建Maven项目，导入依赖。