## 二、常量定義
1. 【**強制**】不允許出現任何魔法值(即未經定義的常量)直接出現在代碼中。
反例:
String key="Id#nbsp_"+tradeId;
cache.put(key, value);
* * * * *
2. 【**強制**】long或者Long初始賦值時,必須使用大寫的L,不能是小寫的l,小寫容易跟數字1 混淆,造成誤解。
舉例說明:Long a = 2l; 寫的是數字的21,還是Long型的2?
* * * * *
3. 【推薦】不要使用一個常量類維護所有常量,應該按常量功能進行歸類,分開維護。如:緩存 相關的常量放在類:CacheConsts下;系統配置相關的常量放在類:ConfigConsts下。
說明:大而全的常量類,非得ctrl+f才定位到修改的常量,不利于理解,也不利于維護。
* * * * *
4. 【推薦】常量的復用層次有五層:跨應用共享常量、應用內共享常量、子工程內共享常量、包內共享常量、類內共享常量。
1) 跨應用共享常量:放置在二方庫中,通常是client.jar中的constant目錄下。
2) 應用內共享常量:放置在一方庫的modules中的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類,下面正例中的數字就是延伸信息,表示星期幾。
正例:
~~~
public Enum{
MONDAY(1),
TUESDAY(2),
WEDNESDAY(3),
THURSDAY(4),
FRIDAY(5),
SATURDAY(6),
SUNDAY(7);
}
~~~
- 說明
- Python編程規范
- Python風格規范
- Python語言規范
- Java編程規范
- 一、命名約定
- 二、常量定義
- 三、格式約定
- 四、OOP約定
- 五、集合處理
- 六、并發控制
- 七、控制語句
- 八、注釋約定
- 九、異常日志
- 十、日志約定
- Android開發規范
- 前端開發規范
- HTML
- JavaScript
- CSS
- MySQL約定
- 一、基本規范
- 二、庫表設計規范
- 三、字段設計規范
- 四、索引規范
- 五、SQL設計規范
- 六、業務字段命名規范
- 開發安全約定
- 一、代碼安全
- 二、移動開發安全
- 三、服務器安全
- 四、安全意識
- 版本管理
- Git使用規范
- 技術實踐及可視化
- 一、Code Review
- 二、單元測試
- 三、自動化測試
- 四、技術債
- 五、CI
- IOS開發規范