【仓库管理】搭建 Maven 私服之一

Nexus 读音：/ˈneksəs/是 Sonatype 公司发布的一款仓库（Repository）管理软件，常用来搭建 Maven 私服，所以也有人将 Nexus 称为“Maven仓库管理器”。

Maven 私服其实并不是 Maven 的核心概念，它仅仅是一种衍生出来的特殊的仓库，但这并不代表它不重要，相反由于私服具有降低中央仓库负荷、节省外网带宽、以及提高项目稳定性等优点，使得私服在实际开发过程中得到了相当普遍地使用。

能够帮助我们建立私服的软件被称为 Maven 仓库管理器，主要有以下 3 种：

其中，Sonatype Nexus 是当前最流行，使用最广泛的 Maven 仓库管理器。Nexus 分为开源版和专业版，其中开源版足以满足大部分 Maven 用户的需求。

Nexus 开源版具有以下特性：

Nexus 专业版需要付费购买，它主要包含一些企业级的高级特性，详情请参考 Sonatype Nexus 官方文档。

目前 Nexus 分为 Nexus 2.x 和 Nexus 3.x 两个大版本，它们是并行的关系，目前使用最多，运行最稳定的是 Nexus 2.x，下面我们以 Nexus 2.x 为例，演示 Nexus 的安装过程。

图1：Nexus 2.x 下载页面

图2：Nexus 2.x 目录 其中：

图3：nexus-2.14.20-02 目录及文件列表 nexus-2.14.20-02 目录说明，如下表所示。

图4：nexus-2.14.20-02\bin\jsw 目录列表

图5：Nexus 启动文件列表

其中：

注意：

图6：Nexus 首页

图7：Nexus 登录界面

图8：Nexus 登录成功

Nexus 作为一款 Maven 仓库管理器，仓库（Repository）自然是 Nexus 最核心的概念。Nexus 中提供了许多仓库概念，如代理仓库、宿主仓库以及仓库组等。Nexus 为每一种仓库都提供了丰富的配置参数，方便我们根据自身需要进行定制。

点击左边导航栏中的 Repositories，可以看到 Nexus 自带的几个内置仓库，如下图所示。

图1：Nexus 内置仓库列表（猛击图片可以查看原图）

在仓库列表中，每个仓库都具有一系列属性：

由图 1 可知，Nexus 2.x 默认创建了 6 个仓库，我们称它们为 Nexus 内置仓库。

Nexus 仓库按照类型（Type）区分，主要分为以下 3 个类型：

为了更加直观的理解仓库组、代理仓库和宿主仓库的概念，我们通过下图展示它们的用途和区别。

图2： Nexus仓库分类

由上图可知：

首先，我们需要创建两个宿主仓库，分别用来存储从本地上传到 Nexus 的 Snapshot 和 Release 版本的构件，操作步骤如下。

图1：Nexus 导航

图2：添加宿主仓库

图3：配置宿主仓库

宿主仓库配置如下：

图4：Nexus 仓库列表（猛击图片，查看原图）

重复以上步骤，再创建一个名称为 bianchengbang_Release_hosted ，策略为 hosted 的宿主仓库。

图5：Nexus 仓库列表-宿主仓库（猛击图片，查看原图）

下面我们创建一个代理仓库，用来下载和缓存中央仓库的构件，操作步骤如下。

点击 Nexus 仓库列表上方的 Add… 按钮，在下拉菜单中选择 Proxy Repository，如图 5 所示。

图5：添加代理仓库

在代理仓库配置界面，填写对应信息，然后点击 Save 按钮进行保存，如图 6 所示。

图6：Nexus 代理仓库配置界面

代理仓库配置中，仓库 ID、仓库名称、Provider、Policy 以及 Default Local Storage Location 等配置的含义与宿主仓库相同，不再赘述。需要注意的是，代理仓库的 Repository Type 的取值是 proxy。

代理仓库配置如下表。

下面我们将创建一个仓库组，并将刚刚创建的 3 个仓库都聚合起来，操作步骤如下。

点击仓库列表上方的 Add… 按钮，在下拉菜单中选择 Repository Group，如下图。

图7：Nexus 添加仓库组

在仓库组配置界面，填写对应信息，并将 bianchengbang_central_proxy、bianchengbang_Release_hosted 和 bianchengbang_Snapshot_hosted 3 个仓库添加到仓库组中，最后点击 Save 按钮进行保存，如下图。

图8：Nexus 仓库组配置

查看 Nexus 仓库列表，可以看到 bianchengbang_repository_group 仓库组已经创建完成，如下图。

图9：Nexus 仓库列表-仓库组（猛击图片，查看原图）

我们知道，Maven 中央仓库为用户提供了多达数十万构件，而 Nexus 可以代理所有的远程仓库（包括 Maven 中央仓库），可见 Nexus 仓库中构件的数量相当庞大。用户想要在这么多构件中，快速的查找自己所需的构件，一个最直接有效的方式就是：搜索。

