IntelliJ IDEA プラグインガイド
IntelliJ IDEA 用の Migration Toolkit for Applications プラグインを使用してアプリケーションを分析し、移行の問題を特定して解決する
概要
多様性を受け入れるオープンソースの強化
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、用語の置き換えは、今後の複数のリリースにわたって段階的に実施されます。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。
第1章 はじめに
1.1. IntelliJ IDEA 用の MTA プラグインについて
IntelliJ IDEA 用の Migration Toolkit for Applications (MTA) プラグインを使用して、アプリケーションを移行および最新化できます。
MTA プラグインはカスタマイズ可能なルールセットを使用してプロジェクトを分析し、ソースコード内の問題をマークし、問題を修正するためのガイダンスを提供し、可能な場合は自動コードの置き換えを提供します。
プラグインは、Community Edition と Ultimate バージョンの IntelliJ IDEA の両方をサポートします。
1.2. Migration Toolkit for Applications の概要
Migration Toolkit for Applications とは
Migration Toolkit for Applications (MTA) は、Red Hat OpenShift 上のハイブリッドクラウド環境全体で大規模なアプリケーションモダナイゼーションに対する取り組みを促進します。このソリューションは、導入プロセス全体を通じて、ポートフォリオレベルとアプリケーションレベルの詳細情報を提供します。ユーザーインターフェイスを使用して、アプリケーションのインベントリー作成、評価、分析、および管理を行い、OpenShift Container Platform への移行をより短期間で行うことができます。
MTA 7.1 以降では、アプリケーションを Application Inventory に追加すると、MTA が言語検出タスクとテクノロジー検出タスクを自動的に作成して実行します。言語の検出では、アプリケーションで使用されているプログラミング言語が識別されます。テクノロジーの検出では、Enterprise Java Beans (EJB)、Spring などのテクノロジーが識別されます。その後、各タスクによってアプリケーションに適切なタグが割り当てられるため、アプリケーションに手動でタグを付ける時間と労力が削減されます。
MTA は、アプリケーションを評価するための基礎として広範にわたるデフォルトの質問リストを使用します。または、独自のカスタム質問リストを作成して、アプリケーションのコンテナー化の準備に必要な難易度、時間、およびその他のリソースを見積もることもできます。ステークホルダー間の議論の基礎として評価の結果を使用して、どのアプリケーションがコンテナー化に適しているか、どのアプリケーションが最初に多大な作業を必要とするか、どのアプリケーションがコンテナー化に適していないかを判断できます。
MTA は、対象のアプリケーションごとに 1 つ以上のルールセットを適用してアプリケーションを分析し、モダナイゼーションする前に、そのアプリケーションに含まれるどの行を変更するかを判断します。
MTA は、プロジェクトソースディレクトリーやアプリケーションアーカイブを含むアプリケーションアーティファクトを検査し、変更を必要とするエリアを強調表示する HTML レポートを作成します。
Migration Toolkit for Applications による移行を単純化する方法
Migration Toolkit for Applications は一般的なリソースを探し、アプリケーションを移行する際の既知の問題点を明らかにします。アプリケーションで使用されるテクノロジーの概要を示します。
MTA は、移行またはモダナイゼーションパスの評価に関する詳細なレポートを生成します。このレポートは、大規模なプロジェクトに必要な作業を見積もり、関係する作業を減らすのに役立ちます。
第2章 IntelliJ IDEA 用の MTA プラグインのインストール
MTA プラグインは、IntelliJ IDEA の Ultimate および Community Edition リリースにインストールできます。
前提条件
Migration Toolkit for Applications (MTA) のインストールの前提条件は次のとおりです。
Java Development Kit (JDK) がインストールされている。MTA がサポートしているのは以下の JDK です。
- OpenJDK 11
- OpenJDK 17
- Oracle JDK 11
- Oracle JDK 17
- Eclipse Temurin™ JDK 11
- Eclipse Temurin™ JDK 17
- 8 GB RAM。
-
macOS のインストール:
maxproc
の値が2048
以上である。 -
MTA ダウンロードページ からの最新バージョンの
mta-cli
。
手順
- IntelliJ IDEA で、Welcome 画面の Plugins タブをクリックします。
-
Marketplace タブの検索フィールドに
Migration Toolkit for Applications
と入力します。 Migration Toolkit for Applications (MTA) by Red Hat プラグインを選択し、Install をクリックします。
プラグインは、Installed タブにリスト表示されます。
第3章 MTA プラグインを使用したプロジェクトの分析
実行設定を作成し、分析を実行して、MTA プラグインでプロジェクトを分析できます。
3.1. 実行設定の作成
IntelliJ IDEA にインポートする各プロジェクトに対して実行する複数の実行設定を作成できます。
手順
- Projects ビューで、分析するプロジェクトをクリックします。
画面の左側にある Migration Toolkit for Applications タブをクリックします。
これが最初の設定である場合は、実行設定パネルが右側に表示されます。
これが最初の設定でない場合は、リストで設定を右クリックして、New configuration を選択します。
実行設定パネルが右側に表示されます。
以下の設定フィールドに入力します。
-
cli: cli 実行ファイルへのパスを入力します。たとえば、
$HOME/mta-cli-7.2.0.GA-redhat/bin/mta-cli
です。 - Input: Add をクリックして、入力ファイルまたはディレクトリーを入力します。
Target: 1 つ以上のターゲット移行パスを選択します。
注記Output に表示される場所は、プラグインによって設定されます。
-
cli: cli 実行ファイルへのパスを入力します。たとえば、
設定のリストで、新しい設定を右クリックし、Run Analysis を選択します。
Console (MTA) ターミナルエミュレーターが開き、分析の進行状況に関する情報が表示されます。
分析が完了したら、実行した設定ファイルの名前の下にある Report または Results をクリックできます。
- Reports は MTA レポートを開きます。このレポートには、アプリケーションを移行または最新化する前に対処する必要のある問題が記載されています。詳細は、CLI ガイド の レポートの確認 を参照してください。
- Results は、アプリケーションごとのヒント (問題) を表示するディレクトリーを開きます。
第4章 移行の問題の確認および解決
左側のペインで MTA プラグインで識別される移行の問題を確認し、解決できます。
4.1. 問題の確認
MTA プラグインアイコンを使用して、重大度に基づいて問題の優先順位付けができます。また、クイック修正 の自動コード置換がある問題とない問題を確認できます。
分析の結果はディレクトリー形式で表示され、分析された各アプリケーションの ヒント と 分類 が示されます。
ヒント は、アプリケーションを最新化または移行する前に対処すべき、または対処しなければらない単一の問題を含む、読み取り専用のコードスニペットです。多くの場合は、クイックフィックスが提案されますが、これは受け入れるか無視できます。
分類 とは、問題はあるが、推奨されるクイック修正がないファイルです。分類を編集できます。
手順
- Migration Toolkit for Applications ビューで、左側のペインで実行設定ディレクトリーを選択します。
Results をクリックします。
実行設定のモジュールとアプリケーションが表示され、各アプリケーションの下にヒントと分類が表示されます。
各ヒントの横に表示される以下のアイコンに基づいて、問題の優先順位付けを行います。
-
: アプリケーションを移行または最新化するには、この問題を修正する必要があります。
-
: アプリケーションを移行または最新化するには、この問題の修正が必要になる場合があります。
-
- オプション: ヒントの詳細を確認するには、ヒントを右クリックして Show More Details を選択します。
4.2. 問題の解決
以下のいずれかを実行して問題を解決できます。
- クイック修正 を使用して、ヒントのあるコードスニペットを修正する
- 分類に表示されるファイルのコードを編集する
4.2.1. クイック修正の使用
クイック修正の自動コード置換を使用して、時間を節約し、繰り返し発生する問題を解決する際の一貫性を確保できます。クイック修正は、結果 ディレクトリーの ヒント セクションに表示される多くの問題に対して利用できます。
手順
左側のペインで、エラーインジケータのあるヒントをクリックします。
クイックフィックスは、左側にクイック修正アイコン付きの子フォルダーとして表示されます (
)。
クイック修正を右クリックして、Preview Quick Fix を選択します。
現在のコードと提案された変更が Preview Quick Fix ウィンドウに表示されます。
- 提案された修正を受け入れるには、Apply Quick Fix をクリックします。
オプション: 問題を右クリックし、Mark As Complete を選択します。
緑のチェック (
) はヒントで表示され、エラーインジケータが置き換えられます。
4.2.2. ファイルのコードの編集
結果 ディレクトリーの 分類 セクションに表示されるファイルを直接編集できます。これらのファイルにはクイック修正はありません。
手順
- 左側のペインで、編集するファイルをクリックします。
- コードに必要な変更を加え、ファイルを保存します。
オプション: 問題を右クリックし、Mark as Complete または Delete を選択します。
Mark as Complete を選択した場合は、緑色のチェック (
) がヒントで表示され、エラーインジケータが置き換えられます。