華為 Java 編程軍規(guī)
關注我們,設為星標,每天7:30不見不散,架構路上與您共享 回復"架構師"獲取資源
1、引言：
這個標準是衡量代碼本身的缺陷，也是衡量一個研發(fā)人員本身的價值。華為作為一家全球化的 IT 公司，十幾萬員工，無論是人事管理，還是代碼管理，都是一件不容易的事情，沒有規(guī)范的約束，想想都是件可怕的事情。下面挑選了一些網(wǎng)上流傳的編程規(guī)范，一起來學習下，以下內容不涉及基礎的語法規(guī)范（請見 Refer），更側重于一些編程習慣，如何提高程序的健壯性、可維護性等。（PS：以下內容未經(jīng)官方考證，如閱讀者出現(xiàn)不適，請選擇立即關閉本頁 -_-||| ）
2、軍規(guī)簡介：
軍規(guī)一：【避免在程序中使用魔鬼數(shù)字，必須用有意義的常量來標識。】
軍規(guī)二：【明確方法的功能，一個方法僅完成一個功能。】
軍規(guī)三：【方法參數(shù)不能超過5個】
軍規(guī)四：【方法調用盡量不要返回null，取而代之以拋出異常，或是返回特例對象（SPECIAL CASE object，SPECIAL CASE PATTERN）；對于以集合或數(shù)組類型作為返回值的方法，取而代之以空集合或0長度數(shù)組。】
軍規(guī)五：【在進行數(shù)據(jù)庫操作或IO操作時，必須確保資源在使用完畢后得到釋放，并且必須確保釋放操作在finally中進行。】
軍規(guī)六：【異常捕獲不要直接catch (Exception ex) ，應該把異常細分處理。】
軍規(guī)七：【對于if ? else if ?(后續(xù)可能有多個else if …)這種類型的條件判斷，最后必須包含一個else分支，避免出現(xiàn)分支遺漏造成錯誤；每個switch-case語句都必須保證有default，避免出現(xiàn)分支遺漏，造成錯誤。】
軍規(guī)八：【覆寫對象的equals()方法時必須同時覆寫hashCode()方法。】
軍規(guī)九：【禁止循環(huán)中創(chuàng)建新線程，盡量使用線程池。】
軍規(guī)十：【在進行精確計算時(例如:貨幣計算)避免使用float和double，浮點數(shù)計算都是不精確的，必須使用BigDecimal或將浮點數(shù)運算轉換為整型運算。】
3、軍規(guī)說明
軍規(guī)一：【避免在程序中使用魔鬼數(shù)字，必須用有意義的常量來標識。】
說明：是否是魔鬼數(shù)字要基于容易閱讀和便于全局替換的原則。0、1作為某種專業(yè)領域物理量枚舉數(shù)值時必須定義常量，嚴禁出現(xiàn)類似NUMBER_ZERO的“魔鬼常量”。
軍規(guī)二：【明確方法的功能，一個方法僅完成一個功能。】
說明：方法功能太多，會增加方法的復雜度和依賴關系，不利于程序閱讀和將來的持續(xù)維護，無論是方法還是類設計都應符合單一職責原則。
軍規(guī)三：【方法參數(shù)不能超過5個】
說明：參數(shù)太多影響代碼閱讀和使用，為減少參數(shù)，首先要考慮這些參數(shù)的合理性，保持方法功能單一、優(yōu)化方法設計，如果參數(shù)確實無法減少，可以將多個參數(shù)封裝成一個類（對象），同時考慮在新的類（對象）中增加相應的行為，以期更符合OOP。
軍規(guī)四：【方法調用盡量不要返回null，取而代之以拋出異常，或是返回特例對象（SPECIAL CASE object，SPECIAL CASE PATTERN）；對于以集合或數(shù)組類型作為返回值的方法，取而代之以空集合或0長度數(shù)組。】
說明：返回null會增加不必要的空指針判斷，遺漏判斷也會導致嚴重的NullPointerException錯誤。
軍規(guī)五：【在進行數(shù)據(jù)庫操作或IO操作時，必須確保資源在使用完畢后得到釋放，并且必須確保釋放操作在finally中進行。】
說明：數(shù)據(jù)庫操作、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);
}
}
}軍規(guī)六：【異常捕獲不要直接 catch(Exception ex) ，應該把異常細分處理。】
說明：catch (Exception ex)的結果會把RuntimeException異常捕獲，RuntimeException是運行期異常，是程序本身考慮不周而拋出的異常，是程序的BUG，如無效參數(shù)、數(shù)組越界、被零除等，程序必須確保不能拋出RuntimeException異常，不允許顯示捕獲RuntimeException異常就是為了方便測試中容易發(fā)現(xiàn)程序問題。
軍規(guī)七：【對于if ? else if ?(后續(xù)可能有多個elseif …)這種類型的條件判斷，最后必須包含一個else分支，避免出現(xiàn)分支遺漏造成錯誤；每個switch-case語句都必須保證有default，避免出現(xiàn)分支遺漏，造成錯誤。】
軍規(guī)八：【覆寫對象的equals()方法時必須同時覆寫hashCode()方法。】
說明：equals和hashCode方法是對象在hash容器內高效工作的基礎，正確的覆寫這兩個方法才能保證在hash容器內查找對象的正確性，同時一個好的hashCode方法能大幅提升hash容器效率。
軍規(guī)九：【禁止循環(huán)中創(chuàng)建新線程，盡量使用線程池。】
軍規(guī)十：【在進行精確計算時(例如:貨幣計算)避免使用float和double，浮點數(shù)計算都是不精確的，必須使用BigDecimal或將浮點數(shù)運算轉換為整型運算。】
說明：浮點運算在一個范圍很廣的值域上提供了很好的近似，但是它不能產(chǎn)生精確的結果。二進制浮點對于精度計算是非常不適合的，因為它不可能將0.1——或者10的其它任何次負冪精確表示為一個長度有限的二進制小數(shù)。
具體案例請參考：浮點數(shù)加法引發(fā)的問題：浮點數(shù)的二進制表示
http://my.oschina.net/leejun2005/blog/156793
4、有關開發(fā)效率和協(xié)作的幾點建議與心得體會
今天看到某同學寫給團隊成員的一封郵件，發(fā)現(xiàn)比較通用，分享出來吧:
1. 小提交:
把大的任務拆分成多個獨立小任務，每完成小任務確保無 Bug 后就可以提交合并到主分支甚至發(fā)布；頻繁提交有利于自己把控項目進度、降低風險、同其他人協(xié)作和代碼 Review ; 每天可以提交合并多次。每個小任務是 1-2 個小時可以完成的粒度，最大的一天完成。并行做多個任務的時候，優(yōu)先做最短時間能夠實現(xiàn)的任務。
2. 命名規(guī)范:
盡量避免無意義的字符做變量 比如 a, b, t 。可以逐步改善，可以參考:
http://google-styleguide.googlecode.com/svn/trunk/javaguide.html
3. 避免過度設計:
能夠用簡單方式實現(xiàn)的功能，不引入復雜的類，對象，避免不必要的 new 對象，避免引入不必要的泛型、線程。開發(fā)初期冗余大于抽象和依賴。避免自己重新實現(xiàn)比較通用的組件和函數(shù)。調研多種實現(xiàn)方式的時候，選用做簡單的實現(xiàn)方式。盡量少寫代碼。
4. Web 工程盡量避免在應用內部保存“狀態(tài)”，這樣可以適應頻繁發(fā)布、重啟無影響。
5. 善于用打日志的方式調試，在程序關鍵點打日志。盡量少用斷點方式，日志方式可以批量調試一批功能，效率相對高。
6. 避免一屏顯示不下的超大函數(shù)。
7. 添加必要、簡潔的注釋：
循環(huán)中的 continue, break 盡量加上單行注釋；盡量避免非函數(shù)結尾的 return，必要的時候加注釋。類自動生成 toString() 方法，方便調試和打日志。
8. 不把自己局限到做某個功能，每個人都是整個項目的 Owner ，盡量交叉 Review ，交叉開發(fā)。
9. 遇到問題及時和其他人溝通，避免浪費時間。
10. 從最終產(chǎn)品的目標審視自己細小的設計，熟悉自己負責部分的上下游代碼。時刻關注最終產(chǎn)品(Web 界面和日志)，發(fā)現(xiàn) Bug 和可以改善的地方。
到此文章就結束了。如果今天的文章對你在進階架構師的路上有新的啟發(fā)和進步，歡迎轉發(fā)給更多人。歡迎加入架構師社區(qū)技術交流群，眾多大咖帶你進階架構師，在后臺回復“加群”即可入群。
這些年小編給你分享過的干貨
2.ERP系統(tǒng)，自帶進銷存+財務+生產(chǎn)功能，拿來即用（附源碼）
3.帶工作流的SpringBoot后臺管理項目快速開發(fā)（附源碼）
4.最好的OA系統(tǒng)，拿來即用，非常方便（附源碼）
5.SpringBoot+Vue完整的外賣系統(tǒng)，手機端和后臺管理，附源碼！
6.SpringBoot+Vue 可視化拖拽編輯的大屏項目（附源碼）
轉發(fā)在看就是最大的支持??