1.2. 環境の準備
Quarkus の使用を開始する前に、環境を準備する必要があります。
手順
システムで次のインストールが完了していることを確認します。
OpenJDK 11 または 17 をインストールし、
JAVA_HOME
環境変数を設定して Java SDK の場所を指定している。- Red Hat build of OpenJDK をダウンロードするには、Red Hat カスタマーポータルにログインし、ソフトウェアダウンロード に移動します。
- Apache Maven 3.8.x がインストールされている。x は 6 以降です。Maven は、Apache Maven Project の Web サイトから入手できます。
オプション: Quarkus コマンドラインインターフェイス (CLI) を使用する場合は、それがインストールされていることを確認してください。
- Quarkus CLI のインストール方法については、Quarkus CLI のコミュニティー固有の情報を参照してください。
Quarkus CLI は、開発モードのみを対象としています。Red Hat は、実稼働環境での Quarkus CLI の使用をサポートしません。
1.2.1. Quarkus BOM について
Red Hat build of Quarkus 2.2 以降、すべてのコア Quarkus エクステンションの依存関係バージョンは、com.redhat.quarkus.platform:quarkus-bom
ファイルを使用して管理されます。
Bill of Materials (BOM) ファイルの目的は、プロジェクト内の Quarkus アーティファクトの依存関係バージョンを管理することです。これにより、プロジェクトで BOM を使用するときに、どの依存関係バージョンが連携するかを指定する必要がなくなります。代わりに、Quarkus BOM ファイルを pom.xml
設定ファイルにインポートできます。依存関係のバージョンは <dependencyManagement>
セクションに含まれています。そのため、pom.xml
ファイルの指定の BOM で管理される個別の Quarkus 依存関係のバージョンを記述する必要はありません。
Red Hat ビルドの Quarkus で利用可能なサポート対象のエクステンション固有の BOM に関する情報は、Red Hat build of Quarkus Component Details を参照してください。
アプリケーションで使用するプラットフォームメンバーのエクステンションのメンバー固有 BOM をインポートのみインポートする必要があります。したがって、モノリシックなシングル BOM と比較して、管理する依存関係が少なくなります。すべてのメンバー固有 BOM はユニバーサル Quarkus BOM のフラグメントであるため、競合を引き起こすことなくメンバー BOM を任意の順序でインポートできます。
1.2.2. Apache Maven および Quarkus について
Apache Maven は分散型構築自動化ツールで、Java アプリケーション開発でソフトウェアプロジェクトの作成、ビルド、管理に使用されます。Maven は Project Object Model (POM) ファイルと呼ばれる標準の設定ファイルを使用して、プロジェクトの定義や構築プロセスの管理を行います。POM ファイルには、モジュールとコンポーネントの依存関係、ビルド順序、結果として得られるプロジェクトのパッケージ化と出力のターゲットがXML ファイルを使用して記述されており、これによりプロジェクトが正しく均一にビルドされることが保証されます。
Maven リポジトリー
Maven リポジトリーには、Java ライブラリー、プラグイン、およびその他のビルドアーティファクトが格納されます。デフォルトのパブリックリポジトリーは Maven 2 Central Repository ですが、複数の開発チームの間で共通のアーティファクトを共有する目的で、社内のプライベートおよび内部リポジトリーとすることが可能です。また、サードパーティーのリポジトリーも利用できます。
Red Hat がホストする Maven リポジトリーを Quarkus プロジェクトで使用するか、Red Hat build of Quarkus Maven リポジトリーをダウンロードできます。
Maven プラグイン
Maven プラグインは、1 つ以上のタスクを実行する POM ファイルの定義済みの部分です。Red Hat build of Quarkus アプリケーションでは、次の Maven プラグインを使用します。
-
Quarkus Maven プラグイン(
quarkus-maven-plugin
): Maven による Quarkus プロジェクトの作成、アプリケーションを JAR ファイルにパッケージ化し、開発モードを提供できるようにします。 -
Maven Surefire プラグイン(
maven-surefire-plugin
): Quarkus がテスト
プロファイルを有効にする場合、Maven Surefire プラグインはビルドライフサイクルのテスト
フェーズで使用され、アプリケーションでユニットテストを実行します。プラグインは、テストレポートが含まれるテキストファイルと XML ファイルを生成します。
関連情報
1.2.3. オンラインリポジトリーの Maven の settings.xml ファイルを設定する
Red Hat がホストする Quarkus リポジトリーを Quarkus Maven プロジェクトで使用するには、ユーザー用に settings.xml
ファイルを設定します。リポジトリーマネージャーまたは共有サーバー上のリポジトリーで使用される Maven 設定により、プロジェクトの制御と管理が向上します。
Maven の settings.xml
ファイルを変更してリポジトリーを設定する場合、変更はすべての Maven プロジェクトに適用されます。設定を特定のプロジェクトにのみ適用する場合は、-s
オプションを使用して、プロジェクト固有の settings.xml
ファイルへのパスを指定します。
手順
テキストエディターまたは統合開発環境 (IDE) で、Maven
$HOME/.m2/settings.xml
ファイルを開きます。注記$
HOME/.m2/ ディレクトリーに
ディレクトリーにコピーします。settings.xml
ファイルがない場合は、$MAVEN_HOME/.m2
/conf/ ディレクトリーのsettings.xml
ファイルを$HOME/.
m2/以下の行を 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>
以下の行を
settings.xml
ファイルの<activeProfiles>
要素に追加し、ファイルを保存します。<activeProfile>red-hat-enterprise-maven-repository</activeProfile>
1.2.4. Quarkus Maven リポジトリーの設定
オンライン Maven リポジトリーを使用しない場合は、Quarkus Maven リポジトリーをダウンロードして設定できます。Quarkus Maven リポジトリーには、Java 開発者がアプリケーションの構築に使用する依存関係が複数含まれています。この手順では、settings.xml
ファイルを編集して Quarkus Maven リポジトリーを設定する方法を説明します。
Maven の settings.xml
ファイルを変更してリポジトリーを設定する場合、変更はすべての Maven プロジェクトに適用されます。特定のプロジェクトに設定を適用する場合は、-s
オプションを使用して、プロジェクト固有の settings.xml
ファイルへのパスを指定します。
手順
- Red Hat カスタマーポータル にログインし、Software Downloads に移動し、Quarkus Maven リポジトリーの ZIP ファイルをダウンロードします。
- ダウンロードしたアーカイブをデプロイメントします。
-
$HOME/.m2/
ディレクトリーに移動し、テキストエディターまたは統合開発環境(IDE)で Maven のsettings.xml
ファイルを開きます。 ダウンロードした 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>
以下の行を
settings.xml
ファイルの<activeProfiles>
要素に追加し、ファイルを保存します。<activeProfile>red-hat-enterprise-maven-repository</activeProfile>
Maven リポジトリーに古いアーティファクトが含まれる場合は、プロジェクトをビルドまたはデプロイしたときに以下のいずれかの Maven エラーメッセージが表示されることがあります。
-
Missing artifact <project_name>
-
[ERROR] Failed to execute goal on project <artifact_name>; Could not resolve dependencies for <project_name>
ここでは、以下のようになります。
-
&
lt;ARTIFACT_NAME>
; は、欠落しているアーティファクトの名前です。 -
<PROJECT_NAME
> - ビルドを試みているプロジェクトの名前。
この問題を解決するには、$HOME/.m2/
repository ディレクトリーにあるローカルリポジトリーのキャッシュバージョンを削除して、最新の Maven アーティファクトを強制的にダウンロードします。
1.2.5. Maven プロジェクトを Red Hat build of Quarkus に再設定する
Quarkus コミュニティープロジェクトは、プロジェクト POM ファイルの Maven 設定を変更することで Red Hat build of Quarkus に移行できます。
前提条件
-
pom.xml
ファイルの Quarkus コミュニティーアーティファクトに依存する Maven でビルドされる Quarkus プロジェクトがあります。
手順
プロジェクトの
pom.xml
ファイルの<properties>
セクションで、次の値を変更します。-
<quarkus.platform.group-id>
プロパティーの値をcom.redhat.quarkus.platform
に変更します。 <
quarkus.platform.version
> プロパティーの値を 2.13.9.SP2-redhatTRUSTED に変更します
。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> ... </project>
-