Java編寫高質量的方法

工作中我們經常編寫大量方法來實現我們的需求，如寫一些公用方法處理相同業務。雖然我們每天都要寫很多方法，不過很多人並不知道如何編寫高質量的方法，寫的方法也是亂成一團，本次參考《**大全》中高質量的子程式一章，介紹下如何編寫高質量的方法，讓我們的**看起來更優秀。

一.我們為什麼要編寫方法

1.避免**重複。試想，如果對每個方法的呼叫都重複寫出**，而不是轉到相應的方法中，那麼**會變得多麼臃腫。

2.可維護性。如果某些部分需求需要進行修改，我們只需要修改這個需求對應的方法即可，如果沒有寫到方法中，那麼我們需要修改的就太多了。

3.可讀性。我們提供乙個方法，說明功能是什麼，輸入輸出結果是什麼，怎麼呼叫即可，其他人從方法名就知道是什麼意思，不需要關心具體實現，同時整個專案的結構也更好理解。

4.方便優化效能。我們可以對方法進行效能監控，知道哪些方法效能低，就可以對相關方法進行優化而不改變其他邏輯。

二.編寫高質量方法我們需要注意什麼？

1.方法名。首先我們要有乙個好的方法名，方法名稱需要遵循命名規則，通常我們使用駝峰式命名，如computereporttotals。還有，我們需要通過方法名能讓人明確知道方法的功能，即見名之意。

2.文件及注釋。我們需要用文件或注釋告訴其他人這個方法的作用，完善的文件和注釋能讓**維護起來成本更低，沒有文件和注釋過不了多久連作者都不清楚方法的具體實現了。

3.單一目的。乙個函式應該有乙個單一而明確的目的，不要為了方便就把一些不相關的邏輯放到一起，這也是我們工作中經常犯的錯誤。

4.防範錯誤資料。我們對外提供了方法，就要保證方法的健壯性，不能因為外界呼叫輸入錯誤某個引數導致方法的崩潰，這裡需要對引數的合法性進行校驗。

5.方法的引數控制。首先如果一些引數我們在方法中根本沒有使用，那麼我們就不要在方法上宣告這些引數。其次，方法引數的數量不要太多，上限大概是7個左右（7個也有點多），引數太多會導致呼叫方很難以理解。另外我們需要在方法上用文件詳細說明各個引數的作用。

6.不要修改輸入變數的值。一般的時候我們不應該在方法中改變輸入變數的值，否則將會大大提公升維護的難度。

三.好的方法名字及正確的使用引數

1.方法名字要描述方法所做的所有事情。方法的名字應當描述其所有的輸出結果以及***。

2.避免使用無意義的，表述不清的動詞做方法名。

3.根據需要確定方法名稱的長度。

4.使用所有的引數。如果某個引數沒用到，就把它從方法的介面中刪除。

5.把狀態或出錯變數放到最後。按照習慣做法，狀態變數和那些用於指示發生錯誤的變數應該放在參數列的最後，它們指示附屬於程式的功能。

6.不要把方法的引數用作工作變數。正確的做法是引入新的變數把輸入值賦給工作變數。

7.如果幾個方法都用了類似的一些引數，應該讓這些引數的排列順序保持一致。