Apache Maven を使用した Quarkus アプリケーションの開発およびコンパイル

手順

1. コマンドターミナルで以下のコマンドを入力し、Maven が JDK 11 を使用していること、そして Maven のバージョンが 3.6.2 以上であることを確認します。

   mvn --version

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

3. Quarkus Maven プラグインを使用して新規プロジェクトを作成するには、以下のいずれかの方法を使用します。

   • 以下のコマンドを入力します。

     mvn io.quarkus:quarkus-maven-plugin:1.11.7.Final-redhat-00009:create \
         -DprojectGroupId=<project_group_id> \
         -DprojectArtifactId=<project_artifact_id> \
         -DplatformGroupId=com.redhat.quarkus \
         -DplatformArtifactId=quarkus-universe-bom \
         -DplatformVersion=1.11.7.Final-redhat-00009 \
         -DclassName="<classname>"

     このコマンドでは、以下の値を置き換えてください。

     • <project_group_id>: プロジェクトの一意識別子
     • <project_artifact_id>: プロジェクトおよびプロジェクトディレクトリーの名前
     • <classname>: 生成されたリソースの完全修飾名 (例: org.acme.quarkus.sample.HelloResource)

   • インタラクティブモードでプロジェクトを作成します。

     mvn io.quarkus:quarkus-maven-plugin:1.11.7.Final-redhat-00009:create

     プロンプトが表示されたら、必要な属性値を入力します。

     注記

     以下のコマンドを入力し、プロジェクト属性のデフォルト値を使用してプロジェクトを作成することもできます。

     mvn io.quarkus:quarkus-maven-plugin:1.11.7.Final-redhat-00009:create -B

     以下の表は、create コマンドで定義できる属性を一覧表示しています。

     属性	デフォルト値	説明
     projectGroupId	org.acme.sample	プロジェクトの一意識別子。
     projectArtifactId	なし	プロジェクトおよびプロジェクトディレクトリーの名前。projectArtifactId を指定しないと、Maven プラグインはインタラクティブモードを起動します。ディレクトリーがすでに存在する場合、生成は失敗します。
     projectVersion	1.0-SNAPSHOT	プロジェクトのバージョン。
     platformGroupId	io.quarkus	プラットフォームのグループ ID。既存のプラットフォームのデフォルト値はすべて、io.quarkus です。ただし、デフォルト値は変更することができます。
     platformArtifactId	quarkus-universe-bom	プラットフォーム BOM のアーティファクト ID。ローカルにビルドされた Quarkus を使用するには、quarkus-universe-bom を pom.xml ファイルに追加します。
     platformVersion	プラットフォームの最新バージョン	プロジェクトに使用するプラットフォームのバージョン。バージョン範囲を指定でき、Maven プラグインは最新バージョンを使用します。
     className	なし	生成されたリソースの完全修飾名。アプリケーションの作成後、REST エンドポイントは以下の URL で公開されます。 http://localhost:8080/$path デフォルトの path を使用する場合、URL は http://localhost:8080/hello になります。
     path	/hello	リソースパス (className を設定した場合のみ)。
     extensions	[]	プロジェクトに追加するエクステンションのコンマ区切りリスト。

手順

1. テキストエディターで pom.xml ファイルを開きます。

2. 以下が含まれる設定プロパティーを追加します。

   • Quarkus Maven プラグインのバージョン
   • Quarkus BOM の groupID、artifactID、および version
   • Maven Surefire プラグインのバージョン

   <properties>
       <quarkus-plugin.version>1.11.7.Final-redhat-00009</quarkus-plugin.version>
       <quarkus.platform.artifact-id>quarkus-universe-bom</quarkus.platform.artifact-id>
       <quarkus.platform.group-id>com.redhat.quarkus</quarkus.platform.group-id>
       <quarkus.platform.version>1.11.7.Final-redhat-00009</quarkus.platform.version>
       <surefire-plugin.version>3.0.0-M5</surefire-plugin.version>
   </properties>

3. Quarkus GAV (Group、Artifact、Version) を追加し、quarkus-universe-bom ファイルを使用して、Quarkus の異なる依存関係のバージョンを省略します。

   <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>

