Eclipse プラグインガイド
Eclipse でアプリケーションに対して Red Hat Application Migration Toolkit を実行することにより、移行の問題を特定して解決します。
概要
第1章 はじめに
1.1. Eclipse プラグインガイドについて
本ガイドは、アプリケーションの移行を支援するために、Migration Toolkit for Applications (MTA) に Eclipse プラグインを使用するエンジニア、コンサルタント、およびその他のユーザーを対象としています。
本ガイドでは、Eclipse を使用して Eclipse または Red Hat Developer Studio のインストールを参照します。
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 から、または Oracle® WebLogic Server や IBM® WebSphere® Application Server などの他のコンテナーから Java アプリケーションを移行できます。
Migration Toolkit for Applications で移行を単純化する方法
Migration Toolkit for Applications は一般的なリソースを探し、アプリケーションを移行する際のテクノロジーと既知の問題点を明らかにします。この目的は、アプリケーションが使用するテクノロジーの概要を提供し、組織がエンタープライズアプリケーションを Java EE および Red Hat JBoss Enterprise Application Platform に推定、文書化、移行するために使用できる詳細なレポートを提供することです。
詳細情報
Migration Toolkit for Applications の機能、サポートされている設定、システム要件、および使用可能なツールの詳細については、スタートガイド を参照してください。
1.3. Eclipse プラグインについて
Migration Toolkit for Applications の Eclipse プラグインは、移行またはモダナイゼーションの作業に変更を加える開発者向けに、Eclipse と Red Hat Developer Studio の直接サポートを提供します。MTA を使用してプロジェクトを分析し、ソースコード内の移行問題をマークし、問題を修正するためのガイダンスを提供して、可能な場合は自動コードの置き換えを提供します。
1.4. サポートされる設定
Eclipse プラグインは、次の開発環境でテストされています。
- Eclipse 4.8 (Photon)
- Red Hat Developer Studio 12.9
第2章 Eclipse プラグインをインストールする
サポートされる設定 を確認し、Eclipse プラグインと互換性のある開発環境を使用していることを確認します。
macOS を実行している場合は、ユーザープロセスの最大数 maxproc
を少なくとも 2048
に設定し、開いているファイルの最大数 maxfiles
を 100000
に設定することを推奨します。
既存のインストールがない場合は、Eclipse または Red Hat Developer Studio をダウンロードし、インストールします。
本ガイドでは、Eclipse を使用して Eclipse または Red Hat Developer Studio のインストールを参照します。
前提条件
- Red Hat Developer Studio ではなく Eclipse を使用している場合は、Eclipse Plugin をインストールする前に JBoss Tools をインストール する必要があります。
プラグインをインストールする
- Eclipse を起動します。
- メニューバーから Help → Install New Software を選択します。
MTA 更新サイトを追加します。
- Work with フィールドの横にある Add をクリックします。
-
Name フィールドに
MTA
を入力します。 -
Location フィールドに
http://download.jboss.org/jbosstools/photon/stable/updates/rhamt/
を入力し、OK をクリックします。 - JBoss Tools - RHAMT の下にあるすべてのチェックボックスを選択し、Next を押します。
- インストールの詳細を確認し、Next を押します。
- ライセンス契約の条件に同意し、Finish をクリックしてプラグインをインストールします。
- 変更を有効にするには、Eclipse を再起動します。
オフライン環境のプラグインのインストール
- Eclipse プラグインリポジトリー をダウンロードします。
- Eclipse を起動します。
- メニューバーから Help → Install New Software を選択します。
MTA 更新サイトを追加します。
- Work with フィールドの横にある Add をクリックします。
-
Name フィールドに
MTA - Offline
と入力します。 - Location フィールドの横にある Archive をクリックします。
- 最初のステップでダウンロードしたファイルを選択し、OK をクリックします。
- JBoss Tools - RHAMT の下にあるすべてのチェックボックスを選択し、Next を押します。
- インストールの詳細を確認し、Next を押します。
- ライセンス契約の条件に同意し、Finish をクリックしてプラグインをインストールします。
- 変更を有効にするには、Eclipse を再起動します。
第3章 MTA Eclipse ツールへのアクセス
プラグインがインストールされると、MTA Eclipse ツールは MTA パースペクティブで利用できます。MTA パースペクティブを開くには、Window → Perspective → Open Perspective → Other に移動します。MTA を選択し、OK をクリックします。
プラグインコンポーネント を確認し、移行の問題を特定して解決 します。Eclipse で Help → Getting Started を選択して、プラグインの埋め込みヘルプを表示することもできます。
3.1. Eclipse プラグインコンポーネント
以下のコンポーネントは、Eclipse プラグインを使用してプロジェクトを分析する際に MTA パースペクティブで利用できます。
- Issue Explorer
このビューでは、解析されているプロジェクトの MTA の問題を確認することができます。
このビューが MTA パースペクティブに表示されない場合は、Window → Show View → Issue Explorer を選択して開きます。
- MTA Server
MTA サーバーは、MTA 分析を実行し、移行の問題にフラグを付け、レポートを生成する別のプロセスです。
Issue Explorer から MTA サーバーの開始、停止、およびステータス表示を行うことができます。
- Issue Details
このビューには、ヒント、重大度、その他のリソースなど、選択した MTA の問題の詳細情報が表示されます。
このビューが MTA パースペクティブに表示されない場合は、Window → Show View → Issue Details を選択して開きます。
- MTA Report
このビューには、MTA の実行時に生成される HTML レポートが表示されます。レポートのランディングページから、アプリケーションの詳細、問題、依存関係などの詳細レポートに移動できます。
MTA レポートを生成するには、使用する MTA 実行設定の Generate Report オプションが選択されている必要があります。
このビューが MTA パースペクティブに表示されない場合は、Window → Show View → MTA Report を選択して開きます。
第4章 移行の問題を特定して解決する
以下の手順に従い、Eclipse プラグインを使用して移行の問題を特定し、解決します。
- Eclipse に分析するプロジェクトをインポートします。
実行設定を作成 します。Issue Explorer から MTA ボタン (
) をクリックします。
少なくとも、分析するプロジェクトを選択します。必要に応じて、追加のオプションを設定します。
- Run をクリックして MTA を実行 します。
- Issue Explorer に一覧表示されている MTA の問題を確認 します。
- MTA の問題を解決 するには、コードを手動で更新するか、利用可能な場合はクイック修正を使用します。
-
必要に応じて MTA を再度実行します。Run ボタン (
) の横にあるドロップダウンを使用して、既存の設定を実行します。
4.1. MTA 実行設定を作成する
MTA 実行設定は MTA ボタン (
) を使用して作成できます。実行設定では、分析するプロジェクト、移行パス、および実行の追加オプションを指定します。複数の実行設定を作成することができます。また、それぞれに一意の名前を付けることができます。
入力
- 移行パス
- 使用する MTA ルールセットを決定する移行パスを選択します。移行パスのデフォルトは Anything to EAP 7 に設定されますが、サポートされる移行パスに変更できます。
- プロジェクト
- 分析するプロジェクトを 1 つ以上選択します。Ctrl キーを押すると、リストの複数のプロジェクトを選択します。
- パッケージ
- スキャンするパッケージを 1 つ以上選択します。MTA 実行時間を短縮するために分析が必要なパッケージのみを選択することが推奨されます。パッケージを選択しないと、プロジェクトのすべてのパッケージがスキャンされます。Ctrl キーを押して、リストの複数のパッケージを選択します。
オプション
- レポート
- MTA HTML レポートを生成する場合は、Generate Report チェックボックスを選択します。レポートは MTA Report タブに表示され、File を基にグループ化すると Issue Explorer に表示されます。
- オプション
-
追加の MTA オプションを設定します。
enableTattletale
などのブール値フラグであるオプションは、true
を値として使用する必要があります。各 MTA 引数の説明は、CLI ガイド の MTA コマンドライン引数 セクションを参照してください。
ルール
- カスタムルールのリポジトリー
- Eclipse プラグインにカスタム MTA ルールをインポートまたは作成している場合は、分析中に追加するカスタムルールセットを選択します。詳細については、カスタムルールを追加する を参照してください。
4.2. MTA を実行する
実行設定を作成したら、以下のいずれかの方法でその設定を使用して MTA を実行できます。
- Run Configurations ダイアログから実行設定を選択し、Run をクリックします。
-
Run ボタン (
) の隣のドロップダウンから最近の実行設定を選択します。
MTA サーバーが現在実行していない場合は、実行設定が実行されると起動します。
近い将来に MTA を実行する予定がない場合は、マシンのメモリーを節約するために MTA サーバーを停止することを推奨します。
実行が完了すると、Issue Explorer に MTA の問題が表示されます。
4.3. MTA の問題を確認する
Issue Explorer を使用して、MTA が特定する移行の問題を確認します。アイコン は、問題の重大度および状態を示しています。
Group By の選択 (重要度、移行ルール、およびファイル) 調整して、問題のグループ化の方法を変更します。

