Quarkus スタートガイド

手順

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

   mvn --version

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

3. プロジェクトを生成するには、以下のコマンドのいずれかを入力します。

   注記

   Apple macOS および Microsoft Windows は、本番環境ではサポートされません。

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

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

     Copy to Clipboard Toggle word wrap

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

     mvn io.quarkus:quarkus-maven-plugin:1.7.6.Final-redhat-00014:create -DprojectGroupId=org.acme -DprojectArtifactId=getting-started -DplatformGroupId=com.redhat.quarkus -DplatformVersion=1.7.6.Final-redhat-00014 -DclassName="org.acme.quickstart.GreetingResource" -Dpath="/hello"

     Copy to Clipboard Toggle word wrap

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

     mvn io.quarkus:quarkus-maven-plugin:1.7.6.Final-redhat-00014:create "-DprojectGroupId=org.acme" "-DprojectArtifactId=getting-started" "-DplatformGroupId=com.redhat.quarkus" "-DclassName=org.acme.quickstart.GreetingResource" "-Dpath=/hello"

     Copy to Clipboard Toggle word wrap

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

     • Maven の構造
     • /hello で公開される org.acme.quickstart.GreetingResource リソース
     • 関連するユニットテスト
     • アプリケーションの起動後に http://localhost:8080 でアクセス可能なランディングページ
     • src/main/docker の Dockerfile ファイルの例
     • アプリケーション設定ファイル

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

   <dependencyManagement>
       <dependencies>
           <dependency>
               <groupId>com.redhat.quarkus</groupId>
               <artifactId>quarkus-universe-bom</artifactId>
               <version>${quarkus-plugin.version}</version>
               <type>pom</type>
               <scope>import</scope>
           </dependency>
       </dependencies>
   </dependencyManagement>
   
   <build>
     <plugins>
       <plugin>
         <groupId>io.quarkus</groupId>
         <artifactId>quarkus-maven-plugin</artifactId>
         <version>${quarkus-plugin.version}</version>
         <executions>
           <execution>
             <goals>
               <goal>build</goal>
             </goals>
           </execution>
         </executions>
       </plugin>
       <plugin>
         <artifactId>maven-compiler-plugin</artifactId>
         <version>${compiler-plugin.version}</version>
       </plugin>
       <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
         <version>${surefire-plugin.version}</version>
         <configuration>
           <systemProperties>
             <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
           </systemProperties>
         </configuration>
       </plugin>
     </plugins>
   </build>

   Copy to Clipboard Toggle word wrap

   Quarkus BOM は pom.xml ファイルにインポートされます。そのため、pom.xml ファイルに個別の Quarkus 依存関係のバージョンを記述する必要はありません。さらに、アプリケーションをパッケージ化し、開発モードを提供する quarkus-maven-plugin プラグインがあることを確認できます。

5. pom.xml ファイルで、quarkus-resteasy の依存関係を確認します。この依存関係により、REST アプリケーションを開発できます。

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

   Copy to Clipboard Toggle word wrap

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

   package org.acme.quickstart;
   
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import javax.ws.rs.core.MediaType;
   
   @Path("/hello")
   public class GreetingResource {
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "hello";
       }
   }

   Copy to Clipboard Toggle word wrap

   このファイルには、Java API for RESTful Web Services (JAX-RS) のほか、/hello への要求に対して hello を返す非常に簡単な REST エンドポイントが含まれます。

   注記

   Quarkus では、JAX-RS の Application クラスはサポートされますが、必須ではありません。さらに、リクエストごとに 1 つのインスタンスが作成されるのではなく、GreetingResource クラスのインスタンスが 1 つだけ作成されます。このインスタンスは、別の *Scoped アノテーションを使用して設定できます。たとえば、ApplicationScoped、RequestScoped などを使用できます。

手順

