メトリクスプラグイン

プラグイン

　拙著に書いたメトリクスプラグインの抜粋です。リファクタリングといっしょに利用すると有効だと思います。--mizkaz

Eclipse Metrics Plugin †

リファクタリングを適用する基準として、よく「長すぎるメソッドや巨大なクラスはリファクタリングした方がよい」と言われます。では、いったいどれぐらいの長さのものが長すぎるのでしょうか? きっと、人によって判断基準はバラバラだと思います。

メトリクスを用いれば、これらの判断基準を数値化できます。 メトリクスとは、ソフトウェアの品質や測定の基準のことです。 Eclipse のプラグインに、メトリクスを測定できる Metrics プラグイン http://www.stateofflow.com/projects/16/eclipsemetricsがあります。このプラグインは次のメトリクスを測定できます。

上記のほかには、Eclipse Metrics プラグインというものもあります。

マッケーブの循環的複雑度 (McCabe?'s cyclomatic complexity)

プログラムの複雑さを測る指標のひとつで、値が大きいほどテストや保守が難しいことを意味します。「」という書籍の中では、5 以下のプログラムは単純、10 以下でもそれほど難しくは無い、20 以上は複雑さが高い、50 以上になるとテスト不可能と指摘しています。

Efferent Couplings

外部パッケージへの依存度

LCOM(Lack of Cohesion in Methods)

クラス中のメソッドどうしの関連の度合いを示す指標。共有している変数が多いほど値が大きくなります。これはメソッドどうしが強く関連しており、望ましいカプセル化が行われていることを表します。逆に、値が小さいものは、メソッドどうしがあまり関連しておらず、さらにクラス分割できることを示唆します。

LOC(Lines of Code in Method)

メソッド中のコードの行数

フィールド数

メソッド中の入れ子の深さ

メソッドのパラメータ数

メソッドのステートメント数

LOC は空白行やコメントなども計測するのでコーディングスタイルの影響がありますが、この値はステートメント数だけをカウントするのであまり影響がありません。

WMC(Weighted Methods Per Class)

あるクラス中のメソッドの複雑さの総和

これらの値を開発チームで予め決めておくことで、リファクタリングを適用する判断基準やソフトウェアの品質を数字で判断することができます。

以下が、メトリクスプラグインで測定したメトリクスの例です。青い部分が基準値以内の値、赤い部分が基準値を越えていることを表しています。また、表は各測定項目でソートすることもできます。ソートすれば、どのメソッド、どのクラスが最も問題であるのかが直ぐに分かります。

インストール †

http://www.stateofflow.com/UpdateSite/ をアップデートサイトに登録してインストールします。

基準値の設定 †

メトリクスの基準値の設定は、メニューバーから [ウィンドウ]-[設定]-[Metrics] を選び、下図の画面から行います。ここで設定した基準値を越えると、グラフや表で赤く表示されます。

メトリクスの実行 †

メトリクス情報を収集するには、プロジェクトのエクスポートから行います。

パッケージエクスプローラーからプロジェクトを選択し、コンテキストメニュー(右クリック)から[エクスポート]を選ぶと、下の画面が表示されます。この画面で Metrics を選択して下さい。

「次へ」をクリックすると、次の画面が表示されます。この画面では、「Export Directory」にメトリクスの測定結果を出力するディレクトリを指定して下さい。「Export HTML」にチェックをいれるとHTMLファイルとして出力されます。また「Export CSV」にチェックをいれると、CSV 形式で出力されます。