4. Quarkus Maven プラグインを追加します。

   <build>
       <plugins>
           <plugin>
               <groupId>io.quarkus</groupId>
               <artifactId>quarkus-maven-plugin</artifactId>
               <version>${quarkus.platform.version}</version>
               <executions>
                   <execution>
                       <goals>
                           <goal>build</goal>
                       </goals>
                   </execution>
               </executions>
           </plugin>
       </plugins>
   </build>

5. 任意手順: ネイティブアプリケーションをビルドするには、Maven Surefire および Maven Failsafe プラグインを含む特定のネイティブプロファイルを追加し、native パッケージタイプを有効にします。

   <profiles>
       <profile>
           <id>native</id>
           <properties>
               <quarkus.package.type>native</quarkus.package.type>
           </properties>
           <build>
               <plugins>
                   <plugin>
                       <groupId>org.apache.maven.plugins</groupId>
                       <artifactId>maven-failsafe-plugin</artifactId>
                       <version>${surefire-plugin.version}</version>
                       <executions>
                           <execution>
                               <goals>
                                   <goal>integration-test</goal>
                                   <goal>verify</goal>
                               </goals>
                               <configuration>
                                   <systemProperties>
                                       <native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
                                   </systemProperties>
                               </configuration>
                           </execution>
                       </executions>
                   </plugin>
               </plugins>
           </build>
       </profile>
   </profiles>

   名前に IT が含まれるテストは、@NativeImageTest アノテーションが付けられ、ネイティブ実行可能ファイルに対して実行されます。

手順

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 プロジェクトの生成はサポートしていません。

        

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

   1. Configure more options を選択し、追加のアプリケーションの詳細が含まれるフィールドを表示します。
   2. プロジェクトから生成されたアーティファクトで使用されるバージョンを入力します。このフィールドのデフォルト値は 1.0.0-SNAPSHOT です。semantic versioning の使用が推奨されますが、必要に応じて、別のタイプのバージョンを使用できます。

   3. code.quarkus.redhat.com がサンプルコードをプロジェクトに追加するかどうかを選択します。エクステンションの一覧から アイコンでマーク付けされたエクステンションをプロジェクトに追加する場合は、このオプションを有効にして、プロジェクトの生成時にこれらのエクステンションのクラスファイルおよびリソースファイルのサンプルを自動的に作成できます。サンプルコードを提供するエクステンションを追加しない場合、このオプションは生成されたプロジェクトには影響しません。

      
      注記

      code.quarkus.redhat.com は、Red Hat ビルドの Quarkus の最新リリースを自動的に使用します。プロジェクトの生成後に、pom.xml ファイルで BOM バージョンを手動で変更できます。

4. エクステンションの一覧から、アプリケーションで使用するエクステンションを選択します。選択したエクステンションは、Quarkus アプリケーションの依存関係として含まれ、それらのバージョンは互換性を確保するために Quarkus プラットフォームによって管理されます。

   このオプションを有効にすると、 アイコンでマーク付けされたエクステンションのサンプルコードを自動的に生成できます。

   

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

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

   • DEPRECATED エクステンション: 同じ機能を提供する新しいテクノロジーまたは実装に置き換えられる予定です。

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

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

     • エクステンションガイドを開く。

       

5. Generate your application を選択して選択内容を確認し、生成されたプロジェクトを含むアーカイブのダウンロードリンクのオーバーレイ画面を表示します。オーバーレイ画面には、アプリケーションのコンパイルおよび起動に使用できるカスタムコマンドも表示されます。
6. Download the ZIP を選択して、生成されたプロジェクトファイルを含むアーカイブをマシンに保存します。
7. アーカイブの内容を展開します。

8. 展開したプロジェクトファイルが含まれるディレクトリーに移動します。

   cd <directory_name>

9. 開発モードでアプリケーションをコンパイルして起動します。

   ./mvnw compile quarkus:dev

手順

1. Quarkus プロジェクトディレクトリーに移動します。

2. 利用可能なエクステンションを一覧表示するには、以下のコマンドを入力します。

   ./mvnw quarkus:list-extensions

