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

手順

1. コマンドターミナルで以下のコマンドを入力し、Maven が OpenJDK 11 または 17 を使用していること、および Maven のバージョンが 3.8.x であることを確認します(x は 6 以降)。

   mvn --version

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

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

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

     mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.13.9.SP2-redhat-00003:create \
         -DprojectGroupId=<project_group_id> \
         -DprojectArtifactId=<project_artifact_id> \
         -DplatformGroupId=com.redhat.quarkus.platform \
         -DplatformArtifactId=quarkus-bom \
         -DplatformVersion=2.13.9.SP2-redhat-00003

     Copy to Clipboard Toggle word wrap

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

     • <project_group_id>: プロジェクトの一意識別子
     • <project_artifact_id>: プロジェクトおよびプロジェクトディレクトリーの名前

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

     mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.13.9.SP2-redhat-00003:create

     Copy to Clipboard Toggle word wrap

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

     注記

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

     mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.13.9.SP2-redhat-00003:create -B

   • Quarkus CLI を使用してプロジェクトを作成します。

     quarkus create app my-groupId:my-artifactId

     Copy to Clipboard Toggle word wrap

     • 次のコマンドを使用して、利用可能なオプションのリストを取得することもできます。

       quarkus create app --help

       Copy to Clipboard Toggle word wrap

手順

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

2. 次の項目を含む設定プロパティーを追加します。

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

   <properties>
       <quarkus.platform.version>2.13.9.SP2-redhat-00003</quarkus.platform.version>
       <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
       <quarkus.platform.group-id>com.redhat.quarkus.platform</quarkus.platform.group-id>
       <surefire-plugin.version>3.0.0-M5</surefire-plugin.version>
   </properties>

   Copy to Clipboard Toggle word wrap

3. Quarkus GAV (グループ、アーティファクト、バージョン) を追加し、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>

   Copy to Clipboard Toggle word wrap

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

   <build>
       <plugins>
           <plugin>
               <groupId>${quarkus.platform.group-id}</groupId>
               <artifactId>quarkus-maven-plugin</artifactId>
               <version>${quarkus.platform.version}</version>
               <executions>
                   <execution>
                       <goals>
                           <goal>build</goal>
                       </goals>
                   </execution>
               </executions>
           </plugin>
           <plugin>
               <artifactId>maven-surefire-plugin</artifactId>
               <version>${surefire-plugin.version}</version>
               <configuration>
                   <systemPropertyVariables>
                       <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                       <maven.home>${maven.home}</maven.home>
                   </systemPropertyVariables>
               </configuration>
           </plugin>
       </plugins>
   </build>

   Copy to Clipboard Toggle word wrap
   注記

   maven-surefire-plugin は、アプリケーションのユニットテストを実行します。

5. オプション: ネイティブアプリケーションをビルドするには、Maven Failsafe Plugin を含むネイティブプロファイルを追加します。

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

   Copy to Clipboard Toggle word wrap
   • 名前に IT が含まれ、@NativeImageTest アノテーションが含まれるテストは、ネイティブ実行可能ファイルに対して実行されます。
   • ネイティブモードが JVM モードとどのように異なるかの詳細は、Quarkus スタートガイド の JVM とネイティブモードの違い を参照してください。

手順

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

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

   
   1. プロジェクトのグループ名を入力します。名前形式は、Java パッケージの命名規則に従います（例： org.acme ）。
   2. プロジェクトから生成された Maven アーティファクトに使用する名前を入力します（例： code-with-quarkus ）。

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

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

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

        注記

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

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

   1. アプリケーションの詳細を含むフィールドを表示するには、More options を選択します。
   2. プロジェクトから生成されるアーティファクトに使用するバージョンを入力します。このフィールドのデフォルト値は 1.0.0-SNAPSHOT です。semantic versioning の使用が推奨されます。ただし、別のタイプのバージョン管理を指定することもできます。

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

      
   注記

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

4. 使用するエクステンションを選択します。選択したエクステンションは、Quarkus アプリケーションの依存関係として含まれています。Quarkus プラットフォームは、これらのエクステンションが将来のバージョンと互換性があることも確認します。

   重要

   RESTEasy エクステンションと RESTEasy Reactive エクステンションは、同じプロジェクト内で使用しないでください。

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

   このオプションを有効にすると、STARTER-CODE のマークが付いたエクステンションのスターターコードを自動的に生成できます。

   

5. 選択を確認するには、Generate your application を選択します。次の項目が表示されます。

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

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

   cd <directory_name>

   Copy to Clipboard Toggle word wrap

9. 開発モードでアプリケーションをコンパイルおよび起動するには、以下のいずれかの方法を使用します。

   • Maven の使用:

     ./mvnw quarkus:dev

     Copy to Clipboard Toggle word wrap

   • Quarkus CLI を使用する:

     quarkus dev

     Copy to Clipboard Toggle word wrap

