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

手順

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

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

   • Apache Maven を使用する場合は、次のコマンドを入力します。

     mvn quarkus:dev

     Copy to Clipboard Toggle word wrap

   • Quarkus コマンドラインインターフェイス (CLI) を使用する場合は、次のコマンドを入力します。

     quarkus dev

     Copy to Clipboard Toggle word wrap

   • Maven ラッパーを使用する場合は、次のコマンドを入力します。

     ./mvnw quarkus:dev

     Copy to Clipboard Toggle word wrap

     予想される出力

     次の抜粋は、予想される出力の例を示しています。

     INFO  [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated.
     INFO  [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, resteasy, smallrye-context-propagation]

     Copy to Clipboard Toggle word wrap

手順

1. アプリケーションを変更し、コンパニオン Bean を追加するには、以下の内容で src/main/java/org/acme/quickstart/GreetingService.java ファイルを作成します。

   package org.acme.quickstart;
   
   import jakarta.enterprise.context.ApplicationScoped;
   
   @ApplicationScoped
   public class GreetingService {
   
       public String greeting(String name) {
           return "hello " + name;
       }
   
   }

   Copy to Clipboard Toggle word wrap

2. src/main/java/org/acme/quickstart/GreetingResource.java を編集して GreetingService を注入し、これを使用して新しいエンドポイントを作成します。

   package org.acme.quickstart;
   
   import jakarta.inject.Inject;
   import jakarta.ws.rs.GET;
   import jakarta.ws.rs.Path;
   import jakarta.ws.rs.Produces;
   import jakarta.ws.rs.core.MediaType;
   
   import org.jboss.resteasy.annotations.jaxrs.PathParam;
   
   @Path("/hello")
   public class GreetingResource {
   
       @Inject
       GreetingService service;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       @Path("/greeting/{name}")
       public String greeting(@PathParam String name) {
           return service.greeting(name);
       }
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "Hello from RESTEasy Reactive";
       }
   }

   Copy to Clipboard Toggle word wrap

3. アプリケーションを停止した場合は、以下のコマンドを入力して再起動します。

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap

4. エンドポイントが hello quarkus を返すことを確認するには、新しいターミナルウィンドウに以下のコマンドを入力します。

   curl -w "\n" http://localhost:8080/hello/greeting/quarkus
   hello quarkus

   Copy to Clipboard Toggle word wrap

手順

1. 生成された pom.xml ファイルを開き、コンテンツを確認します。

   <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>
          </systemPropertyVariable>
       </configuration>
   </plugin>

   Copy to Clipboard Toggle word wrap

   次のプロパティーの値に注意してください。

   • アプリケーションがテストで必ず正しいログマネージャーを使用するように、java.util.logging.manager システムプロパティーが設定されます。
   • maven.home プロパティーは、プロジェクトに適用するカスタム Maven 設定を保存できる settings.xml ファイルの場所を参照します。

2. src/test/java/org/acme/quickstart/GreetingResourceTest.java ファイルを以下の内容に一致するように編集します。

   package org.acme.quickstart;
   
   import io.quarkus.test.junit.QuarkusTest;
   import org.junit.jupiter.api.Test;
   
   import java.util.UUID;
   
   import static io.restassured.RestAssured.given;
   import static org.hamcrest.CoreMatchers.is;
   
   @QuarkusTest
   public class GreetingResourceTest {
   
       @Test
       public void testHelloEndpoint() {
           given()
             .when().get("/hello")
             .then()
                .statusCode(200)
                .body(is("Hello from RESTEasy Reactive"));
       }
   
       @Test
       public void testGreetingEndpoint() {
           String uuid = UUID.randomUUID().toString();
           given()
             .pathParam("name", uuid)
             .when().get("/hello/greeting/{name}")
             .then()
               .statusCode(200)
               .body(is("hello " + uuid));
       }
   
   }

   Copy to Clipboard Toggle word wrap
   注記

   QuarkusTest ランナーを使用することで、テストを開始する前に JUnit にアプリケーションを起動するよう指示します。

