阿里巴巴编程规范实战(一)：编程规约之常量定义&代码格式

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

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

cache.put(key, value);

// 缓存 get 时，由于在代码复制时，漏掉下划线，导致缓存击穿而出现问题

说明：我经历很多的项目中大部分都能看到魔法值，其中包含两家互联网公司，狗东上线前必须代码评审，会规避掉一些，也是没有办法杜绝，CodeReview的时候大家都知道这个点，但是实际开发的过程中，特别是写业务代码，随手一丢，满满的魔法，码处高效啊，所以学习手册还是有很必要的，不然CodeReview会被diss。

2.【强制】在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数

字 1 混淆，造成误解。

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

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

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

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

以下是实战中CacheKey的定义，使用了Function和BiFunction，看上去还是比较优雅的。

 public final static Function<Long,String>  DEMON_FUNCTION =  demoId -> COMMON_PREFIX.concat("demo:" + demoId);

以下是实战中阿波罗的配置定义

阿波罗中的配置也可以再分类，例如：开关配置(所有的开关都在一个文件中)、数据源配置等等。

 

4.【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、

包内共享常量、类内共享常量。

1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。

2） 应用内共享常量：放置在一方库中，通常是子模块中的 constant 目录下。

反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“YES”的变量：

类 A 中：public static fin