Java编程规范,代码验收标准
引言:
這個標準是衡量代碼本身的缺陷,也是衡量一個研發人員本身的價值。
軍規一:【避免在程序中使用魔鬼數字,必須用有意義的常量來標識。】
軍規二:【明確方法的功能,一個方法僅完成一個功能。】
軍規三:【方法參數不能超過5個】
軍規四:【方法調用盡量不要返回null,取而代之以拋出異常,或是返回特例對象(SPECIAL CASE object,SPECIAL CASE PATTERN);對于以集合或數組類型作為返回值的方法,取而代之以空集合或0長度數組。】
軍規五:【在進行數據庫操作或IO操作時,必須確保資源在使用完畢后得到釋放,并且必須確保釋放操作在finally中進行。】
軍規六:【異常捕獲不要直接catch (Exception ex)?,應該把異常細分處理。】
軍規七:【對于if ? else if ?(后續可能有多個else if …)這種類型的條件判斷,最后必須包含一個else分支,避免出現分支遺漏造成錯誤;每個switch-case語句都必須保證有default,避免出現分支遺漏,造成錯誤。】
軍規八:【覆寫對象的equals()方法時必須同時覆寫hashCode()方法。】
軍規九:【禁止循環中創建新線程,盡量使用線程池。】
軍規十:【在進行精確計算時(例如:貨幣計算)避免使用float和double,浮點數計算都是不精確的,必須使用BigDecimal或將浮點數運算轉換為整型運算。】
軍規說明:
軍規一:【避免在程序中使用魔鬼數字,必須用有意義的常量來標識。】
說明:是否是魔鬼數字要基于容易閱讀和便于全局替換的原則。0、1作為某種專業領域物理量枚舉數值時必須定義常量,嚴禁出現類似NUMBER_ZERO的“魔鬼常量”。
軍規二:【明確方法的功能,一個方法僅完成一個功能。】
說明:方法功能太多,會增加方法的復雜度和依賴關系,不利于程序閱讀和將來的持續維護,無論是方法還是類設計都應符合單一職責原則。
軍規三:【方法參數不能超過5個】
說明:參數太多影響代碼閱讀和使用,為減少參數,首先要考慮這些參數的合理性,保持方法功能單一、優化方法設計,如果參數確實無法減少,可以將多個參數封裝成一個類(對象),同時考慮在新的類(對象)中增加相應的行為,以期更符合OOP。
軍規四:【方法調用盡量不要返回null,取而代之以拋出異常,或是返回特例對象(SPECIAL CASE object,SPECIAL CASE PATTERN);對于以集合或數組類型作為返回值的方法,取而代之以空集合或0長度數組。】
說明:返回null會增加不必要的空指針判斷,遺漏判斷也會導致嚴重的NullPointerException錯誤。
軍規五:【在進行數據庫操作或IO操作時,必須確保資源在使用完畢后得到釋放,并且必須確保釋放操作在finally中進行。】
說明:數據庫操作、IO操作等需要關閉對象必須在try -catch-finally 的finally中close(),如果有多個IO對象需要關閉,需要分別對每個對象的close()方法進行try-catch,防止一個IO對象關閉失敗其他IO對象都未關閉。推薦做法如下:
Connection jdbcConnection =?null;Statement stmt =?null;try{........}catch(SQLException e){........}finally{if(stmt !=?null){try{stmt.close();}catch(SQLException e){logger.log(Level.WARNING,"異常說明", e);}}if(jdbcConnection !=?null){try{jdbcConnection.close();}catch(SQLException e){logger.log(Level.WARNING,"異常說明", e);}}}軍規六:【異常捕獲不要直接 catch(Exception ex)?,應該把異常細分處理。】
說明:catch (Exception ex)的結果會把RuntimeException異常捕獲,RuntimeException是運行期異常,是程序本身考慮不周而拋出的異常,是程序的BUG,如無效參數、數組越界、被零除等,程序必須確保不能拋出RuntimeException異常,不允許顯示捕獲RuntimeException異常就是為了方便測試中容易發現程序問題。
軍規七:【對于if?? else if ?(后續可能有多個elseif …)這種類型的條件判斷,最后必須包含一個else分支,避免出現分支遺漏造成錯誤;每個switch-case語句都必須保證有default,避免出現分支遺漏,造成錯誤。】
軍規八:【覆寫對象的equals()方法時必須同時覆寫hashCode()方法。】
說明:equals和hashCode方法是對象在hash容器內高效工作的基礎,正確的覆寫這兩個方法才能保證在hash容器內查找對象的正確性,同時一個好的hashCode方法能大幅提升hash容器效率。
軍規九:【禁止循環中創建新線程,盡量使用線程池。】
軍規十:【在進行精確計算時(例如:貨幣計算)避免使用float和double,浮點數計算都是不精確的,必須使用BigDecimal或將浮點數運算轉換為整型運算。】
說明:浮點運算在一個范圍很廣的值域上提供了很好的近似,但是它不能產生精確的結果。二進制浮點對于精度計算是非常不適合的,因為它不可能將0.1——或者10的其它任何次負冪精確表示為一個長度有限的二進制小數。
總結
以上是生活随笔為你收集整理的Java编程规范,代码验收标准的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: H6机顶盒Android编译[2]-An
- 下一篇: 国家基础地理信息中心编制完成新版世界地图