Quarkus Extension Registry

Quarkus 开发工具(例如 Quarkus CLI 插件、Maven 插件和 Gradle 插件)或 code.quarkus.io 可以用于列出和搜索 Quarkus 生态系统中与某个条件匹配的扩展。这包括 Quarkus platform 扩展和其他各种由社区提供的扩展,其中许多托管在 Quarkiverse Hub 上。 关于所有可用的 Quarkus 扩展的信息由 Quarkus extension registries 提供给开发工具。 Quarkus 扩展注册表是一个提供关于以下信息的数据库:

  • 可用的 Quarkus 平台,指明其中哪些当前对于新项目和/或作为更新推荐使用;

  • 可用的非平台扩展,指明它们与哪些 Quarkus 版本兼容。

registry.quarkus.io

托管在 registry.quarkus.io 上的注册表是默认的 Quarkus 社区扩展注册表。它会在每次发布 Quarkus community platform 时更新,并且包括托管在 Quarkiverse Hub 上的扩展。

Maven repository

托管在 registry.quarkus.io 上的注册表是一个 Maven snapshot 存储库,它为开发工具提供平台和扩展目录,作为 Maven JSON 构件。下载扩展目录后,它们将被缓存在用户的本地 Maven 存储库中,并且即使网络互联网(或注册表本身)不可用,它们仍可供开发工具使用。

本地缓存的扩展目录构件会定期检查更新,并且如果在注册表中提供了这些目录的较新版本,则会更新它们。检查更新的默认时间间隔为 daily,这与 SNAPSHOT 构件的默认 Maven 存储库 updatePolicy 相匹配。

Maven repository configuration

下面的存储库配置仅出于说明目的而显示,且必须 NOT 添加到用户 settings.xml 或应用程序的 pom.xml 中。Quarkus 开发工具预先配置了这个存储库。

<repository>
  <id>registry.quarkus.io</id>
  <name>Quarkus community extension registry</name>
  <url>https://registry.quarkus.io/maven</url>
  <snapshots>
    <enabled>true</enabled>
    <updatePolicy>daily</updatePolicy>
    <checksumPolicy>warn</checksumPolicy>
  </snapshots>
</repository>

初始化 Quarkus 开发工具后,此存储库配置会自动添加到用于从 registry.quarkus.io 解析平台和扩展目录的 Maven 解析器中。

Maven repository mirrors and proxies

初始化 Quarkus 开发工具 Maven 解析器后,会在用户 settings.xml 中找到的相关 Maven 镜像和代理会自动应用至 registry.quarkus.io Maven 存储库配置,就像 registry.quarkus.io Maven 存储库在用户 settings.xml 中进行配置那样。

这意味着,例如,如果将匹配的 Maven 存储库镜像应用至 registry.quarkus.io Maven 存储库,则必须将 registry.quarkus.io Maven 存储库添加到相应的 Maven 服务器实例(例如 Nexus)中的镜像存储库组。

Overriding the default registry Maven repository configuration

实际上,可以通过简单添加所需的 <repository> 配置(其 <id> 值为 registry.quarkus.io)来在用户 settings.xml 中覆盖默认注册表 Maven 存储库配置。如果在用户 settings.xml 中找到了此类存储库配置,则开发工具将使用它来代替上面所示的默认 registry.quarkus.io Maven 存储库配置。

Quarkus Extension Registry Client Configuration

通常情况下,Quarkus 社区的用户在其环境中不需要任何与注册表相关的配置。默认情况下,由 registry.quarkus.io 托管的注册表已在所有 Quarkus 开发工具中启用。但是,在某些情况下,自定义注册表客户端配置可能会有所帮助。例如,更改本地注册表缓存更新策略或配置其他(非默认)Quarkus 扩展注册表。

Registry client configuration location

启动 Quarkus 开发工具时,将按照以下步骤搜索注册表客户端配置文件:

  1. 如果存在,将检查 quarkus.tools.config 系统属性,其值将用作注册表客户端配置文件的路径;

  2. 检查当前目录是否包含 .quarkus/config.yaml 文件,如果该文件存在,它将用于配置注册表客户端;

  3. 检查用户主目录是否包含 ~/.quarkus/config.yaml 文件,如果该文件存在,它将用于配置注册表客户端;

  4. 如果上述步骤均未找到配置文件,则将使用默认 registry.quarkus.io 配置。

