華爲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個】

說明：參數太多影響代碼閱讀和使用，爲減小參數，首先要考慮這些參數的合理性，保持方法功能單1、優化方法設計，若是參數確實沒法減小，能夠將多個參數封裝成一個類（對象），同時考慮在新的類（對象）中增長相應的行爲，以期更符合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的其它任何次負冪精確表示爲一個長度有限的二進制小數。