アプリケーション開発ガイド（共通）: WebOTX Developer Manual

WebOTX Manual V10.3 (第4版)

目次を表示

16. コンテナ向けアプリケーション検証機能

16.1. 概要

Javaアプリケーションのコンテナ向けマイグレーション作業をサポートする機能です。

図16.1-1

コンテナ向けアプリケーション検証機能では、インポートされたプロジェクトソースディレクトリやアプリケーションアーカイブなどを検証し変更が必要な場所などをHTMLレポートに出力します。
また、WebOTX Deveoperが未インストールの環境でコンテナ向けアプリケーション検証ツールを使用する場合は、<WebOTXインストールディレクトリ>/Developer/migration_Toolkit ディレクトリ毎、任意のディレクトリへコピーして
コンテナ向けアプリケーション検証ツールコマンドを使用してHTMLレポートに出力することも出来ます。
コマンドツールによる実行方法については、[コマンドを使用したコンテナ向けアプリケーション検証]を参照してください。

16.2. 事前準備

ファイル選択によるアプリケーションアーカイブ(*.war、*.ear、*.rar、*.zip、*.jar)を検証する場合には、コンテナ向けアプリケーション検証機能プロパティファイルの設定変更が必要です。

16.3. 利用手順

16.3.1. WebOTX Developerを使用したコンテナ向けアプリケーション検証

コンテナ向けアプリケーションの検証例を以下に示します。

検証対象アプリケーションのマイグレーション
検証対象アプリケーションのビルド
検証対象アプリケーションの検証

以下に、コンテナ向けアプリケーション検証の流れの概要を示します。

Memo
ソースファイルを含んだプロジェクトを検証する場合は、[ソースファイルを含んだプロジェクトの検証手順]を参照してください。

16.3.2. 検証対象アプリケーションのマイグレーション

　検証対象アプリケーションを検証する場合には、マイグレーションアシスタントの機能を使用して検証対象アプリケーションのマイグレーションを行ってください。
　マイグレーションアシスタントの詳細は［マイグレーションアシスタントについて］を参照してください。

16.3.3. 検証対象アプリケーションのビルド

　検証対象アプリケーションのビルドを行い、コンパイルエラー等の問題を解決しjar、war、ear等へのパッケージングを行いアプリケーションアーカイブを作成します。

16.4. 検証対象アプリケーションの検証

16.4.1. アプリケーションアーカイブの検証手順

アプリケーションアーカイブの検証手順を以下に説明します。

コンテナ向けアプリケーション検証機能プロパティファイル(config.properties)の、アトリビュート名：sourceModeの設定値をfalseに変更します。
プロパティファイルについてはプロパティファイルの設定変更を参照してください。

Windows のスタートメニューより、WebOTX Developer を起動し、対象プロジェクト配下のアプリケーションアーカイブを選択します。

図16.3.1.2-1

プルダウンメニュー＞ コンテナ向けアプリケーション検証 を選択し、アプリケーション検証ウィザードを表示します。

図16.3.1.2-2

ウィザード画面上の フルプロファイル向けの検証を行う 、マイクロプロファイル向けの検証を行うをチェックします。
チェック後に 検証開始をクリックします

フルプロファイル向けの検証
フルプロファイル向けは、Java EEの全ての機能をコンテナ環境で動作させる為の検証を行います。
マイクロプロファイル向けの検証
マイクロプロファイル向けは、マイクロサービスに特化したコンテナ環境で動作させる為の検証を行います。

検証完了後は、以下の画面が表示されます。
検証結果のレポート出力先は、<WebOTXインストールディレクトリ>/Developer/migration_Toolkit/report/{検証対象アーカイブ名}.reportです。

図16.3.1.2-3

Memo
レポート出力先に同名のディレクトリが存在する場合は、新しいレポート内容が上書き保存されます。
既存のレポート内容を保存する場合は、対象ディレクトリをリネームして保存してください。

レポート内容については、[コンテナ向けアプリケーション検証レポート]を参照してください。

Memo
検証処理時のログは<WebOTXインストールディレクトリ>/Developer/migration_Toolkit/logに出力されます。

Memo
ソースファイルを含んだプロジェクトを検証する場合は、[ソースファイルを含んだプロジェクトの検証手順]を参照してください。

16.4.2. ソースファイルを含んだプロジェクトの検証手順

ソースファイルを含んだプロジェクトの、検証手順を以下に説明します。

Windows のスタートメニューより、WebOTX Developer を起動し、対象プロジェクト配下のソースディレクトリを選択します。

