Java程式設計規則

azz發表於2007-08-24
Java程式設計規則[@more@]  包含了大量有用的建議,幫助大家進行低階程式設計,並提供了程式碼編寫的一般性指導:

  (1) 類名首字母應該大寫。欄位、方法以及物件(控制程式碼)的首字母應小寫。對於所有識別符號,其中包含的所有單詞都應緊靠在一起,而且大寫中間單詞的首字母。例如:
  ThisIsAClassName
  thisIsMethodOrFieldName
  若在定義中出現了常數初始化字元,則大寫static final基本型別識別符號中的所有字母。這樣便可標誌出它們屬於編譯期的常數。
  Java包(Package)屬於一種特殊情況:它們全都是小寫字母,即便中間的單詞亦是如此。對於域名副檔名稱,如com,org,net或者edu等,全部都應小寫(這也是Java 1.1和Java 1.2的區別之一)。

  (2) 為了常規用途而建立一個類時,請採取“經典形式”,幷包含對下述元素的定義:

  equals()
  hashCode()
  toString()
  clone()(implement Cloneable)
  implement Serializable

  (3) 對於自己建立的每一個類,都考慮置入一個main(),其中包含了用於測試那個類的程式碼。為使用一個專案中的類,我們沒必要刪除測試程式碼。若進行了任何形式的改動,可方便地返回測試。這些程式碼也可作為如何使用類的一個示例使用。

  (4) 應將方法設計成簡要的、功能性單元,用它描述和實現一個不連續的類介面部分。理想情況下,方法應簡明扼要。若長度很大,可考慮透過某種方式將其分割成較短的幾個方法。這樣做也便於類內程式碼的重複使用(有些時候,方法必須非常大,但它們仍應只做同樣的一件事情)。

  (5) 設計一個類時,請設身處地為客戶程式設計師考慮一下(類的使用方法應該是非常明確的)。然後,再設身處地為管理程式碼的人考慮一下(預計有可能進行哪些形式的修改,想想用什麼方法可把它們變得更簡單)。

  (6) 使類儘可能短小精悍,而且只解決一個特定的問題。下面是對類設計的一些建議:
  ■一個複雜的開關語句:考慮採用“多形”機制
  ■數量眾多的方法涉及到型別差別極大的操作:考慮用幾個類來分別實現
  ■許多成員變數在特徵上有很大的差別:考慮使用幾個類

  (7) 讓一切東西都儘可能地“私有”——private。可使庫的某一部分“公共化”(一個方法、類或者一個欄位等等),就永遠不能把它拿出。若強行拿出,就可能破壞其他人現有的程式碼,使他們不得不重新編寫和設計。若只公佈自己必須公佈的,就可放心大膽地改變其他任何東西。在多執行緒環境中,隱私是特別重要的一個因素——只有private欄位才能在非同步使用的情況下受到保護。

  (8) 謹惕“巨大物件綜合症”。對一些習慣於順序程式設計思維、且初涉OOP領域的新手,往往喜歡先寫一個順序執行的程式,再把它嵌入一個或兩個巨大的物件裡。根據程式設計原理,物件表達的應該是應用程式的概念,而非應用程式本身。

  (9) 若不得已進行一些不太雅觀的程式設計,至少應該把那些程式碼置於一個類的內部。

  (10) 任何時候只要發現類與類之間結合得非常緊密,就需要考慮是否採用內部類,從而改善編碼及維護工作(參見第14章14.1.2小節的“用內部類改進程式碼”)。

  (11) 儘可能細緻地加上註釋,並用javadoc註釋文件語法生成自己的程式文件。

  (12) 避免使用“魔術數字”,這些數字很難與程式碼很好地配合。如以後需要修改它,無疑會成為一場噩夢,因為根本不知道“100”到底是指“陣列大小”還是“其他全然不同的東西”。所以,我們應建立一個常數,併為其使用具有說服力的描述性名稱,並在整個程式中都採用常數識別符號。這樣可使程式更易理解以及更易維護。

  (13) 涉及構建器和異常的時候,通常希望重新丟棄在構建器中捕獲的任何異常——如果它造成了那個物件的建立失敗。這樣一來,呼叫者就不會以為那個物件已正確地建立,從而盲目地繼續。

  (14) 當客戶程式設計師用完物件以後,若你的類要求進行任何清除工作,可考慮將清除程式碼置於一個良好定義的方法裡,採用類似於cleanup()這樣的名字,明確表明自己的用途。除此以外,可在類內放置一個boolean(布林)標記,指出物件是否已被清除。在類的finalize()方法裡,請確定物件已被清除,並已丟棄了從RuntimeException繼承的一個類(如果還沒有的話),從而指出一個程式設計錯誤。在採取象這樣的方案之前,請確定finalize()能夠在自己的系統中工作(可能需要呼叫System.runFinalizersOnExit(true),從而確保這一行為)。

  (15) 在一個特定的作用域內,若一個物件必須清除(非由垃圾收集機制處理),請採用下述方法:初始化物件;若成功,則立即進入一個含有finally從句的try塊,開始清除工作。

來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/10901326/viewspace-965641/,如需轉載,請註明出處,否則將追究法律責任。

相關文章