Nexus 作为一款成熟的仓库管理工具，它通过维护仓库的索引提供了构件搜索功能，以便帮助用户方便快速地找到所需构件。

我们将详细为您介绍 Nexus 索引以及构件搜索功能。

Nexus 能够遍历仓库的所有内容，搜集它们的坐标，校验和以及所包含的 Java 类等信息，然后以索引（ nexus-indexer） 的形式保存起来。Nexus 索引保存在 Nexus 安装目录下 \sonatype-work\nexus\indexer 目录中，该目录下每个子目录都代表 Nexus 中的一个仓库，用来存放各个仓库的索引 ，如下图所示。

图1：Nexus 索引目录

大多数的远程公共仓库（例如，中央仓库）都维护了一个这样的索引，因此本地的 Nexus 在下载到这个索引后，就能在此基础上为用户提供构件搜索和浏览等服务。需要注意的是，并不是所有的公共仓库都提供了索引 ，对于那些没有提供索引的仓库来说，我们是无法对其进行搜索的。

Nexus 索引下载功能默认是关闭的，如果想在 Nexus 中搜索远程仓库中的构件，就需要先开启索引下载功能。

以 bianchengbang_central_proxy 代理仓库（代理 Maven 中央仓库）为例，在图 2 所示的位置就可以控制它的索引下载功能，true 表示开启索引下载，false 表示关闭索引下载。

图2：远程索引下载

开启索引下载功能后，点击导航栏中 Scheduled Tasks 链接，查看调度任务列表。若 Nexus 正在下载索引，我们就能看到如图 3 所示的任务，其任务状态为 Running。在索引下载完毕后，该任务就会消失。

图3：Nexus 调度任务列表（猛击图片，查看原图）

由于 Maven 中央仓库的内容较多，其索引文件比较大，因此 Nexus 下载该文件所需的时间较长，需要我们耐心等待。

索引下载完成后，点击仓库列表中的 bianchengbang_central_proxy 代理仓库，然后在列表下方选择 Browse Index 选项卡，我们可以看到该仓库内容的树形结构，如图 4 所示。

图4：Nexus 仓库索引树形结构图

Nexus 通过维护索引，为用户提供了关键字搜索、类名搜索、坐标搜索等多种搜索功能，通过这些功能，页面中能够清晰地展示出结果构件的坐标以及所属仓库。用户可以直接下载相应的构件，也可以直接复制构件的 XML 依赖声明，到项目中使用。

在 Nexus 界面左边导航栏中有一个搜索框，在搜索框内输入所需构件的关键字，单击搜索按钮就能快速得到搜索结果，如图 5 所示。

图5：Nexus 搜索功能（猛击图片，查看原图）

搜索结果页中的每一行代表一类构件，其中包含了 Group、Artifact、版本、流行版本、以及下载链接等信息。点击其中某一行，下方就会出现该构件的详细信息，其中不但包含构件的坐标等基本信息，还包含一段 XML 依赖声明，我们可以将这段 XML 依赖声明直接复制到项目的 POM 中使用，如图 6 所示。

图6：Nexus 搜索结果详情

点击右侧的 Artifact 选项卡，还能看到构件的大小、上传时间、最后修改时间、仓库中的相对位置、校验和等信息，如图 7 所示。

图7：Nexus 搜索详情页 Artifact

除了关键字搜索外，Nexus 还提供了一些高级搜索功能，例如类名搜索、GAV 搜索以及“校验和”搜索。我们可以通过点击搜索页左上角的下拉菜单，选择高级搜索功能。

图8：Nexus 高级搜索功能

Nexus 还具有以下高级搜索功能：

这些搜索功能的使用都十分的简单，我们可以根据自己的需求选择合适的搜索功能。

Nexus 作为最流行的 Maven 私服之一，使用它主要目的之一：代理远程仓库，即当 Maven 需要下载构件到本地仓库使用时，不再请求外部的远程仓库，而直接从 Nexus 中下载。我们将介绍如何配置 Maven 从 Nexus 下载构件。

将 Nexus 的代理仓库配置到 Maven 项目中，用它们代替外部的远程仓库，即可实现 Maven 从 Nexus 下载构件。

在 Maven 项目的 pom.xml 中增加以下配置，可以为当前项目配置 Nexus 上的 bianchengbang_central_proxy 代理仓库。

其中，在 repositories 元素下可以使用 repository 子元素声明一个或多个远程仓库，一个 repository 元素对应一个远程仓库。

repository 各个子元素含义如下表。

