快看！寫好Java代碼的30條經驗總結

 

成爲一個優秀的Java程序員，有着良好的代碼編寫習慣是必不可少的。下面就讓咱們來看看代碼編寫的30條建議吧。

(1) 類名首字母應該大寫。字段、方法以及對象（句柄）的首字母應小寫。對於全部標識符，其中包含的全部單詞都應緊靠在一塊兒，並且大寫中間單詞的首字母。例如：

ThisIsAClassNamethisIsMethodOrFieldName

若在定義中出現了常數初始化字符，則大寫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塊，開始清除工做。

(16) 若在初始化過程當中須要覆蓋（取消）finalize()，請記住調用super.finalize()（若Object屬於咱們的直接超類，則無此必要）。在對finalize()進行覆蓋的過程當中，對super.finalize()的調用應屬於最後一個行動，而不該是第一個行動，這樣可確保在須要基礎類組件的時候它們依然有效。

(17) 建立大小固定的對象集合時，請將它們傳輸至一個數組（若準備從一個方法裏返回這個集合，更應如此操做）。這樣一來，咱們就可享受到數組在編譯期進行類型檢查的好處。此外，爲使用它們，數組的接收者也許並不須要將對象」造型」到數組裏。

(18) 儘可能使用interfaces，不要使用abstract類。若已知某樣東西準備成爲一個基礎類，那麼第一個選擇應是將其變成一個interface（接口）。只有在不得不使用方法定義或者成員變量的時候，才須要將其變成一個abstract（抽象）類。接口主要描述了客戶但願作什麼事情，而一個類則致力於（或容許）具體的實施細節。

(19) 在構建器內部，只進行那些將對象設爲正確狀態所需的工做。儘量地避免調用其餘方法，由於那些方法可能被其餘人覆蓋或取消，從而在構建過程當中產生不可預知的結果（參見第7章的詳細說明）。

(20) 對象不該只是簡單地容納一些數據；它們的行爲也應獲得良好的定義。

(21) 在現成類的基礎上建立新類時，請首先選擇」新建」或」創做」。只有本身的設計要求必須繼承時，才應考慮這方面的問題。若在原本容許新建的場合使用了繼承，則整個設計會變得沒有必要地複雜。

(22) 用繼承及方法覆蓋來表示行爲間的差別，而用字段表示狀態間的區別。一個很是極端的例子是經過對不一樣類的繼承來表示顏色，這是絕對應該避免的：應直接使用一個」顏色」字段。

(23) 爲避免編程時遇到麻煩，請保證在本身類路徑指到的任何地方，每一個名字都僅對應一個類。不然，編譯器可能先找到同名的另外一個類，並報告出錯消息。若懷疑本身碰到了類路徑問題，請試試在類路徑的每個起點，搜索一下同名的.class文件。

(24) 在Java 1.1 AWT中使用事件」適配器」時，特別容易碰到一個陷阱。若覆蓋了某個適配器方法，同時拼寫方法沒有特別講究，最後的結果就是新添加一個方法，而不是覆蓋現成方法。然而，因爲這樣作是徹底合法的，因此不會從編譯器或運行期系統得到任何出錯提示–只不過代碼的工做就變得不正常了。

(25) 用合理的設計方案消除」僞功能」。也就是說，倘若只須要建立類的一個對象，就不要提早限制本身使用應用程序，並加上一條」只生成其中一個」註釋。請考慮將其封裝成一個」獨生子」的形式。若在主程序裏有大量散亂的代碼，用於建立本身的對象，請考慮採納一種創造性的方案，將些代碼封裝起來。

(26) 警戒」分析癱瘓」。請記住，不管如何都要提早了解整個項目的情況，再去考察其中的細節。因爲把握了全局，可快速認識本身未知的一些因素，防止在考察細節的時候陷入」死邏輯」中。

(27) 警戒」過早優化」。首先讓它運行起來，再考慮變得更快–但只有在本身必須這樣作、並且經證明在某部分代碼中的確存在一個性能瓶頸的時候，才應進行優化。除非用專門的工具分析瓶頸，不然頗有多是在浪費本身的時間。性能提高的隱含代價是本身的代碼變得難於理解，並且難於維護。

(28) 請記住，閱讀代碼的時間比寫代碼的時間多得多。思路清晰的設計可得到易於理解的程序，但註釋、細緻的解釋以及一些示例每每具備不可估量的價值。不管對你本身，仍是對後來的人，它們都是至關重要的。如對此仍有懷疑，那麼請試想本身試圖從聯機Java文檔裏找出有用信息時碰到的挫折，這樣或許能將你說服。

(29) 如認爲本身已進行了良好的分析、設計或者實施，那麼請稍微更換一下思惟角度。試試邀請一些外來人士–並不必定是專家，但能夠是來自本公司其餘部門的人。請他們用徹底新鮮的眼光考察你的工做，看看是否能找出你一度熟視無睹的問題。採起這種方式，每每能在最適合修改的階段找出一些關鍵性的問題，避免產品發行後再解決問題而形成的金錢及精力方面的損失。

(30) 良好的設計能帶來最大的回報。簡言之，對於一個特定的問題，一般會花較長的時間才能找到一種最恰當的解決方案。但一旦找到了正確的方法，之後的工做就輕鬆多了，不再用經歷數小時、數天或者數月的痛苦掙扎。咱們的努力工做會帶來最大的回報（甚至無可估量）。並且因爲本身傾注了大量心血，最終得到一個出色的設計方案，成功的快感也是使人心動的。堅持抵制草草完工的誘惑–那樣作每每得不償失。