依存性検索ツールガイド

Index

1.はじめに
1.1.本ドキュメントの紹介
1.2.本ツールの紹介
2.利用方法
2.1.利用の流れ
2.1.1.Eclipseプロジェクトの作成
2.1.2.準備
2.1.3.検索の実行
2.1.4.結果の確認
2.1.5.結果の編集
2.1.6.その他
2.1.6.1.ビューメニューの操作
2.1.6.1.1.パッケージフィルタ
2.1.6.1.2.CSV出力
2.1.6.2.プリファレンス設定
2.1.6.2.1.移行先ライブラリ設定
2.1.6.2.2.検索対象設定

1.はじめに


1.1.本ドキュメントの紹介


本マニュアルは、 依存性検索ツール の利用手順について説明したマニュアルです。



1.2.本ツールの紹介


本ツールはソースコードの依存情報を抽出し、指定された移行先ライブラリ情報を利用して、移行先環境で利用できない箇所（移植が必要な箇所)を抽出するツールです。

Table 1. 検索対象となるリソース

項目説明
Java ファイルJava ファイル群で使用している全クラス情報と、移植先で使用可能なライブラリ情報とを比較し、使用できないクラスや非推奨となるクラスなどの情報を抽出します。
JSP ファイルJSP ファイルで使用している Java クラス情報、タグライブラリ情報と、移植先で使用可能なライブラリ情報とを比較し、使用できないクラスや非推奨となるクラスなどの情報を抽出します。
XML ファイルXML の DTD や XSD 情報と、移植先で使用可能な DTD や XSD 情報とを比較し、移植が必要な XML ファイルを抽出します。




2.利用方法


2.1.利用の流れ


ツールの利用の流れを解説します。



2.1.1.Eclipseプロジェクトの作成


以下の手順を実施します。

  1. Eclipse を起動

  2. プロジェクト作成ウィザードの起動

    File → New → Project...

  3. Java Project の作成

    Java Project → Next

    New Java Project ウィザードで、移植元の環境に応じて適宜設定を行いプロジェクトを作成します。

    [Important]Important

    必ず Java Project を作成してください。 Java Project 以外はツールが正常に動作しません。

    [Important]Important

    検索対象とする Java ファイルは必ず、 Eclipse Source Folder 配下に配置するようにしてください。

    [Important]Important

    配置するソースファイルは、 Java で扱える名称であればディレクトリ名、ファイル名は問いません。逆に、 Java で扱えない名称が含まれる(ハイフンなど)場合は検索に失敗する場合があります。



2.1.2.準備


検索実行前に、検索に関わる以下の項目についてプリファレンスページより設定を行うことができます。



2.1.3.検索の実行


以下の手順を実施します。

  1. 検索リソースの選択

    検索したいリソース上で右クリックし、以下のメニューを選択します。

    tubame → 依存性検索

    Figure 1. 依存性検索メニュー画面

    依存性検索メニュー画面


  2. 検索条件の設定

    結果ファイルの出力先指定 : 検索結果の出力ディレクトリを指定します。検索結果は出力ディレクトリにgjbmファイルを作成します。

    Figure 2. 依存性検索ウィザード画面

    依存性検索メニュー画面


  3. 検索の実行

    Finish をクリックすると検索が開始されます。



2.1.4.結果の確認


検索が完了すると、 Eclipse の作業ビューエリアに 依存性検索結果ビュー が表示されます。 また、検索結果ファイルである gjbm ファイルをダブルクリックすることでも 依存性検索結果ビュー を表示することができます。

Figure 1. 依存性検索結果ビュー

依存性検索結果ビュー


依存性検索結果ビュー の各表示項目の説明を以下に記載します。

Table 1. 依存性検索結果ビュー表示項目

項目説明
ヘッダ領域 error 件数、 warn 件数、結果ファイルパスの情報を表示します。
[Note]Note

デフォルトで error 、 warn それぞれ最大 100 件ずつ表示され、以降の結果は表示されません。

結果 移植元と移植先を比較した結果を表示します。
[Note]Note

以下の種類があります。

  • error

    移植が必要と考えられる箇所。

  • warn

    移植が推奨されるか、必要性を確認する必要がある箇所。
カテゴリ 検出した移植元のカテゴリを表示します。
[Note]Note

以下の種類があります。

  • Java

  • XML

  • JSP

パッケージ 検出したものが Java ファイルの場合はパッケージ名を、それ以外の場合は “-” を表示します。
移植元ライブラリ検出した移植元ライブラリ名を表示します。
移植先ライブラリ検出した移植先ライブラリ名を表示します。複数ヒットする場合は、カンマ区切りで表示します。
クラス検出したものに応じて、クラス名、名前空間、タグライブラリパス、スキーマパスなどを表示します。
ヒット数検出した件数をパッケージ単位、クラス単位で表示します。
移植対象ファイル検出した移植対象ファイル名を表示します。
行検出した移植対象ファイルの行番号を表示します。
結果詳細検出した理由が表示されます。
備考非推奨クラスを検出した場合に、対象ライブラリ名を表示します。



2.1.5.結果の編集


依存性検索ツールでは出力結果のエディター機能による結果の編集はできないため、Viewが提供するフィルタ機能及び、CSV出力機能を 利用して編集を行います。