3. プロジェクトにエクステンションを追加するには、以下のコマンドを入力します。ここで、<extension> は、追加するエクステンションの Group、Artifact、Version (GAV) です。

   ./mvnw quarkus:add-extension -Dextensions="<extension>"

   たとえば、Agroal エクステンションを追加するには、以下のコマンドを入力します。

   ./mvnw quarkus:add-extension -Dextensions="io.quarkus:quarkus-agroal"

4. 特定のエクステンションを検索するには、-Dextensions= の後にエクステンション名または名前の一部を入力します。以下の例では、名前に jdbc、agroal、および non-exist-ent のテキストが含まれるエクステンションを検索します。

   ./mvnw quarkus:add-extension -Dextensions=jdbc,agroal,non-exist-ent

   このコマンドは、以下の結果を返します。

   ❌ Multiple extensions matching 'jdbc'
       * io.quarkus:quarkus-jdbc-h2
       * io.quarkus:quarkus-jdbc-mariadb
       * io.quarkus:quarkus-jdbc-postgresql
       Be more specific e.g using the exact name or the full gav.
   ✅ Adding extension io.quarkus:quarkus-agroal
   ❌ Cannot find a dependency matching 'non-exist-ent', maybe a typo?
   [...]

5. 特定のテキスト文字列が返すすべてのエクステンションをインストールするには、-Dextensions= の後にエクステンション名または名前の一部を入力します。以下の例では、hibernate- で始まるすべてのエクステンションを検索し、インストールします。

   ./mvnw quarkus:add-extension -Dextensions="hibernate-*"

CodeReady Studio または Eclipse

1. CodeReady Studio または Eclipse で、File → Import とクリックします。
2. Maven → Existing Maven Project と選択します。
3. 次の画面で、プロジェクトのルートロケーションを選択します。見つかったモジュールの一覧が表示されます。
4. 生成されたプロジェクトを選択し、Finish をクリックします。

5. アプリケーションを起動するには、新しいターミナルウィンドウに以下のコマンドを入力します。

   ./mvnw compile quarkus:dev

IntelliJ

1. IntelliJ で、以下のタスクのいずれかを実行します。

   • File → New → Project From Existing Sources と選択します。
   • Welcome ページで Import project を選択します。
2. プロジェクトの root ディレクトリーを選択します。
3. Import project from external model を選択してから、Maven を選択します。
4. オプションを確認して Next をクリックします。
5. Finish をクリックします。

6. アプリケーションを起動するには、新しいターミナルウィンドウに以下のコマンドを入力します。

   ./mvnw compile quarkus:dev

Apache NetBeans

1. File → Open Project と選択します。
2. プロジェクトの root ディレクトリーを選択します。
3. Open Project クリックします。

4. アプリケーションを起動するには、新しいターミナルウィンドウに以下のコマンドを入力します。

   ./mvnw compile quarkus:dev

Visual Studio Code

1. Java Extension Pack をインストールします。
2. Visual Studio Code でプロジェクトディレクトリーを開きます。プロジェクトは Maven プロジェクトとしてロードされます。

手順

1. テキストエディターで application.properties ファイルを開きます。

2. 変更するプロパティーの値を編集し、ファイルを保存します。

   以下の表は、変更可能なプロパティーをまとめたものです。

   プロパティー	説明	型	デフォルト
   quarkus.package.main-class	アプリケーションのエントリーポイント。ほとんどの場合、この値は変更する必要があります。	文字列	io.quarkus.runner.GeneratedMain
   quarkus.package.type	要求された出力タイプ。	文字列	jar
   quarkus.package.uber-jar	Java ランナーを uber-JAR としてパックすべきかどうか。	ブール値	false
   quarkus.package.manifest.add-implementation-entries	実装情報をランナー JAR ファイルの MANIFEST.MF ファイルに含めるかどうか。	ブール値	true
   quarkus.package.user-configured-ignored-entries	出力アーティファクトにコピーしてはならないファイル。	文字列 (リスト)
   quarkus.package.runner-suffix	ランナー JAR ファイルに適用される接尾辞。	文字列	-runner
   quarkus.package.output-directory	アプリケーションビルドの出力フォルダー。これは、ビルドシステムのターゲットディレクトリーと相対的に解決されます。	文字列
   quarkus.package.output-name	最終的なアーティファクトの名前。	文字列