図16.3.1.1-1

プルダウンメニュー＞ コンテナ向けアプリケーション検証 を選択し、アプリケーション検証ウィザードを表示します。

図16.3.1.1-2

フルプロファイル向けの検証
フルプロファイル向けは、Java EEの全ての機能をコンテナ環境で動作させる為の検証を行います。
マイクロプロファイル向けの検証
マイクロプロファイル向けは、マイクロサービスに特化したコンテナ環境で動作させる為の検証を行います。

Memo
フルプロファイル向けの検証、マイクロプロファイル向けの検証はそれぞれ単独での指定も可能です。

検証完了後は、以下の画面が表示されます。
検証結果のレポート出力先は、<WebOTXインストールディレクトリ>/Developer/migration_Toolkit/report/{検証対象ディレクトリ名}.reportです。

図16.3.1.1-3

Caution
JavaDoc構文が存在するjavaソースファイルを検証した場合、ソースレポート内で指摘される行数がずれる事があります。
JavaDoc構文が存在する場合のソースレポートについては、[JavaDoc構文が存在する場合のSource Report (移行課題があるソースの詳細)]を参照してください。

レポート内容については、[コンテナ向けアプリケーション検証レポート]を参照してください。

Memo
検証処理時のログは<WebOTXインストールディレクトリ>/Developer/migration_Toolkit/logに出力されます。

16.4.3. プロパティファイルの設定変更

config.properties

ファイルパス：<WebOTXインストールディレクトリ>\Developer\Studio\plugins\com.nec.webotx.appmigtool_{バージョン名}\config.properties

コンテナ向けアプリケーション検証機能の変更可能な設定項目

config.properties
属性名(attribute-name)	説明	既定値
sourceMode	アーカイブファイルを検証する場合には false を設定します。	true
output	レポート出力ディレクトリを固定する場合には指定します。	なし
userIgnorePath	検証除外設定ファイルを配置したディレクトリパスを指定します。	なし

Memo
プロパティファイルの設定値を変更した場合、WebOTX Developerの再起動は必要ありません。

16.4.4. コマンドを使用したコンテナ向けアプリケーション検証

コマンドでのコンテナ向けアプリケーション検証の動作環境は以下の通りです。

動作環境
OS	CPUアーキテクチャ	メモリ
Window8.1	x64bits	最小4GB (8GB以上を推奨)
Window10 (verion 1803以降)
Red Hat Enterprise Linux 6
Red Hat Enterprise Linux 7
Red Hat Enterprise Linux 8

Memo
Deveoperが未インストールの環境で、コンテナ向けアプリケーション検証ツールを使用する場合は、<WebOTXインストールディレクトリ>/Developer/migration_Toolkit ディレクトリ毎、コピーしてご利用ください。
またコマンドの実行権は、環境に合わせて適宜設定してください。

16.4.4.1. コンテナ向けアプリケーション検証ツールの構成

コンテナ向けアプリケーション検証ツールのディレクトリ構成図を以下に示します。

図16.3.2.1-1

コマンドツールでのコンテナ向けアプリケーション検証の実行方法(Windows)を説明します。

ここでは、コマンドツールがインストールされているディレクトリ（<WebOTXインストールディレクトリ>/Developer/migration_Toolkit)を
{TOOL_DIR} とします。

コマンドプロンプトを起動します。
CD コマンドで {TOOL_DIR} のディレクトリにカレントを移動します。

以下のコマンドを実行します。

 {TOOL_DIR} > .\bin\amt-cli.bat --sourcemode --input {検証対象ディレクトリ} --output {検証結果出力先ディレクトリ} --target wo-fp wo-mp

コマンド実行終了後、{検証結果出力先ディレクトリ}が作成され、{検証結果出力先ディレクトリ}配下にレポートが出力されます。

Memo
コマンド詳細については、[ その他機能 > コンテナ向けアプリケーション検証ツールコマンド]を参照してください。

16.4.5. コンテナ向けアプリケーション検証レポート

コンテナ向けアプリケーション検証ツールが生成するコンテナ向けアプリケーション検証レポート例を説明します。

ブラウザーを使用して、レポート出力ディレクトリにあるindex.htmlファイルを開きます。
これにより、検証されたアプリケーションをリストするメインページが開きます。

アプリケーションリスト
検証アプリケーションで発生したストーリーポイント、インシデントの数、および技術の概要が含まれます。

図16.3.3.1-1

