Quarkus スタートガイド

手順

1. テキストエディターまたは統合開発環境 (IDE) で、Maven $HOME/.m2/settings.xml ファイルを開きます。

   注記

   $ HOME/.m2/ ディレクトリーに settings.xml ファイルがない場合は、$ MAVEN_HOME/.m2 /conf/ ディレクトリーの settings.xml ファイルを $HOME/. m2/ ディレクトリーにコピーします。

2. 以下の行を Maven の settings.xml ファイルの <profiles> 要素に追加します。

   <!-- Configure the Quarkus Maven repository -->
   <profile>
     <id>red-hat-enterprise-maven-repository</id>
     <repositories>
       <repository>
         <id>red-hat-enterprise-maven-repository</id>
         <url>https://maven.repository.redhat.com/ga/</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
       </repository>
     </repositories>
     <pluginRepositories>
       <pluginRepository>
         <id>red-hat-enterprise-maven-repository</id>
         <url>https://maven.repository.redhat.com/ga/</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
       </pluginRepository>
     </pluginRepositories>
   </profile>

   Copy to Clipboard Toggle word wrap

3. 以下の行を settings.xml ファイルの <activeProfiles> 要素に追加し、ファイルを保存します。

   <activeProfile>red-hat-enterprise-maven-repository</activeProfile>

   Copy to Clipboard Toggle word wrap

手順

1. Red Hat カスタマーポータル にログインし、Software Downloads に移動し、Quarkus Maven リポジトリーの ZIP ファイルをダウンロードします。
2. ダウンロードしたアーカイブをデプロイメントします。
3. $HOME/.m2/ ディレクトリーに移動し、テキストエディターまたは統合開発環境(IDE)で Maven の settings.xml ファイルを開きます。

4. ダウンロードした Quarkus Maven リポジトリーのパスを、settings.xml ファイルの <profiles> 要素に追加します。Quarkus Maven リポジトリーのパスの形式は、file:// $PATH にする必要があります（例：file:///home/userX/<root-directory-of-the-downloaded-archive>/maven-repository ）。

   <!-- Configure the Quarkus Maven repository -->
   <profile>
     <id>red-hat-enterprise-maven-repository</id>
     <repositories>
       <repository>
         <id>red-hat-enterprise-maven-repository</id>
         <url>file:///path/to/Quarkus/Maven/repository/</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
       </repository>
     </repositories>
     <pluginRepositories>
       <pluginRepository>
         <id>red-hat-enterprise-maven-repository</id>
         <url>file:///path/to/Quarkus/Maven/repository/</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
       </pluginRepository>
     </pluginRepositories>
   </profile>

   Copy to Clipboard Toggle word wrap

5. 以下の行を settings.xml ファイルの <activeProfiles> 要素に追加し、ファイルを保存します。

   <activeProfile>red-hat-enterprise-maven-repository</activeProfile>

   Copy to Clipboard Toggle word wrap

手順

1. エクステンションレジストリー設定が含まれる config.yaml ファイルを開きます。エクステンションレジストリーの初回設定時には、マシン上の <user_home_directory_name>/.quarkus ディレクトリーに config.yaml ファイルを作成する必要がある場合があります。

2. 新しいレジストリーを config.yaml ファイルに追加します。以下に例を示します。

   config.yaml

   registries:
     - registry.quarkus.redhat.com
     - registry.quarkus.io

   Copy to Clipboard Toggle word wrap

手順

1. Maven が OpenJDK 11 または 17 を使用していることを確認するには、Maven のバージョンが 3.8.x (x は 6 以降)で、mvn が PATH 環境変数からアクセスできることを確認するには、以下のコマンドを入力します。

   mvn --version

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

