轉(zhuǎn)載自?阿里巴巴對Java編程【常量定義】的規(guī)約

常量定義

---

1. 【強制】不允許任何魔法值 （ 即未經(jīng)定義的常量 ） 直接出現(xiàn)在代碼中。

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

cache . put(key , ?value);

2. 【強制】 long 或者 Long 初始賦值時，使用大寫的 L ，不能是小寫的 l ，小寫容易跟數(shù)字 1 混淆，造成誤解。

說明： Long a = 2 l; 寫的是數(shù)字的 21，還是 Long 型的 2?

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

說明：大而全的常量類，非得使用查找功能才能定位到修改的常量，不利于理解和維護。

正例：緩存相關(guān)常量放在類 CacheConsts 下 ； 系統(tǒng)配置相關(guān)常量放在類 ConfigConsts 下。

4. 【推薦】常量的復(fù)用層次有五層：跨應(yīng)用共享常量、應(yīng)用內(nèi)共享常量、子工程內(nèi)共享常量、包內(nèi)共享常量、類內(nèi)共享常量。

1 ） 跨應(yīng)用共享常量：放置在二方庫中，通常是 client . jar 中的 constant 目錄下。

2 ） 應(yīng)用內(nèi)共享常量：放置在一方庫中，通常是 modules 中的 constant 目錄下。

反例：易懂變量也要統(tǒng)一定義成應(yīng)用內(nèi)共享常量，兩位攻城師在兩個類中分別定義了表示“是”的變量：

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

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

A . YES . equals(B . YES) ，預(yù)期是 true ，但實際返回為 false ，導(dǎo)致線上問題。

3 ） 子工程內(nèi)部共享常量：即在當(dāng)前子工程的 constant 目錄下。

4 ） 包內(nèi)共享常量：即在當(dāng)前包下單獨的 constant 目錄下。

5 ） 類內(nèi)共享常量：直接在類內(nèi)部 private static final 定義。

5. 【推薦】如果變量值僅在一個范圍內(nèi)變化，且?guī)в忻Q之外的延伸屬性，定義為枚舉類。下面正例中的數(shù)字就是延伸信息，表示星期幾。

正例： public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6),SUNDAY(7);}

總結(jié)

以上是生活随笔為你收集整理的阿里巴巴对Java编程【常量定义】的规约的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。