Java斷言(Assertion)

斷言(Assertion)是Java中一條語句，包含一個布爾表達式，當該布爾值為真，程序則被認為是正確的；當布爾值為假，則系統會拋出錯誤。

斷言默認禁用的，在開發時候可開啟功能，有利於糾正錯誤，增加可維護性。

PS：斷言，換句話就是 立flag，false則啪啪啪打臉。

斷言兩種語句形式

assert Expression1 ;
assert Expression1 : Expression2 ;

Expression1是一個布爾表達式，作為斷言的真假。

Expression2是一個有返回值的表達式，用來提供詳細的錯誤信息。

當沒有Expression2時，默認拋出沒有詳細信息的 AssertionError。

用斷言的場景

1、變量值明確

變量值如果很確定是某個值，則可以用斷言。

2、執行不到的語句

某個地方語句確定是執行不會達到的，例如沒有default的switch，則default可加上斷言。

3、前置條件

前置條件（precondition）是一條語句，在方法執行前必須為真。

例子：判斷線程的擁有鎖，結合斷言，可以測試當前線程是否擁有某對象的鎖。

private Object[] a;
public synchronized int find(Object key) {
  return find(key, a, 0, a.length);
}
// Recursive helper method - always called with a lock on this.
private int find(Object key, Object[] arr, int start, int len) {
  assert Thread.holdsLock(this); // lock-status assertion 
  ...
}

我覺得前置條件的異常不要用斷言為好，無論是public還是private方法。

4、后置條件

后置條件（postcondition）是一條語句，當前置條件滿足且完全執行方法后，它為真。

/**
  * Returns a BigInteger whose value is (this-1 mod m).
  *
  * @param  m the modulus.
  * @return this-1 mod m.
  * @throws ArithmeticException  m <= 0, or this BigInteger
  *has no multiplicative inverse mod m (that is, this BigInteger
  *is not relatively prime to m).
  */
public BigInteger modInverse(BigInteger m) {
  if (m.signum <= 0)
    throw new ArithmeticException("Modulus not positive: " + m);
  ... // Do the computation
  assert this.multiply(result).mod(m).equals(ONE) : this;
  return result;
}

5、檢查類的狀態

加一個內部方法，返回布爾值，當檢查類狀態正常時返回true。

不要用斷言場景

1、不要用斷言做參數檢查

因為無論斷言是啟用還是禁用，都必須進行參數檢查的，而斷言是可能被禁用的。並且斷言報出的AssertionError異常，不能准確反饋運行時異常（例如IllegalArgumentException，IndexOutOfBoundsException或NullPointerException）。

2、不要用斷言來完成程序正確操作所需的任何工作

例如，假設你想要從列表名稱中刪除所有空元素，並且知道該列表包含一個或多個空值。

錯誤的做法：

//行為包含在斷言中
assert names.remove（null）;

當斷言被啟用時，程序會正常工作，但在禁用時會失敗，因為它不再從列表中刪除空元素。

正確的用法：

//固定 - 動作先於斷言
boolean nullsRemoved = names.remove（null）;
assert nullsRemoved; //運行是否啟用斷言

開啟斷言

可在eclipse運行配置中VM arguments，添加-ea。

參考文獻

https://docs.oracle.com/javase/8/docs/technotes/guides/language/assert.html