跳到主要內容

Effective Java - Check parameters for validity & Use varargs judiciously


Use varargs judiciously

varargs在我看這個item之前,我用的習以為常:
public String appendStrings(String ...strs) {
	StringBuilder sb = new StringBuilder();
	for( String str : strs ) {
		sb.append(str);
	}
	return sb.toString();
}
後來某天和同事討論到strs輸入檢查的問題時,就回來翻閱了這個item。假如你要限制client必須輸入一個或多個參數時,在method內做限制檢查並不是一個好的設計;書中建議做法可以如下:
public static String appendStrings(String first, String ...strs) {
	StringBuilder sb = new StringBuilder(first);
	for( String str : strs ) {
		sb.append(str);
	}
	return sb.toString();
}
透過限制必須傳入一個參數的方式,可以降低有人傳空資料的機會。除此之外,書中提到使用這種方式可能會導致效能問題,因為每次的呼叫JVM都會針對內容做array的allocation與initialization。從網路上別人做實驗的文章中發現,速度大概慢了60倍。

針對client的呼叫有95%的機會少於三個參數的人,書中給了以下workaround:
public void foo() { }
public void foo(int a1) { }
public void foo(int a1, int a2) { }
public void foo(int a1, int a2, int a3) { }
public void foo(int a1, int a2, int a3, int... rest) { }
還特別舉了JDK中的EnumSet,有使用到這個技術..

Reference:

  1. Effective Java, 3/e, Item 53。

Check parameters for validity

這個item主要在探討檢查輸入參數是否合法。首先先看看不檢查的後果:

  • Constructor: 錯誤的狀態會讓debug變得不容易。
  • Method: (1)拋非預期的例外,通常是NullPointerException,最糟糕的是可以做完但結果不正確。例如傳入10筆要處理的資料但只回傳9筆結果;(2)錯誤的狀態。

而針對處理的建議,主要如下:

  • Constructor或是Factory物件: 都應該要檢查,否則會增加debug成本。
  • Method: 應該要檢查,但有幾種例外 1. 不切實際;2. 效能開銷很大; 3. 和後續工作有重疊。
  • 針對拋出的例外,需加上註解說明。

method中的第二點與第三點的界定很清楚,我比較有疑問的是如何定義不切實際。這種參數檢查如果不如預期,我們通常會拋出IllegalArgumentException、IndexOutOfBoundsException或是NullPointerException;而這種例外屬於programming errors。如果實際狀況根本不可能發生,是否這就代表著不切實際呢? 畢竟如果做這樣子的檢查,我就會需要有對應的測試。因此,目前我的想法如下:

  • 如果client code根本不會有這種使用方式,caller method不需要做檢查。
  • 如果是要發佈出去或者是共用機會比較高的API,最好要做檢查。

另外書中有提到一個原則是: 如果參數足夠完成工作,限制應越少越好。這點也滿足Postel's Law所提倡的。

PS. 檢查可以考慮使用Guava的Preconditions,可以讓你的程式碼看起來較簡潔。

Reference:

  1. Effective Java, 3/e, Item 49。

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php