第 5 章 使用 code.quarkus.redhat.com 创建 Quarkus Maven 项目

作为应用程序开发人员,您可以使用 code.quarkus.redhat.com 生成 Quarkus Maven 项目,并自动添加并配置要在应用程序中使用的扩展。另外,code.quarkus.redhat.com 会自动管理将项目编译成原生可执行文件所需的配置参数。

本节介绍了生成 Quarkus Maven 项目的过程,包括:

  • 指定应用程序的基本详情。
  • 选择您要包含在项目中的扩展。
  • 使用项目文件生成可下载的存档。
  • 使用自定义命令编译和启动应用程序。

先决条件

  • 具有 Web 浏览器。

流程

  1. 使用 Web 浏览器进入到 https://code.quarkus.redhat.com
  2. 指定项目的基本详情:

    1. 输入项目的组名称。名称的格式遵循 Java 软件包命名约定,如 org.acme
    2. 输入您要用于项目生成的 Maven 工件的名称,如 code-with-quarkus
    3. 选择您要用来编译和启动应用程序的构建工具。您选择的构建工具决定:

      • 生成的项目的目录结构。
      • 您生成的项目中使用的配置文件格式。
      • 在生成项目后,用来编译和启动应用程序的自定义构建脚本和命令会显示 code.quarkus.redhat.com。

        注意

        红帽提供了对使用 code.quarkus.redhat.com 创建 Quarkus Maven 项目的支持。红帽不支持生成 Gradle 项目。

        code.quarkus.redhat.com 网站的基本应用程序详情部分截图
  3. 指定应用程序项目的更多详情:

    1. 选择 Configure more options 来显示包含额外应用程序详情的字段。
    2. 输入项目生成的工件中使用的版本。此字段的默认值为 1.0.0-SNAPSHOT。建议使用 语义版本 控制,但如果您偏好使用不同类型的版本控制。
    3. 选择您是否希望 code.quarkus.redhat.com 将示例代码添加到您的项目中。当您从扩展列表中添加标记为 example code 图标的扩展时,您可以启用这个选项,以便在生成项目时为这些扩展自动创建示例类文件和资源文件。当您不添加提供示例代码的任何扩展时,这个选项不会影响您生成的项目。

      code.quarkus.redhat.com 站点的应用程序详情部分截图显示扩展表单,以及其他应用程序详情
      注意

      code.quarkus.redhat.com 会自动使用红帽构建的 Quarkus 的最新版本。您可在生成项目后手动更改 pom.xml 文件中的 BOM 版本。

  4. 从扩展列表中选择您要在应用程序中使用的扩展。所选扩展包含在 Quarkus 应用程序的依赖项中,及其版本由 Quarkus 平台管理,以确保其兼容性。

    您可以启用这个选项来为标记为 example code 图标的扩展自动生成示例代码。

    Screenshot of the list of extensions at the code.quarkus.redhat.com site that you can add to your project

    请注意,红帽为列表上的单个扩展 提供不同的支持级别,由每个扩展名称旁的标签表示:

    • 红帽完全支持 SUPPORTED 扩展,用于生产环境中的企业级应用程序。
    • 技术预览功能支持范围 下,红帽对生产环境中的 支持 受到有限的支持。
    • 红帽不支持将 DEV-SUPPORT 扩展用于生产环境,但红帽提供的核心功能由红帽开发人员支持用于开发新应用程序。
    • 红帽不支持未标记的扩展用于生产环境。
    • DEPRECATED 扩展计划被提供相同功能的较新的技术或实施替代。

      您可以扩展每个扩展旁边的溢出菜单,以访问您可以使用的附加选项:

      • 在命令行中使用 Quarkus maven 插件,将扩展添加到现有项目。
      • 复制 XML 代码片段,将扩展添加到项目的 pom.xml 文件中。
      • 获取每个扩展的 groupIdartifactIdversion
      • 打开扩展指南。

        Screenshot of an expanded overflow menu next to one of the extensions on code.quarkus.redhat.coim showing the custom commands that you can copy

  5. 选择 Generate your application 来确认您的选择并显示覆盖页面,其中包含包含您生成的项目的存档的下载链接。覆盖屏幕还显示可用于编译和启动应用程序的自定义命令。
  6. 选择 Download the ZIP,将生成的项目文件的归档保存到机器中。
  7. 提取存档的内容。
  8. 进入包含您提取的项目文件的目录:

    cd <directory_name>
  9. 以开发模式编译并启动应用程序:

    ./mvnw compile quarkus:dev