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

目录

  • 认识MAVEN
  • 安装&配置MAVEN
    • windows安装MAVEN
    • MAVEN的配置
      • 本地仓库 localRepository
      • 镜像 mirrors
      • 代理仓库 respositories
      • 代理 proxies
    • IDEA配置MAVEN(一个module)
  • MAVEN生命周期
    • install下载包
  • 模块的pom.xml
    • 坐标gav
    • 打包方式 package
    • 属性值 properties
      • 内置属性
      • 自定义属性
    • 依赖dependencies
      • dependency
        • scope 依赖范围
        • 依赖传递(IDEA 配置多个module)
        • exclusions 依赖排除
        • optional 依赖可选
    • 插件 plugins
  • 项目的pom.xml
    • modules 模块聚合
    • dependencyManagement && parent 依赖管理与继承
    • profiles 多环境管理
  • 常见问题
    • IDEA配置MAVEN后异常,右下角需要查看event log
    • scope中provided的依赖本地需要怎么办?
    • 知道import什么包,如何写pom.xml的dependency
  • 附pom.xml内容
    • second_maven.xml
    • module01.xml
    • module02.xml
    • module03.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目录下面

D:\apache-maven-3.8.8\maven_respository

镜像 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/

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

在这里插入图片描述

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

 
    
      aliyunmaven
      *
      阿里云公共仓库
      https://maven.aliyun.com/repository/public
    
    
      alimaven
      central
      aliyun maven
      https://maven.aliyun.com/repository/central
    
    
      maven-default-http-blocker
      external:http:*
      Pseudo repository to mirror external repositories initially using HTTP.
      http://0.0.0.0/
      true
    
  

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

在这里插入图片描述

代理仓库 respositories

可以使用代理仓库

  central
  https://maven.aliyun.com/repository/central
  
    true
  
  
    true
  

代理 proxies

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

IDEA配置MAVEN(一个module)

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

在这里插入图片描述

在这里插入图片描述

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

在这里插入图片描述

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

在这里插入图片描述

完整的项目结构应该是

  • src:源代码
    • main:主目录
      • java java代码
      • resources 资源
    • test 测试目录
      • 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

    
        
            com.alibaba
            fastjson
            1.2.83
        
        
            junit
            junit
            4.12
        
    

点击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等。

举例

    com.ladykiller
    first_maven
    1.0-SNAPSHOT

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}

自定义属性

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

例如:

    
        1.8
    

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

${flink.version}

依赖dependencies

本节参考 依赖机制

dependency

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

    以test为例

              junit            junit            4.12            test        

在这里插入图片描述

依赖传递(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


    4.0.0

    com.ladykiller
    second_maven
    1.0-SNAPSHOT
    pom

    
        module01
        module03
        module02
    

    
        
            dev
            
                
                    
                        com.ladykiller
                        module01
                        1.0-SNAPSHOT
                    
                    
                        com.ladykiller
                        module02
                        1.0-SNAPSHOT
                    
                    
                        com.ladykiller
                        module03
                        1.0-SNAPSHOT
                    
                    
                        log4j
                        log4j
                        1.2.9
                    
                    
                        junit
                        junit
                        4.6
                        true
                    
                
            
            
                true
            
        
        
            prod
            
                
                    
                        com.ladykiller
                        module01
                        1.0-SNAPSHOT
                    
                    
                        com.ladykiller
                        module02
                        1.0-SNAPSHOT
                    
                    
                        com.ladykiller
                        module03
                        1.0-SNAPSHOT
                    
                    
                        log4j
                        log4j
                        1.2.12
                    
                    
                        junit
                        junit
                        4.8.2
                        true
                    
                
            
        
    



module01.xml


    4.0.0

    com.ladykiller
    module01
    1.0-SNAPSHOT
    jar

    
        com.ladykiller
        second_maven
        1.0-SNAPSHOT
        ../pom.xml
    

    
        
            log4j
            log4j
        
        
            junit
            junit
            true
        
    

    
        
            
                org.apache.maven.plugins
                maven-install-plugin
                2.4
                
                    
                        install
                        
                            install
                        
                    
                
            
        
    

module02.xml


    4.0.0

    com.ladykiller
    module02
    1.0-SNAPSHOT

    
        com.ladykiller
        second_maven
        1.0-SNAPSHOT
        ../pom.xml
    

    
        
            com.ladykiller
            module01
            1.0-SNAPSHOT
            
                
                    log4j
                    log4j
                
            
        
        
            com.ladykiller
            module03
            1.0-SNAPSHOT
        
        
            junit
            junit
        
        
            junit
            junit
        
    


module03.xml


    4.0.0

    com.ladykiller
    module03
    1.0-SNAPSHOT

    
        com.ladykiller
        second_maven
        1.0-SNAPSHOT
        ../pom.xml
    

    
        
            log4j
            log4j
        
    

参考

Apache-Maven入门指南

Apache-POM文档

Apache-Maven插件

阿里云MAVEN镜像

本文来自网络,不代表协通编程立场,如若转载,请注明出处:https://net2asp.com/98c0ecd2b3.html