Red Hat build of Quarkus スタートガイド

手順

1. テキストエディターまたは統合開発環境 (IDE) で、Maven $HOME/.m2/settings.xml ファイルを開きます。

   注記

   $HOME/.m2/ ディレクトリーに settings.xml ファイルが存在しない場合は、$MAVEN_HOME/conf/ ディレクトリーから $HOME/.m2/ ディレクトリーに settings.xml ファイルをコピーします。

2. 以下の行を settings.xml ファイルの <profiles> 要素に追加します。

   <!-- Configure the Red Hat build of Quarkus Maven repository -->
   <profile>
     <id>red-hat-enterprise-maven-repository</id>
     <repositories>
       <repository>
         <id>red-hat-enterprise-maven-repository</id>
         <url>https://maven.repository.redhat.com/ga/</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
       </repository>
     </repositories>
     <pluginRepositories>
       <pluginRepository>
         <id>red-hat-enterprise-maven-repository</id>
         <url>https://maven.repository.redhat.com/ga/</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
       </pluginRepository>
     </pluginRepositories>
   </profile>

3. 以下の行を settings.xml ファイルの <activeProfiles> 要素に追加し、ファイルを保存します。

   <activeProfile>red-hat-enterprise-maven-repository</activeProfile>

手順

1. エクステンションレジストリー設定が含まれる config.yaml ファイルを開きます。拡張機能レジストリーを初めて設定する場合は、マシンの $HOME/.quarkus ディレクトリーに config.yaml ファイルを作成する必要があります。

2. 新しいレジストリーを config.yaml ファイルに追加します。以下に例を示します。

   config.yaml

   registries:
     - registry.quarkus.redhat.com
     - registry.quarkus.io

手順

1. Maven が OpenJDK 17 または 21 を使用していること、Maven のバージョンが 3.9.9 であること、および mvn が PATH 環境変数からアクセスできることを確認します。

   mvn --version

2. 前のコマンドで OpenJDK 17 または 21 が返されない場合は、OpenJDK 17 または 21 へのパスを PATH 環境変数に追加し、前のコマンドを再度入力します。

3. プロジェクトを生成します。

   • Linux または Apple macOS を使用している場合は、以下のコマンドを入力します。

     mvn com.redhat.quarkus.platform:quarkus-maven-plugin:3.20.0.redhat-00002:create \
         -DprojectGroupId=org.acme \
         -DprojectArtifactId=getting-started \
         -DplatformGroupId=com.redhat.quarkus.platform \
         -DplatformVersion=3.20.0.redhat-00002 \
         -DclassName="org.acme.quickstart.GreetingResource" \
         -Dpath="/hello"
     cd getting-started

   • Microsoft Windows のコマンドラインを使用している場合は、以下のコマンドを入力します。

     mvn com.redhat.quarkus.platform:quarkus-maven-plugin:3.20.0.redhat-00002:create
     -DprojectGroupId=org.acme -DprojectArtifactId=getting-started
     -DplatformGroupId=com.redhat.quarkus.platform
     -DplatformVersion=3.20.0.redhat-00002
     -DclassName="org.acme.quickstart.GreetingResource"
     -Dpath="/hello"

   • Microsoft Windows PowerShell を使用している場合は、以下のコマンドを入力します。

     mvn com.redhat.quarkus.platform:quarkus-maven-plugin:3.20.0.redhat-00002:create
     "-DprojectGroupId=org.acme"
     "-DprojectArtifactId=getting-started"
     "-DplatformVersion=3.20.0.redhat-00002"
     "-DplatformGroupId=com.redhat.quarkus.platform"
     "-DclassName=org.acme.quickstart.GreetingResource"
     "-Dpath=/hello"

     これらのコマンドにより、./getting-started ディレクトリーに以下の要素が作成されます。

     • Maven プロジェクトディレクトリー構造
     • /hello で公開される org.acme.quickstart.GreetingResource リソース
     • ネイティブモードおよび JVM モードでアプリケーションをテストするための関連するユニットテスト
     • アプリケーションの起動後に http://localhost:8080 でアクセス可能なランディングページ
     • src/main/docker ディレクトリー内のサンプル Dockerfile

     • アプリケーションの設定ファイル

       注記

       Mandrel は macOS をサポートしていないため、Oracle GraalVM を使用してこのオペレーティングシステム上でネイティブ実行可能ファイルをビルドできます。

       ベアメタル Linux または Windows ディストリビューション上で Oracle GraalVM を直接使用して、ネイティブ実行可能ファイルをビルドすることもできます。このプロセスの詳細は、Oracle GraalVM README およびリリースノートを参照してください。

       サポートされる構成の詳細は、Red Hat build of Quarkus でサポートされる構成 を参照してください。

