Java开发规范-编程规范之常量定义

Java编程规约（常量定义）

内容源自阿里巴巴Java开发手册（华山版）

• 【强制】 不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
  • 【反例】：String key = “Id#taobao_” + tradeId; cache.put(key, value); // 缓存get时，由于在代码复制时，容易漏掉下划线，导致缓存击穿而出现问题
• 【强制】在long或者Long赋值时，数值后使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。
• 【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
  • 【说明】大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。
  • 【正例】如缓存相关常量放在类CacheConsts下；系统配置相关常量放在类ConfigConsts下。
• 【推荐】 常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
  1. 跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。
  2. 应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。
  3. 子工程内部共享常量：即在当前子工程的constant目录下。
  4. 包内共享常量：即在当前包下单独的constant目录下。
  5. 类内共享常量：直接在类内部private static final定义。
• 【推荐】如果变量值仅在一个固定范围内变化用enum类型（枚举）来定义。