以下の手順で実施します。

  1. 依存性検索ツールの結果をフィルタします。

    Viewメニューより 結果フィルタ 、 カテゴリフィルタ 、 パッケージフィルタ を利用して、レポート作成にむけて結果をフィルタします。 フィルタは、結果(Error,Warn)、カテゴリ(Java,jsp,xml)、パッケージでフィルタが適用できます。 フィルタの例として、パッケージフィルタを行う。 手順は パッケージフィルタ を参照

  2. フィルタを適用した状態でCSV出力します。

    手順は CSV出力 を参照

    [Note]Note

    • 拡張子をgjbmに変更したファイルは、依存性検索結果ビューで利用することができます。

    • 以下の「報告書の出力」にある手順に従って、レポートを自動生成する場合は、拡張子をgjbmに変更したファイルをEclipseのプロジェクトに保存してください。

      [Warning]Warning

      レポートを自動生成する際、Eclipseのプロジェクト内にgjbmファイルが複数存在場合、意図しないgjbmファイルを検知して、レポート生成する可能性がありますので、ご注意ください。

  3. 報告書の出力します

    TUBAMEでは以下の機能のいずれかを利用して、レポート生成を行います。

    • レポート自動生成

      レポート生成機能を利用して、移植性検討レポートを生成します。詳細は、 移植性検討レポート生成ガイド を参照。

    • CSV出力(レポート手動生成)

      CSV出力したものを手動で集計して頂き、レポート生成を行う。



2.1.6.その他



2.1.6.1.ビューメニューの操作


依存性検索結果ビュー に表示されている内容に対して、ビューメニューより以下のような操作を行うことができます。

Figure 1. 依存性検索結果ビューメニュー

依存性検索結果ビューメニュー


Table 1. ビューメニュー項目

項目説明
結果フィルタ結果列の表示項目を設定できます。
カテゴリフィルタカテゴリ列の表示項目を設定できます。
パッケージフィルタパッケージ列の表示項目を設定できます。
移植元ライブラリフィルタ移植元ライブラリフィルタ列の表示項目を設定できます。
移植先ライブラリフィルタ移植先ライブラリフィルタ列の表示項目を設定できます。
CSV出力 依存性検索結果ビュー に表示されている項目を CSV 形式で保存できます。
表示件数設定 依存性検索結果ビュー に表示する最大件数を設定します。設定値は、 結果 列の error 、 warn それぞれの最大表示件数となります。



2.1.6.1.1.パッケージフィルタ


パッケージフィルタの手順を実施します。



2.1.6.1.2.CSV出力


CSV出力の手順を実施します。



2.1.6.2.プリファレンス設定



2.1.6.2.1.移行先ライブラリ設定


検索に関わる移行先ライブラリの追加登録を行います。本例では、移行先ライブラリとして、Strut2のライブラリをstrut2-libとして追加登録し、利用する方法について示します。

  1. プリファレンスページより、移行先ライブラリの設定を行います。

    Window → Preferences → 依存性検索ツール → ライブラリ設定

    [Note]Note

    ライブラリ設定では、以下の情報が設定できます。

    • ライブラリ設定

      検索の際に使用するライブラリ情報を管理します。チェックボックスが有効なライブラリが、移植先で利用可能なライブラリとみなされて検索されます。

    • キャッシュ

      ライブラリ情報の抽出は、実際には検索開始後に実施されます。やや重い処理となるため、検索結果のキャッシュ機能が備わっています。そのキャッシュを利用するかを設定します。初めて検索する際はキャッシュが存在しないため、キャッシュを有効にしていてもライブラリ情報の抽出処理は実行されます。

    Figure 1. ライブラリ設定画面

    ライブラリ設定画面

  2. ライブラリ設定画面の追加ボタンより、移行先ライブラリを新規追加します

    [Note]Note

    設定項目は以下となります。

    • 名前

      画面表示名称。任意の名前を入力します。

    • ライブラリ種別

      ライブラリが圧縮ファイル (Zip 形式 ) かディレクトリ形式かを選択します。

    • パス

      ライブラリへのパスを設定します。

    • タイプ

      ライブラリが Maven リポジトリ形式の場合はチェックを有効にします。

    • 説明

      ライブラリに関する説明を入力します。

    Figure 2. 新規ライブラリリポジトリ画面

    新規ライブラリリポジトリ画面

  3. ライブラリ設定画面のライブラリ一覧より、依存性検索で利用するライブラリをチェックします。

    利用する移行先ライブラリをチェック後に、以下を実施します。 Apply → OK

    Figure 3. 設定変更後のライブラリ一覧

    設定変更後のライブラリ一覧

  4. 依存性検索ウィザード画面にて依存性検索で利用する移行先ライブラリを確認します。検索したいリソース上で右クリックし、以下のメニューを選択します。

    tubame → 依存性検索

    [Note]Note

    本例の場合は、struts2-libを設定したので、移行先ライブラリに"struts2-lib"が表示されていることを確認します。

    Figure 4. 依存性検索ウィザード画面

    依存性検索ウィザード画面


2.1.6.2.2.検索対象設定


検索対象設定では、依存性検索の検索対象をフィルターすることができます。

  1. プリファレンスページより、検索対象設定の設定を行います。

    Window → Preferences → 依存性検索ツール → 検索対象設定

    Figure 1. 検索対象設定画面

    検索対象設定画面

  2. 検索対象設定を行います

    [Note]Note

    以下の項目の設定変更が可能です。

    • 検索対象設定

      検索対象の拡張子を変更できます。

    • 詳細設定

      • java

        packageを除去対象として追加できます

      • jsp

        package及び、jspで参照しているスキーマ定義を、除去対象として追加できます

      • xml

        xmlで参照しているスキーマ定義を、除去対象として追加できます