4. ディレクトリー構造が作成されたら、テキストエディターで pom.xml ファイルを開き、ファイルの内容を確認します。

   pom.xml

   <project>
     ...
     <properties>
        ...
        <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
        <quarkus.platform.group-id>com.redhat.quarkus.platform</quarkus.platform.group-id>
        <quarkus.platform.version>3.20.0.redhat-00002</quarkus.platform.version>
        ...
     </properties>
     ...
     <dependencyManagement>
         <dependencies>
           <dependency>
             <groupId>${quarkus.platform.group-id}</groupId>
             <artifactId>${quarkus.platform.artifact-id}</artifactId>
             <version>${quarkus.platform.version}</version>
             <type>pom</type>
             <scope>import</scope>
           </dependency>
         </dependencies>
     </dependencyManagement>
     ...
     <build>
         ...
         <plugins>
           ...
           <plugin>
             <groupId>${quarkus.platform.group-id}</groupId>
             <artifactId>quarkus-maven-plugin</artifactId>
             <version>${quarkus.platform.version}</version>
             <extensions>true</extensions>
             <executions>
               <execution>
                 <goals>
                   <goal>build</goal>
                   <goal>generate-code</goal>
                   <goal>generate-code-tests</goal>
                 </goals>
               </execution>
             </executions>
           </plugin>
           ...
         </plugins>
         ...
     </build>
    ...
   </project>

   pom.xml ファイルの <dependencyManagement> セクションには、Quarkus BOM が格納されています。そのため、pom.xml ファイルに個別の Quarkus 依存関係のバージョンを記述する必要はありません。この設定ファイルには、アプリケーションをパッケージ化する quarkus-maven-plugin プラグインも含まれています。

5. pom.xml ファイル内の quarkus-rest (旧称 quarkus-resteasy-reactive) 依存関係を確認します。この依存関係により、Jakarta REST アノテーションを使用して REST アプリケーションを開発できるようになります。

   <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-rest</artifactId>
   </dependency>

   注記

   Red Hat build of Quarkus バージョン 3.15 以降、quarkus-resteasy-reactive エクステンションの名前が quarkus-rest に変更されます。quarkus-resteasy-reactive 依存関係を使用するアプリケーションは、依存関係を更新するよう求められます。

6. src/main/java/org/acme/quickstart/GreetingResource.java ファイルを確認します。

   import jakarta.ws.rs.GET;
   import jakarta.ws.rs.Path;
   import jakarta.ws.rs.Produces;
   import jakarta.ws.rs.core.MediaType;
   
   @Path("/hello")
   public class GreetingResource {
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "Hello from Quarkus REST";
       }
   }

   このファイルには、/hello エンドポイントに送信したリクエストに対するレスポンスとして、Hello from Quarkus REST を返す単純な REST エンドポイントが含まれています。

   注記

   Quarkus では、Jakarta REST (旧名 JAX-RS) の Application クラスがサポートされていますが、必須ではありません。さらに、デフォルトでは、GreetingResource クラスのインスタンスは 1 つだけ作成され、リクエストごとに 1 つ作成されるわけではありません。これは、RequestScoped などのさまざまな *Scoped アノテーションを使用して設定できます。

検証

1. 開発モードで、アプリケーションのコンパイルと起動を行います。詳細は、Red Hat build of Quarkus Getting Started プロジェクトのコンパイルと起動 を参照してください。
2. Quarkus CLI から Getting Started プロジェクトをパッケージ化して実行します。詳細は、Red Hat build of Quarkus Getting Started アプリケーションのパッケージ化と実行 を参照してください。

手順

1. Web ブラウザーで、https://code.quarkus.redhat.com に移動します。

2. code.quarkus.redhat.com アプリケーションでは、利用可能なバージョンのリストから、Red Hat build of Quarkus の最新リリースがデフォルトで選択されます。

   注記

   code.quarkus.redhat.com アプリケーションでは、推奨オプションである Red Hat build of Quarkus の最新リリースが使用されます。プロジェクトを生成した後、必要に応じて pom.xml ファイルで以前の BOM バージョンに手動で変更することもできます。ただし、これは推奨されません。

3. プロジェクトの基本情報を指定します。

   
   1. プロジェクトのグループ名を入力します。名前の形式は、Java パッケージ命名規則に従います (例: org.acme)。
   2. プロジェクトによって生成される Maven アーティファクトの名前 (code-with-quarkus など) を入力します。

   3. アプリケーションのコンパイルおよび起動に使用するビルドツールを選択します。選択したビルドツールにより、次の設定が決まります。

      • 生成されるプロジェクトのディレクトリー構造
      • 生成されるプロジェクトで使用される設定ファイルのフォーマット

      • プロジェクトの生成後に code.quarkus.redhat.com に表示される、アプリケーションのコンパイルと起動のためのカスタムビルドスクリプトおよびコマンド

        注記

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

