JAVA-MAVEN初学者教程（配置、pom.xml、依赖管理等）-阿里云开发者社区

认识MAVEN

Java的包管理工具有Maven、Gradle等，其中Maven是一款服务于Java平台的自动化构建工具，把整个过程抽象成一个项目对象模型（Project Object Model，POM），它不仅可以用作包管理，还有许多的插件，可以支持整个项目的开发、打包、测试及部署等一系列行为。Gradle是一个基于Apache Ant和Apache Maven概念的项目自动化构建工具。

安装&配置MAVEN

windows安装MAVEN

MAVEN官方下载地址如下：

MAVEN下载地址

下载后设置环境变量，使用

mvn --version

验证，有输出即可。

MAVEN的配置

maven的安装目录下，有一个Conf目录，其中settings.xml是配置文件

本地仓库 localRepository

设置一些依赖的Jar包保存在哪里，默认是${user.home}/.m2/repository，我一般就放在MAVEN目录下面

<localRepository>D:\apache-maven-3.8.8\maven_respository</localRepository>

镜像 mirrors

常用的镜像地址有以下几个：

Maven Central Repository: https://repo.maven.apache.org/maven2/
JBoss Repository: https://repository.jboss.org/nexus/content/groups/public/
Spring Repository: https://repo.spring.io/libs-release/
Apache Repository: https://repository.apache.org/content/repositories/releases/

打开可以看到一些包的目录

当然，无法科学上网的时候下载包会比较慢，这里以阿里云为例进行配置。

<mirrors>
 <!-- 阿里云仓库 -->
    <mirror>
      <id>aliyunmaven</id>
      <mirrorOf>*</mirrorOf>
      <name>阿里云公共仓库</name>
      <url>https://maven.aliyun.com/repository/public</url>
    </mirror>
    <mirror>
      <id>alimaven</id>
      <mirrorOf>central</mirrorOf>
      <name>aliyun maven</name>
      <url>https://maven.aliyun.com/repository/central</url>
    </mirror>
    <mirror>
      <id>maven-default-http-blocker</id>
      <mirrorOf>external:http:*</mirrorOf>
      <name>Pseudo repository to mirror external repositories initially using HTTP.</name>
      <url>http://0.0.0.0/</url>
      <blocked>true</blocked>
    </mirror>
  </mirrors>

可以通过文件搜索查找可以下载的包及版本

代理仓库 respositories

可以使用代理仓库

<repository>
  <id>central</id>
  <url>https://maven.aliyun.com/repository/central</url>
  <releases>
    <enabled>true</enabled>
  </releases>
  <snapshots>
    <enabled>true</enabled>
  </snapshots>
</repository>

代理 proxies

一般设置公司的vpn，来下载一些不公开的自研包

IDEA配置MAVEN（一个module）

使用IDEA创建MAVEN项目，可以选择Empty Project，然后自己手动配置，也可以直接选择MAVEN

GroupId一般是公司域名反写，ArtifactId是你项目打包后的名字，Verion就是版本，之后的pom.xml再详细解释。

创建好后点击右上角有蓝色的Project Structure查看项目结构

完整的项目结构应该是

src：源代码

java java代码
resources 资源

java 测试代码
resources 测试资源

pom.xml
标准目录结构参考 maven标准目录结构
标记目录可以在上面的项目结构，也可以在左侧目录栏右键 Mark Directory as。

MAVEN配置
File->settings->Build, Execution,Deployment

修改Maven目录、配置文件、本地仓库位置，记得打勾。

MAVEN生命周期

点击右侧的Maven可以看到生命周期

解释如下：

clean：删除先前版本生成的所有文件
validate- 验证项目是否正确，以及所有必要的信息是否可用
compile- 编译项目的源代码
test- 使用合适的单元测试框架测试编译的源代码。这些测试不应要求打包或部署代码
package- 获取编译后的代码并将其打包为其可分发的格式，例如 JAR。
verify- 对集成测试结果进行任何检查，以确保满足质量标准
install- 将包安装到本地存储库中，以用作本地其他项目中的依赖项
site：生成项目的站点文档
deploy- 在构建环境中完成，将最终包复制到远程存储库，以便与其他开发人员和项目共享。

更多生命周期查看Maven生命周期

install下载包

main的java中创建Hero类

Hero.java

public class Hero {
    private String name;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getProfession() {
        return profession;
    }
    public void setProfession(String profession) {
        this.profession = profession;
    }
    private String profession;
}

pom.xml中添加dependency

<dependencies>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.83</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
    </dependencies>

点击install，可以看到下载

test的java中创建HeroTest.java

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import org.junit.Test;
public class HeroTest {
    @Test
    public void testJsonToHero() {
        String jsonStr = "{\"name\":\"狂铁\",\"profession\":\"战士\"}";
        JSONObject jsonObject = JSON.parseObject(jsonStr);
        Hero hero = new Hero();
        hero.setName(jsonObject.getString("name"));
        hero.setProfession(jsonObject.getString("profession"));
        System.out.println(hero.getName() + " " + hero.getProfession());
    }
}