3. Maven からこれらのテストを実行するには、以下のコマンドを入力します。

   ./mvnw test

   Copy to Clipboard Toggle word wrap
   注記

   IDE からテストを実行することもできます。その場合は、まずアプリケーションを停止してください。

   デフォルトでは、テストはポート 8081 で実行されるため、実行中のアプリケーションと競合しません。Quarkus では、RestAssured 依存関係はこのポートを使用するように設定されています。

   注記

   別のクライアントを使用する場合は、@TestHTTPResource アノテーションを使用して、テスト済みアプリケーションの URL を Test クラスのフィールドに直接注入します。このフィールドには、String、URL、または URI の型を使用できます。@TestHTTPResource アノテーションにテストパスを入力することもできます。たとえば、/myservlet にマップされたサーブレットをテストするには、以下の行をテストに追加します。

   @TestHTTPResource("/myservlet")
   URL testUrl;

   Copy to Clipboard Toggle word wrap
4. 必要な場合は、quarkus.http.test-port 設定プロパティーにテストポートを指定します。

手順

1. Quarkus アプリケーションを起動します。

   • code.quarkus.redhat.com または Quarkus CLI を使用して Getting Project プロジェクトを作成した場合、プロジェクトの生成時に Maven ラッパーが提供されています。プロジェクトディレクトリーから次のコマンドを入力します。

     ./mvnw quarkus:dev

     Copy to Clipboard Toggle word wrap

   • マシンにインストールされている Apache Maven を使用して Getting Project プロジェクトを作成した場合、次のコマンドを入力します。

     mvn quarkus:dev

     Copy to Clipboard Toggle word wrap

   • 開発モードで継続的テストを実行しており、Quarkus CLI を使用している場合は、次のコマンドを入力します。

     quarkus dev

     Copy to Clipboard Toggle word wrap

2. 生成された出力ログで、テストステータスの詳細を表示します。

   注記

   出力ログを表示するには、画面の一番下までスクロールする必要がある場合があります。

   • 継続的テストが有効になっている場合、次のメッセージが表示されます。

     Press [e] to edit command line args (currently ''), [r] to re-run, [o] Toggle test output, [:] for the terminal, [h] for more options>

     Copy to Clipboard Toggle word wrap

   • 継続的テストが一時停止されると、次のメッセージが表示されます。

     Press [e] to edit command line args (currently ''), [r] to resume testing, [o] Toggle test output, [:] for the terminal, [h] for more options>

     Copy to Clipboard Toggle word wrap
     注記

     デフォルトでは、継続的テストが有効になっている場合、アプリケーションの起動後にテストが一時停止されます。テストの実行方法を制御するために使用できるキーボードコマンドを表示するには、継続的テストの制御コマンド を参照してください。

3. テストの実行を開始するには、キーボードの `r` を押します。

4. 更新された出力ログを表示して、テストステータスとテスト結果の監視、およびテストの統計情報の確認を行い、フォローアップアクションのガイダンスを取得します。以下に例を示します。

   All 2 tests are passing (0 skipped), 2 tests were run in 2094ms. Tests completed at 14:45:11.
   Press [e] to edit command line args (currently ''), [r] to re-run, [o] Toggle test output, [:] for the terminal, [h] for more options>

   Copy to Clipboard Toggle word wrap

検証

1. コードを変更します。たとえばテキストエディターで、src/main/java/org/acme/quickstart/GreetingsResource.java ファイルを開きます。

2. "Hello world" を返すように "hello" エンドポイントを変更し、ファイルを保存します。

   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 world";
       }
   }

   Copy to Clipboard Toggle word wrap
3. Quarkus がすぐにテストを再実行して、変更後のコードをテストすることを確認します。

4. 出力ログを表示してテスト結果を確認します。この例の場合、テストでは変更後の文字列に "Hello from RESTEasy Reactive" の値が含まれているか確認します。文字列が "Hello world" に変更されているため、テストは失敗します。

   2023-09-08 15:03:45,911 ERROR [io.qua.test] (Test runner thread) Test GreetingResourceTest#testHelloEndpoint() failed: java.lang.AssertionError: 1 expectation failed.
   Response body doesn't match expectation.
   Expected: is "Hello from RESTEasy Reactive"
     Actual: Hello world
           at io.restassured.internal.ValidatableResponseOptionsImpl.body(ValidatableResponseOptionsImpl.java:238)
           at org.acme.quickstart.GreetingResourceTest.testHelloEndpoint(GreetingResourceTest.java:20)
   --
   1 test failed (1 passing, 0 skipped), 2 tests were run in 2076ms. Tests completed at 15:03:45.
   Press [e] to edit command line args (currently ''), [r] to re-run, [o] Toggle test output, [:] for the terminal, [h] for more options>

   Copy to Clipboard Toggle word wrap