4. アプリケーションプロジェクトに関する追加情報を指定します。

   1. アプリケーションの詳細を含むフィールドを表示するには、More options を選択します。

      
   2. プロジェクトによって生成されたアーティファクトに使用するバージョンを入力します。このフィールドのデフォルト値は 1.0.0-SNAPSHOT です。semantic versioning の使用が推奨されます。ただし、別のタイプのバージョン管理を指定することもできます。
   3. code.quarkus.redhat.com でプロジェクトにスターターコードを追加するかどうかを選択します。"STARTER-CODE" でマークされたエクステンションをプロジェクトに追加する場合、このオプションを有効にして、プロジェクト生成時にそのエクステンションのサンプルクラスとリソースファイルを自動的に作成できます。ただし、サンプルコードを提供するエクステンションを追加しない場合、このオプションは生成されたプロジェクトには影響しません。
   注記

   code.quarkus.redhat.com アプリケーションでは、Red Hat build of Quarkus の最新リリースが自動的に使用されます。ただし、必要に応じて、プロジェクト生成後に pom.xml ファイル内の以前の BOM バージョンに手動で変更することもできますが、これは推奨されません。

5. 使用するエクステンションを選択します。Quarkus アプリケーションには、依存関係として選択した拡張機能が含まれます。Quarkus プラットフォームにより、これらのエクステンションは今後のバージョンとの互換性も確保されます。

   重要

   同じプロジェクトで quarkus-rest エクステンションと quarkus-resteasy エクステンションを使用しないでください。どちらも同様の機能を提供しますが、動作方法は非常に異なります。quarkus-rest の使用が推奨されます。

   エクステンションの横にある quark アイコン ( ) は、そのエクステンションが Red Hat build of Quarkus プラットフォームリリースの一部であることを示します。Red Hat は、同じプラットフォームのエクステンションを使用することを推奨します。これは、エクステンションは一緒にテストおよび検証され、使用とアップグレードが容易になるためです。

   "STARTER-CODE" という表示があるエクステンションでは、スターターコードを自動的に生成するオプションを有効にできます。

   

6. 選択を確認するには、Generate your application を選択します。表示されるダイアログボックスには、次の項目が表示されます。

   • 生成されたプロジェクトを含むアーカイブをダウンロードするためのリンク
   • アプリケーションをコンパイルして起動するために使用できるコマンド
7. 生成されたプロジェクトファイルを含むアーカイブをマシンに保存するには、Download the ZIP を選択します。
8. アーカイブの内容をデプロイメントします。

検証

1. 開発モードで、アプリケーションのコンパイルと起動を行います。詳細は、Red Hat build of Quarkus Getting Started プロジェクトのコンパイルと起動 を参照してください。
2. Quarkus CLI から Getting Started プロジェクトをパッケージ化して実行します。詳細は、Red Hat build of Quarkus Getting Started アプリケーションのパッケージ化と実行 を参照してください。

手順

1. プロジェクトを生成するには、コマンドターミナルで次のコマンドを入力します。

   quarkus create && cd code-with-quarkus

   注記

   'app' サブコマンド (例: quarkus create app) を指定することもできます。ただし、'app' サブコマンドが指定されていない場合は暗黙的に指定されるため、必須ではありません。

   このコマンドを使用すると、Quarkus プロジェクトを現在の作業ディレクトリーの 'code-with-quarkus' というフォルダーに作成します。

2. デフォルトでは、groupId 属性、artifactId 属性、version 属性は次のデフォルト値に指定されます。

   • groupId='org.acme'
   • artifactId='code-with-quarkus'

   • version='1.0.0-SNAPSHOT'

     groupId、artifactId、および version 属性の値を変更するには、quarkus create コマンドを発行し、CLI で次の構文を指定します。

     groupId:artifactId:version

     たとえば quarkus create app mygroupId:myartifactid:version です。

   注記

   使用可能なすべての Quarkus コマンドに関する情報を表示するには、help パラメーターを指定します。

   quarkus --help

3. テキストエディターで src/main/java/org/acme/GreetingResource.java ファイルを確認します。

   package org.acme;
   
   import jakarta.ws.rs.GET;
   import jakarta.ws.rs.Path;
   import jakarta.ws.rs.Produces;
   import jakarta.ws.rs.core.MediaType;
   
   @Path("/hello")
   public class GreetingResource {
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "Hello from Quarkus REST";
       }
   }

   このファイルには、/hello エンドポイントに送信したリクエストに対するレスポンスとして、Hello from Quarkus REST を返す単純な REST エンドポイントが含まれています。

検証

1. 開発モードで、アプリケーションのコンパイルと起動を行います。詳細は、Red Hat build of Quarkus Getting Started プロジェクトのコンパイルと起動 を参照してください。
2. Quarkus CLI から Getting Started プロジェクトをパッケージ化して実行します。詳細は、Red Hat build of Quarkus Getting Started アプリケーションのパッケージ化と実行 を参照してください。