在Maven世界中,依赖、插件、项目构建完成后输出的jar包都可以看作是一个构件,任何一个构件都有一组坐标唯一标识。Maven实现了重用,得益于坐标机制。Maven在仓库中存储所有Maven项目共享的构件。我们的项目构建完毕后生成的构件也可以安装或者部署到仓库中,供其他项目使用。
仓库的布局
任何一个构件都有其唯一的坐标,根据这个坐标可以定义其在仓库中的唯一存储路径,路径与坐标大致对应关系为 groupId/artifactId/version/artifactId-version.packaging
我们来看一下Maven处理仓库布局的源码:
private static final char PATH_SEPARATOR = '/';
private static final char GROUP_SEPARATOR = '.';
private static final char ARTIFACT_SEPARATOR = '-';
public String pathOf( Artifact artifact ){
ArtifactHandler artifactHandler = artifact.getArtifactHandler();
StringBuilder path = new StringBuilder( 128 );
path.append( formatAsDirectory( artifact.getGroupId() ) ).append( PATH_SEPARATOR );
path.append( artifact.getArtifactId() ).append( PATH_SEPARATOR );
path.append( artifact.getBaseVersion() ).append( PATH_SEPARATOR );
path.append( artifact.getArtifactId() ).append( ARTIFACT_SEPARATOR ).append( artifact.getVersion() );
if ( artifact.hasClassifier() ){
path.append( ARTIFACT_SEPARATOR ).append( artifact.getClassifier() );
}
if ( artifactHandler.getExtension() != null && artifactHandler.getExtension().length() > 0 ){
path.append( GROUP_SEPARATOR ).append( artifactHandler.getExtension() );
}
return path.toString();
}
private String formatAsDirectory( String directory ){
return directory.replace( GROUP_SEPARATOR, PATH_SEPARATOR );
}
依然用之前的POM来看一下
<groupId>com.play.myMaven</groupId>
<artifactId>hello-maven</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
- 基于构件的groupId准备路径:formatDirectory()将groupId中的'.'分隔符转换为'/'分隔符。groupId: com.play.myMaven会被转化为com/play/myMaven,然后append一个'/',即com/play/myMaven/。
- 基于构件的artifactId准备路径:直接在artifactId后添加'/'。artifactId:hello-maven,即com/play/myMaven/hello-maven/。
- 版本信息:也是直接在版本信息后添加'/',即com/play/myMaven/hello-maven/1.0-SNAPSHOT/。值得注意的是,这里用到的artifactId.getBaseVersion(),是为SNAPSHOT版本服务的,比如1.0-SNAPSHOT,getBaseVersion为1.0(但是按照目前自己打包好的结果显示依然为1.0-SNAPSHOT,在此先标注一下)。
- 最后加上artifactId-version,即com/play/myMaven/hello-maven/1.0-SNAPSHOT/hello-maven-1.0-SNAPSHOT。
- 存在classifier时,添加-classifier。
-
检查构件的extension,存在即添加.extension。可以看到extension是从artifactIdHandler中获取,artifactIdHandler是由项目的packaging决定的,即.packaging,所以我们的路径为com/play/myMaven/hello-maven/1.0-SNAPSHOT/hello-maven-1.0-SNAPSHOT.jar
仓库分类
本地仓库和远程仓库。Maven会根据构件坐标信息优先查看本地仓库,如果本地仓库存在此构件,直接使用,如果不存在,或者需要查看是否有更新的构件版本,Maven会去远程仓库查找,找到了即下载到本地仓库再使用。若本地和远程仓库均无此构件,Maven会报错。
中央仓库是Maven默认内置的远程仓库。
私服是另一种特殊的远程仓库,为了节省带宽和时间,应该在局域网内假设一个私有的仓库服务器,用来代理所有外部的远程仓库。内部项目还能够部署到私服上供其他项目使用。
远程仓库除了中央仓库和私服还有其他公开的远程仓库,例如Java.net Maven库和JBoss库
1.本地仓库
默认情况下,无论是Windows还是Linux,每个用户在自己的用户目录下都有一个路径为.m2/repository的仓库目录,我的Windowsvebdu仓库地址为C:\Users\songyanyan.m2\repository。在Linux中以 . 开头的文件/目录默认隐藏,使用ls -a显示。
当然,我们也可以自定义本地仓库目录地址。编辑文件~/.m2/repository/settings.xml,修改localRepository元素值。
<!-- localRepository
| The path to the local repository maven will use to store artifacts.
| Default: ~/.m2/repository
<localRepository>/path/to/local/repo</localRepository> -->
<localRepository>D:/Repository/m2repo</localRepository>
默认情况下,~/.m2/repository/settings.xml文件不存在,我们需要从Maven安装目录$M2_HOME复制出来一份$M2_HOME/conf/settings.xml文件。不建议直接修改全局目录的settings.xml文件,因为这个文件是全局范围的,整台机器上的所有用户都会直接受到该配置的影响 对复制到用户目录~/.m2/repository/settings.xml文件进行修改即可。
本地仓库的构件组成
- Maven从远程仓库下载到本地仓库
- 本地项目的构件安装到本地仓库中(mvn clean install)
2.远程仓库
安装好Maven后不执行任何Maven命令,本地仓库目录是不存在的。当输入第一条Maven命令之后,Maven才会创建本地仓库,并根据配置和需要从远程仓库下载构件至本地仓库。
每个用户只有一个本地仓库,但可以配置访问很多远程仓库。
3.中央仓库
https://repo.maven.apache.org/maven2 默认的远程仓库。
我们来解压一下$M2_HOME/lib/maven-model-builder-3.3.9.jar,进入\org\apache\maven\model\,打开pom-4.0.0.xml,这个是所有Maven项目都会继承的超级POM
<!-- START SNIPPET: superpom -->
<project>
<modelVersion>4.0.0</modelVersion>
<repositories>
<repository>
<id>central</id>
<name>Central Repository</name>
<url>https://repo.maven.apache.org/maven2</url>
<layout>default</layout>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
...
<build>
<directory>${project.basedir}/target</directory>
<outputDirectory>${project.build.directory}/classes</outputDirectory>
<finalName>${project.artifactId}-${project.version}</finalName>
<testOutputDirectory>${project.build.directory}/test-classes</testOutputDirectory>
<sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
<scriptSourceDirectory>${project.basedir}/src/main/scripts</scriptSourceDirectory>
<testSourceDirectory>${project.basedir}/src/test/java</testSourceDirectory>
<resources>
<resource>
<directory>${project.basedir}/src/main/resources</directory>
</resource>
</resources>
<testResources>
<testResource>
<directory>${project.basedir}/src/test/resources</directory>
</testResource>
</testResources>
...
</build>
<reporting>
<outputDirectory>${project.build.directory}/site</outputDirectory>
</reporting>
...
</project>
<!-- END SNIPPET: superpom -->
- id:central,是对中央仓库进行唯一标识
- name:Central Repository,名为Central Repository中央仓库
- url:https://repo.maven.apache.org/maven2 仓库地址
- layout:default默认仓库布局(即上文中的仓库布局)
- snapshots:enabled→false表示不从中央仓库下载快照版本的构件。
可以看到包括build元素中定义的目录结构也同前几篇讲的一致。项目主代码目录和测试代码目录也都可以知道是在这个位置进行定义的。
私服
私服是特殊的远程仓库,它是架设在局域网内的仓库服务,代理广域网上的远程仓库,供局域网内Maven用户使用。
当Maven需要下载构件时候,它从私服请求,若私服不存在该构件,则从外部的远程仓库下载,缓存在私服上后,再为Maven的下载请求提供服务。此外,我们本地也可上传构件到私服供大家使用。使用私服可以:
- 节省自己的外网带宽。
- 加速Maven构建。
- 部署第三方构件。
- 提高构建稳定性,增强控制。
- 降低中央仓库的负荷。
远程仓库
a.远程仓库的配置
仓库信息配置在POM文件中。
在<repositories>元素下可以声明一个或多个远程仓库<repository>
<!-- Maven仓库 -->
<repositories>
<repository>
<id>myproj</id>
<name>Myproj Repository</name>
<url>http://172.17.5.244/repository/maven</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
<layout>default</layout>
</repository>
</repositories>
在snapshots和releases元素下,除了enabled,它们还有另外两个子元素updatePolicy和checksumPolicy
<snapshots>
<enabled>true</enabled>
<updatePolicy>daily</updatePolicy>
<checksumPolicy>ignore</checksumPolicy>
</snapshots>
- updatePolicy用来配置Maven从远程仓库检查更新的频率。
daily——(默认值)每天检查一次更新
never——从不检查更新
always——每次构建都检查更新
interval:X——每隔X分钟检查一次更新 - checksumPolicy用来配置Maven检查校验和文件的策略。当构件被部署到Maven仓库中时,会同时部署对应的校验和文件。下载构件时候,Maven会验证校验和文件。checksumPolicy值为:
warn——(默认值)Maven会在执行构建时输出警告信息
fail——Maven遇到校验和错误就让构建失败
ignore——Maven完全忽略校验和错误
b.远程仓库的认证
出于安全考虑,组织内有一个Maven仓库服务器,该服务器为每个项目都提供独立的Maven仓库,为了防止非法的仓库访问,管理员为每个仓库提供一组用户名和密码。为了能让Maven访问仓库内容,就需要配置认证信息。
仓库信息配置在POM中,认证信息配置在settings.xml中。POM往往被提交到代码仓库中供所有成员访问,settings一般只放在本机
<servers>
<server>
<id>myproj</id>
<username>songyanyan</username>
<password>xxx</password>
</server>
<server>
<id>releases</id>
<username>songyanyan</username>
<password>xxx</password>
</server>
<server>
<id>snapshots</id>
<username>songyanyan</username>
<password>xxx</password>
</server>
<servers>
server元素中的id必须与POM中需要认证的repository元素的id完全一致。正是这个id将认证信息与仓库配置联系在了一起。
c.部署至远程仓库
部署构件到私服。需要配置distributionManagement元素
<!-- 制品管理 -->
<distributionManagement>
<repository>
<id>releases</id>
<name>Proj Release Repository</name>
<url>http://172.17.5.244/repository/maven-releases/</url>
</repository>
<snapshotRepository>
<id>snapshots</id>
<name>Proj Snapshot Repository</name>
<url>http://172.17.5.244/repository/maven-snapshots/</url>
</snapshotRepository>
</distributionManagement>
distributionManagement包含repository和snapshotRepository子元素,前者表示发布版本构件的仓库,后者表示快照版本的仓库。配置认证方式同上文b.远程仓库的认证一致,server元素的id与仓库id匹配。
不论从远程仓库下载构件还是部署构件至远程仓库,当需要认证的时候,配置的方式是一样的。
配置完成,运行mvn clean deploy,Maven会将项目构建输出的构件部署到对应的远程仓库。
从仓库解析依赖的机制
本地仓库没有该依赖构件时,Maven会自动从远程仓库下载;当依赖版本为快照的时候,Maven会自动找到最新的快照。背后的机制:
- 依赖的范围是system时,Maven直接从本地系统解析构件。
- 根据依赖坐标计算仓库路径后,尝试直接从本地仓库寻找构件,发现相应构件,解析成功!
- 解析不成功,如果依赖的版本是显式的发布版本构件,如1.2、2.1-beta-1,则遍历所有远程仓库,发现后下载并解析。
- 如果依赖的版本是REALEASE或LATEST,则依据更新策略读取所有远程仓库的元数据groupId/artifactId/maven-metadata.xml,对应本地仓库元数据,得到最新快照版本值。
<metadata modelVersion="1.1.0">
<groupId>com.play.myMaven</groupId>
<artifactId>hello-maven</artifactId>
<version>1.0-SNAPSHOT</version>
<versioning>
<snapshot>
<localCopy>true</localCopy>
</snapshot>
<lastUpdated>20180606025623</lastUpdated>
<snapshotVersions>
<snapshotVersion>
<extension>jar</extension>
<value>1.0-SNAPSHOT</value>
<updated>20180606025623</updated>
</snapshotVersion>
<snapshotVersion>
<extension>pom</extension>
<value>1.0-SNAPSHOT</value>
<updated>20180606025623</updated>
</snapshotVersion>
</snapshotVersions>
</versioning>
</metadata>
只有仓库开启了对于发布/快照版本的支持(仓库配置enabled元素),才可以访问该仓库的发布版本构件信息。我们可以在命令行中加入-U,强行检查更新。
镜像
如果仓库X可以提供仓库Y存储的所有内容,那么X就可以认为是Y的一个镜像。
我们一般使用国内镜像会好很多。我们编辑settings.xml中mirrors元素
<mirror>
<id>alimaven</id>
<name>aliyun maven</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<mirrorOf>central</mirrorOf>
</mirror>
mirrorOf值为central,即表示该配置为中央仓库的镜像也可以配置多镜像。
镜像结合私服,即私服就是所有仓库的镜像,我们可以这样配置:
<mirror>
<id>inter-repo</id>
<url>http://xxx/xxx/</url>
<mirrorOf>*</mirrorOf>
</mirror>
这里的*号表示该配置是所有Maven仓库的镜像,对于任何远程仓库的请求都会被转至http://xxx/xxx/。若该镜像仓库需要认证,则配置相应id为inter-repo的<server>即可。
- <mirrorOf>*</mirrorOf> 匹配所有远程仓库
- <mirrorOf>external:*</mirrorOf> 匹配所有远程仓库,使用localhost的除外,使用file://协议的除外。即匹配所有不在本机上的远程仓库。
- <mirrorOf>repo1,repo2</mirrorOf> 匹配仓库repo1,repo1使用逗号分隔。
- <mirrorOf>*,!repo2</mirrorOf>匹配所有远程仓库,除了repo2
仓库搜索服务
Sonatype,关键字搜索、类名搜索、坐标搜索、校验和搜索等功能。
注:《Maven实战》学习笔记