アプリケーションリストの部品名称
番号	説明
１	検証されたアプリケーション名クリックすることで、Dashboard (レポートインデックス) 画面に遷移します。
２	検証されたアプリケーションのストーリーポイント(※１)
３	Cloud Mandatoryカテゴリごとの検出数(※２)
４	Informationカテゴリごとの検出数(※２)
５	総検出数
６	使用されている技術
７	ヘッダメニューヘッダメニューから表示されるレポートは複数アプリケーションの情報が表示されます。

(※1) ストーリーポイント
(※2) カテゴリごとの検出数

Technologies (使用されている技術)

テクノロジーは、アプリケーションリストのヘッダメニューから「Technologies」を選択することで表示されます。
ヘッダメニューからTechnologiesを選択した場合は、アプリケーションリストに表示されている複数のアプリケーションで使用されるテクノロジーが表示されます。

図16.3.3.1-2

テクノロジーの部品名称
番号	説明
１	検証されたアプリケーションに使用されている技術を機能別に分類し「EJB」などの項目をクリックすると、３のソート対象データをもとに降順/昇順で並べ替えられます。
２	検証されたアプリケーション名表示項目の「Name」をクリックすることでファイル名でソートされます。検証されたアプリケーション名をクリックすることで検証されたアプリケーション単位の Technologies (使用されている技術)に遷移します。
３	ソート対象データ
４	検証されたアプリケーションで使用されている技術がどのように分散されているかを示しています。
５	検証されたアプリケーションのサイズ、ライブラリの数、ストーリーポイントの合計が表示されます。

　　　検証されたアプリケーション単位のテクノロジーは、上記テクノロジーの部品名称２をクリックすることで表示されます。
　　　アプリケーションに見られるテクノロジの概要であり、ユーザーが各アプリケーションの目的をすばやく理解できるように表示されます。

図16.3.3.1-3

Dependencies Graph (依存関係グラフ)

デペンデンシーグラフは、アプリケーションリストのヘッダメニューから「Dependencies Graph」を選択することで表示されます。
ヘッダメニューから「Dependencies Graph」を選択した場合は、アプリケーションリストに表示されている複数のアプリケーションの各依存関係グラフが表示されます。
また、ヘッダメニューから「Dependencies」を選択した場合は「Dependencies Graph」で表示されるファイル名がリスト表示されます。

図16.3.3.1-1

デペンデンシーグラフ部品名称
番号	説明
１	複数のアプリケーション単位の各依存関係が表示されます。
２	選択されたファイル名グラフ表示されたアイコンが選択されている場合に表示されます。
３	グラフアイコンの凡例

Dashboard (レポートインデックス)

ダッシュボードは、アプリケーションリストのアプリケーション名を選択することで表示されます。

図16.3.3.2-1

Dashboard (レポートインデックス)の部品名称
番号	説明
１	カテゴリごとの検出インシデント数とストーリーポイント数
２	検出カテゴリ(※２)毎の検出インシデント数
３	検出カテゴリ(※２)の検出インシデント数とストーリーポイント数
４	ストーリーポイントレベル(※１)に対する検出インシデント数、ストーリーポイント数
５	ストーリーポイントレベル(※１)毎の検出インシデント数
６	カテゴリ別の検出インシデント数
７	Javaパッケージ毎の検出インシデント数
８	Javaパッケージ毎の検出インシデント数の構成比

(※1) ストーリーポイントレベル
(※2) 検出カテゴリ

次の表に、アクセスできるすべてのレポートとページを示します。

レポート	説明
Issues (移行課題)	注意を要するすべての問題の簡潔な要約を提供します。
Application Details (アプリケーション詳細)	アプリケーション内で見つかった、移行中に注意が必要なすべてのリソースの詳細な概要を提供します。
Technologies (使用されている技術)	機能別にグループ化されたすべての埋め込みライブラリを表示し、各アプリケーションで使用されている技術を表示します。
Dependencies Graph (依存関係グラフ)	分析されたアプリケーション内で見つかったすべてのJavaパッケージの依存関係のグラフを表示します。
Dependencies (依存関係)	アプリケーション内で見つかったすべてのJavaパッケージの依存関係を表示します。
Remote Services (Remote)	アプリケーション内で見つかったすべてのリモートサービス参照を表示します。
EJB Report (Java EE EJB Bean)	アプリケーション内で見つかったEJBのリストを表示します。
Server Resources (Server)	アプリケーションのすべてのサーバーリソース（JNDIリソースなど）を表示します。
Ignored Files (除外ファイル)	処理されなかったアプリケーションで見つかったファイルを表示します。詳細については、--userignorepathオプションを参照してください。

