Java ソース・ファイルのコード・レビューは、ヘッドレス・ワークベンチ (開発環境向けの、ユーザー・インターフェースのないワークベンチ) でコマンド行から実行できます。これは、無人で定期的にコード・レビューを実行したい場合、またはコード・レビューを Ant スクリプトに組み込みたい場合に便利です。
コマンド行インターフェースによって、ワークスペースおよびオプショナル・パラメーターを指定できます。コマンド行はヘッドレスの Eclipse 環境を起動します。この環境はコード・レビュー実行に必要なコア機能のみを備え、ユーザー・インターフェース機能はありません。
デフォルトでは、即時コード・レビューのルールか、最後にコード・レビューが実行された際に UI で指定されたルールを使用して、
ワークスペースのソース・コードでコード・レビューを実行します。
ヘッドレス・モードでコード・レビューを実行する前に、Java ソース・ファイルを持つプロジェクトを含むワークスペースが用意されている必要があります。開発環境は稼働中でなくてもかまいません。
注: Windows オペレーティング・システムの制限により、コマンド行モードの実行に使用される文字列 (C:¥path¥java.exe …) の長さは、
できるだけ短くする必要があります。長すぎると、文字列末尾のパラメーターがシステムによってカットされたり、失われたりすることがあります。
Windows ユーザーは、以下のベスト・プラクティスに従って最良の結果を得る必要があります。
- PATH 変数にはできるだけ多くのパスを組み込む必要がある。例えば、Java のパスおよび JAR ファイルへのパス。
- ワークスペースへのパスは、できるだけ短くする必要がある。例えば、C:¥workspace。
- レポートが生成される場所のパスもできるだけ短くする必要がある。例えば、C:¥report。
ヘッドレス・モードのコード・レビューを同一のワークスペースで同時に複数実行することはできません。
また、Eclipse グラフィカル・ユーザー・インターフェースによってワークスペースがロックされている場合もヘッドレス・モードは使用できません。
例
次のコマンド行によって、Windows OS 上のワークスペース D:¥workspace からコード・レビューが実行されます。
HTML レポートは D:¥workspace¥report に作成されます。
D:¥eclipse¥jre¥bin¥java -Xj9 -Dorg.eclipse.swt.browser.internal.flash
-Dorg.eclipse.emf.ecore.EPackage.Registry.INSTANCE=org.eclipse.emf.ecore.impl.EPackageRegistryImpl
-cp D:¥eclipse¥startup.jar org.eclipse.core.launcher.Main -application com.ibm.r2a.command.line.mode.CommandLineModeApplication
-plugincustomization <pluginCustomizationPath> -data <workspace_dir> -reportDirectory
D:¥workspace¥report -onlyClient CodeReview
注: ご使用のオペレーティング・システム構成によっては、
コード・レビューを実行するために、この例のコマンドにパラメーターを追加する必要がある場合があります。これらのパラメーターは、にある"「システム・プロパティー (System properties)」"下のシステム構成の詳細にあります。