Eclipse および Red Hat CodeReady Studio ガイド
Eclipse または Red Hat CodeReady Studio の MTA プラグインでアプリケーションを分析して、移行の問題を特定し、解決します。
概要
多様性を受け入れるオープンソースの強化
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。
第1章 はじめに
1.1. Eclipse および Red Hat CodeReady Studio の MTA プラグインについて
Eclipse および Red Hat CodeReady Studio の Migration Toolkit for Applications (MTA) プラグインを使用すると、アプリケーションの移行およびモダナイゼーションが可能になります。
MTA プラグインはカスタマイズ可能なルールセットを使用してプロジェクトを分析し、ソースコード内の問題をマークし、問題を修正するためのガイダンスを提供し、可能な場合は自動コードの置き換えを提供します。
1.2. Migration Toolkit for Applications の概要
Migration Toolkit for Applications とは ?
Migration Toolkit for Applications (MTA) は、Red Hat OpenShift 上のハイブリッドクラウド環境全体で大規模なアプリケーションモダナイゼーションに対する取り組みを促進します。このソリューションは、ポートフォリオレベルとアプリケーションレベルの両方で、採用プロセス全体を通じて洞察を提供します。つまり、アプリケーションのインベントリー、評価、分析、および管理を行い、ユーザーインターフェイスを介して OpenShift への移行をより短い期間で行うことができます。
MTA は、アプリケーションを評価するための基礎として広範にわたる質問リストを使用して、コンテナー化のアプリケーションの準備に必要な難易度、時間、およびその他のリソースを見積もることができるようにします。ステークホルダー間の議論の基礎として評価の結果を使用して、どのアプリケーションがコンテナー化に適しているか、最初に多大な作業が必要なアプリケーション、およびコンテナー化に適していないアプリケーションを判断できます。
MTA は、考慮された各アプリケーションに 1 つ以上のルールセットを適用してアプリケーションを分析し、最新化する前にそのアプリケーションの中でどの特定の行を変更する必要があるかを判断します。
MTA は、プロジェクトソースディレクトリーやアプリケーションアーカイブを含むアプリケーションアーティファクトを検査し、変更を必要とするエリアを強調表示する HTML レポートを作成します。MTA は、以下を含む多くの移行パスをサポートします。
- Red Hat JBoss Enterprise Application Platform の最新リリースへのアップグレード
- Oracle WebLogic または IBM WebSphere Application Server から Red Hat JBoss Enterprise Application Platform への移行
- アプリケーションのコンテナー化とクラウド化
- Java Spring Boot から Quarkus への移行
- OpenJDK 8 から OpenJDK 11 へのアップグレード
- OpenJDK 11 から OpenJDK 17 へのアップグレード
- EAP Java アプリケーションの Azure App Service への移行
- Spring Boot Java アプリケーションの Azure App Service への移行
ユースケースおよび移行パスの詳細は、開発者向け MTA Web ページを参照してください。
Migration Toolkit for Applications による移行を単純化する方法
Migration Toolkit for Applications は一般的なリソースを探し、アプリケーションを移行する際の既知の問題点を明らかにします。これは、アプリケーションが使用するテクノロジーのハイレベルビューを提供します。
MTA は、移行またはモダナイゼーションパスの評価に関する詳細なレポートを生成します。このレポートは、大規模なプロジェクトに必要な作業を見積もり、関係する作業を減らすのに役立ちます。
第2章 MTA プラグインのインストール
接続されているネットワーク環境またはネットワークが制限された環境に MTA プラグインをインストールできます。
2.1. 接続環境でのインストール
接続されている環境に MTA プラグインをインストールできます。
MTA プラグインは、Java Enterprise Developers 2022-03 および Red Hat CodeReady Studio 12.21.3.GA の Eclipse IDE でテストされています。
前提条件
Java Development Kit(JDK) がインストールされている。MTA は以下の JDK をサポートします。
- OpenJDK 11
- Oracle JDK 11
- 8 GB RAM
-
macOS のインストール:
maxproc
の値は2048
以上である必要がある。 - Red Hat CodeReady Studio または Eclipse IDE for Java Enterprise Developers 2022-03
- Eclipse Marketplace クライアント と共にインストールされた JBoss Tools。
- Eclipse と共にインストールされた Mylyn SDK およびフレームワーク
手順
- 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 プラグインは、Java Enterprise Developers 2022-03 および Red Hat CodeReady Studio 12.21.3.GA の Eclipse IDE でテストされています。
前提条件
Java Development Kit(JDK) がインストールされている。MTA は以下の JDK をサポートします。
- OpenJDK 11
- Oracle JDK 11
- 8 GB RAM
-
macOS のインストール:
maxproc
の値は2048
以上である必要がある。 - Red Hat CodeReady Studio または Eclipse IDE for Java Enterprise Developers 2022-03
- Eclipse Marketplace クライアント と共にインストールされた JBoss Tools。
- Eclipse と共にインストールされた Mylyn SDK およびフレームワーク
- すべてのダウンロードに接続されたワークステーション
手順
-
ネットワークアクセスのあるコンピューターで、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 サーバーの開始、停止、およびステータス表示を行うことができます。
- Issue Details には、ヒント、重大度、追加のリソースなど、選択した問題に関する詳細情報が表示されます。
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 ボタン ( ) をクリックし、実行設定を選択します。
MTA プラグインはプロジェクトを分析します。Issue Explorer は、ルールセットで検出された移行の問題を表示します。
- プロジェクトの分析が終了したら、Issue Explorer で MTA サーバーを停止して、メモリーを節約します。
3.3. 問題の確認
MTA プラグインによって特定された問題を確認できます。
手順
- Window → Show View → Issue Explorer をクリックします。
オプション: Options メニュー をクリックし、Group By およびオプションを選択して問題をフィルターリングします。
右クリックし、Issue Details を選択して問題についての情報を表示します。これには、重大度や対処方法が含まれます。
以下のアイコンは、問題の重大度および状態を示しています。
表3.1 問題アイコン
アイコン 説明 移行を成功させるには、この問題を修正する必要があります。
移行については、この問題の修正は任意となります。
この問題は、移行時に対処する必要がある場合があります。
この問題は解決されています。
この問題は古くなっています。問題としてマークされたコードは、MTA が最後に問題として識別したときから変更されています。
この問題にはクイック修正を利用できます。正常に移行するには修正は必須となります。
この問題にはクイック修正を利用できます。移行については、修正は任意となります。
この問題にはクイック修正を利用できます。これは、移行中に問題が発生する可能性があります。
- 問題をダブルクリックして、エディターでコードの関連する行を開きます。
3.4. 問題の解決
以下のアクションのいずれかを実行して、MTA プラグインによって検出された問題を解決できます。
問題をダブルクリックしてエディターで開き、ソースコードを編集できます。
この問題は、次に MTA プラグインを実行するまで Stale アイコン ( ) が表示されます。
- 問題を右クリックし、Mark as Fixed を選択します。
- 問題にクイック修正アイコン ( ) が表示される場合には、問題を右クリックし、Preview Quick Fix を選択してから Apply Quick Fix を選択します。
第4章 ルールの管理
MTA プラグインには、プロジェクトを分析し、移行およびモダナイゼーションの問題を特定するための システム ルールのコアセットが含まれています。
カスタムルールセットを作成してインポートできます。
4.1. ルールの表示
MTA プラグインで、システムおよびカスタムルールが存在する場合は、それを表示できます。
前提条件
- システムルールを表示するには、MTA サーバーが実行している必要があります。
手順
- Rulesets タブをクリックします。
- System を展開して、システムのルールセットまたは Custom を表示してカスタムルールセットを表示します。
- ルールセットを展開します。
- ルールをダブルクリックして、ビューアーで開きます。
- Source タブをクリックして、ルールの XML ソースを表示します。
4.2. カスタムルールセットの作成
MTA パースペクティブでカスタムルールセットを作成できます。
カスタム XML ルールの作成に関する詳細は、ルール開発ガイド を参照してください。
手順
- Rulesets タブをクリックします。
- ルールセットの作成アイコン ( ) をクリックします。
- ルールセットのプロジェクトおよびディレクトリーを選択します。
ファイル名を入力します。
注記ファイルには拡張子
.windup.xml
が必要です。-
ruleset ID (
my-ruleset-id
など) を入力します。 - オプション: Generate quickstart template を選択し、基本的なルールテンプレートをファイルに追加します。
- Finish をクリックします。
- エディターでルールセットファイルが開かれ、ルールを追加および編集できます。
- Source タブをクリックして、ルールセットファイルの XML ソースを編集します。
実行設定の作成時に、新しいルールセットを選択できます。
4.3. カスタムルールセットのインポート
カスタムルールセットを MTA プラグインにインポートして、プロジェクトを分析できます。
前提条件
拡張子が
.windup.xml
のカスタムルールセットファイル。ルールセットの作成に関する詳細は、ルール開発ガイド を参照すること。
手順
- Rulesets タブをクリックします。
- ルールセットのインポートアイコン ( ) をクリックします。
インポートする XML ルールファイルを参照して選択します。
Rulesets タブで Custom を拡張すると、カスタムルールセットが表示されます。
4.4. カスタムルールセットの送信
公式の MTA ルールリポジトリーに組み込むカスタムルールセットを送信できます。これにより、カスタムルールを確認して、MTA の後続のリリースに含めることができます。
手順
- Rulesets タブをクリックします。
- 矢印アイコン ( ) をクリックし、Submit Ruleset を選択します。
以下のフィールドに入力します。
- Summary: ルールの目的を説明します。これは送信時のタイトルになります。
- Code Sample: ルールが実行するソースコードの例を入力します。
- Description: ルールの簡単な説明を入力します。
- Choose Files をクリックし、ルールセットファイルを選択します。
- Submit をクリックします。