手順

1. プラグイン設定を pom.xml ファイルに追加します。

   <project>
       [...]
         <plugin>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-bootstrap-maven-plugin</artifactId>
             <version>${quarkus-plugin.version}</version>
         </plugin>
       [...]
   </project>

2. アプリケーションのビルド依存関係ツリーを一覧表示するには、以下のコマンドを入力します。

   ./mvnw quarkus-bootstrap:build-tree

3. このコマンドの出力は、以下のようになります。

   [INFO] --- quarkus-bootstrap-maven-plugin:1.11:build-tree (default-cli) @ getting-started ---
   [INFO] org.acme:getting-started:jar:1.0-SNAPSHOT
   [INFO] └─ io.quarkus:quarkus-resteasy-deployment:jar:1.11 (compile)
   [INFO]    ├─ io.quarkus:quarkus-resteasy-server-common-deployment:jar:1.11 (compile)
   [INFO]    │  ├─ io.quarkus:quarkus-core-deployment:jar:1.11 (compile)
   [INFO]    │  │  ├─ commons-beanutils:commons-beanutils:jar:1.9.3 (compile)
   [INFO]    │  │  │  ├─ commons-logging:commons-logging:jar:1.2 (compile)
   [INFO]    │  │  │  └─ commons-collections:commons-collections:jar:3.2.2 (compile)
   ...

手順

1. Getting Started プロジェクトの pom.xml ファイルを開き、native プロファイルが含まれていることを確認します。

   <profiles>
       <profile>
           <id>native</id>
           <properties>
               <quarkus.package.type>native</quarkus.package.type>
           </properties>
       </profile>
   </profiles>

   注記

   Quarkus native プロファイルを使用すると、ネイティブ実行可能ファイルおよびネイティブイメージテストの両方を実行できます。

2. 以下のいずれかの方法を使用して、ネイティブ実行可能ファイルをビルドします。

   1. Docker を使用してネイティブ実行可能ファイルをビルドします。

      ./mvnw package -Pnative -Dquarkus.native.container-build=true

   2. Podman を使用してネイティブ実行可能ファイルをビルドします。

      ./mvnw package -Pnative -Dquarkus.native.container-build=true -Dquarkus.native.container-runtime=podman

      これらのコマンドにより、target ディレクトリーに getting-started-*-runner バイナリーが作成されます。

      重要

      Quarkus アプリケーションをネイティブ実行可能ファイルにコンパイルすると、分析および最適化の際にメモリーを大量に消費します。quarkus.native.native-image-xmx 設定プロパティーを設定して、ネイティブコンパイル時に使用されるメモリーの量を制限できます。メモリー制限を低く設定すると、ビルド時間が長くなる可能性があります。詳細は、ネイティブ実行可能ファイルの設定プロパティー を参照してください。

3. ネイティブ実行可能ファイルを実行します。

   ./target/getting-started-*-runner

   ネイティブ実行可能ファイルをビルドすると、prod プロファイルが有効になり、prod プロファイルを使用して Quarkus ネイティブテストが実行されます。これは、quarkus.test.native-image-profile プロパティーを使用して変更できます。

手順

1. pom.xml ファイルを開き、native プロファイルに以下の要素が含まれていることを確認します。

   <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-failsafe-plugin</artifactId>
       <version>${surefire-plugin.version}</version>
       <executions>
           <execution>
               <goals>
                   <goal>integration-test</goal>
                   <goal>verify</goal>
               </goals>
               <configuration>
                   <systemPropertyVariables>
                       <native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
                       <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                       <maven.home>${maven.home}</maven.home>
                   </systemPropertyVariables>
               </configuration>
           </execution>
       </executions>
   </plugin>

   failsafe-maven-plugin はインテグレーションテストを実行し、作成されたネイティブ実行可能ファイルの場所を示します。