Issue Explorer の MTA の問題をダブルクリックして、エディターでコードの関連する行を開きます。右クリックし、Issue Details を選択して MTA の問題についての情報を表示します。これには、重大度や対処方法が含まれます。
4.4. MTA の問題を解決する
MTA の問題を解決するには、コードを手動で更新するか、利用可能な場合はクイック修正を適用します。
4.4.1. 問題を手動で解決する
MTA の問題の詳細とその他のリソースを確認し、必要に応じてソースコードを更新します。MTA の問題としてマークされたコードの行を更新すると、MTA が次回プロジェクトで実行されるまで、MCTA の問題には古いアイコン (
) でマークが付けられます。
MTA の問題を修正済みとしてマークすることもできます。これにより、MTA が次回プロジェクトで実行されるまで、その問題には解決済みアイコン (
) でマークが付けられます。問題が修正されたことを示すには、Issue Explorer の MTA の問題を右クリックして、Mark as Fixed を選択します。
4.4.2. クイックフィックスを使用して問題を解決する
一部の MTA の問題により、問題に対処するために必要な編集に役立つ修正が提供されます。アイコンの凡例 を参照して、MTA の問題がすぐに修正できることを示すアイコンを確認してください。
- クイックフィックスをプレビューする
- 問題を右クリックし、Preview Quick Fix を選択します。これにより、変更をプレビューできるウィンドウが表示されます。ここから、修正を適用したり、ウィンドウを閉じることができます。
- クイックフィックスを適用する
- 問題を右クリックし、Apply Quick Fix を選択します。これにより、ソースコードが必要に応じて更新され、MTA の問題は解決済みとしてマークされます。
第5章 カスタムルールを追加する
デフォルトでは、Eclipse プラグインには、移行およびモダナイゼーションの問題を特定するためのシステムルールのコアセットが含まれています。Eclipse プラグインから 既存のルールを参照 できます。
独自のルールを作成して、アプリケーション固有の問題を特定することもできます。既存のカスタムルールセットをインポート するか、Eclipse プラグインで直接 カスタムルールセットを作成 できます。
5.1. 閲覧ルール
Eclipse プラグインから、システムおよびカスタムルールの両方を表示できます。
- MTA パースペクティブから、Rulesets タブを開きます。
System 項目を展開してコアシステムルールを表示するか、Custom 項目を展開してカスタムルールを表示します。
注記システムルールを表示するには、MTA サーバーを起動する必要があります。
- 確認するルールが含まれる ruleset を展開します。
- ルールをダブルクリックして、ビューアーでルールを開きます。Source タブを選択すると、ルールの XML ソースを表示できます。
5.2. カスタムルールセットをインポートする
プロジェクトの分析時に使用する既存のカスタムルールセットを Eclipse プラグインにインポートできます。
- MTA パースペクティブから、Rulesets タブを開きます。
-
ルールセットのインポートアイコン (
) をクリックします。
インポートする XML ルールファイルを参照して選択します。
注記XML ルールファイルが MTA ルールとして認識されるようにするには、
.windup.xml
または.rhamt.xml
拡張子を使用する必要があります。- カスタムルールセットは、Rulesets タブの Custom アイテムの下に表示されます。
プロジェクトを分析する際に、このカスタムルールセットが実行設定で選択できるようになりました。
カスタム XML ルールの作成に関する詳細は、ルール開発ガイド を参照してください。
5.3. カスタムルールセットを作成する
プロジェクトの分析中に使用する Eclipse プラグインで新しいカスタムルールセットを作成できます。
- MTA パースペクティブから、Rulesets タブを開きます。
-
ルールセットの作成アイコン (
) をクリックします。
- プロジェクトおよびディレクトリーを選択して、新しいルールセットを保存します。
ルールセットファイルのファイル名を入力します。
注記XML ルールファイルが MTA ルールとして認識されるようにするには、
.windup.xml
または.rhamt.xml
拡張子を使用する必要があります。-
ruleset ID (
my-ruleset-id
など) を入力します。 - 必要に応じて、Generate quickstart template チェックボックスをチェックして、ルールセットファイルに基本的なルールテンプレートを追加します。
- Finish を選択します。
- エディターで新しいルールセットファイルが開かれ、ルールを追加および編集できます。Source タブを選択して、ruleset ファイルの XML ソースを編集することもできます。
プロジェクトを分析する際に、この新しいルールセットが実行設定で選択できるようになりました。
カスタム XML ルールの作成に関する詳細は、ルール開発ガイド を参照してください。
5.4. カスタムルールセットを提出する
カスタムルールセットを作成すると、公式の MTA ルールリポジトリーに含めるために、送信できます。これにより、カスタムルールは MTA の後続のリリースにレビューおよび組み込むことができ、MTA が分析するアプリケーションおよびサーバー設定を強化できます。
- MTA パースペクティブから、Rulesets タブを開きます。
-
ドロップダウンアイコン (
) をクリックします。
- 表示されるオプションから Submit Ruleset をクリックします。これにより、ブラウザーで新しいページが起動します。
表示されるページで、次のフィールドに入力します。
- Summary フィールドに、ルールの目的を入力します。これは送信時のタイトルになります。
- Code Sample テキストフィールドに、ルールを実行するソースコードの例を入力します。
- Choose Files をクリックし、保存されたルールに移動して、これを割り当てます。
- Description テキストフィールドに、ルールの簡単な説明を入力します。
- すべての情報を入力したら、Submit をクリックして送信を完了します。
付録A 参考資料
A.1. MTA の問題アイコンの凡例
Issue Explorer およびファイルエディターでは、MTA の問題はアイコンを使用して重大度およびステータスを示します。以下の表は、さまざまなアイコンの意味を示しています。
アイコン | 説明 |
---|---|
![]() | 移行を成功させるには、この問題を修正する必要があります。 |
![]() | 移行については、この問題の修正は任意となります。 |
![]() | この問題は、移行時に問題が発生する可能性があります。 |
![]() | この問題は解決されています。 |
![]() | この問題は、MTA がプロジェクトで最後に実行した後に問題としてマークされたコードが変更しているため、古い問題となります。 |
![]() | この問題にはクイック修正を利用できます。正常に移行するには修正は必須となります。 |
![]() | この問題にはクイック修正を利用できます。移行については、修正は任意となります。 |
![]() | この問題にはクイック修正を利用できます。これは、移行中に問題が発生する可能性があります。 |
A.2. JBoss ツールを Eclipse にインストールする
Eclipse プラグインは JBoss Tools に依存するため、これらの依存関係を MTA が正常に機能させるにはこれらの依存関係をインストールする必要があります。Eclipse インストールへの JBoss Tools のインストールに関する詳細は、以下を参照してください。
JBoss ツールのインストール
- メニューバーから Help → Eclipse Marketplace を選択します。
-
Find フィールドに
JBoss Tools
を入力し、Enter を押してプロジェクトを検索します。 - 一覧に JBoss Tools が表示されるまで下にスクロールし、このプロジェクトの横にある Install をクリックします。
- 選択した機能を確認し、Confirm をクリックします。デフォルトを受け入れて、MTA に必要な依存関係をインストールすることが推奨されます。
-
最初のラジオボタン (
Keep my installation the same and modify the items being installed to be compatible
) を選択していることを確認します。 - 選択したパッケージを確認し、Confirm をクリックします。
- ライセンス契約の条件に同意し、Finish をクリックします。
- Install anyway をクリックして、証明書を受け入れます。
- 指定した証明書をすべて信頼する場合は Select all をクリックし、Accept selected をクリックします。
- 変更を有効にするには、Eclipse を再起動します。
改訂日時: 2023-01-23 07:40:49 +1000