企业级微服务构建-01搭建和使用Maven私有仓库(Nexus)-29上传组件

亲历的企业级微服务的完整构建过程-系列文章目录

本人参与了这次的企业级微服务的完整构建，想要记录下来以便以后复习，同时也想分享给小伙伴们，抛砖引玉，欢迎大家提出自己的意见和建议，大家一起探讨一起成长。以下为该系列所有文章的链接：

1. 搭建和使用Maven私有仓库(Nexus)（更新中。。。）
2. API网关（待发布）
3. 认证中心（待发布）
4. Redis框架（待发布）
5. RabbitMQ（待发布）
6. MyBatis（待发布）
7. Web模块（待发布）
8. 低代码（待发布）
9. Core
   1. JSON工具类（待发布）
   2. 日期工具类（待发布）
   3. String工具类（待发布）
   4. Number工具类（待发布）
   5. Spring操作工具类（待发布）
   6. API结构统一封装（待发布）
10. 监控和告警（待发布）
11. MongoDB（待发布）

---

搭建和使用Maven私有仓库(Nexus)-系列文章目录

说明：

• 以下部分模块，绝大多数人，在日常工作中都是用不到的，所以我就没有介绍，毕竟时间是最重要的成本，没必要花大量时间在我们用不到的内容上。
• 下面的“1 通用”章节，系列文章中的每一篇内容都相同，介绍一些背景、约定和官网链接等，大家只要知道这些内容了，就不用每篇文章都去看了。

1. 安装步骤
2. 登录和界面
3. 备份和恢复
4. 管理：讲述了Nexus的管理功能，包括用户管理、权限管理、任务管理等
   1. 管理菜单
   2. 仓库管理
   3. 格式（Formats）（暂时用不到，略）
   4. 分期（Staging）（暂时用不到，略）
   5. 标记（Tagging）（暂时用不到，略）
   6. Maven和Jenkins插件（暂时用不到，略）
   7. 任务（Tasks）
   8. 访问控制
      1. 领域（Realms）管理
      2. 权限（Privileges）管理
      3. 角色（Roles）管理
      4. 用户（Users）管理
      5. 默认角色（Default Role）管理
      6. 内容选择器（Content Selectors）管理
   9. 用户认证（暂时用不到，略）
   10. 能力（Capabilities）（暂时用不到，略）
   11. 节点（Nodes）
   12. 配置SSL
   13. HTTP和HTTPS请求和代理设置（暂时用不到，略）
   14. 电子邮件服务器配置
   15. 重试限制配置（暂时用不到，略）
   16. 审计
   17. 安装和更新许可证
   18. 支持功能
5. 使用Nexus仓库：讲述了使用（而非管理） Nexus Repository 的方方面面的知识
   1. 仓库管理器概念：使用 Nexus 需要先理解一些概念，该节内容提供了必要的背景和知识
      1. 组件、仓库和仓库格式（暂时用不到，略）
      2. 一个示例 - Maven 仓库格式（暂时用不到，略）
      3. 管理仓库（暂时用不到，略）
      4. 软件供应链自动化（暂时用不到，略）
      5. 代理仓库概念（暂时用不到，略）
   2. 用户界面概述
   3. 搜索组件（暂时用不到，略）
   4. 浏览仓库和仓库组
   5. 管理当前登录用户的资料
   6. 上传组件
   7. 查看标签（仅可用于Pro版本，略）
6. 集成（主要讲述了如何使用 APIs 和 集成外部工具）（暂时用不到，略）
7. Maven中配置和使用Nexus

---

---

正文

1 通用

1.1 前言

在构建微服务之前，需要先做一些准备工作，比如Maven私有仓库的管理。因为有些微服务模块是作为公共组件被其他微服务引用的，这些公共的微服务，就要设置为依赖，并用Maven仓库管理起来，将自定义的依赖上传到Maven中央仓库并不是一个明智的选择。原因有3个：

1. 最重要的是隐私和安全问题，我们不可能把企业内部开发的组件上传到公共网络，让所有人能够随便下载；
2. 上传很麻烦，上传方法详见 https://blog.csdn.net/agonie201218/article/details/124800163；
3. 可能不允许上外网，则无法上传；
4. 可能会有网络延迟、上传缓慢的问题。
5. 降低了中央仓库的负担。

综上，我们最好是搭建自己的私有Maven仓库，而当前最流行的就是 Sonatype Nexus Repository Manager，以下简称 Nexus。

1.2 约定