Issues (移行課題)

インシデントを検出したファイルのリストを表示します。
ヘッダメニューから「All Issues」を選択した場合は、アプリケーションリストに表示されている複数のアプリケーションで検出したインシデントが表示されます。

図16.3.3.3-1

Issues (移行課題)の部品名称
番号	説明
１	カテゴリ(※１)
２	検証されたアプリケーション内で検出したインシデント名(※２)
３	検出インシデント毎の総数
４	検出インシデントのストーリーポイント(※３)
５	検出インシデント毎の総数に対するストーリーポイント総数(※４)

(※１)カテゴリ
(※２)インシデント名を選択するとインシデントの詳細情報を表示します。
(※３)ストーリーポイントレベル
(※４)ストーリーポイント総数(検出インシデント毎の総数×検出インシデントのストーリーポイント)

詳細情報

図16.3.3.4-1

詳細情報の部品名称
番号	説明
１	検証されたアプリケーション内で検出したインシデント名
２	インシデントが検出されたファイル名(※１)
３	ファイル内検出インシデント数(※２)
４	検出インシデント詳細
５	インシデント検出ルール(※３)

(※１)ファイル名を選択するとソースレポートを表示します。
(※２)ストーリーポイント数。
(※３)選択すると検出ルールを表示します。

Source Report (移行課題があるソースの詳細)

問題のソースコードを指摘し、修正提案を具体的に説明します。

図16.3.3.5-1

Source Report (移行課題があるソースの詳細)の部品名称
番号	説明
１	ファイル内でのストーリーポイント総数
２	検出インシデントの概要説明
３	インシデントを検出したソースコード行数
４	インシデント対応のヒント
５	インシデント検出ルール(※１)

(※１)選択すると検出ルールを表示します。

検出ルール

インシデントを検出したルールを表示します。

図16.3.3.6-1

ストーリポイント

ストーリーポイントは、検出されたインシデントを修正する為に必要な作業量を相対的に表した数になります。また、ストーリーポイントは具体的な時間を表すのでは無く
難易度を見積る為に規模や複雑さの指標値です。

ストーリーポイントには以下のレベルが存在します。

ストーリーポイント
レベル	ストーリーポイント	説明
Information	０	優先度が非常に低い情報
Trivial	１	些細な対応、使用APIの変更、または使用ライブラリ変更等
Complex	３	複雑な対応が必要
Redesign	５	大幅なAPIの変更を伴う再設計、またはライブラリの完全な変更が必要
Rearchitecture	７	完全なコンポーネント、またはサブシステムの再構成が必要
Unknown	１３	完全な書き換えが必要な場合がある

カテゴリ

カテゴリは４つのグループに分かれています。

カテゴリ
名称	説明
Cloud Mandatory	マイグレーションで必ず解決が必要です。変更が行われない場合にはコンテナ環境にて正常に動作しません。
Optional	コンテナ環境でアプリケーションは動作するが正常に動作しないことがあります。スケジュールの変更を検討してください。
Potential	コンテナ環境での互換性など調査が必要です
Information	問題はありませんが、将来的に調査または修正が必要です。

JavaDoc構文が存在する場合のSource Report (移行課題があるソースの詳細)

ここでは、JavaDoc構文が存在する場合の指摘例について説明します。

図16.3.3.9-1

JavaDoc構文がある場合のSource Report (移行課題があるソースの詳細)
番号	説明
１	インシデントを検出されたとしてJavaDoc先頭行にインシデント対応のヒント「Micropro Service(inheritance)」が表示されます。
２	指摘されている行の前にJavaDoc構文のブロックコメントが存在するため、この行で指摘されたインシデントが１の位置に表示されます。
３	インシデントを検出されたとしてJavaDoc先頭行にインシデント対応のヒント「Java Remote Method Invocation (RMI) API」が表示されます。
４	指摘されている行の前にJavaDoc構文のブロックコメントが存在するため、この行で指摘されたインシデントが３の位置に表示されます。
５	指摘されている行の前のブロックコメントがJavaDoc構文ではないため、位置ずれなくインシデント対応のヒント「Java Remote Method Invocation (RMI) API」が表示されます。

Memo
コンテナ向けアプリケーション検証機能は、プリケーションアーカイブを使った検証を推奨しています。
アプリケーションアーカイブを使った検証については、[アプリケーションアーカイブの検証手順]を参照してください。