Eclipse および CodeReady Studio プラグインガイド
Eclipse または Red Hat CodeReady Studio の MTA プラグインでアプリケーションを分析することで、移行の問題を特定し、解決します。
概要
多様性を受け入れるオープンソースの強化
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、弊社 の CTO、Chris Wright のメッセージ を参照してください。
第1章 はじめに
1.1. MTA プラグインについて
Migration Toolkit for Applications の MTA プラグインは、移行またはモダライゼーションの作業に変更を加える開発者向けに、Eclipse と Red Hat CodeReady Studio を直接サポートを提供します。
MTA プラグインは、カスタマイズ可能なルールセットを使用してプロジェクトを分析し、ソースコード内の移行問題をマークし、問題を修正するためのガイダンスを提供して、可能な場合は自動コード置換または修正を提供します。
1.2. Migration Toolkit for Applications の概要
Migration Toolkit for Applications とは
Migration Toolkit for Applications(MTA)は、Java アプリケーションの移行とモダライゼーションを簡素化する拡張可能かつカスタマイズ可能なルールベースのツールです。
MTA は、プロジェクトソースディレクトリーやアプリケーションアーカイブを含むアプリケーションアーティファクトを検査し、変更を必要とするエリアを強調表示する HTML レポートを作成します。MTA は、以下の例を含む多くの移行パスをサポートします。
- エンタープライズアプリケーションサーバーから Red Hat JBoss Enterprise Application Platform への移行
- アプリケーションをコンテナー化してクラウド対応の状態にする
- Spring Boot から Quarkus への移行
- OpenJDK バージョンの更新
ユースケースおよび移行パスの詳細は、開発者 Web ページの MTA を参照してください。
Migration Toolkit for Applications で移行を単純化する方法
Migration Toolkit for Applications は一般的なリソースを検索し、アプリケーションの移行時に問題のあるスポットを検索します。これは、アプリケーションによって使用される技術の概要ビューを提供します。
MTA は、移行またはモダライゼーションパスを評価する詳細なレポートを生成します。このレポートは、大規模なプロジェクトに必要な作業の見積もりを予測して、関係する作業を軽減するのに役立ちます。
詳細情報
Migration Toolkit for Applications の機能、サポートされる構成、システム要件、利用可能なツールの詳細は、『Migration Toolkit for Applications の概要』を参照してください。
第2章 MTA プラグインのインストール
接続された環境またはネットワークが制限された環境に MTA プラグインをインストールできます。
2.1. オンライン環境でのインストール
接続された環境で MTA プラグインをインストールできます。
MTA プラグインは、Eclipse IDE for Java Enterprise Developers 2020-09 R および Red Hat CodeReady Studio 12.15 でテストされています。
前提条件
- Red Hat CodeReady Studio or Eclipse IDE for Java Enterprise Developers 2020-09 R
- Eclipse Marketplace Client でインストールされる JBoss Tools。
-
MTA プラグインを macOS
にインストールする場合は、maxproc
の値は2048
以上である必要があります。
手順
- Eclipse または CodeReady Studio を起動します。
- メニューバーから Help → Install New Software と選択します。
- Work with フィールドの横にある Add をクリックします。
-
Name フィールドに
MTA
を入力します。 -
Location フィールドで
http://download.jboss.org/jbosstools/photon/stable/updates/mta/
を入力し、OK をクリックします。 - すべての JBoss Tools - MTA チェックボックスを選択して、Next をクリックします。
- インストールの詳細を確認し、Next をクリックします。
- ライセンス契約の条件に同意し、Finish をクリックします。
- Eclipse または CodeReady Studio を再起動します。
2.2. 非接続環境でのインストール
MTA プラグインは、オフラインネットワーク環境にインストールできます。
MTA プラグインは、Eclipse IDE for Java Enterprise Developers 2020-09 R および Red Hat CodeReady Studio 12.15 でテストされています。
前提条件
- Red Hat CodeReady Studio or Eclipse IDE for Java Enterprise Developers 2020-09 R
- Eclipse Marketplace Client でインストールされる JBoss Tools。
-
MTA プラグインを macOS
にインストールする場合は、maxproc
の値は2048
以上である必要があります。
手順
-
ネットワークアクセスのあるコンピューターで、Migration Toolkit for Applications のダウンロードサイト
に移動し、migrationtoolkit-mta-eclipse-plugin-repository
ファイルをダウンロードします。 - Eclipse または CodeReady Studio を起動します。
- メニューバーから Help → Install New Software と選択します。
- Work with フィールドの横にある Add をクリックします。
-
Name フィールドに
MTA
を入力します。 - Location フィールドの横にある Archive をクリックします。
-
migrationtoolkit-mta-eclipse-plugin-repository ファイルを選択し 、OK
をクリックします。 - すべての JBoss Tools - MTA チェックボックスを選択して、Next をクリックします。
- インストールの詳細を確認し、Next をクリックします。
- ライセンス契約の条件に同意し、Finish をクリックします。
- Eclipse または CodeReady Studio を再起動します。
2.3. MTA ツールへのアクセス
MTA パースペクティブでは、MTA プラグインツールにアクセスできます。
前提条件
- MTA プラグインをインストールした後に、Eclipse IDE または Red Hat CodeReady Studio を再起動する必要があります。
手順
- Window → Perspective → Open Perspective → Other とクリックします。
MTA を選択し、OK をクリックします。
以下のコンポーネントが表示されます。
- Issue Explorer は MTA プラグインによって識別される移行の問題を表示します。
MTA Server は、プロジェクト、フラグの移行問題を分析し、レポートを生成する別のプロセスです。
Issue Explorer で MTA サーバーの開始、停止、およびステータス表示を行うことができます。
- 問題の詳細には、ヒント、重大度、その他のリソースなど、選択した問題の詳細情報が表示されます。
MTA Report は、MTA プラグインによって生成された HTML レポートです。レポートのランディングページから、アプリケーションの詳細、問題、依存関係などの詳細レポートに移動できます。
注記デフォルトではレポートが生成されません。実行設定で Generate Report オプションを選択する必要があります。
第3章 MTA プラグインを使用したプロジェクトの分析
MTA プラグインでプロジェクトを分析するには、実行設定を作成し、分析を実行し、MTA プラグインによって検出される移行の問題を確認し、解決します。
3.1. 実行設定の作成
Issue Explorer で実行設定を作成できます。実行設定では、分析するプロジェクト、移行パス、および追加オプションを指定します。
複数の実行設定を作成できます。実行にはそれぞれ一意の名前を指定する必要があります。
前提条件/事前作業
- プロジェクトを Eclipse IDE または CodeReady Studio にインポートする必要があります。
手順
-
Issue Explorer で MTA アイコン(
)をクリックし、実行設定を作成します。
入力 タブで、以下のフィールドに入力します。
- 移行パスを選択します。
- Projects フィールドの横にある Add をクリックし、1 つ以上のプロジェクトを選択します。
Packages フィールドの横にある Add をクリックし、パッケージを 1 つまたは複数選択します。
注記分析用のパッケージを指定すると、ランタイムが短縮されます。パッケージを選択しないと、プロジェクトのすべてのパッケージがスキャンされます。
Options タブで Generate Report を選択して HTML レポートを生成することができます。レポートは Report タブに表示され、ファイルとして保存されます。
その他のオプションが表示されます。詳細は、『CLI ガイド』の「MTA コマンドライン引数 」を参照してください。
- Rules タブで、MTA プラグインにインポートまたは作成したカスタムルールセットを選択できます。
- 実行 をクリックして分析を開始します。
3.2. プロジェクトの分析
保存した実行設定で MTA プラグインを実行すると、プロジェクトを分析します。
手順
MTA パースペクティブで、Run ボタン(
)をクリックし、run 設定を選択します。
MTA プラグインはプロジェクトを分析します。Issue Explorer は、ルールセットで検出された移行問題を表示します。
- プロジェクトの分析が終了したら、Issue Explorer で MTA サーバーを停止して、メモリーを節約します。
3.3. 問題の確認
MTA プラグインによって識別される問題を確認できます。
手順
- Window → Show View → Issue Explorer の順にクリックします。
オプション: Options メニュー
をクリックし、Group By および options を選択して問題をフィルターします。
右クリックし、Issue Details を選択して問題に関する情報を表示します。これには、重大度や対処方法が含まれます。
以下のアイコンは、問題の重大度および状態を示しています。
表3.1 問題アイコン アイコン 説明 移行を成功させるには、この問題を解決する必要があります。
移行については、この問題の修正は任意です。
この問題は、移行時に問題が発生する可能性があります。
この問題は解決されています。
この問題は古くなりました。MTA が最後に問題を特定した後に、問題としてマークされたコードが変更されていました。
この問題には、クイック修正を利用できます。これは、移行を成功させるために修正する必要があります。
この問題にはクイック修正を利用できます。移行の修正は任意です。
この問題にはクイック修正を利用できます。これは移行中に問題が発生する可能性があります。
- 問題をダブルクリックして、エディターでコードの関連する行を開きます。
3.4. 問題の解決
以下のアクションのいずれかを実行することで、MTA プラグインで検出された問題を解決することができます。
問題をダブルクリックして、エディターで開き、ソースコードを編集できます。
この問題は、MTA プラグインを次に実行するまで、Stale アイコン(
)を表示します。
- 問題を右クリックし、Mark as Fixed を選択します。
-
クイック修正アイコン(
) が表示される場合、問題を右クリックして、Preview Quick Fix を選択した後、クイック修正を適用します。
第4章 ルールの管理
MTA プラグインには、プロジェクトを分析するためのシステムルールのコアセットが含まれ、移行およびモダライゼーションの問題を特定します。
カスタムルールセットを作成してインポートできます。
4.1. ルールの表示
MTA プラグインのシステムおよびカスタムルールを表示できます。
前提条件
- システムルールを表示するには、MTA サーバーが実行している必要があります。
手順
- Rulesets タブをクリックします。
- System を展開して、システムルールセットを表示するか、Custom してカスタムルールセットを表示します。
- ruleset を展開します。
- ルールをダブルクリックして、ビューアーで開きます。
- Source タブをクリックして、ルールの XML ソースを表示します。
4.2. カスタムルールセットの作成
MTA パースペクティブでカスタムルールセットを作成できます。
カスタム XML ルールの作成に関する詳細は、『ルール開発ガイド』を参照してください。
手順
- Rulesets タブをクリックします。
-
Create Ruleset アイコン(
)をクリックします。
- ルールセットのプロジェクトおよびディレクトリーを選択します。
ファイル名を入力します。
注記ファイルには、extension.windup.xml または.
。-
ruleset ID (
my-ruleset-id
など) を入力します。 - オプション: Generate quickstart template を選択し、基本的なルールテンプレートをファイルに追加します。
- Finish をクリックします。
- エディターでルールセットファイルが開かれ、ルールを追加および編集できます。
- Source タブをクリックして、ルールセットファイルの XML ソースを編集します。
実行設定の作成時に、新しいルールセットを選択できます。
4.3. カスタムルールセットのインポート
カスタムルールセットを MTA プラグインにインポートして、プロジェクトを分析できます。
前提条件
a.windup.xml
拡張子を持つカスタムルールセットファイル。または.mta.xml
手順
- Rulesets タブをクリックします。
-
Import Ruleset アイコン(
)をクリックします。
インポートする XML ルールファイルを参照して選択します。
Rulesets タブで Custom を拡張すると、カスタムルールセットが表示されます。
4.4. カスタムルールセットの送信
公式の MTA ルールリポジトリーに組み込むカスタムルールセットを送信できます。これにより、カスタムルールは MTA の後続のリリースにレビューおよび組み込むことができます。
手順
- Rulesets タブをクリックします。
-
矢印アイコン(
) をクリックし、Submit Ruleset を選択します。
以下のフィールドに入力します。
- Summary: ルールの目的を説明します。これは提出のタイトルになります。
- Code Sample: ルールが実行するソースコードの例を入力します。
- Description: ルールの簡単な説明を入力します。
- Choose Files をクリックし、ルールセットファイルを選択します。
- Submit をクリックします。