在 pluginRepositories 元素下可以使用 pluginRepository 子元素声明一个或多个远程插件仓库（包括私服上的仓库），一个 pluginRepository 元素对应一个远程插件仓库。pluginRepository 下所有子元素的含义均与与 repository 的子元素相同，这里就不再做过多赘述了。 示例 1 将以上配置加入 Maven 项目 Root 的 POM 文件中，并手动清空本地仓库的所有依赖构件（目的是为了让 Maven 重新获取构件）。

打开命令行窗口，跳转到 Root 所在的目录下，执行以下 mvn 命令。

执行结果如下。

图1： 使用 Nexus 私服构建结果

由图 1 的构建过程可以看出，Root 项目构建所需的构建是从 Nexus 私服的 banchengbang_central_proxy 代理仓库中下载的，而不是从 Maven 中央仓库去下载。 在 setting 中配置 在 pom.xml 中配置 Nexus ，只对当前项目有效，在实际应用中，我们往往希望能够通过一次配置就能让本机中的所有 Maven 项目都使用 Nexus。此时，您可能会想到在 Maven 的 setting.xml 文件中进行配置，但 setting.xml 是不支持直接配置 repositories 和 pluginRepositories 。所幸 Maven 提供了 profile 机制，能够让我们将仓库配置放在 profile 中。

以上配置中使用了一个 id 为 nexus 的 profile，这个 profile 中包含了与仓库相关的配置，同时配置中还使用了一个 activeProfiles 元素将 id 为 nexus 的 profile 激活。当本机有 Maven 项目构建时，profile 中的仓库配置就会应用到项目中。 示例 2 将以上配置分别添加到 Maven 安装目录\conf 和本地仓库目录下的 setting.xml 中，并将 Root 项目 POM 文件中的 repositories 和 pluginRepositories 等仓库设置删除。

打开命令行窗口，跳转到 Root 项目下，执行以下 mvn 命令。 mvn clean install

执行结果如下。

图2：Nexus 全局配置仓库 setting.xml 中添加镜像 Nexus 私服通常会与镜像（mirror）结合使用，使 Nexus 成为所有远程仓库的私服，这样不仅可以从 Nexus 中获取所有所需构件，还能将配置集中到 Nexus 私服中，简化 Maven 本身的配置。

我们可以创建一个匹配任何仓库的镜像，镜像的地址为 Nexus 中仓库的地址，这样 Maven 对于任何构件的下载请求都会被拦截跳转到 Nexus 私服中，其具体配置如下。

仓库和插件仓库的配置中，它们的 id 取值都是 central，即它们的设置覆盖了 Maven 中央仓库，但此时这里的 URL 已经无法起到任何作用，因为镜像的匹配规则是 *，所有的请求都已经被拦截，跳转到 Nexus 私服的地址。

如果仅仅是为了代理远程的公共仓库，那么 Nexus 的代理仓库就完全能够满足需要，但是我们知道，Nexus 除了代理仓库外，还有另一种仓库：宿主仓库。

宿主仓库的主要作用是存储公司或组织内部的构件，以及一些无法从公共仓库获取的第三方构件（JDBC 驱动），供用户下载使用。用户可以通过配置 Maven 将构件自动部署到 Nexus 宿主仓库，也可以在 Nexus 界面手动上传构件。

日常开发中，快照版本构件可以直接部署到 Nexus 中策略为 Snapshot 的宿主仓库中，而最终发布的版本则应该部署到 Nexus 中策略为 Release 的宿主仓库中。

使用 Maven 将构件部署到 Nexus 宿主仓库中主要分为 3 步：

下面我们通过一个实例来详细介绍如何使用 Maven 部署构件到 Nexus 宿主仓库。

创建一个名为 test-upload-snapshot 的 Maven 项目，并在其 POM 文件中添加如下配置。

以上配置说明如下：

最初版本的 Nexus 没有为宿主仓库提供任何的安全措施。如果宿主仓库开启了部署功能，任何人可以连接并部署构件至这个仓库，这显然是极不安全的。因此，现在的 Nexus 中增加了权限认证，Nexus 对于匿名用户是只读的，若想部署构件到 Nexus 中，则需要在 setting.xml 中配置如下认证信息。

注意：以上配置中，server 元素中的 id 必须和 pom.xml 中 distributionManagement 元素对应仓库的 id 保持一致。Maven 在部署构件时，会先根据 id 查找用户名称和密码进行认证和登录，然后将构件部署到对应得宿主仓库。

完成以上配置之后，就可以使用 Maven 命令将构件部署到宿主仓库了，操作步骤如下。

在 Nexus 界面的仓库列表选中 bianchengbang_Snapshot_hosted 宿主仓库，在下方的 Browse Index 选项卡中，可以看到 test-upload-snapshot 构件已经被部署到该仓库中，如图 1 所示。

图1：使用 Maven 部署构件到 Nexus

