Maven基础教程:从下载到使用全过程详解
文章目录
前言
本文从概念、作用、下载、安装、配置、使用等方面对 Maven 做了一个系统的的介绍,通过本文的学习达到快速上手 Maven 的目的。
一、Maven 简述
Maven官网:https://maven.apache.org/
Maven 包含一个项目对象模型(Project Object Model,反映在配置中就是一个 pom.xml 文件)、一组标准集合,一个项目生命周期、一个依赖管理系统,和用来运行定义在生命周期阶段中插件目标的逻辑。当我们使用Maven的时候,通过一个明确定义的项目对象模型(即 pom.xml 文件)来描述我们的项目,然后Maven可以应用横切的逻辑,这些逻辑来自一组共享的或者自定义的插件。
- Maven 是一款自动化构建工具。不仅能帮我们自动化构建,还能够抽象构建过程,提供构建任务实现;它跨平台,对外提供了一致的操作接口。
- Maven 是一款依赖管理工具,对 jar 进行统一管理,它提供了一个中央仓库,当我们在项目中添加完依赖之后,Maven 会自动去中央仓库下载相关的依赖,很好地解决依赖冲突及依赖的依赖问题。
- Maven 是一款项目管理工具,对项目进行编译、测试、打包、部署、上传到私服等。
- Maven 能够很方便的帮你管理项目报告,生成站点,等等。
二、Maven 作用
通过上面对 Maven 的介绍,对 Maven 的作用已经有了一个基本的了解,下面详细说明一下 Maven 的两个主要作用。
主要作用一:统一的项目文件目录结构
- 所有的java代码都放在
src/main/java
下面; - 所有的测试代码都放在
src/test/java
下; - 有一个 pom.xml 用于维护当前项目都用了哪些 jar 包。
使用统一的 Maven 项目文件目录结构,能让程序员迅速理解其它 Maven 项目。
主要作用二:统一维护 jar 包
比如说有3个 Java 项目,这些项目都不是 Maven 风格,那么这3个项目,就会各自维护一套 jar 包,而其中有些 jar 包是相同的。通过 Maven 构建项目。就可以通过把所有的 jar 包都放在 Maven 仓库里,使用的时候通过 Maven 坐标导入即可。实现 jar 包的共享,技能提高效率节省资源,又能避免jar包冲突。
三、Maven 下载、安装
Maven 是一个基于 Java 的工具,所以要做的第一件事情就是安装 JDK。
如果你还未安装 JDK,可以参考下载安装JDK,搭建Java开发环境。
步骤一:进入Maven官网,点击“Download”进入下载页
步骤二:选择版本进行下载
Binary意为二进制,含有此单词的文件为我们使用Maven的安装包;Source意为源码,含有此单词的文件为Maven提供的源码,下载后需要经过编绎才可以使用。
tar.gz和zip是两种压缩格式,linux和mac下选择tar.gz,windows下选择zip。
- Binary tar.gz archive:适用linux环境的二进制包;
- Binary zip archive:适用Windows环境的二进制包(下载);
- Source tar.gz archive:适用linux环境的源文件包;
- Source zip archive::适用Windows环境的源文件包;
步骤三:选择版本进行下载
步骤四:将下载好的 apache-maven-3.8.6-bin.zip 解压缩,打开 Maven 目录
解压缩后即安装完成,建议将解压缩后的文件移动到自己专门配置环境变量的路径下。下图为 Maven 目录:
bin目录: 该目录包含了mvn运行的脚本,这些脚本用来配置java命令,准备好classpath和相关的Java系统属性,然后执行Java命令。
boot目录: 该目录只包含一个文件,该文件为plexus-classworlds-2.5.2.jar。plexus-classworlds是一个类加载器框架,相对于默认的java类加载器,它提供了更加丰富的语法以方便配置,Maven使用该框架加载自己的类库。
conf目录: 该目录包含了一个非常重要的文件settings.xml。直接修改该文件,就能在机器上全局地定制Maven的行为,一般情况下,我们更偏向于复制该文件至/.m2/目录下(表示用户目录),然后修改该文件,在用户范围定制Maven的行为。
lib目录: 该目录包含了所有Maven运行时需要的Java类库,Maven本身是分模块开发的,因此用户能看到诸如maven-core-3.0.jar、maven-model-3.0.jar之类的文件,此外这里还包含一些Maven用到的第三方依赖如commons-cli-1.2.jar、commons-lang-2.6.jar等等。
步骤五:测试是否安装成功
在 Maven 安装路径的bin目录下打开命令行,输入 mvn -v
,成功输出版本号即为安装成功。
四、Maven 配置环境变量
步骤一:新建系统变量
按照步骤“右键此电脑→属性→高级系统设置→环境变量→系统变量”,找到系统变量,新建系统变量,起个变量名( MAVEN_HOME
,注意跟下一步匹配),变量值为Maven的安装路径,记得点确定保存。
步骤二:在Path 系统变量,新建 %MAVEN_HOME%\bin
系统变量中,选中 Path 变量,点编辑,在新弹出来的编辑环境变量中点击新建,填入 %MAVEN_HOME%\bin
后一路点击确定即可。
注意:这里编辑的是系统变量中的 Path 变量,不是用户变量中。
步骤三:验证 Maven 环境变量是否配置成功
win+r 打开运行窗口,输入cmd,点回车,进入命令行窗口,输入 mvn -v
,成功输出 Maven 版本号即为配置成功。如图所示:
五、Maven 仓库
5.1 Maven 仓库分类
总的来说 Maven 仓库有两大类:即本地仓库和远程仓库。远程仓库又可以细分为中央仓库、私服、其他公共库。
5.1.1 本地仓库
① 含义
- 本地仓库是远程仓库的一个缓冲和子集,当你构建 Maven 项目的时候,首先会从本地仓库查找资源,如果没有,那么 Maven 会从远程仓库下载到你本地仓库。这样在你下次使用的时候就不需要从远程下载了。如果你所需要的 jar 包版本在本地仓库没有,而且也不存在于远程仓库,Maven 在构建的时候会报错,这种情况可能是有些 jar 包的新版本没有在 Maven 仓库中及时更新。
- Maven 本地仓库实际上就是本地计算机上的一个目录(文件夹)
- Maven 默认的本地仓库路径为
${user.home}/.m2/repository
,也就是说,一个用户会对应的拥有一个本地仓库,它在安装 Maven 后并不会立刻创建,而是在第一次执行 Maven 命令的时候才被创建。
② 配置(自定义本地仓库)
- 我们已经知道 Maven 默认的本地仓库路径为:
${user.home}/.m2/repository
- 如果你想修改本地仓库的默认存储位置,你可以在
Maven安装路径/conf/settings.xml
文件中,通过<localRepository>自定义本地仓库地址</localRepository>
元素自定义本地仓库地址。 - 实际项目开发中,Maven 的大多数配置都是在 settings.xml 这个文件中进行设置的,该配置文件针对系统所有用户。
例如:
<settings xmlns="http://maven.apache.org/SETTINGS/1.2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.2.0 https://maven.apache.org/xsd/settings-1.2.0.xsd">
<localRepository>D:\Program Files (x86)\repository\apache-maven-repository</localRepository>
</settings>
5.1.2 远程仓库
如果Maven在本地仓库和中央仓库中都找不到依赖的库文件,它就会停止构建过程并输出错误信息到控制台。为避免这种情况的发生,Maven还提供了远程仓库的概念,它是一种由开发人员自己定制的仓库,其中包含了供其他项目使用的代码库或者构件。
远程仓库还可以分为3个小类:中央仓库、私服、其他公共仓库。
5.1.2.1 中央仓库
① 含义
- 中央仓库是由 Maven 社区提供的一种特殊的远程仓库,Maven 在安装的时候,自带的就是中央仓库的配置。它包含了绝大多数流行的开源构件,以及源码、作者信息、SCM、信息、许可证信息等。一般来说,简单的Java项目依赖的构件都可以在这里下载到。在默认情况下,当本地仓库没有 Maven 所需的构件时,会首先尝试从中央仓库下载。
- 虽然中央仓库属于远程仓库的范畴,但由于它的特殊性,一般会把它与其他远程仓库区分开。我们常说的远程仓库,一般不包括中央仓库。
- 要浏览中央仓库的内容,Maven 社区提供了一个 URL:https://central.sonatype.dev/。使用这个仓库,开发人员可以搜索所有可以获取的代码库。
- 由于默认的官方 Maven 仓库在国内下载速度很慢,而且可能项目的某些构件中央仓库是没有的,因此我们通常使用一些国内的镜像仓库,如最常用的是阿里云仓库。
- Maven 中央仓库地址一:https://repo1.maven.org/maven2/
- Maven 中央仓库地址二:https://mvnrepository.com/
- 阿里云镜像仓库地址:http://maven.aliyun.com/nexus/content/groups/public/
② 配置(镜像仓库)
- 首先明确什么是镜像,如果仓库 X 可以提供仓库 Y 存储的所有内容,那么就可以认为 X 是 Y 的一个镜像。换句话说,任何一个可以从仓库 Y 获得的构件,都能从它的镜像中获取。
- 配置镜像仓库,需要在
Maven安装路径/conf/settings.xml
文件内的<mirrors>如下内容</mirrors>
节点中添加镜像仓库使用地址。以阿里云镜像仓库为例:
<mirror>
<id>alimaven</id>
<mirrorOf>central</mirrorOf>
<name>aliyun maven</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
</mirror>
配置不生效的解决方法:http://events.jianshu.io/p/fd9984236937
多个镜像节点执行问题
虽然 mirrors 可以配置多个子节点,但是它只会使用其中的一个节点,即默认情况下配置多个 mirror 的情况下,只有第一个生效,只有当前一个 mirror 无法连接的时候,才会去找后一个;
而实际项目中想要的效果是:当 a.jar 在第一个 mirror 中不存在的时候,Maven 会自动去下一个 mirror 中查询下载,但是 Maven 执行机制不是这样的!
5.1.2.2 私服
① 含义
- Maven 私服是指私有服务器,是架设在局域网的一种特殊的远程仓库,目的是代理远程仓库及部署第三方构建。有了私服之后,当 Maven 需要下载构件时,直接请求私服,私服上存在则下载到本地仓库;否则,私服请求外部的远程仓库,将构件下载到私服,再提供给本地仓库下载。我们还可以把一些无法从外部仓库下载到的构件上传到私服上。
- 提高访问速度,节省带宽,比外部的远程仓库更加稳定。
- 存放公司内部自己开发的 jar 。
当前主流的 Maven 私服:
- Apache 的 Archiva
- JFrog 的 Artifactory
- Sonatype 的 Nexus
② 配置(镜像仓库)
关于私服的安装与配置这里暂不做详细说明。
5.1.2.3 其他公共库
① 含义
有时候也无法满足我们项目的需求,可能项目需要的某些构件中央仓库中是没有的,而在其他远程仓库中有,如JBossMaven库,Java.netMaven库等等。
② 配置(镜像仓库)
如果想使用其它代理仓库,可以在 Maven安装路径/conf/settings.xml
文件内的 <repositories>如下内容</repositories>
节点中加入对应的仓库使用地址。以 JBoss 为例:
<!-- 配置远程仓库 -->
<repository>
<id>jboss</id>
<name>JBoss Repository</name>
<url>http://repository.jboss.com/maven2/</url>
<releases>
<enabled>true</enabled>
<updatePolicy>daily</updatePolicy>
</releases>
<snapshots>
<enabled>false</enabled>
<checksumPolicy>warn</checksumPolicy>
</snapshots>
<layout>default</layout>
</repository>
5.2 Maven仓库优先级(依赖搜索顺序)
- 当我们在项目中依赖一个 jar 包时,Maven 程序会先去本地仓库中找,如果本地仓库没找到就会去全局配置的私服仓库 (settings.xml)找,如果也没找到就会去项目自身配置的私服仓库 (pom.xml) 找,如果仍然没找到,最后就会去中央仓库找,如果没有则终止寻找。
- 如果在找寻依赖的过程中,如果发现该仓库有镜像设置,则会转到镜像中查找该依赖,不会再从原仓库中查找。
- settings.xml 中配置的 profile(激活的)下的 respository 优先级高于项目中 pom.xml 配置的 respository。
- 本地仓库 > 私服(profile)> 远程仓库(repository)
- local_repo > settings_profile_repo > pom_profile_repo > pom_repositories > settings_mirror > central
六、Maven 的 settings.xml 文件
6.1 分类
6.1.1 Maven用户可以选择配置路径(配置文件 settings.xml 在两个地方:):
- 全局配置:
Maven安装路径/conf/settings.xml
。 - 用户配置:
Maven仓库路径/settings.xml
(默认仓库路径下${user.home}/.m2/settings.xml
)。 - 项目配置:创建项目后自动生成的
pom.xml
。(这里不做详述)
6.1.1 配置优先级
需要注意的是:局部配置优先于全局配置。
配置优先级从高到低:pom.xml> user settings > global settings
如果这些文件同时存在,在应用配置时,会合并它们的内容,如果有重复的配置,优先级高的配置会覆盖优先级低的。
6.1.1 说明
- 用户配置,即仓库路径下的 settings.xml 文件默认是不存在的,但是 Maven 允许用户在这里定义自己的 settings.xml,你可以把 Maven 安装目录下面的 settings.xml 文件拷贝到用户配置下,然后自定义修改。
- 全局配置是全局范围的,整台机器上的所有用户都会直接受到该配置的影响;而用户配置是用户范围的,只有当前用户才会受到该配置的影响;
- 个人使用用户范围的 settings.xml,可以避免无意识的影响到系统中的其他用户;
- 如果团队开发需要统一系统中所有用户的 settings.xml 配置,则使用全局范围的 settings.xml;
- 除了影响范围这一因素,配置用户范围 settings.xml 文件还便于文件升级,如果直接修改 conf 目录下的 settings.xml,每次升级到新版本的 Maven 都需要复制 settings.xml 文件。如果使用用户目录下的 settings.xml,就不会影响到 Maven 安装文件,升级时就不需要触动 settings.xml 文件。
6.1 settings.xml 配置详解
<?xml version="1.0" encoding="UTF-8"?>
<settings 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/settings-1.0.0.xsd">
<!--本地仓库。该值表示构建系统本地仓库的路径。其默认值为${user.home}/.m2/repository。 -->
<localRepository>usr/local/maven</localRepository>
<!--Maven是否需要和用户交互以获得输入。如果Maven需要和用户交互以获得输入,则设置成true,反之则应为false。默认为true。 -->
<interactiveMode>true</interactiveMode>
<!--Maven是否需要使用plugin-registry.xml文件来管理插件版本。 -->
<!--如果设置为true,则在{user.home}/.m2下需要有一个plugin-registry.xml来对plugin的版本进行管理 -->
<!--默认为false。 -->
<usePluginRegistry>false</usePluginRegistry>
<!--表示Maven是否需要在离线模式下运行。如果构建系统需要在离线模式下运行,则为true,默认为false。 -->
<!--当由于网络设置原因或者安全因素,构建服务器不能连接远程仓库的时候,该配置就十分有用。 -->
<offline>false</offline>
<!--当插件的组织Id(groupId)没有显式提供时,供搜寻插件组织Id(groupId)的列表。 -->
<!--该元素包含一个pluginGroup元素列表,每个子元素包含了一个组织Id(groupId)。 -->
<!--当我们使用某个插件,并且没有在命令行为其提供组织Id(groupId)的时候,Maven就会使用该列表。 -->
<!--默认情况下该列表包含了org.apache.maven.plugins。 -->
<pluginGroups>
<!--plugin的组织Id(groupId) -->
<pluginGroup>org.codehaus.mojo</pluginGroup>
</pluginGroups>
<!--用来配置不同的代理,多代理profiles可以应对笔记本或移动设备的工作环境:通过简单的设置profile id就可以很容易的更换整个代理配置。 -->
<proxies>
<!--代理元素包含配置代理时需要的信息 -->
<proxy>
<!--代理的唯一定义符,用来区分不同的代理元素。 -->
<id>myproxy</id>
<!--该代理是否是激活的那个。true则激活代理。当我们声明了一组代理,而某个时候只需要激活一个代理的时候,该元素就可以派上用处。 -->
<active>true</active>
<!--代理的协议。 协议://主机名:端口,分隔成离散的元素以方便配置。 -->
<protocol>http://…</protocol>
<!--代理的主机名。协议://主机名:端口,分隔成离散的元素以方便配置。 -->
<host>proxy.somewhere.com</host>
<!--代理的端口。协议://主机名:端口,分隔成离散的元素以方便配置。 -->
<port>8080</port>
<!--代理的用户名,用户名和密码表示代理服务器认证的登录名和密码。 -->
<username>proxyuser</username>
<!--代理的密码,用户名和密码表示代理服务器认证的登录名和密码。 -->
<password>somepassword</password>
<!--不该被代理的主机名列表。该列表的分隔符由代理服务器指定;例子中使用了竖线分隔符,使用逗号分隔也很常见。 -->
<nonProxyHosts>*.google.com|ibiblio.org</nonProxyHosts>
</proxy>
</proxies>
<!--配置服务端的一些设置。一些设置如安全证书不应该和pom.xml一起分发。这种类型的信息应该存在于构建服务器上的settings.xml文件中。 -->
<servers>
<!--服务器元素包含配置服务器时需要的信息 -->
<server>
<!--这是server的id(注意不是用户登陆的id),该id与distributionManagement中repository元素的id相匹配。 -->
<id>server001</id>
<!--鉴权用户名。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。 -->
<username>my_login</username>
<!--鉴权密码 。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。 -->
<password>my_password</password>
<!--鉴权时使用的私钥位置。和前两个元素类似,私钥位置和私钥密码指定了一个私钥的路径(默认是/home/hudson/.ssh/id_dsa)以及如果需要的话,一个密钥 -->
<!--将来passphrase和password元素可能会被提取到外部,但目前它们必须在settings.xml文件以纯文本的形式声明。 -->
<privateKey>${usr.home}/.ssh/id_dsa</privateKey>
<!--鉴权时使用的私钥密码。 -->
<passphrase>some_passphrase</passphrase>
<!--文件被创建时的权限。如果在部署的时候会创建一个仓库文件或者目录,这时候就可以使用权限(permission)。-->
<!--这两个元素合法的值是一个三位数字,其对应了unix文件系统的权限,如664,或者775。 -->
<filePermissions>664</filePermissions>
<!--目录被创建时的权限。 -->
<directoryPermissions>775</directoryPermissions>
<!--传输层额外的配置项 -->
<configuration></configuration>
</server>
</servers>
<!--为仓库列表配置的下载镜像列表。 -->
<mirrors>
<!--给定仓库的下载镜像。 -->
<mirror>
<!--该镜像的唯一标识符。id用来区分不同的mirror元素。 -->
<id>planetmirror.com</id>
<!--镜像名称 -->
<name>PlanetMirror Australia</name>
<!--该镜像的URL。构建系统会优先考虑使用该URL,而非使用默认的服务器URL。 -->
<url>http://downloads.planetmirror.com/pub/maven2</url>
<!--被镜像的服务器的id。例如,如果我们要设置了一个Maven中央仓库(http://repo1.maven.org/maven2)的镜像,-->
<!--就需要将该元素设置成central。这必须和中央仓库的id central完全一致。 -->
<mirrorOf>central</mirrorOf>
</mirror>
</mirrors>
<!--根据环境参数来调整构建配置的列表。settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。-->
<!--它包含了id,activation, repositories, pluginRepositories和 properties元素。-->
<!--这里的profile元素只包含这五个子元素是因为这里只关心构建系统这个整体(这正是settings.xml文件的角色定位),而非单独的项目对象模型设置。-->
<!--如果一个settings中的profile被激活,它的值会覆盖任何其它定义在POM中或者profile.xml中的带有相同id的profile。 -->
<profiles>
<!--根据环境参数来调整的构件的配置 -->
<profile>
<!--该配置的唯一标识符。 -->
<id>test</id>
<!--自动触发profile的条件逻辑。Activation是profile的开启钥匙。-->
<!--如POM中的profile一样,profile的力量来自于它能够在某些特定的环境中自动使用某些特定的值;这些环境通过activation元素指定。-->
<!--activation元素并不是激活profile的唯一方式。settings.xml文件中的activeProfile元素可以包含profile的id。-->
<!--profile也可以通过在命令行,使用-P标记和逗号分隔的列表来显式的激活(如,-P test)。 -->
<activation>
<!--profile默认是否激活的标识 -->
<activeByDefault>false</activeByDefault>
<!--activation有一个内建的java版本检测,如果检测到jdk版本与期待的一样,profile被激活。 -->
<jdk>1.7</jdk>
<!--当匹配的操作系统属性被检测到,profile被激活。os元素可以定义一些操作系统相关的属性。 -->
<os>
<!--激活profile的操作系统的名字 -->
<name>Windows XP</name>
<!--激活profile的操作系统所属家族(如 'windows') -->
<family>Windows</family>
<!--激活profile的操作系统体系结构 -->
<arch>x86</arch>
<!--激活profile的操作系统版本 -->
<version>5.1.2600</version>
</os>
<!--如果Maven检测到某一个属性(其值可以在POM中通过${名称}引用),其拥有对应的名称和值,Profile就会被激活。-->
<!--如果值字段是空的,那么存在属性名称字段就会激活profile,否则按区分大小写方式匹配属性值字段 -->
<property>
<!--激活profile的属性的名称 -->
<name>mavenVersion</name>
<!--激活profile的属性的值 -->
<value>2.0.3</value>
</property>
<!--提供一个文件名,通过检测该文件的存在或不存在来激活profile。missing检查文件是否存在,如果不存在则激活profile。-->
<!--另一方面,exists则会检查文件是否存在,如果存在则激活profile。 -->
<file>
<!--如果指定的文件存在,则激活profile。 -->
<exists>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</exists>
<!--如果指定的文件不存在,则激活profile。 -->
<missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</missing>
</file>
</activation>
<!--对应profile的扩展属性列表。Maven属性和Ant中的属性一样,可以用来存放一些值。这些值可以在POM中的任何地方使用标记${X}来使用,这里X是指属性的名称。-->
<!--属性有五种不同的形式,并且都能在settings.xml文件中访问。 -->
<!--1. env.X: 在一个变量前加上"env."的前缀,会返回一个shell环境变量。例如,"env.PATH"指代了$path环境变量(在Windows上是%PATH%)。 -->
<!--2. project.x:指代了POM中对应的元素值。 -->
<!--3. settings.x: 指代了settings.xml中对应元素的值。 -->
<!--4. Java System Properties: 所有可通过java.lang.System.getProperties()访问的属性都能在POM中使用该形式访问, -->
<!-- 如/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0/jre。 -->
<!--5. x: 在<properties/>元素中,或者外部文件中设置,以${someVar}的形式使用。 -->
<properties>
<!-- 如果这个profile被激活,那么属性${user.install}就可以被访问了 -->
<user.install>usr/local/winner/jobs/maven-guide</user.install>
</properties>
<!--远程仓库列表,它是Maven用来填充构建系统本地仓库所使用的一组远程项目。 -->
<repositories>
<!--包含需要连接到远程仓库的信息 -->
<repository>
<!--远程仓库唯一标识 -->
<id>codehausSnapshots</id>
<!--远程仓库名称 -->
<name>Codehaus Snapshots</name>
<!--如何处理远程仓库里发布版本的下载 -->
<releases>
<!--true或者false表示该仓库是否为下载某种类型构件(发布版,快照版)开启。 -->
<enabled>false</enabled>
<!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。这里的选项是:-->
<!--always(一直),daily(默认,每日),interval:X(这里X是以分钟为单位的时间间隔),或者never(从不)。 -->
<updatePolicy>always</updatePolicy>
<!--当Maven验证构件校验文件失败时该怎么做:-->
<!--ignore(忽略),fail(失败),或者warn(警告)。 -->
<checksumPolicy>warn</checksumPolicy>
</releases>
<!--如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置,POM就可以在每个单独的仓库中,为每种类型的构件采取不同的策略。-->
<!--例如,可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 -->
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
</snapshots>
<!--远程仓库URL,按protocol://hostname/path形式 -->
<url>http://snapshots.maven.codehaus.org/maven2</url>
<!--用于定位和排序构件的仓库布局类型-可以是default(默认)或者legacy(遗留)。-->
<!--Maven 2为其仓库提供了一个默认的布局;然而,Maven 1.x有一种不同的布局。我们可以使用该元素指定布局是default(默认)还是legacy(遗留)。 -->
<layout>default</layout>
</repository>
</repositories>
<!--发现插件的远程仓库列表。仓库是两种主要构件的家。第一种构件被用作其它构件的依赖。这是中央仓库中存储的大部分构件类型。另外一种构件类型是插件。-->
<!--Maven插件是一种特殊类型的构件。由于这个原因,插件仓库独立于其它仓库。pluginRepositories元素的结构和repositories元素的结构类似。-->
<!--每个pluginRepository元素指定一个Maven可以用来寻找新插件的远程地址。 -->
<pluginRepositories>
<!--包含需要连接到远程插件仓库的信息.参见profiles/profile/repositories/repository元素的说明 -->
<pluginRepository>
<releases>
<enabled />
<updatePolicy />
<checksumPolicy />
</releases>
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
</snapshots>
<id />
<name />
<url />
<layout />
</pluginRepository>
</pluginRepositories>
<!--手动激活profiles的列表,按照profile被应用的顺序定义activeProfile。 该元素包含了一组activeProfile元素,每个activeProfile都含有一个profile id。-->
<!--任何在activeProfile中定义的profile id,不论环境设置如何,其对应的 profile都会被激活。-->
<!--如果没有匹配的profile,则什么都不会发生。例如,env-test是一个activeProfile,则在pom.xml(或者profile.xml)中对应id的profile会被激活。-->
<!--如果运行过程中找不到这样一个profile,Maven则会像往常一样运行。 -->
<activeProfiles>
<activeProfile>env-test</activeProfile>
</activeProfiles>
</profile>
</profiles>
</settings>
七、Maven 生命周期及常用命令
7.1 Maven 生命周期
使用 Maven 完成项目的构建,项目构建包括:清理,编译,部署等过程,Maven 将这些过程规范为一个生命周期,如下所示是生命周期的各阶段。
Maven 有三套相互独立的生命周期,请注意这里说的是“三套”,而且“相互独立”,初学者容易将 Maven 的生命周期看成一个整体,其实不然。这三套生命周期分别是:
- Clean Lifecycle :在进行真正的构建之前进行一些清理工作。
- pre-clean 执行一些需要在clean之前完成的工作
- clean 移除所有上一次构建生成的文件
- post-clean 执行一些需要在clean之后立刻完成的工作
- Default Lifecycle :构建的核心部分,编译,测试,打包,部署等等。
- validate
- generate-sources
- process-sources
- generate-resources
- process-resources 复制并处理资源文件,至目标目录,准备打包
- compile 编译项目的源代码
- process-classes
- generate-test-sources
- process-test-sources
- generate-test-resources
- process-test-resources 复制并处理资源文件,至目标测试目录
- test-compile 编译测试源代码
- process-test-classes
- test 使用合适的单元测试框架运行测试。这些测试代码不会被打包或部署
- prepare-package
- package 接受编译好的代码,打包成可发布的格式,如 JAR
- pre-integration-test
- integration-test
- post-integration-test
- verify
- install 将包安装至本地仓库,以让其它项目依赖。
- deploy 将最终的包复制到远程的仓库,以让其它开发人员与项目共享
- Site Lifecycle :生成项目报告,站点,发布站点。
- pre-site 执行一些需要在生成站点文档之前完成的工作
- site 生成项目的站点文档
- post-site 执行一些需要在生成站点文档之后完成的工作,并且为部署做准备
- site-deploy 将生成的站点文档部署到特定的服务器上
7.2 Maven 常用命令
Maven 通过执行一些简单命令即可实现上边生命周期的各各过程。
序号 | 命令 | 解释 | 备注 |
---|---|---|---|
1 | mvn -v | 查看maven版本 | |
2 | mvn archetype:generate | 创建项目目录骨架 | |
3 | mvn help:system | 显示平台详细信息的列表 | 详细参考 |
4 | mvn clean | 清理项目 | 会删除 target 目录,但是已经 install到仓库里的包不会删除 |
5 | mvn compile | 编译主程序 | 只编译 main 目录,不编译 test 目录;编译主程序之后生成的 .class 字节码文件保存在 target/classes 目录中 |
6 | mvn test-compile | 编译测试程序 | 只编译 test 目录,不编译 main 目录;编译测试程序之后生成的 .class 字节码文件保存在 target/classes 目录中 |
7 | mvn test | 执行测试 | 自动编译,然后测试;生成一个 surefire- reports 目录,保存测试结果 |
8 | mvn package | 打包主程序 | 自动编译、测试,然后打包 |
9 | mvn install | 安装主程序 | 自动编译、测试、打包,然后按照本工程的坐标保存到本地仓库中 |
10 | mvn deploy | 部署主程序 | 自动编译、测试、打包,按照本工程的坐标保存到本地仓库中,并且还会保存到私服中。还会自动把项目部署到web容器中 |
11 | mvn site | 生成站点目录 |
- 执行 Maven 命令必须进入到 pom.xml 的目录中进行执行。
- 组合命令,例如:mvn clean package:先删除以前的编译结果,然后重新进行编译、测试、打包。
八、Maven 项目的创建与执行(命令行方式)
实际工作中,很少会直接通过 Maven 命令行来创建 Maven 项目。通常都是在 Eclipse 或者 IDEA 中,通过集成 Maven 的方式来创建 Java 项目。
步骤一: 新建一个文件夹 test
,用于存放项目。
步骤二: 执行命令,创建 Maven 项目。
在刚刚创建的 test
文件夹目录下打开命令行,运行如下命令(注意有空格间隔):
mvn archetype:generate -DgroupId=com.aaa -DartifactId=myproject -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
mvn archetype:generate
:表示创建个项目
-DgroupId
:项目包名: com.aaa
-DartifactId
:项目名称: myproject
-DarchetypeArtifactId
:项目类型: maven-archetype-quickstart
-DinteractiveMode:false
:表示前面参数都给了,就不用一个一个地输入了
注:如果是第一次执行时间会稍长,命令行会输出很多内容,提示下载了很多 jar 包到本地仓库,属正常情况。
步骤三: 查看 Maven 项目结构
如图所示, 通过运行 mvn archetype:generate
命令会创建一个标准结构的 Maven 项目,还自动生成一个App.java。里面输出了一个Hello World!
- src/main/java:Java 项目的源代码目录;
- src/test/java:Java 项目的测试代码目录,测试用例存储的位置;
- pom.xml:即 project object model 的首字母缩写,是 Maven 的项目配置文件,也是 Maven 工具的核心。
App.java 代码如下:
package com.aaa;
/**
* Hello world!
*
*/
public class App
{
public static void main( String[] args )
{
System.out.println( "Hello World!" );
}
}
步骤四: 运行 mvn package
打包命令
注意:要在项目路径下运行该命令
- 从输出可以发现,运行
mvn package
命令后,Maven 会自动先执行编译(compile),再执行测试(test),最后才执行打包(package)。在这些步骤都通过后,便会在 target 目录下生成 jar 包。
项目目录下多了一个 target 目录。
target 目录下有一个 myproject-1.0-SNAPSHOT.jar
包,就是程序最终打成的 jar 包。
步骤五: 执行 jar
在 target 目录下启动命令行,运行 java -cp myproject-1.0-SNAPSHOT.jar com.aaa.App
命令,成功输出。
java -jar
和java -cp
详解:https://zhuanlan.zhihu.com/p/214093661
九、Maven 的 pom.xml 文件介绍
- pom: Project Object Model,项目对象模型。通过xml可扩展标记语言(EXtensible Markup Language)格式保存的 pom.xml 文件。
- 作用:该文件用于管理源代码、配置文件、开发者的信息和角色、问题追踪系统、组织信息、项目授权、项目的url、项目的依赖关系等等。
- 位置:pom.xml 放置在项目的根目录下。
- Maven 命令执行时,真正完成功能的是插件;插件就是一些 jar 文件,一些类;在 pom.xml 文件中进行配置。
Spring Boot 工程 pom.xml 文件配置示例:
<?xml version="1.0" encoding="UTF-8"?>
<!-- xml的版本和编码-->
<!-- xml 可扩展标记语言(EXtensible Markup Language)-->
<!-- xml 被设计用来传输和存储数据 html 被设计用来显示数据-->
<!-- xmlns-命名空间,类似包名,因为xml的标签可以自定义,所以需要命名空间来区分-->
<!-- xmlns:xsi-xml遵循的标签规范-->
<!-- xsi:schemaLocation-用来定义xmlschema的地址,也就是xml书写时需要遵循的语法,
两部分组成,前面部分就是命名空间的名字,后面是xsd(xmlschema)的地址-->
<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">
<!-- pom作为项目对象模型。通过xml表示maven项目,使用pom.xml来实现。
主要描述了项目:包括配置文件;开发者需要遵循的规则,缺陷管理系统,
组织和licenses,项目的url,项目的依赖性,以及其他所有的项目相关因素。-->
<!-- pom模型的版本-->
<modelVersion>4.0.0</modelVersion>
<!-- 父级项目,parent的引用是固定的-->
<!-- 当我们创建一个 Spring Boot 工程时,可以继承自一个 spring-boot-starter-parent-->
<!-- 父项目中定义了依赖的版本,我们继承了它,所以依赖dependence可以不写版本号,
若不用父项目中的版本号则自己用<version>标签指定-->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.0</version>
<relativePath/>
<!-- lookup parent from repository(从存储库中查找父级项目) -->
</parent>
<!-- 本项目的一些信息-->
<!-- groupId是项目的唯一标识-->
<groupId>com.upc.pipeline</groupId>
<!-- 项目的名称-->
<artifactId>pdfs</artifactId>
<!-- 版本-->
<version>0.0.1-SNAPSHOT</version>
<!-- 项目的名称,Maven产生的文档用-->
<name>pdfs</name>
<!-- 项目的描述,Maven产生的文档用-->
<description>Demo project for Spring Boot</description>
<!-- 一些属性的设置-->
<properties>
<!-- JDK的版本-->
<java.version>1.8</java.version>
</properties>
<!-- <groupId>-主要用来唯一标识一个项目或者一组项目,通常是java包名的全称,例如上面的com.upc.pipeline-->
<!-- <artifactId>-用来标识同一groupId下不同的项目,例如spring-boot-starter-thymeleaf,都是这种格式的-->
<!-- <version>-用来标识一个artifact的版本,格式有8.0.21 0.0.1-SNAPSHOT 等-->
<!-- <scope>-用来表示当前的这个依赖(通过pom加载进来的包)所作用的场景,就是说应该把它添加到哪个环境当中,例如只在测试时此jar包生效,
取值主要有compile-编译时(若未指定则为该默认值) runtime-运行时 test-测试时 等 -->
<!-- <optional>-标记依赖是否可以传递,默认值是false,可以用来减少项目之间jar包的冲突-->
<!-- 依赖关系-->
<dependencies>
<!-- 支持Thymeleaf模板引擎,包括与Spring的集成。使用模板thymeleaf,Thymeleaf是一个java类库,他是一个xml/xhtml/html5的模板引擎,可以作为mvc的web应用的view层-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!-- 支持全栈式Web开发,包括Tomcat和spring-webmvc-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mysql数据库的连接-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.21</version>
<scope>runtime</scope>
</dependency>
<!-- JDBC驱动,支持JDBC数据库-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!-- lombok能通过注解帮我们消除那些必须要写但是重复的代码,比如setter,getter,构造函数之类的方法-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!-- 单元测试-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- 类似一个中间件,链接Spring Boot和MyBatis,构建基于Spring Boot的MyBatis应用程序-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.4</version>
</dependency>
<!-- Mybatis分页插件-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>4.1.0</version>
</dependency>
<!-- JSON包,因为后端业务中用到了将对象数组转换为JSON格式的数据-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.38</version>
</dependency>
<!-- springboot devtools 的主要作用是热部署,引入devtools,这样每次在保存代码的时候都会自动重新加载-->
<!-- 所谓热部署,就是在应用正在运行的时候升级软件,却不需要重新启动应用,在运行时更新Java类文件-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
<scope>runtime</scope>
</dependency>
</dependencies>
<!-- <configuration>-指定插件配置-->
<!-- <excludes>-指定哪些文件将被忽略-->
<!-- <plugins>-用于指定使用的插件-->
<!-- 编译-->
<build>
<!-- 一些插件-->
<plugins>
<!-- Maven插件-->
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>
详细参考:
十、Maven 常见报错及处理
报错一:执行 mvn archetype:generate
命令报错
报错展示:
分析:报错提示已经很清楚了,可以看到是 Maven 的 settings.xml 配置文件的问题,问题具体出现在56行20列,这句话的大概意思是在两个短横线 --
后面必须是 >
,而不应该是 z
,注释语法有问题。
定位错误:
修改为:
通过该问题的处理思路,我们可以意识到,类似的 Maven 报错问题可以通过阅读错误提示尝试解决。
报错二:执行 mvn package
命令报错
报错展示:不再支持源选项 5。请使用 7 或更高版本。
分析:这是由于 Maven 默认使用的 jdk 版本过低导致的,可以通过配置自定义 Maven 使用的 jdk 版本来解决。
修改:在 Maven 配置文件 settings.xml 文件中配置运行 Maven 的 jdk 版本,在 <profiles>如下代码</profiles>
标签中添加如下代码:
<profiles>
<profile>
<id>jdk-17</id>
<activation>
<activeByDefault>true</activeByDefault>
<jdk>17</jdk>
</activation>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<maven.compiler.compilerVersion>17</maven.compiler.compilerVersion>
</properties>
</profile>
</profiles>
十一、Eclipse Maven
Eclipse 本身已经集成了 Maven,但是自带的 Maven 版本一般都比较低,难以满足开发要求,因此我们可以使用我们自己下载配置的 Maven 版本,只需要简单配置一下。
11.1 配置添加自己下载安装的 Maven
步骤一: 菜单栏依次选择 Windows -> Preference -> Maven -> Installations -> Add 。
步骤二: 选择自己下载配置的 Maven。
步骤三: 选择自己下载配置的 Maven,添加进来。
步骤四: 勾选添加进来的 Maven,并应用。
步骤五: 选择Global Settings 和 User Settings,更新本地仓库路径。
11.2 使用 Eclipse 新建 Maven 工程
步骤一: 菜单依次选择 File-> New -> Other -> Maven -> Maven Project ,点击进行下一步。
步骤二: 勾选上 Create a simple project ,点击进行下一步。
步骤三: 填写要新建的项目信息 ,点击完成。
步骤四: 新建完成 ,项目目录结构如下。
结尾
通过本文的学习,相信你已经大体了解了 Maven 有什么用,以及该如何去使用它。如果你在本文中发现有什么不对的地方,也请即使与笔者取得联系。
参考一:https://www.cnblogs.com/wang-meng/p/11887337.html
参考二:https://blog.csdn.net/qq_37006625/article/details/123433264
参考三:https://how2j.cn/k/maven/maven-eclipse-setting/1335.html
参考四:https://www.runoob.com/maven/maven-eclipse.html
参考五:https://www.cnblogs.com/hzg110/p/6936101.html
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 无需6万激活码!GitHub神秘组织3小时极速复刻Manus,手把手教你使用OpenManus搭建本
· C#/.NET/.NET Core优秀项目和框架2025年2月简报
· 葡萄城 AI 搜索升级:DeepSeek 加持,客户体验更智能
· 什么是nginx的强缓存和协商缓存
· 一文读懂知识蒸馏