【Java】Java程式設計規範
阿新 • • 發佈：2019-02-07
- 讓一切東西都儘可能地私有private。可使庫的某一部分公共化，一個方法、類或者一個欄位等等，就永遠不能把它拿出，若強行拿出，就可能破壞其他人現有的程式碼，使他們不得不重新編寫和設計。若只公佈自己必須公佈的，就可放心大膽地改變其他任何東西。在多執行緒環境中，隱私是特別重要的一個因素，只有private欄位才能在非同步使用的情況下受到保護。
- 謹慎巨大物件綜合症。對一些習慣於過程程式設計思維，且除涉OOP領域的新手，往往喜歡先寫一個順序執行的程式，再把它嵌入一個或兩個巨大的物件裡。根據程式設計原理，物件表達的應該是應用程式的概念，而非應用程式本身。
- 若不得已進行一些不太雅觀的程式設計，至少應該把那些程式碼置於一個類的內部。
- 任何時候只要發現類與類之間結合得非常緊密，就需要考慮是否採用內部類，從而改善編碼及維護工作。
- 儘可能細緻地加上註釋，並用javadoc註釋文件語法生成自己的程式文件。
- 避免使用魔術數字，這些數字很難與程式碼很好地配合。如以後需要修改它，無疑會成為一場噩夢，因為根本不知道
100到底是指“陣列大小”還是“其他全然不同的東西”。所以，我們應建立一個常數，併為其使用具有說服力的描述性名稱，並在整個程式中都採用常數識別符號，這樣可使程式更易理解且更易維護。 - 涉及構建器和異常的時候，如果異常造成了物件的構建失敗，通常希望重新丟棄在構建器中捕獲的任何異常，這樣一來，呼叫者就不會以為那個物件已正確構建，從而盲目地繼續。
- 當客戶程式設計師用完物件之後，若你的類要求進行任何清除工作，可考慮將清除程式碼置於一個良好定義的接口裡，採用類似於
cleanup()這樣的名字，明確表明自己的意圖。除此之外，可在類內放置一個boolean標記，指出物件是否已被清除。在類的finalize()方法裡，請確定對方已被清除，如果還沒有的話，丟棄從RuntimeException繼承的一個類，從而指出一個編譯錯誤。在採取像這樣的方案之前，請確定finalize()能夠在自己的系統中工作，可能需要呼叫System.runFinalizersOnExit(true)以確保這一行為。 - 在一個特定的作用域內，若一個物件必須清除，不是由垃圾收集機制處理，請採用這個方法：初始化物件，若成功，則立即進入一個含有finally從句的try塊，開始清除工作。
- 若在初始化過程中需要重寫
finalize()，請記住呼叫super.finalize()，若Object屬於我們的直接超類，則無此必要。在對finalize()進行重寫的過程中，對super.finalize()應屬於最後一個行動，而不是第一個行動，這樣可以確保在需要基礎類最件的時候仍然有效。 - 建立大小固定的物件集合時，請將他們傳輸至一個數組，若準備從一個方法裡返回這個集合，更應如此操作，這樣一來，我們就可享受到陣列在編譯期進行型別檢查的好處。此外，為使用它們，陣列的接收者也許並不需要將物件轉換型別為到數組裡。
- 儘量使用interface，不要使用abstract類。若已知某樣東西準備成為一個基礎類，那麼第一選擇應是將其變為一個interface。只有在不得不使用方法定義或成員變數的時候，才需要將其變成一個abstract類。介面主要描述了客戶希望做什麼事情，而一個類致力於具體的實施細節。
- 在構建器內部，只進行那些將物件設定為正確狀態所需的工作，儘可能地避免呼叫其它方法，因為那些方法可能被其它人重寫，從而在構建過程中產生不可預知的結果。
- 物件不應只是簡單地容納一些資料，它們的行為也應得到良好的定義。
- 在現成類的基礎上建立新類時，請首先選擇聚合，只有自己的要求必須繼承時，才應考慮這方面的問題，若在本來允許聚合的場合使用了繼承，則整個設計會變得沒有必要的複雜。
- 用繼承及方法過載來表示行為間的差異，而用欄位表示狀態間的差別，一個非常極端的例子是通過對不同類的繼承來表示顏色，這是絕對應該避免的，應該直接使用一個顏色欄位。
- 為避免程式設計時遇到麻煩，請確保在自己類路徑指到的任何地方，每個名字都僅對應一個類，複雜，編譯器可能先找到同名的另一個類，並報告出錯訊息。若懷疑自己碰到了類路徑問題，請試試在類路徑的每一個起點，搜尋一下同名的
.class檔案。 - 在AWT中使用事件介面卡時，特別容易碰到一個陷阱，若覆蓋了某個介面卡方法，同時拼寫方法沒有特別講究，最後的結果就是新增一個新方法，而不是覆蓋現成方法，然而，由於這樣做是完全合法的，所以不會從編譯期或執行期獲得任何出錯提示，只不過程式碼的工作就變得不正常了。
- 用合理的設計方案消除偽功能，也就是說，假若只需要建立類的一個物件，就不要提前限制自己使用應用程式，並加上一條“只生成其中一個”註釋。請考慮將其封裝成一個“獨生子”的形式。若在主程式裡有大量散亂的程式碼，用於建立自己的物件，請考慮採用一種創造性的方案，將這些程式碼封裝起來。
- 警惕分析癱瘓。請記住，無論如何都需要了解整個專案的狀況，再去考慮其中的細節。由於把握了全域性，可快速認識自己未知的一些因素，防止在考慮細節的時候陷入“死邏輯”中。
- 警惕過早優化。首先讓它執行起來，再考慮變得更快。但只有在自己必須這樣做，而且經證實在某部分程式碼中的確存在一個性能瓶頸時，才應進行優化。除非用專門的工具分析瓶頸，否則很有可能使在浪費自己的時間。效能提升的隱含代價是自己的程式碼變得難於理解，而且難於維護。
- 請記住，閱讀程式碼的時間比寫程式碼的時間多得多。思路清晰的設計可獲得易於理解的程式，但註釋、細緻的解釋以及一些示例具有不可估量的價值。無論對你自己，還是對後來的人，它們都是相當重要的，如對此仍有懷疑，那麼請試想自己試圖從Java文件裡找出有用資訊時碰到的挫折，這樣或許能將你說服。
- 如認為自己已進行了良好的分析、設計或者實施，那麼請稍微更換一下思維角度。試試邀請一些未來人士，並不一定是專家，但可以是來自本公司其他部門的人，請他們用完全新鮮的眼光考察你的工作，看看能否找出一些熟視無睹的問題。採取這種形式，往往能在最適合修改的階段找出一些關鍵性的問題，避免產品發行後在解決問題造成的時間及金錢方面的損失。
- 良好的設計能帶來最大的回報。簡言之，對於一個特定的問題，通常會花較長的時間才能獲得一種最恰當的解決方案。但一旦找到了正確的方法，以後的工作就輕鬆多了，再也不用經歷數小時、數天或者數月的痛苦掙扎。我們的努力工作會帶來最大的回報，甚至無可估量。而且由於自己傾注了大量心血，最終獲得一個出色的設計方案，成功的快感也是令人心動的。堅持抵制草草完工的誘惑，那樣做往往得不償失。