• プログラミング作法
  • クイズ
  • クイズ解答
• Eclipse とプラグイン
• CheckStyle プラグイン
  • プラグインのインストールと設定
  • 使用例
• FindBungs プラグイン
  • プラグインのインストールと設定
  • 使用例
• Metrics プラグイン
  • プラグインのインストールと設定
  • 使用例

■プログラミング作法

• ここでは、単一のクラス内、おもに制御文や名前についての作法を論じます。

■クイズ

• つぎのコードの問題点を指摘してください。

1. 配列要素に値を設定します。 (解答)

   
    for (int theElementIndex = 0; theElementIndex < numberOfElements; theElementIndex++) {
        elementArray[theElementIndex] = theElementIndex;
    }
   
   

2. 値c にエラーがあるかどうかを検査し、その結果を boolean 型で戻します。 (解答)

   
    if (check(c)) ...
   
   

3. blockId がbottomBlockId を下回っていないか、topBlockId 以上でない。 (解答)

   
    if (!(blockId < bottomBlockId) || !(blockId >= topBlockId))
        ...
   
   

4. x に マスクをかけて、それが BITS と等しい。 (解答)

   
    int x = ...;
    if (x & MASK == BITS)
        ...
   
   

5. ... (解答)

   
    x += (xp = (2 * k < (n-m) ? c[k+1] : d[k--]));
   
   

6. bitoff を 8 で割った余り分だけ右シフトします。 (解答)

   
    subkey = subkey >> (bitoff - ((bitoff >> 3) << 3));
   
   

7. str 配列の 2 つの要素を空白にします。 (解答)

   
    str[i++] = str[i++] = ' ';
   
   

8. 2月の最大日の検査をします。(実行結果エラーです) (解答)

   
    boolean = true; 
    if (month == FEB) {
        if (year%4 == 0)
            if (day > 29)
                legal = false; 
        else
            if (day > 28)
                legal = false; 
    }
   
   

9. 配列のすべての要素を 1 にします。 (解答)

   
    int i = 0;
    while (i <= n-1)
        a[i++] = 1;
   
   

   
    for (int i = 0; i < n; )
        a[i++] = 1;
   
   

   
    for (int i = n; --i >= 0; )
        a[i] = 1;
   
   

10. うるう年を判定します。 (解答)

    
     boolean leap = false;
     if (y % 4 == 0)
         if (y % 100 != 0)
             leap = true;
         else if (y % 400 == 0)
             leap = true;
    
    

11. ヒストグラムを書きます。 (解答)

    
     fac = lim / 20; /* スケールファクターをセット */
     if (fac < 1)
         fac = 1;
     
      /* ヒストグラムを生成 */
     for (int i = 0, col = 0; i < 27; i++, j++) {
         col += 3;
         k = 21 - (let[i] / fac);
         star = (let[i] == 0) ? ' ' : '*';
         for (int j = k; j < 22; j++)
             dwar(j, col, star);
     }
     draw(23, 2, ' ');  /* x軸のラベル */
     for (int i = 'A'; i <= 'Z'; i++)
         drawLabel(i);
    
    

12. 大文字かどうかを検査します。 (解答)

    
     char c = ...;
     if (c >= 65 && c <= 90)
    
    

13. 要素数がわからない配列要素の平均値を出します。 (解答)

    
     int arg(int[] a) {
         int sum = 0;
         for (int i = 0; i < a.length; i++) {
             sum += a[i];
         }
         return sum / a.length;
     }
    
    

14. 型の違う値を使います。(コンパイル･エラーになります) (解答)

    
     int i1, i2, i3;
     long l1;
     ...
     i3 = (i1 > 10) ? i2 : l1;
    
    

15. 引数で指定された回数分、ループします。 (解答)

    
     void func(long n) {
         for (int i = 0; i < n; i++) {
             ...
         }
     }
    
    

16. 値を検査します。 (解答)

    
     if (var1 == 0) {
         ...
     } else if (0 < var1) {
         ...
     }
    
    

17. 値を検査します。 (解答)

    
     switch (var1) {
     case 0:
         ...
         break;
     case 1:
         ...
         break;
     }
    
    

18. 配列の要素数分ループします。 (解答)

    
     int[] a = ...;
     for (int i = 0; i != a.length; i++) {
         ...
     }
    
    

19. (解答)

    
     int i;
     for (i = 0; i < MAX; i++) {
         data[i] = i;
     }
     if (min > max) {
         i = max;
         max = min;
         min = i;
     }
    
    

