Java - アサーション

■ページ目次

■アサーション

■アサーションの形式

• つぎの構文形式をとります。

 assert boolean式;
      または
 assert boolean式: メッセージ;

• boolean式には、検証したい条件を記述します。
• trueの場合は、そのまま通過します。
• falseの場合はアサーション違反となり、AssertionErrorをスローします。
• AssertionErrorクラスはErrorクラスのサブクラスとして定義しています。したがって、プログラマーが例外オブジェクトを処理する必要はありません。
• assert文は、指定した種類の例外をスローしません。assert文がスローできるのは、AssertionError のみです。

■アサーションの有効化と無効化

■javacコマンドのオプション

 -source 1.3　　assert文を無効にする(デフォルト)

 -source 1.4　　assert文を有効にする

■javaコマンドのオプション

• デフォルトでは、実行時にアサーションは無効になっています。

	有効(*1)	無効(*3)
すべてのクラス	-ea(*2)	-da(*4)
指定クラス	-ea:MyClass	-da:MyClass
カレント･ディレクトリー内の無名パッケージ	-ea:...	-da:...
指定パッケージとすべてのサブパッケージ	-ea:myPackage...	-da:myPackage...

(*1) システム･クラスも含んで有効にするためには、オプションを -esa (enablesystemassertions)にします。
(*2) -enableassertions の省略形です。
(*3) システム･クラスも含んで無効にするためには、オプションを -dsa (disablesystemassertions)にします。
(*4) -disableassertions の省略形です。



• 例：

  
   java -ea:p1... -da:B -da:E A
  
  

■条件付コンパイル

 static fainal boolean ASSERTS = false;

 if (ASSERTS) assert文;                   // assert文は無効になります。

■(参考) java.lang.ClassLoaderクラスによる有効化

• この方法は、設定後にロードされるクラスに対してのみ影響するため、自由に有効 / 無効を切り替えることができるわけではありません。

  void clearAssertionStatus()	このクラスローダのデフォルト宣言ステータスを false に設定し、クラスローダに関連付けられたデフォルトパッケージおよびクラス宣言ステータス設定をすべて破棄します。
  void setClassAssertionStatus 　　　　　　(String className, boolean enabled)	このクラスローダおよび内部の入れ子構造クラス内の名前付きのトップレベルクラスに対して、目的の宣言ステータスを設定します。
  void setDefaultAssertionStatus(boolean enabled)	このクラスローダのデフォルト宣言ステータスを設定します。
  void setPackageAssertionStatus 　　　　　　(String packageName, boolean enabled)	名前付きパッケージのデフォルト宣言ステータスを設定します。

■契約による設計

• 「契約による設計」は、バートランド・メイヤー（Bertrand Meyer）はによって提唱された手法です。これは、呼び出す側のモジュールと呼ばれる側のモジュールの間の役割分担がより厳密に守られるようにするということの積み重ねでソフトウェア全体の正しさを確保します。

• アサーションは以下のような条件を検証するのに使います。
• 不変条件
• 事前条件
• 事後条件

■不変条件

■事前条件

• 事前条件は、メソッドを使う側(クライアント)が守るべき条件です。

• このアサーションは、メソッドを呼び出したときに引数をチェックして、メソッド内の処理に必要となる前提条件を検証します。
• public メソッドの引数のチェックにはアサーションを使用しないでください。

• public メソッドは、常に引数チェックを適用することを保証するので、assert は適していません。 public メソッドは、アサーションが有効かどうかにかかわらず引数をチェックする必要があります。
• 例

 static int aRemainder(int x, int y) {
     assert y != 0: "Zero divide."; // 事前条件(ゼロ除算)
     int r = 0;
     if (x >= 0) {
         r = x % y;
     } else if (x < 0 ) {
         r = x % y + Math.abs(y);
     } else {
         assert false: "Execution should never reach this point."; 
                                                      // 不変条件(到達不能)
     }
     assert r >= 0 && r < y: "Remainder is out of range."; 
                                                      // 事後条件(余りが範囲外)
     return r;
 }

■事後条件

• 事後条件とは、事前条件を守っていた場合に限り、クライアントに対して実行結果を保証する条件のことです。
• このアサーションは、メソッドを処理した後に満たしていなければならない条件を検証します。
• 例

 static int aRemainder(int x, int y) {
     assert y != 0: "Zero divide."; // 事前条件(ゼロ除算)
     int r = 0;
     if (x >= 0) {
         r = x % y;
     } else if (x < 0 ) {
         r = x % y + Math.abs(y);
     } else {
         assert false: "Execution should never reach this point."; 
                                                      // 不変条件(到達不能)
     }
     assert r >= 0 && r < y: "Remainder is out of range."; 
                                                      // 事後条件(余りが範囲外)
     return r;
 }

■実習