1.2 常量定义

1

【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。

反例：

// 本例中，开发者A 定义了缓存的key，开发者B 使用缓存时少了下

// 画线，即key 是"Id#taobao"+tradeId，导致出现故障

String key = "Id#taobao_" + tradeId;

cache.put(key, value);

2

【强制】在对long 或者Long 赋值时，数值后使用大写字母L，不能用小写字母l，小写字母l 容易跟数字1 混淆，造成误解。

​说明：Long a = 2l; 写的是数字的21，还是Long 型的2？​

3

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

​说明：大而全的常量类杂乱无章，必须使用查找功能才能定位到要修改的常量，既不利于理解，也不利于维护。​

正例：缓存相关常量放在类CacheConsts 下；系统配置相关常量放在类

SystemConfigConsts 下。

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 类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。​

正例：

public enum SeasonEnum {

SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);

private int seq;

SeasonEnum(int seq) {

this.seq = seq;

}

public int getSeq() {

return seq;

}