有些 Jar 文件（如 Oracle 的 JDBC 驱动）由于许可证等原因，无法存放在公开仓库中。此外，还有一些小型的开源项目，它们没有将自己的构件分发到公共仓库中，也没有维护自己的仓库，因此这些构件是无法从公共仓库中获得的。若 Maven 项目中需要这类构件，我们就需要将构件下载到本地，然后手动上传到 Nexus 私服。

我们还是以 Maven 项目 App-Core-lib 为例，将其打包后手动上传到 Nexus 内置宿主仓库 3rd party 中，具体步骤如下。

图2：Maven 打包生成 jar 文件

GAV Definition 中提供了两种定义构件坐标的方式：

以上 2 种方式操作时会略有不同，下面我们分别对它们进行介绍。 From POM 若该构件是通过 Maven 构建产生的，那么可以在 GAV Definition 下拉列表中，选择 From POM，然后指定该构件所属项目的 pom.xml，Nexus 会自动从 pom.xml 中获取构件的坐标。最后点击页面最下方的 Upload Artifact(s) 按钮，将构件上传到仓库中，如图 3 所示。

图3：Nexus 手动上传构件 GAV Paramters 若构件不是通过 Maven 构建的，而是来自第三方（例如 Oracle 的 JDBC 驱动），则只能在 GAV Definition 下拉列表中，选择 GAV Parameters 手动定义构件的坐标。

定义好坐标后，点击 Select Artifact(s) to Upload… 按钮选择要上传的构件，然后点击 Add Artifact 按钮将其加入上传列表中。最后点击页面最下方的 Upload Artifact(s) 按钮，将构件上传到仓库中，如图 4 所示。

图4：Nexus 第三方构件手动上传

图5：第三方构件手动上传到Nexus

目前 Nexus 分为 Nexus 2 和 Nexus 3 两个大版本，它们是并行的关系。与 Nexus 2 相比，Nexus 3 具有很多优势，例如支持更多的仓库格式、优化了用户的使用界面以及更加强大的搜索功能等等。

目前使用最多的，运行最稳定是 Nexus 2，但随着 Nexus 3 对 Maven 的支持越来越稳定，很多公司和组织都陆续开始使用 Nexus 3。

本节我们将介绍 Nexus 3 的安装和访问过程。

图1：Nexus 下载页面

图2：Nexus 解压 其中：

我们可以在 nexus-3.30.0-01\bin 目录下发现一个名称位 nexus.exe 的可执行文件，它是在 Windows 平台上运行 Nexus 的启动脚本，该脚本包含了启动服务、停止服务、创建服务和删除服务等命令。

打开命令行窗口，跳转到 nexus-3.30.0-01\bin 目录下，执行以下命令，启动 Nexus 服务。

执行结果结果如图 3 所示，则表示 Nexus 启动完成。

图3：Nexus 3 启动完成

启动完成后，在浏览器地址栏输入 http://localhost:8081/，访问 Nexus 界面，如图 4 所示。

图4：Nexus 3 用户界面

点击 Nexus 3.x 首页右上角的“Sign in”按钮，在登录页面输入用户名和 密码（默认用户名为 admin，默认密码则保存在 /sonatype-work/nexus3 目录下的 admin.password 文件中)，点击“Sign in”按钮登录，如图 5 所示。

图5：Nexus 3 登录界面

登录成功后，结果如图 6 所示。

图6：Nexus 3 登录成功

我们知道 Nexus 可以远程下载和缓存中央仓库索引，但是对于国内用户来说，Nexus 远程更新索引使用的站点位于国外且部分索引文件较大，经常会出现下载速度缓慢或索引文件不完整等情况。下面我们将介绍一种更加快捷可靠的索引更新方式：离线更新中央仓库索引。

离线更新中央仓库索引，顾名思义，就是直接将索引文件下载，然后拷贝至 Nexus 工作目录中，以达到离线更新索引的目的。

离线更新中央仓库索引主要分为以下 3 步：

首先，我们需要下载以下 3 个文件：

图1：Nexus 中央仓库离线索引下载列表

图2：Nexus 索引生成器

图3：选择 Indexer CLI 版本

图4：Nexus indexer-cli 5.1.1 详情

图5：Nexus indexer-cli 文件列表

图6：Nexus 中央仓库离线索引文件

解压过程大约需要 10 分钟左右，请耐心等待，解压完成后，结果如图 7 所示。

图7：Nexus 中央仓库离线索引解压

图8：Nexus 离线索引文件

图9：Nexus 中央仓库索引目录

图10：Nexus 离线索引

图11：Nexus 远程索引

需要注意的是，目前只有 Nexus 2.x 可以通过以上方式离线更新中央仓库索引，Nexus 3.x 暂不支持该功能。若想在 Nexus 3.x 中使用离线索引，我们建议您先在 Nexus 2.x 中离线更新索引后，再将数据迁移到 Nexus 3.x 中。