IntelliJ IDEA プラグインガイド
IntelliJ IDEA 用の Migration Toolkit for Runtimes プラグインを使用してアプリケーションを分析することにより、移行の問題を特定して解決します。
概要
多様性を受け入れるオープンソースの強化
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。
第1章 はじめに
1.1. IntelliJ IDEA 用の MTR プラグインについて
IntelliJ IDEA 用の Migration Toolkit for Runtimes (MTR) プラグインを使用して、アプリケーションを移行およびモダナイズすることができます。
MTR プラグインは、カスタマイズ可能なルールセットを使用してプロジェクトを分析し、ソースコード内の問題をマークし、問題を修正するためのガイダンスを提供し、可能な場合は自動コードの置き換えを提供します。
プラグインは、Community Edition と Ultimate バージョンの IntelliJ IDEA の両方をサポートします。
1.2. Migration Toolkit for Runtimes
Migration Toolkit for Runtimes とは
Migration Toolkit for Runtimes (MTR) は、Java アプリケーションの移行およびモダナイゼーションを簡素化する拡張可能でカスタマイズ可能なルールベースのツールです。
MTR は、プロジェクトソースディレクトリーやアプリケーションアーカイブを含むアプリケーションアーティファクトを検査し、変更を必要とするエリアを強調表示する HTML レポートを作成します。MTR は、以下の例を含む多くの移行パスをサポートします。
- Red Hat JBoss Enterprise Application Platform の最新リリースへのアップグレード
- Oracle WebLogic または IBM WebSphere Application Server から Red Hat JBoss Enterprise Application Platform への移行
- アプリケーションのコンテナー化とクラウド化
- Java Spring Boot から Quarkus への移行
- Oracle JDK から OpenJDK への更新
- OpenJDK 8 から OpenJDK 11 へのアップグレード
- OpenJDK11 から OpenJDK 17 へのアップグレード
- EAP Java アプリケーションの Azure への移行
- Spring Boot Java アプリケーションの Azure への移行
ユースケースおよび移行パスの詳細は、開発者向け MTR Web ページを参照してください。
Migration Toolkit for Runtimes を使用して移行を単純化する方法
Migration Toolkit for Runtimes は一般的なリソースを探し、アプリケーションを移行する際の既知の問題点を明らかにします。これは、アプリケーションが使用するテクノロジーのハイレベルビューを提供します。
MTR は、移行またはモダナイゼーションパスの評価に関する詳細なレポートを生成します。このレポートは、大規模なプロジェクトに必要な作業を見積もり、関係する作業を減らすのに役立ちます。
詳細情報
Migration Toolkit for Runtimes の機能、サポートされる設定、システム要件、利用可能なツールの詳細は、Migration Toolkit for Runtimes の概要 を参照してください。
第2章 IntelliJ IDEA 用の MTR プラグインのインストール
MTR プラグインは、IntelliJ IDEA の Ultimate および Community Edition リリースにインストールできます。
前提条件
Java Development Kit(JDK) がインストールされている。MTR は以下の JDK をサポートする。
- OpenJDK 11
- Oracle JDK 11
- 8 GB RAM
-
macOS のインストール:
maxproc
の値は2048
以上である必要がある。 -
MTR ダウンロードページ からの最新バージョンの
mtr-cli
手順
- Intelli J IDEA で、Welcome 画面の Plugins タブをクリックします。
-
Marketplace タブの検索フィールドに
Migration Toolkit for Runtimes
と入力します。 Migration Toolkit for Runtimes (MTR) by Red Hat プラグインを選択し、Install をクリックします。
プラグインは、Installed タブに一覧表示されます。
第3章 MTRプラグインを使用したプロジェクトの分析
実行設定を作成し、分析を実行して、MTR プラグインでプロジェクトを分析できます。
3.1. 実行設定の作成
IntelliJ IDEA にインポートする各プロジェクトに対して実行する複数の実行設定を作成できます。
手順
- Projects ビューで、分析するプロジェクトをクリックします。
画面の左側で、Migration Toolkit for Runtimes タブをクリックします。
これが最初の設定である場合は、実行設定パネルが右側に表示されます。
これが最初の設定でない場合は、リストで設定を右クリックして、New configuration を選択します。
実行設定パネルが右側に表示されます。
以下の設定フィールドに入力します。
-
cli: cli 実行ファイルへのパスを入力します。たとえば、
$HOME/mtr-cli-1.0.2.GA-redhat-00001/bin/windup-cli
です。 - Input: Add をクリックして、入力ファイルまたはディレクトリーを入力します。
Target: 1 つ以上のターゲット移行パスを選択します。
注記Output に表示される場所は、プラグインによって設定されます。
-
cli: cli 実行ファイルへのパスを入力します。たとえば、
設定のリストで、新しい設定を右クリックし、Run Analysis を選択します。
Console (MTR) ターミナルエミュレーターが開き、分析の進行状況に関する情報が表示されます。
分析が完了したら、実行した設定ファイルの名前の下にある Report または Results をクリックできます。
- Reports は MTR レポートを開きます。このレポートには、アプリケーションを移行または最新化する前に対処する必要のある問題が記載されています。詳細は、CLI ガイド の レポートの確認 を参照してください。
- Results は、アプリケーションごとのヒント (問題) を表示するディレクトリーを開きます。
第4章 移行の問題の確認および解決
左側のペインで MTR プラグインで識別される移行の問題を確認し、解決できます。
4.1. 問題の確認
MTR プラグインアイコンを使用して、重大度に基づいて問題の優先順位付けができます。また、クイック修正 の自動コード置換がある問題とない問題を確認できます。
分析の結果はディレクトリー形式で表示され、分析された各アプリケーションの ヒント と 分類 が示されます。
ヒント は、アプリケーションを最新化または移行する前に対処すべき、または対処しなければらない単一の問題を含む、読み取り専用のコードスニペットです。多くの場合、クイックフィックスが提案されますが、これは受け入れるか無視することができます。
分類 とは、問題はあるが、推奨されるクイック修正がないファイルです。分類を編集できます。
手順
- Migration Toolkit for Runtimes ビューで、左側のペインで実行設定ディレクトリーを選択します。
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 を選択した場合は、緑色のチェック (
) がヒントで表示され、エラーインジケータが置き換えられます。