第3章 Getting Started プロジェクトの作成

手順

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

   mvn --version

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

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

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

     これらのコマンドにより、./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>

   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>

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

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

   注記

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