20. (解答)

    
     for (int i = 0; i < MAX; j++) {
         ...
         i++;
     }
    
    

21. (解答)

    
     for (i = 0; ループの継続条件1; i++) {
         ...
         if (終了条件1) {
             break;
         }
         if (終了条件2) {
             break;
         }
         if (継続条件2) {
             continue;
         }
         ...
     }
    
    

22. var1 の値により、sig に設定します。(結果誤り) (解答)

    
     switch (var1) {
     case 0:
         sig = ZERO;
     case 1:
         sig = PLUS;
     default:
         sig = MINUS;
     }
    
    

• ここにあげたもの以外にも、いろいろな作法はありますが、すくなくとも、バグを出しにくい、というのは、ツールを使ってチェックすることもできます。

■Eclipse とプラグイン

• Eclipseについては、"Eclipse のインストールとJavaアプリケーション開発" を参照してください。

• コード品質を上げるために、つぎのプラグインを使うこともできます。これらのプラグインによって、プログラミング作法を守らせる、また、コードの品質を上げるための指摘ができます。

  CheckStyle プラグイン(*)	Javaソースコードのコーディング・スタイルの検査
  	com.atlassw.tools.eclipse.checkstyle_4.1.1-bin.zip
  	http://eclipse-cs.sourceforge.net/
  FindBungs プラグイン(*)	Javaバイトコードの静的解析
  	de.tobject.findbugs_0.0.14.zip
  	http://sourceforge.net/project/showfiles.php?group_id=96405&package_id=118233
  ステップカウンタ	stepcounter1_13.zip
  	https://sourceforge.jp/projects/amateras/files/?release_id=16538
  Metrics プラグイン(*)	メトリクス計測
  	com.teaminabox.eclipse.metrics_2.7.0.zip ... Eclipse3.0用
  	http://sourceforge.net/project/showfiles.php?group_id=128057
  Test & Performance Tools Platform	tptp.runtime-TPTP-4.0.1-200510031151.zip
  	http://www.eclipse.org/tptp/home/downloads/drops/TPTP-4.0.1.html

• 上記のプラグインは、コンパイルが通っていることが前提になります。

■CheckStyle プラグイン

• CheckStyle プラグインは、コーディング・スタイルを検査します。