运行

左侧的External Libraries会展示包和包中的代码，右侧的Dependencies会展示依赖和依赖的依赖。

由于install在package生命周期后面，所以也会生成target目录，里面有打好的jar包。

在本地仓库可以根据坐标找到对应的包。

模块的pom.xml

坐标gav

groupId：公司或组织域名反写
artifactId：项目模块Id
version：版本号，例如1.0-SNAPSHOT、1.0-RELEASE等。

举例

<groupId>com.ladykiller</groupId>
    <artifactId>first_maven</artifactId>
    <version>1.0-SNAPSHOT</version>

RELEASE一般在功能完成一个阶段，进行发布时会使用。

详见：命名指南

打包方式 package

jar：默认的Java工程
war：Web工程
pom：管理其他工程的工程

属性值 properties

内置属性

1.env.X

获取系统环境变量值，例如

${env.PATH}

2.project.x

获取项目相关的变量，例如

${project.version}

3.settings.x

获取配置文件相关的变量，例如

${settings.localRepository}

4.java.x

获取配置文件相关的变量，例如

${java.home}

自定义属性

常用来定义一些版本等，后序可以使用，方便修改，类似编程时的全局变量。

例如：

<properties>
        <flink.version>1.8</flink.version>
    </properties>

使用时使用${标签值即可}

<version>${flink.version}</version>

依赖dependencies

本节参考依赖机制

dependency

scope 依赖范围

compile - 默认范围。编译依赖项在所有类路径中都可用。此外，这些依赖项将传播到依赖项目。
provided - 这很像编译，但表示希望 JDK 或容器在运行时提供它。它仅在编译和测试类路径上可用，即在main目录和test目录下可用，不会打包，并且不是可传递的。
runtime - 此范围指示编译不需要依赖项，但执行需要依赖项。它位于运行时和测试类路径中，但不在编译类路径中。
test - 此范围指示依赖项不是正常使用应用程序所必需的，并且仅适用于测试编译和执行阶段，在test目录下可用。它不是可传递的。
system - 此作用域类似于，只是您必须提供显式包含它的 JAR。工件始终可用，不会在repository中查找。
以test为例

<dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>

依赖传递(IDEA 配置多个module)

创建一个空项目

之后添加模块module01 module02

有三个pom.xml，项目的和两个module的

在module02的pom.xml中添加对module01的依赖，右侧刷新后可以看到

同理，创建module03, 并在module02中添加对module03的依赖

依赖传递中的冲突

直接依赖：pom.xml中写的依赖

间接依赖：依赖所需的资源，或者说依赖的依赖

声明优先：间接依赖，先声明的优先

特殊优先：直接依赖，后声明的优先

路径优先：出现相同资源，层级越深，优先级越低

依赖如下图所示

结果如下图所示

exclusions 依赖排除

项目中依赖其他模块，但是项目本身不需要模块的某些依赖时，可以排除

optional 依赖可选

表示是否需要依赖的依赖，默认为false。

插件 plugins

插件太多了，以一个插件为例

添加并执行install生命周期

项目的pom.xml

模块存在依赖，且特别多时，需要把很多模块整合在一起，看做整体进行生命周期管理，这个时候就用到了管理模块，即root模块。

modules 模块聚合

添加上面橘红色的pom.yaml文件为新的模块，进行项目的管理，添加成功后会变成蓝色，点击生命周期时可以看到多个模块会一起变化，例如，点击了clean，三个模块的target就都没有了。

dependencyManagement && parent 依赖管理与继承

通过dependencyManagement由root模块进行统一的依赖管理，通过parent进行依赖的继承。

profiles 多环境管理

实际生产过程中可能会有开发环境、测试环境、生产环境等，在MAVEN中可以通过profiles进行多环境配置与管理

使用profiles进行环境管理，使用activation指定默认的环境

给生产环境打包时，可以使用-P参数指定使用的环境id

mvn install -P prod

常见问题

IDEA配置MAVEN后异常，右下角需要查看event log

点击Help->Show log in Explore，打开后如果是类似下面的内容，说明你的IDEA和MAVEN版本不匹配，查看MAVEN的发行时间和你的IDEA的版本，修改后即可。

org.jetbrains.idea.maven - com.google.inject.CreationException: Unable to create injector, see the following errors:
1) No implementation for org.apache.maven.model.path.PathTranslator was bound.
  while locating org.apache.maven.model.path.PathTranslator
    for field at org.apache.maven.model.interpolation.AbstractStringBasedModelInterpolator.pathTranslator(Unknown Source)
  at org.codehaus.plexus.DefaultPlexusContainer$1.configure(DefaultPlexusContainer.java:350)