5. 継続的テストを終了するには、キーボードの Ctrl-C または 'q' を押します。

手順

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

2. Quarkus Getting Started プロジェクトをパッケージ化するには、使用する開発者ツールに応じて、次のいずれかの方法を使用します。

   • Apache Maven を使用する場合は、次のコマンドを入力します。

     mvn package

     Copy to Clipboard Toggle word wrap

   • Quarkus コマンドラインインターフェイス (CLI) を使用する場合は、次のコマンドを入力します。

     quarkus build

     Copy to Clipboard Toggle word wrap

   • Maven ラッパーを使用する場合は、次のコマンドを入力します。

     ./mvnw package

     Copy to Clipboard Toggle word wrap

     このコマンドは、以下の JAR ファイルを /target ディレクトリーに生成します。

     • getting-started-1.0-0-SNAPSHOT.jar: プロジェクトのクラスおよびリソースが含まれます。これは、Maven ビルドで生成される通常のアーティファクトです。
     • quarkus-app/quarkus-run.jar: 実行可能な JAR ファイルです。このファイルは uber-JAR ファイルではありません。依存関係は target/quarkus-app/lib ディレクトリーにコピーされます。

3. 以下のコマンドを入力してアプリケーションを起動します。

   java -jar target/quarkus-app/quarkus-run.jar

   Copy to Clipboard Toggle word wrap
   注記
   • アプリケーションを実行する前に、必ず開発モードを停止してください (CTRL+C キーを押します)。停止しない場合、ポートの競合が発生します。
   • quarkus-run.jar ファイルの MANIFEST.MF ファイルの Class-Path エントリーには、lib ディレクトリーの JAR ファイルが明示的にリストされます。アプリケーションを別の場所からデプロイする場合は、quarkus-app ディレクトリー全体をデプロイする必要があります。

手順

1. ランタイム環境を設定するために、GRAALVM_HOME 環境変数を GraalVM インストールディレクトリーに設定します。以下に例を示します。

   export GRAALVM_HOME=$HOME/Development/graalvm/

   Copy to Clipboard Toggle word wrap

   • macOS の場合、変数が Home サブディレクトリーを指すようにします。

     export GRAALVM_HOME=$HOME/Development/graalvm/Contents/Home/

     Copy to Clipboard Toggle word wrap
   • Windows の場合、コントロールパネルを使用して環境変数を設定します。

2. native-image ツールをインストールします。

   ${GRAALVM_HOME}/bin/gu install native-image

   Copy to Clipboard Toggle word wrap

3. JAVA_HOME 環境変数を GraalVM インストールディレクトリーに設定します。

   export JAVA_HOME=${GRAALVM_HOME}

   Copy to Clipboard Toggle word wrap

4. GraalVM bin ディレクトリーをパスに追加します。

   export PATH=${GRAALVM_HOME}/bin:$PATH

   Copy to Clipboard Toggle word wrap

5. Getting Started プロジェクトフォルダーに移動します。

   cd getting-started

   Copy to Clipboard Toggle word wrap

6. 次のいずれかの方法で、ネイティブイメージをコンパイルします。

   • Maven を使用:

     mvn clean package -Pnative

     Copy to Clipboard Toggle word wrap

   • Quarkus CLI を使用:

     quarkus build --native

     Copy to Clipboard Toggle word wrap

検証

1. アプリケーションを起動します。

   ./target/getting-started-1.0.0-SNAPSHOT-runner

   Copy to Clipboard Toggle word wrap

2. ログメッセージを観察し、native という単語が含まれていることを確認します。

   2023-08-30 09:51:51,505 INFO [io.quarkus] (main) getting-started 1.0.0-SNAPSHOT native (powered by Red Hat build of Quarkus 3.2.9.Final) started in 0.043s.
   Listening on: http://0.0.0.0:8080

   Copy to Clipboard Toggle word wrap