1. 開発モードで Quarkus Hello アプリケーションをコンパイルするには、プロジェクトディレクトリーから以下のコマンドを入力します。

   ./mvnw compile quarkus:dev

   Copy to Clipboard Toggle word wrap

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

   2020-04-02 10:53:44,263 INFO  [io.quarkus] (main) getting-started 1.0-SNAPSHOT (powered by 1.7.6.Final-redhat-00014) started in 0.946s. Listening on: http://0.0.0.0:8080
   2020-04-02 10:53:44,267 INFO  [io.quarkus] (main) Profile dev activated. Live Coding activated.
   2020-04-02 10:53:44,267 INFO  [io.quarkus] (main) Installed features: [cdi, resteasy]

   Copy to Clipboard Toggle word wrap

2. 提供されたエンドポイントを要求するには、新しいターミナルウィンドウに以下のコマンドを入力します。

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

   Copy to Clipboard Toggle word wrap
   注記

   この例では、"\n" 属性を使用して、コマンドの出力の前に新しい行を自動的に追加します。これにより、ターミナルで '%' 文字が出力されたり、出力結果と次のコマンドプロンプトが同じ行に表示されたりすることを防ぎます。

3. アプリケーションを停止するには、CTRL+C を押します。

手順

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

   package org.acme.quickstart;
   
   import javax.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 javax.inject.Inject;
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import javax.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";
       }
   }

   Copy to Clipboard Toggle word wrap

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

   ./mvnw compile 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. Surefire Maven プラグインのバージョンを設定します。

   <plugin>
       <artifactId>maven-surefire-plugin</artifactId>
       <version>${surefire-plugin.version}</version>
       <configuration>
          <systemProperties>
            <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
          </systemProperties>
       </configuration>
   </plugin>

   Copy to Clipboard Toggle word wrap

   デフォルトの Surefire Maven プラグインバージョンは、JUnit 5 をサポートしません。

2. java.util.logging システムプロパティーを設定して、テストが適切なログマネージャーを使用するようにします。

3. 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"));
       }
   
       @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 にアプリケーションを起動するよう指示します。

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

   ./mvnw test

   Copy to Clipboard Toggle word wrap
   注記

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

   デフォルトでは、テストはポート 8081 で実行されるため、実行中のアプリケーションと競合しません。Quarkus では、RestAssured 依存関係はこのポートを使用するように設定されています。別のクライアントを使用する場合は、@TestHTTPResource アノテーションを使用して、テスト済みアプリケーションの URL を Test クラスのフィールドに直接インジェクトします。このフィールドには、タイプ string、URL、または URI を使用できます。このアノテーションにテストパスを指定することもできます。たとえば、/myservlet にマップされたサーブレットをテストするには、以下の行をテストに追加します。

   @TestHTTPResource("/myservlet")
   URL testUrl;

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

手順

1. Quarkus Getting Started プロジェクトをパッケージ化するには、root ディレクトリーで以下のコマンドを入力します。

   ./mvnw package

   Copy to Clipboard Toggle word wrap

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

   • getting-started-1.0-SNAPSHOT.jar: プロジェクトのクラスおよびリソースが含まれます。これは、Maven ビルドで生成される通常のアーティファクトです。
   • getting-started-1.0-SNAPSHOT-runner.jar: 実行可能な JAR ファイルです。依存関係は target/lib ディレクトリーにコピーされるため、このファイルは uber-JAR ファイルではない点に注意してください。
2. 開発モードを実行している場合は、CTRL+C を押して開発モードを停止します。停止しないと、ポートの競合が発生します。

3. アプリケーションを実行するには、以下のコマンドを入力します。

   java -jar target/getting-started-1.0-SNAPSHOT-runner.jar

   Copy to Clipboard Toggle word wrap
   注記

   runner JAR ファイルからの MANIFEST.MF ファイルのClass-Path エントリーは、lib ディレクトリーからの JAR ファイルを明示的に記述します。別の場所からアプリケーションをデプロイする場合は、runner JAR ファイルと lib ディレクトリーをコピーする必要があります。