2) No implementation for org.apache.maven.model.path.UrlNormalizer was bound.
  while locating org.apache.maven.model.path.UrlNormalizer
    for field at org.apache.maven.model.interpolation.AbstractStringBasedModelInterpolator.urlNormalizer(Unknown Source)
  at org.codehaus.plexus.DefaultPlexusContainer$1.configure(DefaultPlexusContainer.java:350)
3) No implementation for org.apache.maven.model.interpolation.ModelVersionProcessor was bound.
  while locating org.apache.maven.model.interpolation.ModelVersionProcessor
    for field at org.apache.maven.model.interpolation.AbstractStringBasedModelInterpolator.versionProcessor(Unknown Source)
  at org.codehaus.plexus.DefaultPlexusContainer$1.configure(DefaultPlexusContainer.java:350)

scope中provided的依赖本地需要怎么办？

有的时候我们导入了其他人的项目，有些依赖没有，但是在pom.xml中是provided

可以改pom.xml，编译时下载包，之后再改过来，比较麻烦，不够优雅。

我们可以通过修改configuration，打勾包含provided scope即可

知道import什么包，如何写pom.xml的dependency

查询gav，知道后查看仓库中有哪些版本

附pom.xml内容

second_maven.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>com.ladykiller</groupId>
    <artifactId>second_maven</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <modules>
        <module>module01</module>
        <module>module03</module>
        <module>module02</module>
    </modules>
    <profiles>
        <profile>
            <id>dev</id>
            <dependencyManagement>
                <dependencies>
                    <dependency>
                        <groupId>com.ladykiller</groupId>
                        <artifactId>module01</artifactId>
                        <version>1.0-SNAPSHOT</version>
                    </dependency>
                    <dependency>
                        <groupId>com.ladykiller</groupId>
                        <artifactId>module02</artifactId>
                        <version>1.0-SNAPSHOT</version>
                    </dependency>
                    <dependency>
                        <groupId>com.ladykiller</groupId>
                        <artifactId>module03</artifactId>
                        <version>1.0-SNAPSHOT</version>
                    </dependency>
                    <dependency>
                        <groupId>log4j</groupId>
                        <artifactId>log4j</artifactId>
                        <version>1.2.9</version>
                    </dependency>
                    <dependency>
                        <groupId>junit</groupId>
                        <artifactId>junit</artifactId>
                        <version>4.6</version>
                        <optional>true</optional>
                    </dependency>
                </dependencies>
            </dependencyManagement>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <id>prod</id>
            <dependencyManagement>
                <dependencies>
                    <dependency>
                        <groupId>com.ladykiller</groupId>
                        <artifactId>module01</artifactId>
                        <version>1.0-SNAPSHOT</version>
                    </dependency>
                    <dependency>
                        <groupId>com.ladykiller</groupId>
                        <artifactId>module02</artifactId>
                        <version>1.0-SNAPSHOT</version>
                    </dependency>
                    <dependency>
                        <groupId>com.ladykiller</groupId>
                        <artifactId>module03</artifactId>
                        <version>1.0-SNAPSHOT</version>
                    </dependency>
                    <dependency>
                        <groupId>log4j</groupId>
                        <artifactId>log4j</artifactId>
                        <version>1.2.12</version>
                    </dependency>
                    <dependency>
                        <groupId>junit</groupId>
                        <artifactId>junit</artifactId>
                        <version>4.8.2</version>
                        <optional>true</optional>
                    </dependency>
                </dependencies>
            </dependencyManagement>
        </profile>
    </profiles>
</project>

module01.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>com.ladykiller</groupId>
    <artifactId>module01</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>
    <parent>
        <groupId>com.ladykiller</groupId>
        <artifactId>second_maven</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <dependencies>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-install-plugin</artifactId>
                <version>2.4</version>
                <executions>
                    <execution>
                        <phase>install</phase>
                        <goals>
                            <goal>install</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

module02.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>com.ladykiller</groupId>
    <artifactId>module02</artifactId>
    <version>1.0-SNAPSHOT</version>
    <parent>
        <groupId>com.ladykiller</groupId>
        <artifactId>second_maven</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <dependencies>
        <dependency>
            <groupId>com.ladykiller</groupId>
            <artifactId>module01</artifactId>
            <version>1.0-SNAPSHOT</version>
            <exclusions>
                <exclusion>
                    <groupId>log4j</groupId>
                    <artifactId>log4j</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.ladykiller</groupId>
            <artifactId>module03</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
    </dependencies>
</project>

module03.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>com.ladykiller</groupId>
    <artifactId>module03</artifactId>
    <version>1.0-SNAPSHOT</version>
    <parent>
        <groupId>com.ladykiller</groupId>
        <artifactId>second_maven</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <dependencies>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
        </dependency>
    </dependencies>
</project>

参考

JAVA-MAVEN初学者教程（配置、pom.xml、依赖管理等）