1. 程式人生 > >1.2 編程規約_命名風格

1.2 編程規約_命名風格

下單 變化 問題 sum false 變量 層次 bsp 配置

1. 【強制】不允許任何魔法值 ( 即未經預先定義的常量 ) 直接出現在代碼中。

反例: String key = " Id # taobao _" + tradeId;

cache . put(key , value);

2. 【強制】在 long 或者 Long 賦值時,數值後使用大寫的 L ,不能是小寫的 l ,小寫容易跟數字1 混淆,造成誤解。

說明: Long a = 2 l; 寫的是數字的 21,還是 Long 型的 2?

3. 【推薦】不要使用一個常量類維護所有常量,要按常量功能進行歸類,分開維護。

說明:大而全的常量類,雜亂無章,使用查找功能才能定位到修改的常量,不利於理解和維護。

正例:緩存相關常量放在類 CacheConsts 下 ; 系統配置相關常量放在類 ConfigConsts 下。

4. 【推薦】常量的復用層次有五層:跨應用共享常量、應用內共享常量、子工程內共享常量、包內共享常量、類內共享常量。

1 ) 跨應用共享常量:放置在二方庫中,通常是 client . jar 中的 constant 目錄下。

2 ) 應用內共享常量:放置在一方庫中,通常是子模塊中的 constant 目錄下。

反例:易懂變量也要統一定義成應用內共享常量,兩位攻城師在兩個類中分別定義了表示“是”的變量:

類 A 中: public static final String YES = " yes " ;

類 B 中: public static final String YES = " y " ;

A . YES . equals(B . YES) ,預期是 true ,但實際返回為 false ,導致線上問題。

3 ) 子工程內部共享常量:即在當前子工程的 constant 目錄下。

4 ) 包內共享常量:即在當前包下單獨的 constant 目錄下。

5 ) 類內共享常量:直接在類內部 private static final 定義。

5. 【推薦】如果變量值僅在一個固定範圍內變化用 enum 類型來定義。

說明:如果存在名稱之外的延伸屬性應使用 enum 類型,下面正例中的數字就是延伸信息,表示一年中的第幾個季節。

正例

1 public enum SeasonEnum {
2     SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
3     private int seq;
4     SeasonEnum(int seq){
5         this.seq = seq;
6     }
7 }

1.2 編程規約_命名風格