2. src/test/java/org/acme/quickstart/NativeGreetingResourceIT.java ファイルを開き、次のコンテンツが含まれていることを確認します。

   package org.acme.quickstart;
   
   
   import io.quarkus.test.junit.NativeImageTest;
   
   @NativeImageTest 1
   public class NativeGreetingResourceIT extends GreetingResourceTest { 2
   
       // Run the same tests
   
   }

   1

   テストの前に、ネイティブファイルからアプリケーションを開始する別のテストランナーを使用します。実行可能ファイルは、Failsafe Maven Plugin に設定された native.image.path システムプロパティーを使用して取得されます。

   2

   この例は、GreetingResourceTest を拡張しますが、新しいテストを作成することも可能です。

3. テストを実行します。

   ./mvnw verify -Pnative

   以下の例は、このコマンドの出力を示しています。

   ./mvnw verify -Pnative
   ...
   [getting-started-1.0-SNAPSHOT-runner:18820]     universe:     587.26 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]      (parse):   2,247.59 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]     (inline):   1,985.70 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]    (compile):  14,922.77 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]      compile:  20,361.28 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]        image:   2,228.30 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]        write:     364.35 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]      [total]:  52,777.76 ms
   [INFO]
   [INFO] --- maven-failsafe-plugin:2.22.1:integration-test (default) @ getting-started ---
   [INFO]
   [INFO] -------------------------------------------------------
   [INFO]  T E S T S
   [INFO] -------------------------------------------------------
   [INFO] Running org.acme.quickstart.NativeGreetingResourceIT
   Executing [/data/home/gsmet/git/quarkus-quickstarts/getting-started/target/getting-started-1.0-SNAPSHOT-runner, -Dquarkus.http.port=8081, -Dtest.url=http://localhost:8081, -Dquarkus.log.file.path=build/quarkus.log]
   2019-04-15 11:33:20,348 INFO  [io.quarkus] (main) Quarkus 999-SNAPSHOT started in 0.002s. Listening on: http://[::]:8081
   2019-04-15 11:33:20,348 INFO  [io.quarkus] (main) Installed features: [cdi, resteasy]
   [INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.387 s - in org.acme.quickstart.NativeGreetingResourceIT
   ...

   注記

   Quarkus は、ネイティブイメージの開始まで 60 秒間待機し、その後ネイティブテストに自動的に失敗します。この期間は、quarkus.test.native-image-wait-time システムプロパティーを使用して変更できます。

   以下のコマンドを使用して、待機時間を延長することができます。<duration> は、秒単位の待機時間になります。

   ./mvnw verify -Pnative -Dquarkus.test.native-image-wait-time=<duration>

手順

1. 開発モードで Quarkus を起動するには、Quarkus アプリケーションの pom.xml ファイルが含まれるディレクトリーで以下のコマンドを入力します。

   ./mvnw quarkus:dev

2. アプリケーションに変更を加え、ファイルを保存します。

3. ブラウザーを更新して、ワークスペースのスキャンをトリガーします。

   変更が検出されると、Java ファイルが再コンパイルされ、アプリケーションが再デプロイされます。その後、要求は再デプロイされたアプリケーションによって処理されます。コンパイルまたはデプロイメントに問題がある場合は、エラーページが表示されます。

   開発モードでは、デバッガーがアクティベートされ、ポート 5005 をリッスンします。

4. 任意手順: アプリケーションの実行前にデバッガーが割り当てられるのを待つようにするには、-Dsuspend を追加します。

   ./mvnw quarkus:dev -Dsuspend

5. 任意手順: デバッガーが実行されないようにするには、-Ddebug=false を追加します。

   ./mvnw quarkus:dev -Ddebug=false

システムプロパティーを使用したデバッガーの制御

1. 以下の debug システムプロパティーの値の 1 つを変更します。ここで、PORT はデバッガーがリッスンするポートです。

   • false: JVM はデバッグモードを無効にして開始します。
   • true: JVM はデバッグモードで開始し、ポート 5005 でリッスンしています。
   • client: JVM はクライアントモードで起動され、localhost:5005 への接続を試みます。
   • PORT: JVM はデバッグモードで開始され、PORT をリッスンしています。

2. suspend システムプロパティーの値を変更します。このプロパティーは、Quarkus がデバッグモードで開始する際に使用されます。

   • y または true: デバッグモードの JVM の起動が一時停止します。
   • n または false: デバッグモードの JVM は一時停止せずに起動します。