Maven的理解和使用
1:没有Maven之前我们是如何管理项目依赖的?
如果项目A需要用到项目B某些类,这时候该怎么做?我们会将B打成jar包,然后在A项目的Library(本地仓库)下导入B的jar文件,这样,A项目就可以调用B项目中的某些类了。
这样做几种缺陷:
1.如果在开发过程中,发现B中的bug,则必须将B项目修改好,并重新将B打包并对A项目进行重编译操作。
2.在完成A项目的开发后,为了保证A的正常运行,就需要依赖B(就像在使用某个jar包时必须依赖另外一个jar一样),两种解决方案,第一种,选择将B打包入A中,第二种,将B也发布出去,等别人需要用A时,告诉开发者,想要用A就必须在导入Bjar包。两个都很麻烦,前者可能造成资源的浪费(比如,开发者可能正在开发依赖B的其它项目,B已经存储到本地了,在导入A的jar包的话,就有了两个B的jar),后者是我们常遇到的,找各种jar包,非常麻烦(有了maven就不一样了)
3.我们开发一个项目,或者做一个小demo,比如用SSH框架,那么我们就必须将SSH框架所用的几十个依赖的jar包依次找出来并手动导入,超级繁琐。
上面两个问题的描述,其实都属于项目与项目之间依赖的问题[A项目使用SSH的所有jar,就说A项目依赖SSH],人为手动的去解决,很繁琐,也不方便,所以使用maven来帮我们管理
2.什么是Maven项目?
Maven是基于项目对象模型(POM project object model),可以通过一小段描述信息(配置)来管理项目的构建,报告和文档的软件项目管理工具。(来源维基百科)
这种又是大白话,如果没明白maven是什么,那么上面这句话跟没说一样,我自己觉得,Maven的核心功能便是合理叙述项目间的依赖关系,通俗点讲,就是通过pom.xml文件的配置获取jar包,而不用手动去添加jar包,而这里pom.xml文件对于学了一点maven的人来说,就有些熟悉了,怎么通过pom.xml的配置就可以获取到jar包呢?pom.xml配置文件从何而来?等等类似问题我们需要搞清楚,如果需要使用pom.xml来获取jar包,那么首先该项目就必须为maven项目,maven项目可以这样去想,就是在java项目和web项目的上面包裹了一层maven,本质上java项目还是java项目,web项目还是web项目,但是包裹了maven之后,就可以使用maven提供的一些功能了(通过pom.xml添加jar包)。
1.pom.xml获取依赖的格式
pom.xml获取junit的jira包的编写。
2. 为什么通过groupId、artifactId、version三个属性就能定位一个jar包?
加入上面的pom.xml文件属于A项目,那么A项目肯定是一个maven项目,通过上面这三个属性能够找到junit对应版本的jar包,那么junit项目肯定也是一个maven项目,junit的maven项目中的pom.xml文件就会有三个标识符,比如像下图这样,然后别的maven项目就能通过这三个属性来找到junit项目的jar包了。所以,在每个创建的maven项目时都会要求写上这三个属性值的。
3.maven的安装
1.下载maven的二进制包
从http://maven.apache.org/download.cgi下载所需要的版本,并确认依赖的java环境版本
2.检查java环境是否正确
在CMD命令行中输入echo %JAVA_HOME%,查看JAVA_HOME是否配置。在CMD命令行中输入java -v,查看jdk是否正确安装。
从这里我们看到我们的java环境并没有进行配置,我们这里需要提前进行配置符合要求的java环境。这里可以参考其他文章,我们这里就不做演示了。
3.解压下载好的maven的压缩包到指定目录下
解压后的文件目录如下
4.配置环境变量
新建系统变量
配置系统变量(添加环境变量)
5.测试
出现下面的界面就代表maven安装配置成功
4.仓库的概念
通过pom.xml中的配置,就能够获取到想要的jar包(还没讲解如何配置先需要了解一下仓库的概念),但是这些jar是在哪里呢?就是我们从哪里获取到的这些jar包?答案就是仓库。
仓库分为:本地仓库、第三方仓库(私服)、中央仓库
1.本地仓库
Maven会将工程中依赖的构件(Jar包)从远程下载到本机一个目录下管理,每个电脑默认的仓库是在 $user.home/.m2/repository下
一般我们会修改本地仓库位置,自己创建一个文件夹,在从网上下载一个拥有相对完整的所有jar包的结合,都丢到本地仓库中,然后每次写项目,直接从本地仓库里拿就行了
修改本地库位置:在$MAVEN_HOME/conf/setting.xml文件中修改,
D:\java\maven\repository:就是我们自己创建的本地仓库,将网上下载的所有jar包,都丢到该目录下,我们就可以直接通过maven的pom.xml文件直接拿。
2.第三方仓库
第三方仓库,又称为内部中心仓库,也称为私服
私服:一般是由公司自己设立的,只为本公司内部共享使用。它既可以作为公司内部构件协作和存档,也可作为公用类库镜像缓存,减少在外部访问和下载的频率。(使用私服为了减少对中央仓库的访问
私服可以使用的是局域网,中央仓库必须使用外网
也就是一般公司都会创建这种第三方仓库,保证项目开发时,项目所需用的jar都从该仓库中拿,每个人的版本就都一样。
注意:连接私服,需要单独配置。如果没有配置私服,默认不使用
3.中央仓库
Maven内置了远程公用仓库:http://repo1.maven.org/maven2
这个公共仓库是由Maven自己维护,里面有大量的常用类库,并包含了世界上大部分流行的开源项目构件。目前是以java为主
工程依赖的jar包如果本地仓库没有,默认从中央仓库下载
4.总结(获取jar包的过程)
5.使用命令行管理maven项目
1.创建maven java项目
自己创建一个文件夹,在该文件夹下按shift+右击,点开使用命令行模式,这样创建的maven[java]项目就在该文件夹下了。
命令: mvn archetype:generate -DgroupId=com.wuhao.maven.quickstart -DartifactId=simple -DarchetypeArtifactId=maven-archetype-quickstart
mvn:核心命令
archetype:generate:创建项目,现在maven在3.0.5版本之后废弃了create命令而使用generate命令了。
-DgroupId=com.wuhao.maven.quickstart :创建该maven项目时的groupId是什么,该作用在上面已经解释了。一般使用包名的写法。因为包名是用公司的域名的反写,独一无二
-DartifactId=simple:创建该maven项目时的artifactId是什么,就是项目名称
-DarchetypeArtifactId=maven-archetype-quickstart:表示创建的是[maven]java项目
运行成功后
在D:\java\maven\demo下就会生成一个simple的文件,该文件就是我们的maven java项目
2.maven java项目结构
simple
---pom.xml 核心配置,项目根下
---src
---main
---java java源码目录
---resources java配置文件目录
---test
---java 测试源码目录
---resources 测试配置目录
图中有一个target目录,是因为将该java项目进行了编译,src/main/java下的源代码就会编译成.class文件放入target目录中,target就是输出目录。
3.创建maven web项目
命令:mvn archetype:generate -DgroupId=com.wuhao.maven.quickstart -DartifactId=myWebApp -DarchetypeArtifactId=maven-archetype-webapp -Dversion=0.0.1-snapshot
其他都差不多,创建maven web项目的话 -DarchetypeArtifactId=maven-archetype-webapp 比创建java项目多了一个 -Dversion=0.01-snapshot, 在创建java项目的时候也可以加上这个,如果不写,会默认帮我们加上1.0-snapshot。
在D:\java\maven\demo下就会生成一个myWebApp的文件
4.maven web项目结构
pom.xml 核心配置
src/main/java java源码
src/main/resources java配置
src/main/webapp myeclipse web项目中 WebRoot目录
|-- WEB-INF
|-- web.xml
src/test 测试
target 输出目录
5.命令操作maven java或web项目
编译:mvn compile --src/main/java目录java源码编译生成class (target目录下)
测试:mvn test --src/test/java 目录编译
清理:mvn clean --删除target目录,也就是将class文件等删除
打包:mvn package --生成压缩文件:java项目#jar包;web项目#war包,也是放在target目录下
安装:mvn install --将压缩文件(jar或者war)上传到本地仓库
部署|发布:mvn deploy --将压缩文件上传私服
6.例子:使用命令操作maven java项目
注意:使用命令时,必须在maven java项目的根目录下,及可以看到pom.xml
描述:将maven java项目打包上传到本地仓库供别人调用
使用 mvn install
在本地仓库中查看是否有该项目
D:\java\maven\repository\com\wuhao\maven\quickstart\simple\1.0-SNAPSHOT
通过在本地仓库中的目录可以发现为什么通过groupId、artifactId、version可以定位到仓库中得jar包,也可以知道为什么groupId要使用公司域名的反写(因为这样唯一,不会与别的项目重名导致查找到的内容不精确)
7.maven项目的完整生命周期,当执行生命周期后面命令时,前面步骤的命令自动执行
红色标记字体的意思就是当我们直接使用mvn install命令对项目进行上传至本地仓库时,那么前面所有的步骤将会自动执行,比如源代码的编译,打包等等。
8.其他命令
maven java或web项目转换Eclipse工程
mvn eclipse:eclipse
mvn eclipse:clean 清楚eclipse设置信息,又从eclipse工程转换为maven原生项目了
...转换IDEA工程
mvn idea:idea
mvn idea:clean 同上
6.pom.xml的依赖关系讲解(重点)
之前一直在使用pom.xml中找jar包最关键的三个属性,groupId、artifactId、version,应该有些印象了,也知道为什么通过这三个能找到对应的jar包,但是没有细讲其中的一些小的知识点,比如出现的一些属性就不太懂,所以,这一章节,就将依赖关系全面分析。
1.如何获取坐标(也就是三个关键属性值)
方式1:使用网站搜索[从中央仓库拿]
步骤一:百度搜索关键字“maven repository”
步骤二:输入关键字查询获得需要内容,确定需要版本
步骤三、获得坐标
方式2、使用本地仓库,通过myeclipse获得坐标
上面已经介绍过了如何从本地仓库获取对应jar,这里在简单阐述一下
步骤一:添加依赖,pom.xml文件中,右键
步骤二:获得坐标
2.依赖(坐标)的常见配置
为了避免不知道说的哪些配置属性,看下面图就明白了,就是dependency下的属性配置,全部有9个,讲其中的7个。
groupId、artifactId、version是依赖的基本坐标,缺一不可,这三个可以不用将,都知道,重要的是除了这三个之外的配置属性需要我们理解
type:依赖的类型,比如是jar包还是war包等
默认为jar,表示依赖的jar包
注意:<type>pom.lastUpdated</type> 这个我们在上面添加servlet-jar的时候就遇到过,看到lastUpdated的意思是表示使用更新描述信息,占位符作用,通俗点讲,选择该类型,jar包不会被加载进来,只是将该jar包的一些描述信息加载进来,使别的jar包在引用他时,能够看到一些相关的提示信息,仅此而已,所以说他是个占位符,只要记住他的jar包不会被加载进来。
optional:标记依赖是否可选。默认值false
比如struts2中内置了log4j这个记录日志的功能,就是将log4j内嵌入struts2的jar包中,而struts2有没有log4j这个东西都没关系,有它,提示的信息更多,没它,也能够运行,只是提示的信息就相对而言少一些,所以这个时候,就可以对它进行可选操作,想要它就要,不想要,就设置为false。
exclusions:排除传递依赖,解决jar冲突问题
依赖传递的意思就是,A项目 依赖 B项目,B项目 依赖 C项目,当使用A项目时,就会把B也给加载进来,这是传递依赖,依次类推,C也会因此给加载进来。
这个有依赖传递有好处,也有坏处,坏处就是jar包的冲突问题,比如,A 依赖 B(B的版本为1),C 依赖 B(B的版本为2),如果一个项目同时需要A和C,那么A,C都会传递依赖将B给加载进来,问题就在这里,两个B的版本不一样,将两个都加载进去就会引起冲突,这时候就需要使用exclusions这个属性配置了。maven也会有一个机制避免两个都加载进去,maven 默认配置在前面的优先使用,但是我们还是需要使用exclusions来配置更合理,这里使用spring bean 和 struts2 spring plugin 来举例子说明这个问题并使用exclusions解决这个问题。(spring bean 和 struts2 spring plugin都需要依赖spring-core,但版本不一样)
从本地仓库中找到这两个jar包
maven自己的解决方案如下
maven 默认配置在前面的优先使用,下面是证明
先将spring-beans加载进去的,所以会将spring-beans依赖的spring-core的版本加载进来。
先将struts2-spring-plugin加载进来,那么就会将其依赖的spring-core的版本加载进来
使用exclusions来配置
即使struts2-spring-plugin 配置在前面,也需要使用3.2.0版本。则需要为struts2-spring-plugin 排除依赖(不使用3.0.5依赖)
注意:这样,就将struts2-spring-plugin依赖的spring-core的版本排除依赖了,也就是该依赖的spring-core不会在加载进来,查看代码,看是否符合要求,如果不符合要求,需要手动的修改
scope:依赖范围,意思就是通过pom.xml加载进来的jar包,来什么范围内使用生效,范围包括编译时,运行时,测试时
compile:默认值,如果选择此值,表示编译、测试和运行都使用当前jar
test:表示只在测试时当前jar生效,在别的范围内就不能使用该jar包。例如:junit 。此处不写也不报错,因为默认是compile,compile包扩了测试
runtime,表示测试和运行时使用当前jar,编译时不用该jar包。例如:JDBC驱动。JDBC驱动,在编译时(也就是我们写代码的时候都是采用接口编程,压根就没使用到JDBC驱动包内任何东西,只有在运行时才用的到,所以这个是典型的使用runtime这个值的例子),此处不写也不报错,理由同上
provided,表示编译和测试时使用当前jar,运行时不在使用该jar了。例如:servlet-api、jsp-api等。【必须填写】
什么意思呢? 在我们以前创建web工程,编写servlet或者jsp时,就没导入过jar包把,因为myeclipse或者别的ide帮我们提供了这两个jar包,内置了,所以我们在编译期测试期使用servlet都不会报缺少jar包的错误,而在运行时期,离开了myeclipse或别的ide,就相当于缺失了这两个jar包,但此时tomcat又会帮我们提供这两个jar,以便我们不会报错,所以,这两个很特殊。看图
1、开发阶段(MyEclipse提供),看下图以此证明我们说的
java web 5.0项目
java web 6.0项目
2、运行阶段(tomcat提供)
所以,根据这个特点,如果使用maven开发项目,就不是web项目了,那么myeclipse就不会在给我们提供这两个jar包,我们就必须自己手动通过坐标从仓库中获取,但是针对上面的分析,当运行的时候,tomcat会帮我们提供这两个jar包,所以我们自己从仓库中获取的jar包就不能和tomcat中的冲突,那么就正好可以通过provided这个属性,来设置这两个jar的作用范围,就是在变异时期和测试时期生效即可。
这个例子就可以解释上面创建maven web时产生的错误和解决方案了。
system:表示我们自己手动加入的jar包,不属于maven仓库(本地,第三方等),属于别得类库的这样的jar包,只在编译和测试期生效,运行时无效。一般不用
3.依赖调节原则
这个就是maven解决传递依赖时jar包冲突问题的方法,按照两种原则,上面已经介绍了一种了,就是下面的第二原则
1、第一原则:路径近者优先原则
A-->B-->C-->D-->X(1.6)
E-->D-->X(2.0)
使用X(2.0),因为其路径更近
2、第二原则:第一声明者优先原则。就是如果路径相同,maven 默认配置在前面的优先使用
A-->B --> X(1.6)
C-->D--> X(2.0)
这样就是路径相同,那么如果A在前面,C在后面,则使用X(1.6)
maven会先根据第一原则进行选择,第一原则不成,则按第二原则处理。
4.pom中作用域scope的作用和用法
举例如下:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
scope的值有以下几种可能,进行分情况讲解:
-
compile
默认就是compile,什么都不配置也就是意味着compile。compile表示被依赖项目需要参与当前项目的编译,当然后续的测试,运行周期也参与其中,是一个比较强的依赖。打包的时候通常需要包含进去。默认的scope,在部署的时候将会打包到lib目录下,项目在编译,测试,运行阶段都需要
-
test
scope为test表示依赖项目仅仅参与测试相关的工作,在编译和运行环境下都不会被使用,更别说打包了。
-
runntime
runntime这个scope,仅仅适用于运行环境,在编译和测试环境下都不会被使用
-
provided
provided适合在编译和测试的环境,他和compile很接近,但是provide仅仅需要在编译和测试阶段,同样provide将不会被打包到lib目录下。
-
system
从参与度来说,也provided相同,不过被依赖项不会从maven仓库抓,而是从本地文件系统拿,一定需要配合systemPath属性使用。
-
scope的依赖传递
A–>B–>C。当前项目为A,A依赖于B,B依赖于C。知道B在A项目中的scope,那么怎么知道C在A中的scope呢?答案是:
当C是test或者provided时,C直接被丢弃,A不依赖C;
否则A依赖C,C的scope继承于B的scope。
为什么需要区分这些scope
可以用来限制dependency的范围可以在不同的环境下打包不同的jar包,比如junit测试类的jar包不需要在编译运行的时候,就可以设置scope为test。
最后还有一个<optional>true</optional>是什么意思,怎么用的呢?
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
例如上面的例子,在SpringBoot官网文件中你可以得到解释就是,<optional>true</optional>的话,其他项目依赖此项目也不会进行传递,只能本项目使用。
5.总结
<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/maven-v4_0_0.xsd "> <!-- 父项目的坐标。如果项目中没有规定某个元素的值,那么父项目中的对应值即为项目的默认值。 坐标包括group ID,artifact ID和 version。 --> <parent> <!-- 被继承的父项目的构件标识符 --> <artifactId>xxx</artifactId> <!-- 被继承的父项目的全球唯一标识符 --> <groupId>xxx</groupId> <!-- 被继承的父项目的版本 --> <version>xxx</version> <!-- 父项目的pom.xml文件的相对路径。相对路径允许你选择一个不同的路径。默认值是../pom.xml。 Maven首先在构建当前项目的地方寻找父项目的pom,其次在文件系统的这个位置(relativePath位置), 然后在本地仓库,最后在远程仓库寻找父项目的pom。 --> <relativePath>xxx</relativePath> </parent> <!-- 声明项目描述符遵循哪一个POM模型版本。模型本身的版本很少改变,虽然如此,但它仍然是必不可少的, 这是为了当Maven引入了新的特性或者其他模型变更的时候,确保稳定性。 --> <modelVersion> 4.0.0 </modelVersion> <!-- 项目的全球唯一标识符,通常使用全限定的包名区分该项目和其他项目。并且构建时生成的路径也是由此生成, 如com.mycompany.app生成的相对路径为:/com/mycompany/app --> <groupId>xxx</groupId> <!-- 构件的标识符,它和group ID一起唯一标识一个构件。换句话说,你不能有两个不同的项目拥有同样的artifact ID 和groupID;在某个特定的group ID下,artifact ID也必须是唯一的。构件是项目产生的或使用的一个东西,Maven 为项目产生的构件包括:JARs,源码,二进制发布和WARs等。 --> <artifactId>xxx</artifactId> <!-- 项目产生的构件类型,例如jar、war、ear、pom。插件可以创建他们自己的构件类型,所以前面列的不是全部构件类型 --> <packaging> jar </packaging> <!-- 项目当前版本,格式为:主版本.次版本.增量版本-限定版本号 --> <version> 1.0-SNAPSHOT </version> <!-- 项目的名称, Maven产生的文档用 --> <name> xxx-maven </name> <!-- 项目主页的URL, Maven产生的文档用 --> <url> http://maven.apache.org </url> <!-- 项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时(例如,CDATA中的文本会被解析器忽略, 就可以包含HTML标签), 不鼓励使用纯文本描述。如果你需要修改产生的web站点的索引页面,你应该修改你自己的 索引页文件,而不是调整这里的文档。 --> <description> A maven project to study maven. </description> <!-- 描述了这个项目构建环境中的前提条件。 --> <prerequisites> <!-- 构建该项目或使用该插件所需要的Maven的最低版本 --> <maven></maven> </prerequisites> <!-- 项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL,本例为 jira --> <issueManagement> <!-- 问题管理系统(例如jira)的名字, --> <system> jira </system> <!-- 该项目使用的问题管理系统的URL --> <url> http://jira.baidu.com/banseon </url> </issueManagement> <!-- 项目持续集成信息 --> <ciManagement> <!-- 持续集成系统的名字,例如continuum --> <system></system> <!-- 该项目使用的持续集成系统的URL(如果持续集成系统有web接口的话)。 --> <url></url> <!-- 构建完成时,需要通知的开发者/用户的配置项。包括被通知者信息和通知条件(错误,失败,成功,警告) --> <notifiers> <!-- 配置一种方式,当构建中断时,以该方式通知用户/开发者 --> <notifier> <!-- 传送通知的途径 --> <type></type> <!-- 发生错误时是否通知 --> <sendOnError></sendOnError> <!-- 构建失败时是否通知 --> <sendOnFailure></sendOnFailure> <!-- 构建成功时是否通知 --> <sendOnSuccess></sendOnSuccess> <!-- 发生警告时是否通知 --> <sendOnWarning></sendOnWarning> <!-- 不赞成使用。通知发送到哪里 --> <address></address> <!-- 扩展配置项 --> <configuration></configuration> </notifier> </notifiers> </ciManagement> <!-- 项目创建年份,4位数字。当产生版权信息时需要使用这个值。 --> <inceptionYear /> <!-- 项目相关邮件列表信息 --> <mailingLists> <!-- 该元素描述了项目相关的所有邮件列表。自动产生的网站引用这些信息。 --> <mailingList> <!-- 邮件的名称 --> <name> Demo </name> <!-- 发送邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 --> <post> banseon@126.com </post> <!-- 订阅邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 --> <subscribe> banseon@126.com </subscribe> <!-- 取消订阅邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 --> <unsubscribe> banseon@126.com </unsubscribe> <!-- 你可以浏览邮件信息的URL --> <archive> http:/hi.baidu.com/banseon/demo/dev/ </archive> </mailingList> </mailingLists> <!-- 项目开发者列表 --> <developers> <!-- 某个项目开发者的信息 --> <developer> <!-- SCM里项目开发者的唯一标识符 --> <id> HELLO WORLD </id> <!-- 项目开发者的全名 --> <name> banseon </name> <!-- 项目开发者的email --> <email> banseon@126.com </email> <!-- 项目开发者的主页的URL --> <url></url> <!-- 项目开发者在项目中扮演的角色,角色元素描述了各种角色 --> <roles> <role> Project Manager </role> <role> Architect </role> </roles> <!-- 项目开发者所属组织 --> <organization> demo </organization> <!-- 项目开发者所属组织的URL --> <organizationUrl> http://hi.baidu.com/xxx </organizationUrl> <!-- 项目开发者属性,如即时消息如何处理等 --> <properties> <dept> No </dept> </properties> <!-- 项目开发者所在时区, -11到12范围内的整数。 --> <timezone> -5 </timezone> </developer> </developers> <!-- 项目的其他贡献者列表 --> <contributors> <!-- 项目的其他贡献者。参见developers/developer元素 --> <contributor> <!-- 项目贡献者的全名 --> <name></name> <!-- 项目贡献者的email --> <email></email> <!-- 项目贡献者的主页的URL --> <url></url> <!-- 项目贡献者所属组织 --> <organization></organization> <!-- 项目贡献者所属组织的URL --> <organizationUrl></organizationUrl> <!-- 项目贡献者在项目中扮演的角色,角色元素描述了各种角色 --> <roles> <role> Project Manager </role> <role> Architect </role> </roles> <!-- 项目贡献者所在时区, -11到12范围内的整数。 --> <timezone></timezone> <!-- 项目贡献者属性,如即时消息如何处理等 --> <properties> <dept> No </dept> </properties> </contributor> </contributors> <!-- 该元素描述了项目所有License列表。 应该只列出该项目的license列表,不要列出依赖项目的 license列表。 如果列出多个license,用户可以选择它们中的一个而不是接受所有license。 --> <licenses> <!-- 描述了项目的license,用于生成项目的web站点的license页面,其他一些报表和validation也会用到该元素。 --> <license> <!-- license用于法律上的名称 --> <name> Apache 2 </name> <!-- 官方的license正文页面的URL --> <url> http://www.baidu.com/banseon/LICENSE-2.0.txt </url> <!-- 项目分发的主要方式: repo,可以从Maven库下载 manual, 用户必须手动下载和安装依赖 --> <distribution> repo </distribution> <!-- 关于license的补充信息 --> <comments> A business-friendly OSS license </comments> </license> </licenses> <!-- SCM(Source Control Management)标签允许你配置你的代码库,供Maven web站点和其它插件使用。 --> <scm> <!-- SCM的URL,该URL描述了版本库和如何连接到版本库。欲知详情,请看SCMs提供的URL格式和列表。该连接只读。 --> <connection> scm:svn:http://svn.baidu.com/banseon/maven/banseon/banseon-maven2-trunk(dao-trunk) </connection> <!-- 给开发者使用的,类似connection元素。即该连接不仅仅只读 --> <developerConnection> scm:svn:http://svn.baidu.com/banseon/maven/banseon/dao-trunk </developerConnection> <!-- 当前代码的标签,在开发阶段默认为HEAD --> <tag></tag> <!-- 指向项目的可浏览SCM库(例如ViewVC或者Fisheye)的URL。 --> <url> http://svn.baidu.com/banseon </url> </scm> <!-- 描述项目所属组织的各种属性。Maven产生的文档用 --> <organization> <!-- 组织的全名 --> <name> demo </name> <!-- 组织主页的URL --> <url> http://www.baidu.com/banseon </url> </organization> <!-- 构建项目需要的信息 --> <build> <!-- 该元素设置了项目源码目录,当构建项目的时候,构建系统会编译目录里的源码。该路径是相对 于pom.xml的相对路径。 --> <sourceDirectory></sourceDirectory> <!-- 该元素设置了项目脚本源码目录,该目录和源码目录不同:绝大多数情况下,该目录下的内容会 被拷贝到输出目录(因为脚本是被解释的,而不是被编译的)。 --> <scriptSourceDirectory></scriptSourceDirectory> <!-- 该元素设置了项目单元测试使用的源码目录,当测试项目的时候,构建系统会编译目录里的源码。 该路径是相对于pom.xml的相对路径。 --> <testSourceDirectory></testSourceDirectory> <!-- 被编译过的应用程序class文件存放的目录。 --> <outputDirectory></outputDirectory> <!-- 被编译过的测试class文件存放的目录。 --> <testOutputDirectory></testOutputDirectory> <!-- 使用来自该项目的一系列构建扩展 --> <extensions> <!-- 描述使用到的构建扩展。 --> <extension> <!-- 构建扩展的groupId --> <groupId></groupId> <!-- 构建扩展的artifactId --> <artifactId></artifactId> <!-- 构建扩展的版本 --> <version></version> </extension> </extensions> <!-- 当项目没有规定目标(Maven2 叫做阶段)时的默认值 --> <defaultGoal></defaultGoal> <!-- 这个元素描述了项目相关的所有资源路径列表,例如和项目相关的属性文件,这些资源被包含在 最终的打包文件里。 --> <resources> <!-- 这个元素描述了项目相关或测试相关的所有资源路径 --> <resource> <!-- 描述了资源的目标路径。该路径相对target/classes目录(例如${project.build.outputDirectory})。 举个例子,如果你想资源在特定的包里(org.apache.maven.messages),你就必须该元素设置为 org/apache/maven/messages。然而,如果你只是想把资源放到源码目录结构里,就不需要该配置。 --> <targetPath></targetPath> <!-- 是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性,文件在filters元素 里列出。 --> <filtering></filtering> <!-- 描述存放资源的目录,该路径相对POM路径 --> <directory></directory> <!-- 包含的模式列表,例如**/*.xml. --> <includes> <include></include> </includes> <!-- 排除的模式列表,例如**/*.xml --> <excludes> <exclude></exclude> </excludes> </resource> </resources> <!-- 这个元素描述了单元测试相关的所有资源路径,例如和单元测试相关的属性文件。 --> <testResources> <!-- 这个元素描述了测试相关的所有资源路径,参见build/resources/resource元素的说明 --> <testResource> <!-- 描述了测试相关的资源的目标路径。该路径相对target/classes目录(例如${project.build.outputDirectory})。 举个例子,如果你想资源在特定的包里(org.apache.maven.messages),你就必须该元素设置为 org/apache/maven/messages。然而,如果你只是想把资源放到源码目录结构里,就不需要该配置。 --> <targetPath></targetPath> <!-- 是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性,文件在filters元素 里列出。 --> <filtering></filtering> <!-- 描述存放测试相关的资源的目录,该路径相对POM路径 --> <directory></directory> <!-- 包含的模式列表,例如**/*.xml. --> <includes> <include></include> </includes> <!-- 排除的模式列表,例如**/*.xml --> <excludes> <exclude></exclude> </excludes> </testResource> </testResources> <!-- 构建产生的所有文件存放的目录 --> <directory></directory> <!-- 产生的构件的文件名,默认值是${artifactId}-${version}。 --> <finalName></finalName> <!-- 当filtering开关打开时,使用到的过滤器属性文件列表 --> <filters></filters> <!-- 子项目可以引用的默认插件信息。该插件配置项直到被引用时才会被解析或绑定到生命周期。给定插件的任何本 地配置都会覆盖这里的配置 --> <pluginManagement> <!-- 使用的插件列表 。 --> <plugins> <!-- plugin元素包含描述插件所需要的信息。 --> <plugin> <!-- 插件在仓库里的group ID --> <groupId></groupId> <!-- 插件在仓库里的artifact ID --> <artifactId></artifactId> <!-- 被使用的插件的版本(或版本范围) --> <version></version> <!-- 是否从该插件下载Maven扩展(例如打包和类型处理器),由于性能原因,只有在真需要下载时,该 元素才被设置成enabled。 --> <extensions>true/false</extensions> <!-- 在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 --> <executions> <!-- execution元素包含了插件执行需要的信息 --> <execution> <!-- 执行目标的标识符,用于标识构建过程中的目标,或者匹配继承过程中需要合并的执行目标 --> <id></id> <!-- 绑定了目标的构建生命周期阶段,如果省略,目标会被绑定到源数据里配置的默认阶段 --> <phase></phase> <!-- 配置的执行目标 --> <goals></goals> <!-- 配置是否被传播到子POM --> <inherited>true/false</inherited> <!-- 作为DOM对象的配置 --> <configuration></configuration> </execution> </executions> <!-- 项目引入插件所需要的额外依赖 --> <dependencies> <!-- 参见dependencies/dependency元素 --> <dependency> </dependency> </dependencies> <!-- 任何配置是否被传播到子项目 --> <inherited>true/false</inherited> <!-- 作为DOM对象的配置 --> <configuration></configuration> </plugin> </plugins> </pluginManagement> <!-- 该项目使用的插件列表 。 --> <plugins> <!-- plugin元素包含描述插件所需要的信息。 --> <plugin> <!-- 插件在仓库里的group ID --> <groupId></groupId> <!-- 插件在仓库里的artifact ID --> <artifactId></artifactId> <!-- 被使用的插件的版本(或版本范围) --> <version></version> <!-- 是否从该插件下载Maven扩展(例如打包和类型处理器),由于性能原因,只有在真需要下载时,该 元素才被设置成enabled。 --> <extensions>true/false</extensions> <!-- 在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 --> <executions> <!-- execution元素包含了插件执行需要的信息 --> <execution> <!-- 执行目标的标识符,用于标识构建过程中的目标,或者匹配继承过程中需要合并的执行目标 --> <id></id> <!-- 绑定了目标的构建生命周期阶段,如果省略,目标会被绑定到源数据里配置的默认阶段 --> <phase></phase> <!-- 配置的执行目标 --> <goals></goals> <!-- 配置是否被传播到子POM --> <inherited>true/false</inherited> <!-- 作为DOM对象的配置 --> <configuration></configuration> </execution> </executions> <!-- 项目引入插件所需要的额外依赖 --> <dependencies> <!-- 参见dependencies/dependency元素 --> <dependency> </dependency> </dependencies> <!-- 任何配置是否被传播到子项目 --> <inherited>true/false</inherited> <!-- 作为DOM对象的配置 --> <configuration></configuration> </plugin> </plugins> </build> <!-- 在列的项目构建profile,如果被激活,会修改构建处理 --> <profiles> <!-- 根据环境参数或命令行参数激活某个构建处理 --> <profile> <!-- 构建配置的唯一标识符。即用于命令行激活,也用于在继承时合并具有相同标识符的profile。 --> <id></id> <!-- 自动触发profile的条件逻辑。Activation是profile的开启钥匙。profile的力量来自于它能够 在某些特定的环境中自动使用某些特定的值;这些环境通过activation元素指定。activation元 素并不是激活profile的唯一方式。 --> <activation> <!-- profile默认是否激活的标志 --> <activeByDefault>true/false</activeByDefault> <!-- 当匹配的jdk被检测到,profile被激活。例如,1.4激活JDK1.4,1.4.0_2,而!1.4激活所有版本 不是以1.4开头的JDK。 --> <jdk>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> <!-- 构建项目所需要的信息。参见build元素 --> <build> <defaultGoal /> <resources> <resource> <targetPath></targetPath> <filtering></filtering> <directory></directory> <includes> <include></include> </includes> <excludes> <exclude></exclude> </excludes> </resource> </resources> <testResources> <testResource> <targetPath></targetPath> <filtering></filtering> <directory></directory> <includes> <include></include> </includes> <excludes> <exclude></exclude> </excludes> </testResource> </testResources> <directory></directory> <finalName></finalName> <filters></filters> <pluginManagement> <plugins> <!-- 参见build/pluginManagement/plugins/plugin元素 --> <plugin> <groupId></groupId> <artifactId></artifactId> <version></version> <extensions>true/false</extensions> <executions> <execution> <id></id> <phase></phase> <goals></goals> <inherited>true/false</inherited> <configuration></configuration> </execution> </executions> <dependencies> <!-- 参见dependencies/dependency元素 --> <dependency> </dependency> </dependencies> <goals></goals> <inherited>true/false</inherited> <configuration></configuration> </plugin> </plugins> </pluginManagement> <plugins> <!-- 参见build/pluginManagement/plugins/plugin元素 --> <plugin> <groupId></groupId> <artifactId></artifactId> <version></version> <extensions>true/false</extensions> <executions> <execution> <id></id> <phase></phase> <goals></goals> <inherited>true/false</inherited> <configuration></configuration> </execution> </executions> <dependencies> <!-- 参见dependencies/dependency元素 --> <dependency> </dependency> </dependencies> <goals></goals> <inherited>true/false</inherited> <configuration></configuration> </plugin> </plugins> </build> <!-- 模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的 相对路径 --> <modules> <!--子项目相对路径--> <module></module> </modules> <!-- 发现依赖和扩展的远程仓库列表。 --> <repositories> <!-- 参见repositories/repository元素 --> <repository> <releases> <enabled><enabled> <updatePolicy></updatePolicy> <checksumPolicy></checksumPolicy> </releases> <snapshots> <enabled><enabled> <updatePolicy></updatePolicy> <checksumPolicy></checksumPolicy> </snapshots> <id></id> <name></name> <url></url> <layout></layout> </repository> </repositories> <!-- 发现插件的远程仓库列表,这些插件用于构建和报表 --> <pluginRepositories> <!-- 包含需要连接到远程插件仓库的信息.参见repositories/repository元素 --> <pluginRepository> <releases> <enabled><enabled> <updatePolicy></updatePolicy> <checksumPolicy></checksumPolicy> </releases> <snapshots> <enabled><enabled> <updatePolicy></updatePolicy> <checksumPolicy></checksumPolicy> </snapshots> <id></id> <name></name> <url></url> <layout></layout> </pluginRepository> </pluginRepositories> <!-- 该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的 仓库中下载。要获取更多信息,请看项目依赖机制。 --> <dependencies> <!-- 参见dependencies/dependency元素 --> <dependency> </dependency> </dependencies> <!-- 不赞成使用. 现在Maven忽略该元素. --> <reports></reports> <!-- 该元素包括使用报表插件产生报表的规范。当用户执行“mvn site”,这些报表就会运行。 在页面导航栏能看 到所有报表的链接。参见reporting元素 --> <reporting></reporting> <!-- 参见dependencyManagement元素 --> <dependencyManagement> <dependencies> <!-- 参见dependencies/dependency元素 --> <dependency> </dependency> </dependencies> </dependencyManagement> <!-- 参见distributionManagement元素 --> <distributionManagement> </distributionManagement> <!-- 参见properties元素 --> <properties /> </profile> </profiles> <!-- 模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 --> <modules> <!--子项目相对路径--> <module></module> </modules> <!-- 发现依赖和扩展的远程仓库列表。 --> <repositories> <!-- 包含需要连接到远程仓库的信息 --> <repository> <!-- 如何处理远程仓库里发布版本的下载 --> <releases> <!-- true或者false表示该仓库是否为下载某种类型构件(发布版,快照版)开启。 --> <enabled><enabled> <!-- 该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。这里的选项是:always(一直), daily(默认,每日),interval:X(这里X是以分钟为单位的时间间隔),或者never(从不)。 --> <updatePolicy></updatePolicy> <!-- 当Maven验证构件校验文件失败时该怎么做:ignore(忽略),fail(失败),或者warn(警告)。 --> <checksumPolicy></checksumPolicy> </releases> <!-- 如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置,POM就可以在每个单独的仓库中, 为每种类型的构件采取不同的策略。例如,可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 --> <snapshots> <enabled><enabled> <updatePolicy></updatePolicy> <checksumPolicy></checksumPolicy> </snapshots> <!-- 远程仓库唯一标识符。可以用来匹配在settings.xml文件里配置的远程仓库 --> <id> banseon-repository-proxy </id> <!-- 远程仓库名称 --> <name> banseon-repository-proxy </name> <!-- 远程仓库URL,按protocol://hostname/path形式 --> <url> http://192.168.1.169:9999/repository/ </url> <!-- 用于定位和排序构件的仓库布局类型-可以是default(默认)或者legacy(遗留)。Maven 2为其仓库提供了一个默认 的布局;然而,Maven 1.x有一种不同的布局。我们可以使用该元素指定布局是default(默认)还是legacy(遗留)。 --> <layout> default </layout> </repository> </repositories> <!-- 发现插件的远程仓库列表,这些插件用于构建和报表 --> <pluginRepositories> <!-- 包含需要连接到远程插件仓库的信息.参见repositories/repository元素 --> <pluginRepository> </pluginRepository> </pluginRepositories> <!-- 该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。 要获取更多信息,请看项目依赖机制。 --> <dependencies> <dependency> <!-- 依赖的group ID --> <groupId> org.apache.maven </groupId> <!-- 依赖的artifact ID --> <artifactId> maven-artifact </artifactId> <!-- 依赖的版本号。 在Maven 2里, 也可以配置成版本号的范围。 --> <version> 3.8.1 </version> <!-- 依赖类型,默认类型是jar。它通常表示依赖的文件的扩展名,但也有例外。一个类型可以被映射成另外一个扩展 名或分类器。类型经常和使用的打包方式对应,尽管这也有例外。一些类型的例子:jar,war,ejb-client和test-jar。 如果设置extensions为 true,就可以在plugin里定义新的类型。所以前面的类型的例子不完整。 --> <type> jar </type> <!-- 依赖的分类器。分类器可以区分属于同一个POM,但不同构建方式的构件。分类器名被附加到文件名的版本号后面。例如, 如果你想要构建两个单独的构件成JAR,一个使用Java 1.4编译器,另一个使用Java 6编译器,你就可以使用分类器来生 成两个单独的JAR构件。 --> <classifier></classifier> <!-- 依赖范围。在项目发布过程中,帮助决定哪些构件被包括进来。欲知详情请参考依赖机制。 - compile :默认范围,用于编译 - provided:类似于编译,但支持你期待jdk或者容器提供,类似于classpath - runtime: 在执行时需要使用 - test: 用于test任务时使用 - system: 需要外在提供相应的元素。通过systemPath来取得 - systemPath: 仅用于范围为system。提供相应的路径 - optional: 当项目自身被依赖时,标注依赖是否传递。用于连续依赖时使用 --> <scope> test </scope> <!-- 仅供system范围使用。注意,不鼓励使用这个元素,并且在新的版本中该元素可能被覆盖掉。该元素为依赖规定了文件 系统上的路径。需要绝对路径而不是相对路径。推荐使用属性匹配绝对路径,例如${java.home}。 --> <systemPath></systemPath> <!-- 当计算传递依赖时, 从依赖构件列表里,列出被排除的依赖构件集。即告诉maven你只依赖指定的项目,不依赖项目的 依赖。此元素主要用于解决版本冲突问题 --> <exclusions> <exclusion> <artifactId> spring-core </artifactId> <groupId> org.springframework </groupId> </exclusion> </exclusions> <!-- 可选依赖,如果你在项目B中把C依赖声明为可选,你就需要在依赖于B的项目(例如项目A)中显式的引用对C的依赖。 可选依赖阻断依赖的传递性。 --> <optional> true </optional> </dependency> </dependencies> <!-- 不赞成使用. 现在Maven忽略该元素. --> <reports></reports> <!-- 该元素描述使用报表插件产生报表的规范。当用户执行“mvn site”,这些报表就会运行。 在页面导航栏能看到所有报表的链接。 --> <reporting> <!-- true,则,网站不包括默认的报表。这包括“项目信息”菜单中的报表。 --> <excludeDefaults /> <!-- 所有产生的报表存放到哪里。默认值是${project.build.directory}/site。 --> <outputDirectory /> <!-- 使用的报表插件和他们的配置。 --> <plugins> <!-- plugin元素包含描述报表插件需要的信息 --> <plugin> <!-- 报表插件在仓库里的group ID --> <groupId></groupId> <!-- 报表插件在仓库里的artifact ID --> <artifactId></artifactId> <!-- 被使用的报表插件的版本(或版本范围) --> <version></version> <!-- 任何配置是否被传播到子项目 --> <inherited>true/false</inherited> <!-- 报表插件的配置 --> <configuration></configuration> <!-- 一组报表的多重规范,每个规范可能有不同的配置。一个规范(报表集)对应一个执行目标 。例如, 有1,2,3,4,5,6,7,8,9个报表。1,2,5构成A报表集,对应一个执行目标。2,5,8构成B报 表集,对应另一个执行目标 --> <reportSets> <!-- 表示报表的一个集合,以及产生该集合的配置 --> <reportSet> <!-- 报表集合的唯一标识符,POM继承时用到 --> <id></id> <!-- 产生报表集合时,被使用的报表的配置 --> <configuration></configuration> <!-- 配置是否被继承到子POMs --> <inherited>true/false</inherited> <!-- 这个集合里使用到哪些报表 --> <reports></reports> </reportSet> </reportSets> </plugin> </plugins> </reporting> <!-- 继承自该项目的所有子项目的默认依赖信息。这部分的依赖信息不会被立即解析,而是当子项目声明一个依赖 (必须描述group ID和artifact ID信息),如果group ID和artifact ID以外的一些信息没有描述,则通过 group ID和artifact ID匹配到这里的依赖,并使用这里的依赖信息。 --> <dependencyManagement> <dependencies> <!-- 参见dependencies/dependency元素 --> <dependency> </dependency> </dependencies> </dependencyManagement> <!-- 项目分发信息,在执行mvn deploy后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者 把构件部署到远程仓库。 --> <distributionManagement> <!-- 部署项目产生的构件到远程仓库需要的信息 --> <repository> <!-- 是分配给快照一个唯一的版本号(由时间戳和构建流水号)?还是每次都使用相同的版本号?参见 repositories/repository元素 --> <uniqueVersion /> <id> banseon-maven2 </id> <name> banseon maven2 </name> <url> file://${basedir}/target/deploy </url> <layout></layout> </repository> <!-- 构件的快照部署到哪里?如果没有配置该元素,默认部署到repository元素配置的仓库,参见 distributionManagement/repository元素 --> <snapshotRepository> <uniqueVersion /> <id> banseon-maven2 </id> <name> Banseon-maven2 Snapshot Repository </name> <url> scp://svn.baidu.com/banseon:/usr/local/maven-snapshot </url> <layout></layout> </snapshotRepository> <!-- 部署项目的网站需要的信息 --> <site> <!-- 部署位置的唯一标识符,用来匹配站点和settings.xml文件里的配置 --> <id> banseon-site </id> <!-- 部署位置的名称 --> <name> business api website </name> <!-- 部署位置的URL,按protocol://hostname/path形式 --> <url> scp://svn.baidu.com/banseon:/var/www/localhost/banseon-web </url> </site> <!-- 项目下载页面的URL。如果没有该元素,用户应该参考主页。使用该元素的原因是:帮助定位 那些不在仓库里的构件(由于license限制)。 --> <downloadUrl /> <!-- 如果构件有了新的group ID和artifact ID(构件移到了新的位置),这里列出构件的重定位信息。 --> <relocation> <!-- 构件新的group ID --> <groupId></groupId> <!-- 构件新的artifact ID --> <artifactId></artifactId> <!-- 构件新的版本号 --> <version></version> <!-- 显示给用户的,关于移动的额外信息,例如原因。 --> <message></message> </relocation> <!-- 给出该构件在远程仓库的状态。不得在本地项目中设置该元素,因为这是工具自动更新的。有效的值 有:none(默认),converted(仓库管理员从Maven 1 POM转换过来),partner(直接从伙伴Maven 2仓库同步过来),deployed(从Maven 2实例部署),verified(被核实时正确的和最终的)。 --> <status></status> </distributionManagement> <!-- 以值替代名称,Properties可以在整个POM中使用,也可以作为触发条件(见settings.xml配置文件里 activation元素的说明)。格式是<name>value</name>。 --> <properties> <name>value</name> </properties> </project> 注:详解文件中,用红色进行标注的是平常项目中常用的配置节点。要详细学习!
7.settings.xml配置详解
settings.xml里面是Maven的基本配置,元素比较多,逐一看一下
1.proxy
<proxies> <proxy> <id>optional</id> <active>true</active> <protocol>http</protocol> <username>proxyuser</username> <password>proxypass</password> <host>proxy.host.net</host> <port>80</port> <nonProxyHosts>local.net|some.host.com</nonProxyHosts> </proxy> </proxies>
需要proxy是因为很多时候你所在的公司基于安全因素考虑,要求你使用通过安全认证的代理访问因特网。这种情况下,就需要为Maven配置HTTP代理,才能让它正常访问外部仓库,以下载所需要的资源。proxies下可以配置多个proxy元素,如果声明了多个proxy元素,则默认情况下第一个被激活的proxy会生效。active为true表示激活该代理,protocol表示使用的代理协议,当然最重要的是指定正确的主机名(host)和端口(port),如果代理服务器需要认证则配置username和password,nonProxyHost元素表示指定哪些主机名不需要代理,可以用"|"分隔多个主机名,也支持通配符"*"。
2.repository
repository表示Maven的中央仓库,因为尽管默认的远程仓库中的构件非常庞大,但是总归会有不满足我们需求的时候,这时候就要用到别的中央仓库了。看一下写法:
<repositories>
<repository> <id>public</id> <name>local private nexus</name> <url>http://192.168.1.6:8081/nexus/content/groups/public</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </repository>
</repositories>
可以声明多个repository。id必须是唯一的,尤其注意,Maven自带的中央仓库使用的id为central,如果其他仓库声明也用该id,就会覆盖中央仓库的配置。releases和snapshots比较重要,前者表示开启仓库的发布版本下载支持,后者表示关闭仓库的快照版本下载支持,这样一来,Maven就会去仓库下载发布版本的构件而不会下载快照版本的构件了。
这里需要注意的是,repositories下可以声明多个repository,但是repositories只能有一个。这段也可以写到pom.xml里面,这样就能在每个项目配置不同的中央库。配置在这里就是全局的作用,就是所有项目都生效。
3.server
大部分远程仓库无须认证就可以访问,但是有时候处于安全方面的因素考虑,需要提供认证信息才能访问一些远程仓库,处于安全考虑,认证信息一般只放在settings.xml中,server就是认证元素。看一下配置:
<server> <id>nexus-releases</id> <username>deployment</username> <password>deployment</password> </server>
这里的关键是id,这个id必须与需要认证的repositiry元素的id完全一致才行,换句话说,正式这个id将认证信息和仓库配置联系在了一起。
4.mirror
如果仓库X可以提供仓库Y存储的所有内容,那么就可以认为仓库X是仓库Y的一个镜像(mirror),换句话说,任何一个可以从Y中获取到的构件够可以从X中获取到。举个例子,"http://maven.net.cn/content/groups/public/"是中央仓库"http://repo1.maven.org/maven2/"在中国的镜像,由于地理位置的因素,该镜像往往能够提供比中央仓库更快的服务,这就是为什么要使用mirror的原因。
看一下mirror的配置:
<mirror> <id>nexus</id> <name>internal nexus repository</name> <url>http://192.168.1.6:8081/nexus/content/groups/public</url> <mirrorOf>*</mirrorOf> </mirror>
该例子中,mirrof为*,表示该配置为所有中央仓库的镜像,任何对于中央仓库的请求都会转至该镜像。另外三个元素id、name、url与一般仓库配置无异,表示该镜像仓库的唯一标识符、名称以及地址。类似的,如果该镜像需要认证,也可以基于该id配置仓库认证。
5.总结
这里贴一个最全的汇总版
<?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"> <!--本地仓库。该值表示构建系统本地仓库的路径。其默认值为~/.m2/repository。 --> <localRepository>usr/local/maven</localRepository> <!--Maven是否需要和用户交互以获得输入。如果Maven需要和用户交互以获得输入,则设置成true,反之则应为false。默认为true。--> <interactiveMode>true</interactiveMode> <!--Maven是否需要使用plugin-registry.xml文件来管理插件版本。如果需要让Maven使用文件~/.m2/plugin-registry.xml来管理插件版本,则设为true。默认为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> <!--当匹配的jdk被检测到,profile被激活。例如,1.4激活JDK1.4,1.4.0_2,而!1.4激活所有版本不是以1.4开头的JDK。--> <jdk>1.5</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> <user.install>/ebs1/build-machine/usr/local/hudson/hudson-home/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>