编程规范（二）

二、常量定义

1、【强制】不允许任何魔法值（即未经定义的常量）直接出现在代码中。反例：String key = "Id#taobao_" + tradeId;

cache.put(key, value);

2、【强制】long或者Long初始赋值时，使用大写的L，不能是小写的l，小写容易跟数字1混淆，产生误解。说明: Long a = al；写的是21，还是2？。

3、【推荐】不要使用一个常量类维护所所有的常量。按常量功能进行分类，分来维护。

　　说明：大而全的常量类，非得使用查询功能才能定位所修改的常量，不利于理解和维护。

　　正例：缓存相关的常量类CacheConsts下；系统的常量放在ConfigConsts下。

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、【推荐】如果变量值仅有一个范围变化，且带有名称之外的延伸属性，定义为枚举类。证例：

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