Configuring multiple registries

registry.quarkus.io 是默认的 Quarkus 社区扩展注册表,但并不意味着它总是唯一注册表。其他组织可能发现创建自己的 Quarkus 扩展注册表以提供自己的 Quarkus platforms 和/或单独(非平台)Quarkus 扩展很有用。希望在其环境中启用自定义 Quarkus 扩展注册表的用户需要将其添加到注册表客户端配置文件。

注册表客户端配置文件是一个简单的 YAML 文件,其中包含注册表列表,例如:

registries:
- registry.acme.org
- registry.quarkus.io

上面的配置启用两个注册表: registry.acme.orgregistry.quarkus.io 。注册表的顺序实际上很重要。当 Quarkus 开发工具应用户的请求寻找扩展时,将按照配置的顺序搜索注册表,即从列表的顶部到底部。首先找到的扩展和平台将显示为用户首选的扩展和平台。

registry.quarkus.io 是默认注册表,通常无需显式配置,但是,如果用户提供自定义注册表列表并且其中没有 registry.quarkus.io ,则将启用 registry.quarkus.io

例如,这里有一个将默认 registry.quarkus.io 注册表替换为自定义注册表的注册表客户端配置:

registries:
- registry.acme.org

Adjusting the registry cache update policy

通常,Quarkus 扩展注册表将实现为 Maven 快照存储库。从注册表解析出的平台和扩展目录将缓存到用户的本地 Maven 存储库。平台和扩展目录实际上是 SNAPSHOT 构件,注册表客户端会定期检查它们是否有更新。检查更新的默认注册表间隔与 Maven 的 snapshot repositories 的默认值 updatePolicy 匹配,即 daily 。可以在注册表配置中覆盖此默认值,例如:

registries:
- registry.acme.org:
    update-policy: "always"
- registry.quarkus.io

在上面的示例中,将在每个目录请求中检查 registry.acme.org 注册表的目录更新,而将每天检查一次 registry.quarkus.io 注册表的目录更新(在当天的第一个目录请求中)。

下面是注册表的 update-policy 值的所有选择列表:

  • always - 在每个目录请求中检查更新;

  • daily (默认值) - 在第一个目录请求中每天检查一次目录更新;

  • interval:X (其中 X 是以分钟为单位的整数) - 以分钟为单位的自定义间隔;

  • never - 解析目录一次,永不检查更新。

Disabling a registry in the configuration

配置文件中列出的所有注册表默认情况下均已启用。但是,可以通过向其配置中添加 enabled: false 来禁用注册表。例如:

registries:
- registry.acme.org
- registry.quarkus.io:
    enabled: false

在上面的配置中,仅启用了 registry.acme.org。上面的配置等同于:

registries:
- registry.acme.org

Enabling the debug mode

默认情况下,注册表客户端不会记录太多信息。但是,它确实会从 Maven 存储库后台解析各种工件。如果你想在日志中查看工件传输和其他调试相关消息,可以在配置中启用调试模式。例如:

debug: true
registries:
- registry.acme.org
- registry.quarkus.io

Overriding a registry URL

可能会发生注册表 URL 更改的情况,但 ID 必须相同(因为查询了 Maven 坐标)。要覆盖注册表 URL,请添加以下内容:

registries:
- registry.acme.org
- registry.quarkus.io:
    maven:
      repository:
        url: https://internal.registry.acme.org/maven

[id="how-to-register-as-nexus-repository"] How to register as a Nexus Repository proxy

你可以将 Quarkus 扩展注册表注册为 Nexus 存储库代理。你需要成为管理员才能执行这些操作。

[id="how-to-register-as-nexus-2-repository"] Nexus 2.x

需要设置一些选项:

  • Repository Policy 设置为 Snapshot

  • Disable Download Remote Indexes;

  • Disable Allow File Browsing;

  • Disable Include in Search.

以下是如何设置的示例:

Nexus Repository Manager: Add Proxy Repository

Nexus Repository Proxy

[id="how-to-register-as-nexus-3-repository"] Nexus 3.x

Nexus Repository Proxy