手順

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

2. 次のいずれかの方法を使用して、利用可能なすべてのエクステンションをリストします。

   • Maven の使用:

     ./mvnw quarkus:list-extensions

     Copy to Clipboard Toggle word wrap

   • Quarkus CLI を使用する:

     quarkus extension --installable

     Copy to Clipboard Toggle word wrap

3. 次のいずれかの方法を使用して、プロジェクトにエクステンションを追加します。

   • Maven を使用して、追加するエクステンションのグループ、アーティファクト、バージョン(GAV)である次のコマンド <extension> を入力します。

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

     Copy to Clipboard Toggle word wrap

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

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

     Copy to Clipboard Toggle word wrap

   • Quarkus CLI を使用して、追加するエクステンションの Group、Artifact、Version (GAV)の以下のコマンド <extension> を入力します。

     quarkus extension add "<extension>"

     Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap

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

   ❌ Multiple extensions matching 'jdbc'
       * io.quarkus:quarkus-jdbc-h2
       * io.quarkus:quarkus-jdbc-mariadb
       * io.quarkus:quarkus-jdbc-postgresql
       Be more specific, for example, by 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?
   [...]

   Copy to Clipboard Toggle word wrap

CodeReady Studio または Eclipse

1. CodeReady Studio または Eclipse で、 File > *Import* をクリックします。
2. Maven → Existing Maven Project を選択します。
3. 次に、プロジェクトのルートの場所を選択します。利用可能なモジュールがリストされます。
4. 生成されたプロジェクトを選択し、Finish をクリックします。

5. アプリケーションをコンパイルして起動するには、次のいずれかの方法を使用します。

   • Maven の使用:

     ./mvnw quarkus:dev

     Copy to Clipboard Toggle word wrap

   • Quarkus CLI を使用する:

     quarkus dev

     Copy to Clipboard Toggle word wrap

IntelliJ

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

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

6. アプリケーションをコンパイルして起動するには、次のいずれかの方法を使用します。

   • Maven の使用:

     ./mvnw quarkus:dev

     Copy to Clipboard Toggle word wrap

   • Quarkus CLI を使用する:

     quarkus dev

     Copy to Clipboard Toggle word wrap

Apache NetBeans

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

4. アプリケーションをコンパイルして起動するには、次のいずれかの方法を使用します。

   • Maven の使用:

     ./mvnw quarkus:dev

     Copy to Clipboard Toggle word wrap

   • Quarkus CLI を使用する:

     quarkus dev

     Copy to Clipboard Toggle word wrap

Visual Studio Code

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

手順

1. {project}/src/main/resources フォルダーに移動し、テキストエディターで application.properties ファイルを開きます。

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

   次の表は、変更可能なプロパティーを示しています。

   Expand

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

   Show more

1. 次のコマンドを実行してアプリケーションをテストします。

手順

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>

   Copy to Clipboard Toggle word wrap

   Maven Failsafe プラグイン(maven-failsafe-plugin)は統合テストを実行し、生成されるネイティブ実行可能ファイルの場所も示します。

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

   package org.acme.getting.started;
   
   import io.quarkus.test.junit.QuarkusIntegrationTest;
   
   @QuarkusIntegrationTest 

   1

   
   public class GreetingResourceIT extends GreetingResourceTest { 

   2

   
   
       // Execute the same tests but in native mode.
   }

   Copy to Clipboard Toggle word wrap

   1

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

   2

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

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

   ./mvnw verify -Pnative

   Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap
   注記

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

   以下のコマンドを使用して、待機時間を延長できます。この場合の <duration> は待機時間 (秒単位) です。

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

   Copy to Clipboard Toggle word wrap

手順

1. Quarkus アプリケーションの pom.xml ファイルが含まれるディレクトリーに切り替えます。

2. Quarkus アプリケーションを開発モードでコンパイルして起動するには、次のいずれかの方法を使用します。

   • Maven の使用:

     ./mvnw quarkus:dev

     Copy to Clipboard Toggle word wrap

   • Quarkus CLI を使用する:

     quarkus dev

     Copy to Clipboard Toggle word wrap
3. アプリケーションに変更を加え、ファイルを保存します。

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

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

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

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

   ./mvnw quarkus:dev -Dsuspend

   Copy to Clipboard Toggle word wrap

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

   ./mvnw quarkus:dev -Ddebug=false

   Copy to Clipboard Toggle word wrap

システムプロパティーを設定してデバッガーを制御する

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

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

2. デバッグモードでの実行中に JVM を一時停止するには、suspend システムプロパティーの値を次のいずれかの値に設定します。

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