第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 が表示)。

        注記

        Red Hat は、code.quarkus.redhat.com を使用して Quarkus Maven プロジェクトのみを作成する際にサポートを提供します。Red Hat では、Gradle プロジェクトの生成はサポートしていません。

        code.quarkus.redhat.com サイトの基本アプリケーションの詳細セクションのスクリーンショット
  3. アプリケーションプロジェクトに関する追加情報を指定します。

    1. Configure more options を選択し、追加のアプリケーションの詳細が含まれるフィールドを表示します。
    2. プロジェクトから生成されたアーティファクトで使用されるバージョンを入力します。このフィールドのデフォルト値は 1.0.0-SNAPSHOT です。semantic versioning の使用が推奨されますが、必要に応じて、別のタイプのバージョンを使用できます。
    3. code.quarkus.redhat.com がサンプルコードをプロジェクトに追加するかどうかを選択します。エクステンションの一覧から example code アイコンでマーク付けされたエクステンションをプロジェクトに追加する場合は、このオプションを有効にして、プロジェクトの生成時にこれらのエクステンションのクラスファイルおよびリソースファイルのサンプルを自動的に作成できます。サンプルコードを提供するエクステンションを追加しない場合、このオプションは生成されたプロジェクトには影響しません。

      code.quarkus.redhat.com サイトのアプリケーションの詳細セクションのスクリーンショット。追加のアプリケーションの詳細を含む拡張フォームが表示されています。
      注記

      code.quarkus.redhat.com は、Red Hat ビルドの 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

    Red Hat は、一覧にある個別のエクステンションに対して さまざまなレベル のサポートを提供します。レベルは、各エクステンション名の横にあるラベルで示されています。

    • SUPPORTED エクステンション: Red Hat は、実稼働環境でのエンタープライズアプリケーションでの使用に対して完全にサポートしています。
    • TECH-PREVIEW 拡張: Red Hat は、テクノロジープレビュー機能のサポート範囲 に基づき、限定的に、実稼働環境でのサポートを提供します。
    • DEV-SUPPORT エクステンション: Red Hat は、実稼働環境での使用をサポートしていません。ただし、新規アプリケーションの開発での使用に対しては、Red Hat 開発者がこれらのコア機能をサポートしています。
    • Red Hat は、ラベル付けされていないエクステンションの実稼働環境での使用をサポートしていません。
    • DEPRECATED エクステンション: 同じ機能を提供する新しいテクノロジーまたは実装に置き換えられる予定です。

      各エクステンションの横にあるオーバーフローメニュー (⋮) を展開して、以下を実行する追加オプションにアクセスできます。

      • エクステンションを既存プロジェクトに追加する (コマンドラインで Quarkus Maven プラグインを使用)。
      • プロジェクトの pom.xml ファイルへエクステンションを追加するための XML スニペットをコピーする。
      • 各エクステンションの groupIdartifactId、および version を取得する。
      • エクステンションガイドを開く。

        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