1. 我使用的版本是 OSS 3.40.1-01，整个系列的文章都是在该版本上展开介绍，你们可能使用的是 Pro 版，少数模块是我的 OSS 版上没有的。不过一般使用的话，OSS 版已经够用了
2. 文中出现的 Repository ，中文称之为“仓库”
3. 文中出现的变量 $install-dir，值为 /opt/sonatype/nexus
4. 文中出现的变量 $data-dir，值为 /opt/sonatype/sonatype-work/nexus3 ，或 /nexus-data，两者都是在docker容器nexus中的路径，一个是软链接，一个是实际路径
5. 文中出现的变量 ${jetty.etc}，值为 /opt/sonatype/nexus/etc/jetty
6. NXRM：Nexus Repository Manager，即 Nexus 仓库管理器
7. RBAC：Role-Based Access Control，即 基于角色的访问控制

1.3 官方文档

提供Nexus的官方文档：https://help.sonatype.com/repomanager3/
官方文档包含了系统要求、搭建方法，以及各种操作方法等，内容已经非常全面了。

2 上传组件

可用于：OSS，Pro
需要的访问权限：nx-component-upload 或 nx-all

2.1 概述

当你的构建使用私有的或自定义的依赖时，因为这些依赖无法在公共仓库中下载，所以需要将它们上传到一个私有仓库中，以便开发者们可以下载使用。Nexus可以非常简单地将这类第三方依赖，在 UI 界面上 上传到你的托管仓库中。

2.2 上传前注意事项

1. 需要的访问权限：nx-component-upload 或 nx-all
2. 需要有至少一个托管仓库，另外支持的仓库格式参考下表
3. 用户必须有编辑仓库的权限。如果用户有 browse 和 read 仓库的权限，则仍然可以看到“Upload”按钮，但如果尝试上传一个文件，则被提示“未授权”
4. 不同的仓库格式，需要有各自合适的文件类型

注： 不同仓库格式和各自对应的有效文件类型参考表

仓库格式	有效的文件类型	是否支持多文件同时上传
Apt	.deb, .udeb	No
Maven (release only)	没有限制，但通常使用这些类型：.pom, .jar, and .zip	Yes
Helm	.tgz, .tgz.prov	No
npm	.tgz	No
NuGet	.nupkg	No
PyPI	.tar.gz	No
R	.tar.gz, .tgz	No
Raw	没有限制	Yes
RubyGems	.gem	No
Yum	没有权限策略，或者 .rpm 和 .drpm	No

2.3 上传方法

1. 点击“Upload”菜单，右侧的主功能面板显示“上传页面”，里面显示了所有的可上传依赖的托管仓库列表
   

2. 点击右侧列表中的“maven-releases”，进入上传页面
   

3. 填写页面中的所有必填字段，然后点击“Upload”按钮，即可上传
   

4. 上传完成后，会有提示信息“Component uploaded to the repository, view it now”
   
   点击“view it now”链接，即可查看刚刚上传的依赖：
   
   注意：这里是直接跳转到“Search”菜单了。

5. 额外说明下“Classifier”，如下图所示
   

当填写了 Classifier 的值为 test ，然后点击“Upload”按钮，然后我们点击“view it now”链接去查看该依赖：


发现该依赖的名称是“javaU-1.0.3-test.jar”，多了个后缀名 -test。

上图中，我们发现引用该依赖的 XML 文本，artifactid 值没变，多了一个 classifier 属性。

综上所述，这个 classifier 属性，中文意思是 分类器，其实就是给 依赖名称添加了一个后缀，后缀值就是 classifier属性值。然后在项目的 pom.xml 中引用该依赖时，多了个 classifier 属性。其他也没啥。

2.4 Maven - 上传携带 Artifacts 信息的 pom 文件

上传一个 jar包依赖的同时，上传该 依赖 配套的 pom.xml 文件，则 Nexus 会直接读取和解析 pom.xml 中的坐标信息。可以看到下图中的提示信息“Component details will be extrated from the provided POM file（组件详情将会从提供的 POM 文件中提取）”：

注意：上图中的“Extension”必填，且必须填写“pom”，然后 Nexus 才能知道，坐标信息 要从 pom 文件中解析和获取，而不是从 UI 中获取。

然后，可以看下上传的 pom.xml 中的一些内容：

<parent>
        <groupId>com.el</groupId>
        <artifactId>el_shop</artifactId>
        <version>1.0.0</version>
    </parent>
    <artifactId>el_admin</artifactId>

到这里已经很明显了，刚刚上传到依赖 el_admin ，确实使用了 配套上传的 pom.xml 中的信息。

2.5 高级功能

批量上传依赖，自动从 jar 文件中提取依赖，参考 REST and Integration API 中的组件端点。