3. プロジェクトをビルドするには、以下のコマンドのいずれか 1 つを実行します。

   注記

   Apple macOS および Microsoft Windows は開発者環境としてサポートされますが、実稼働環境ではサポートされません。

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

     mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.13.9.SP2-redhat-00003:create \
         -DprojectGroupId=org.acme \
         -DprojectArtifactId=getting-started \
         -DplatformGroupId=com.redhat.quarkus.platform \
         -DplatformVersion=2.13.9.SP2-redhat-00003 \
         -DclassName="org.acme.quickstart.GreetingResource" \
         -Dpath="/hello"
     cd getting-started

     Copy to Clipboard Toggle word wrap

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

     mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.13.9.SP2-redhat-00003:create
     -DprojectGroupId=org.acme -DprojectArtifactId=getting-started
     -DplatformGroupId=com.redhat.quarkus.platform
     -DplatformVersion=2.13.9.SP2-redhat-00003
     -DclassName="org.acme.quickstart.GreetingResource"
     -Dpath="/hello"

     Copy to Clipboard Toggle word wrap

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

     mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.13.9.SP2-redhat-00003:create
     "-DprojectGroupId=org.acme"
     "-DprojectArtifactId=getting-started"
     "-DplatformVersion=2.13.9.SP2-redhat-00003"
     "-DplatformGroupId=com.redhat.quarkus.platform"
     "-DclassName=org.acme.quickstart.GreetingResource"
     "-Dpath=/hello"

     Copy to Clipboard Toggle word wrap

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

     • Maven プロジェクトディレクトリー構造
     • /hello で公開される org.acme.quickstart.GreetingResource リソース
     • ネイティブモードおよび JVM モードでアプリケーションをテストするための関連するユニットテスト
     • アプリケーションの起動後に http://localhost:8080 でアクセス可能なランディングページ
     • src/main/docker ディレクトリー内のサンプル Dockerfile
     • アプリケーションの設定ファイル

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

   pom.xml

   <project>
     ...
     <properties>
        ...
        <quarkus.platform.group-id>com.redhat.quarkus.platform</quarkus.platform.group-id>
        <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
        <quarkus.platform.version>2.13.9.SP2-redhat-00003</quarkus.platform.version>
        ...
     </properties>
     ...
     <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>
     ...
     <build>
         ...
         <plugins>
           ...
           <plugin>
             <groupId>${quarkus.platform.group-id}</groupId>
             <artifactId>quarkus-maven-plugin</artifactId>
             <version>${quarkus.platform.version}</version>
             <extensions>true</extensions>
             <executions>
               <execution>
                 <goals>
                   <goal>build</goal>
                   <goal>generate-code</goal>
                   <goal>generate-code-tests</goal>
                 </goals>
               </execution>
             </executions>
           </plugin>
           ...
         </plugins>
         ...
     </build>
    ...
   </project>

   Copy to Clipboard Toggle word wrap

   pom.xml ファイルの <dependencyManagement> セクションには、Quarkus BOM が格納されています。そのため、pom.xml ファイルに個別の Quarkus 依存関係のバージョンを記述する必要はありません。pom.xml ファイルでは、アプリケーションのパッケージ化を行う quarkus-maven-plugin プラグインを見つけることもできます。

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

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

   Copy to Clipboard Toggle word wrap

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

   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import javax.ws.rs.core.MediaType;
   {CompanyName}
   @Path("/hello")
   public class GreetingResource {
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "Hello from RESTEasy Reactive";
       }
   }

   Copy to Clipboard Toggle word wrap

   このファイルには、/hello エンドポイントに送信するリクエストへの応答として hello を返す単純な REST エンドポイントが含まれます。

   注記

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

手順

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

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

   

   View larger image

   
   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でマークされたエクステンションをプロジェクトに追加する場合、このオプションを有効にして、プロジェクトの生成時にこれらのエクステンションのクラスおよびリソースファイルのサンプルを自動的に作成できます。ただし、サンプルコードを提供するエクステンションを追加しない場合、このオプションは生成されたプロジェクトには影響しません。

      

      View larger image

      
   注記

   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 create && cd code-with-quarkus

   Copy to Clipboard Toggle word wrap
   注記

   'app' サブコマンド (例: quarkus create app) を指定することもできます。ただし、'app' サブコマンドが指定されていない場合は暗黙的に指定されるため、必須ではありません。

   このコマンドを使用すると、Quarkus プロジェクトが現在の作業ディレクトリーの 'code-with-quarkus' というフォルダーに作成されます。

2. デフォルトでは、groupId 属性、artifactId 属性、version 属性は次のデフォルト値に指定されます。

   • groupId='org.acme'
   • artifactId='code-with-quarkus'

   • version='1.0.0-SNAPSHOT'

     groupId、artifactId、および version 属性の値を変更するには、quarkus create コマンドを発行し、CLI で次の構文を指定します。

     groupId:artifactId:version

     たとえば quarkus create app mygroupId:myartifactid:version です。

   注記

   使用可能なすべての Quarkus コマンドに関する情報を表示するには、help パラメーターを指定します。

   quarkus --help

   Copy to Clipboard Toggle word wrap

3. テキストエディターで src/main/java/org/acme/GreetingResource.java ファイルを確認します。

   package org.acme;
   
   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 from RESTEasy Reactive";
       }
   }

   Copy to Clipboard Toggle word wrap

   このファイルには、/hello エンドポイントに送信するリクエストへの応答として hello を返す単純な REST エンドポイントが含まれます。

検証

1. 開発モードでアプリケーションをコンパイルして起動します。
2. Quarkus CLI から Getting Started プロジェクトをパッケージ化して実行します。