Implementation Patterns: Variable State

Oct. 11 10:00~11:41

Teddy的博士論文裡面曾建議Java例外類別應該要支援Variable State模式。

Teddy之前介紹過三個Kent Beck的實作模式，分別是《Guard Clause》、《Boolean Setting Method》、《Composed Method》，今天介紹另一個也算是蠻常用的實作模式：「Variable State」。

簡而言之，Variable State就是在類別（Class）裡面宣告一個Map這種具有儲存key、value能力的型別，然後用這個Map來儲存資料。看一個例子：

class DataHolder {

  Map<Sttring, Object> data = new HashMap<String, Object>();

  public Object getData(String key) {

      return data.get(key); 

  }

  public void setData(String key, Object value){

      data.set(key, value);

  }

}

相對應於Variable State，另一種更常見的做法叫做Common State（這也是一個實作模式），就是用一般的變數來儲存資料，例如：

class Point {

  int x;

  int y;

}

x和y就是Common State。Common State還有一些其他的特性，在此就不多做說明。

***

看到這邊鄉民們一定會想，Variable State就這樣，有沒有什麼實際應用的例子？有，Teddy舉一個Kent Beck書上沒有提到的例子：Exception。

什麼，怎麼扯來扯去又扯到Exception這個Teddy的法定專長。先談一個例外處理的問題，當錯誤發生的時候，處理錯誤的人（就是你）想要產生一個新的例外往外丟用以代表這個錯誤狀況。再往外傳遞例外之前你想要塞一些額外的資料到例外物件裡面，這樣一來，上一層收到例外的人就可以有更多的資訊可以做為例外處理的參考。但是，以Java語言為例，Java內建的Exception類別只有四種不同的建構元：

• Exception()
• Exception(String message) 
• Exception(String message, Throwable cause)
• Exception(Throwable cause)

而Exception（嚴格講起來是Throwable）只有setStackTrace(StackTraceElement[] stackTrace)這個method可以在例外物件產生之後用來設定stack trace，並沒有其他的setter method。也就是說，當你產生一個例外物件準備往外丟的時候，最多只能塞進一個String外加一個Throwable物件。如果想要附加額外的資料，就必須自行建立繼承自Exception類別的新例外類別，然後在自己新的例外類別裡面宣告新的變數來儲存資料。例如，

class MyException extends Exception {

  Map<Sttring, Object> data = new HashMap<String, Object>();

  public Object getData(String key) {

      return data.get(key); 

  }

  public void setData(String key, Object value){

      data.set(key, value);

  }

}

這樣一來不管鄉民們要走私或夾帶什麼額外資料到例外物件裡面都沒有問題了。但是，這樣做有一個很嚴重的問題，就是會產生大量的子類別，而這些子類別的出現僅僅只是為了能夠塞一些使用者自訂的資料而已。舉個例子，假設原本Java內建的IOException這個類別就可以代表鄉民們想要表達的例外狀況，但是現在為了能夠多塞一些資料到例外物件裡面，鄉民們被迫就得產生一個MyIOException，然後讓MyIOException實作Variable State。

***

寫到這邊不得不說微軟的例外類別就設計得比較好，因為它支援了Variable State。有沒有證據？有，.Net的Exception類別有一個Data的Property，用它來實作Variable State。MSDN對於Exception類別的Data屬性說明：「Gets a collection of key/value pairs that provide additional user-defined information about the exception.」

以下是節錄自MSDN裡面的範例：

***

MSDN只說明了Data屬性的用途和提供程式範例，但是它並沒有也不會告訴鄉民們為什麼要這樣設計。這就是Teddy經常提到為什麼要學Pattern（不管是Design Pattern、Implementation Pattern、Architecture Pattern、還是HCI Pattern）的原因，因為學了之後除了幫助自己做出更好的設計，還可以了解現存系統或是framework的設計原理，如此一來不但可以加快學習新知的速度，還可以大幅減少誤用的機會。

寫到這邊很自然地應該要順便打個廣告：

• 第五梯次Design Patterns這樣學就會了：入門實作班（確定開課），上課日期2013年10月26、27日、11月2日（週六，日，六）。
• 第二梯次Design Patterns這樣學就會了：進階實作班，2013年12月7、8、14日（週六，日，六）。
• 第二梯次例外處理設計與重構實作班，2013年11月16日，週六。

***

友藏內心獨白：江湖傳言，有九陽神功護體，學什麼武功都快。