java常量命名规则

Java常量命名规则如下：

规则一. 所有单词的字母都是大写，如果有多个单词，那么使用下划线链接即可。

如：public static final int AGE_OF_PERSON = 20; //通常加上static

规则二. 不允许任何魔法值(即未经定义的常量)直接出现在代码中。

反例: String key ="Id#taobao_" + tradeId;。

规则三. long 或者 Long 初始赋值时,必须使用大写的 L,不能是小写的 l,小写容易跟数字1 混淆,造成误解。
说明:Long a = 2l; 写的是数字的21,还是Long型的2?

规则四. 不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。

如:缓存相关的常量放在类:CacheConsts 下;系统配置相关的常量放在类:ConfigConsts 下。说明:大而全的常量类,非得使用查找功能才能定位到修改的常量,不利于理解和维护。

规则五. 常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

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定义。