• たとえば、つぎのようなものを指摘します。
  • 変数名
  • メソッド名
  • メソッド名と「{」の間の空白の有無
  • インデント
  • コメント
  • ...

■プラグインのインストールと設定

• インストール後、つぎの手順にしたがって、CheckStyle を有効にします。

• [対象プロジェクトを右クリック] - [プロパティを選択] - [Checkstyle] - [Checkstyle active for this project にチェック] - [OK]

■使用例

1. CheckStyle を使用する前に、まず、Eclipse のコード･フォーマッターを使って、コードのスタイルを整えます。

   [エディッターで右クリック] - [ソース] - [フォーマット]
   

2. プロジェクトの CheckStyle を有効にすると、つぎの図のように、行の背景色や、行番号のところにレンズ・アイコンが出て、スタイルに違反している行を表示します。

   
    
    図 ソース上のメッセージ
   

■FindBungs プラグイン

• FindBungs プラグインは、バグになる可能性があるコードを検査します。

• たとえば、つぎのようなものを指摘します。
  • 文字列を「==」で比較する
  • open したリソースを close していない
  • NullPointerException になりうるコード
  • ...

■プラグインのインストールと設定

■使用例

1. □"FindBugsSample01.java"

   
    public class FindBugsSample01 {
        public static Counter count = new Counter();    
        public static void main(String[] args) {
            String aString = "bob";
            aString.replace('b', 'p');
            if (aString.equals("pop")) {
                System.out.println("true");
            }
    
            String bString = null;
            if (isBound() && isBound()) {
                bString = " Hello! ";
            }
            aString = bString.trim();
            System.out.println("true");
    
            if (aString == bString) {
                System.out.println("same string");
            }
        }
    
        public static boolean isBound() {
            return count.countup() == 10;
        }
        
    }
    
    class Counter {
        int count;
    
        public int countup() {
            return count++;
        }
        
        public boolean isUnBound() {
            return !new FindBugsSample01().isBound();
        }
    }
   
   

   
    
    図 ソース上のメッセージ
   

   
    
    図 「問題」タグのリスト
   

2. ソースの「警告」マークや「問題タグ」のエントリーを右クリックして、「Show Bug Details」を選択すると、つぎのような「問題」の詳細が表示されます。

   
    
    図 「問題」の詳細
   

■Metrics プラグイン

• つぎのソース･コードの計測値を出します。

  記号	意味	内容
  CC	マッケーブの循環的複雑度 (McCabe's cyclomatic complexity)	プログラムの複雑さを測る指標のひとつで、値が大きいほどテストや保守が難しいことを意味します。「ソフトウェア開発の定量化手法―生産性と品質の向上をめざして 」という書籍の中では、5 以下のプログラムは単純、10 以下でもそれほど難しくはない、20 以上は複雑さが高い、50 以上になるとテスト不可能と指摘しています。
  Ce	Efferent Couplings	外部パッケージへの依存度
  LOCM-CK	Lack of Cohesion in Methods	クラス中のメソッドどうしの関連の度合いを示す指標。共有している変数が多いほど値が大きくなります。これはメソッドどうしが強く関連しており、望ましいカプセル化が行われていることを表します。逆に、値が小さいものは、メソッドどうしがあまり関連しておらず、さらにクラス分割できることを示唆します。
  LOCM	Lines of Code in Method	メソッド中のコードの行数
  NOF	フィールド数
  NOL	メソッド中の入れ子の深さ
  NOP	メソッドのパラメータ数
  NOS	メソッドのステートメント数	LOC は空白行やコメントなども計測するのでコーディングスタイルの影響がありますが、この値はステートメント数だけをカウントするのであまり影響がありません。
  WMC	Weighted Methods Per Class	あるクラス中のメソッドの複雑さの総和

■プラグインのインストールと設定

• インストール後、つぎの手順にしたがって、Metrics を有効にします。

• [対象プロジェクトを右クリック] - [プロパティを選択] - [Metrics] - [Enable Metricsにチェック] - [OK]

• しきい値の設定は、つぎの手順にしたがって、設定します。

• [ウィンドウ・メニュー] - [設定] - [Metrics] - [各タグのところにある Upper Bound の値を設定] - [OK]

■使用例

1. "FindBugsSample01.java"で、メソッドの行数がしきい値を超えるものには、メッセージが出ます。

   
    
    図 ソース上のメッセージ
   

2. Metrics プラグインの測定結果のレポートは、以下の手順で、指定したディレクトリーに HTML ファイルとして出力されます。指定より、CSV ファイルのレポートも出力することができます。

3. [対象プロジェクトを右クリック] - [エクスポートを選択] - [その他] - [Metricsを選択] - [Export Directoryにレポートの出力先を記入] - [OK]

   
    
    図 ホームページ
   

   
    
    図 パッケージ内行数
   

   
    
    図 パッケージ内サイクロマチック数
   

   
    
    図 パッケージ内サイクロマチック数の詳細
   

■クイズ解答

1. ローカル変数には短い名前を使おう

   
    for (int i = 0; i < elem.length; i++) {
        elem[i] = i;
    }
   
   

2. メソッドには能動的な名前を使おう

   
    if (hasError(c)) ...
   
   

3. 自然な形の式を使おう

   
    if (!((blockId >= bottomBlockId) && (blockId < topBlockId)))
        ...
   
   

4. かっこを使ってあいまいさを解消しよう

   
    int x = ...;
    if ((x & MASK) == BITS)
        ...
   
   

5. 複雑な式は分割しよう

   
    if (2*k < n-m) {
        xp = c[k+1];
    } else {
        xp = d[k--];
    }
    x += xp;
   
   

6. 明快に書こう

   
    subkey >>= bitoff & 0x7;
   
   

   • デバッグしているうちに、式や文が複雑になってきます。そうなった場合は、リファクタリングしましょう。

7. 副作用に注意しよう

   
    str[i++] = ' ';
    str[i++] = ' ';
   
   

8. インデントとプレースのスタイルを統一しよう

   
    boolean = true; 
    if (month == FEB) {
        if (year%4 == 0) {
            if (day > 29) {
                legal = false; 
            }
        } else if (day > 28) {
            legal = false; 
        }
    }
   
   

   • このスタイルは、Eclipse のコード･フォーマッターを利用することでいつでも標準にしたがうことができます。

9. 慣用句によって一貫性を確保しよう

   
    for (int i = 0; i < a.length; i++) {
        a[i] = 1;
    }
   
   

10. 多分岐の判定にはelse-ifを使おう

    
     boolean leap = false;
     if (y % 400 == 0) {
         leap = true;
     } else if(y % 100 == 0) {
         /* DO NOTHING */
     } else if(y % 4 == 0) {
         leap = true;
     } else {
         /* DO NOTHING */
     }
    
    

    ただ、この程度であれば、つぎのように論理演算子を使ったほうがわかりやすい場合もあります。

    
     boolean leap = false;
     if ((y % 400 == 0) || ((y % 100 != 0) && (y % 4 == 0))) {
         leap = true;
     }
    
    

    さらに、boolean 型の変数に値を代入しているのであれば、つぎのようにすることもできます。

    
     boolean leap = (y % 400 == 0) || ((y % 100 != 0) && (y % 4 == 0));
    
    

11. マジックナンバーには名前をつけよう

    
     final int MINROW = 1;                 /* 上端 */
     final int MINCOL = 1;                 /* 左端 */
     final int MAXROW = 24;                /* 下端(<=) */
     final int MAXCOL = 80;                /* 右端(<=) */
     final int LABELROW = 1;               /* ラベル位置 */
     final int NLET = 1;                   /* アルファベットの数 */
     final int HEIGHT = MAXROW - 4;        /* バーの高さ */
     final int WIDTH = (MAXCOL-1)/NLET;    /* バーの幅 */
     
     fac = (lim + HEIGHT - 1) / HEIGHT; /* スケールファクターをセット */
     if (fac < 1)
         fac = 1;
     
      /* ヒストグラムを生成 */
     for (int i = 0; i < NLET; i++) {
         if (let[i] == 0)
             continue;
     
         for (int j = HEIGHT - let[i]/fac; j++)
             dwar(j+1+LABELROW, (i+1)*WIDTH, '*');
     }
     draw(MAXROW-1, MINCOL+1, ' ');  /* x軸のラベル */
     for (int i = 'A'; i <= 'Z'; i++)
         drawLabel(i);
    
    

12. 整数ではなく文字定数を使おう

    
     char c = ...;
     if (c >= 'A' && c <= 'Z')
    
    

    ただし、上記もお勧めできません。以下のようにすべきです。

    システムの用意しているライブラリーを使おう

    
     char c = ...;
     Character.isUpperCase(c)
    
    

13. 事前と事後の状態をテストしよう

    
     int arg(double[] a) {
         int sum = 0;
         for (int i = 0; i < a.length; i++) {
             sum += a[i];
         }
         return a.length <= 0 ? 0 : sum / a.length;
     }
    
    

    または、Exception をスローします。

    
     int arg(double[] a) throws Exception {
         if (a.length <= 0) throw new Exception();
         int sum = 0;
         for (int i = 0; i < a.length; i++) {
             sum += a[i];
         }
         return sum / a.length;
     }
    
    

14. データの型を合わせよう

    
     int i1, i2, i3;
     long l1;
     ...
     i3 = (i1 > 10) ? i2 : (int) l1;
    
    

    この場合、可能であればキャストではなく、すべての型を long にした方がいい場合が多いです。

    
     long i1, i2, i3;
     long l1;
     ...
     i3 = (i1 > 10) ? i2 : (int) l1;
    
    

15. ループのカウンターと終了値の型を合わせよう

    
     void func(long n) {
         for (long i = 0; i < n; i++) {
             ...
         }
     }
    
    

16. else 句を書こう

    
     if (var1 == 0) {
         ...
     } else if (0 < var1) {
         ...
     } else {
         例外処理 または コメント
     }
    
    

17. default 句を書こう

    
     switch (var1) {
     case 0:
         ...
         break;
     case 1:
         ...
         break;
     default:
         例外処理 または コメント
         break;
     }
    
    

18. カウントするループの終了条件は比較しよう

    
     int[] a = ...;
     for (int i = 0; i < a.length; i++) {
         ...
     }
    
    

19. 変数はひとつの目的で使おう

    
     for (int i = 0; i < MAX; i++) {
         data[i] = i;
     }
     if (min > max) {
         int work = max;
         max = min;
         min = work;
     }
    
    

20. for 文の式には for 文の制御をさせよう

    
     for (int i =0; i < MAX; i++) {
         ...
         j++;
     }
    
    

21. break 文はひとつ、continue 文は使わないようにしよう

    
     for (i = 0; ループの継続条件; i++) {
         ...
         if (終了条件1 || 終了条件2) {
             break;
         }
         if (!継続条件2) {
             ...
         }
     }
    
    

22. switch 文で break 文を忘れないようにしよう

    
     switch (var1) {
     case 0:
         sig = ZERO;
         break;
     case 1:
         sig = PLUS;
         break;
     default:
         sig = MINUS;
         break;
     }