java定义返回码常量_码出规范（四）常量定义

01

各位屏幕前的读者朋友大家早上中午晚上凌晨好，本文是《码出规范》专题的第四篇，文中参考阿里巴巴最新发布的《Java开发手册》，结合《springboot2.x独门秘籍》专题中的项目开发进度，学以致用，让你在开发中码出高效，码出质量。本专题所得收入均捐赠公益事情，希望用技术情怀帮助更多的人。

02

编程规约包括：

常量定义

OOP规约

集合处理

并发处理

控制语句

其中常量定义就是编程规约下的一个子模块，上一篇博客命名风格讲述的是如何规范命名，清晰明了的命名，本期我们分享编码过程中同样很重要的一件事，那就是常量定义。

阿里巴巴常量定义主要内容

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

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

cache.put(key, value);

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

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

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

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

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

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

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

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

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

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

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

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

【推荐】如果变量值仅在一个固定范围内变化用 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; } }

03

总结

总结起来，开发中一定要注意常量的定义规则，不符合规范的常量影响的不仅仅是可读性，还可能影响到程序的安全性。

一如既往，期待您的真知灼见…，《码出规范》系列文章以及大厂内部资料将持续更新，如需获取资料或实战案例源码，欢迎点击我的主页呼叫我，乐意为你解决开发中的疑难杂症。