一、编程规约 (二)常量定义
编程 定义 常量 规约
2023-06-13 09:15:55 时间
- 【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。 反例:
String key = "Id#taobao_" + tradeId;
cache.put(key, value);
- 【强制】long或者Long初始赋值时,使用大写的L,不能是小写的l,小写容易跟数字1混淆,造成误解。 说明:
Long a = 2l;
- 写的是数字的
21
,还是Long型的2
? - 【推荐】不要使用一个常量类维护所有常量,按常量功能进行归类,分开维护。 说明:大而全的常量类,非得使用查找功能才能定位到修改的常量,不利于理解和维护。 正例:缓存相关常量放在类CacheConsts下;系统配置相关常量放在类ConfigConsts下。
- 【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。 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定义。
- 【推荐】如果变量值仅在一个固定范围内变化用enum类型来定义。 说明:如果存在名称之外的延伸属性使用enum类型,下面正例中的数字就是延伸信息,表示一年中的第几个季节。 正例:
public enum SeasonEnum {
SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
int seq;
SeasonEnum(int seq){
this.seq = seq;
}
}
相关文章
- Python Flask 编程 | 连载 03 - Flask 请求
- 你有没有使用过这些编程骚操作(二)- 验证框架(Part B)
- VS Code竟然能约会,找对象不看脸,看编程水平
- 【Groovy】MOP 元对象协议与元编程 ( 使用 Groovy 元编程进行函数拦截 | 重写 MetaClass#invokeMethod 方法拦截 JDK 中已经定义的函数 )
- 器编程玩转Linux C服务器编程(linuxc服务)
- 苹果CEO库克与马拉拉谈论编程、教育、大流行病等问题
- MySQL备份之用PHP编程(mysql备份php)
- 如何在 Linux Shell 编程中定义和使用函数
- 魔方搭配linux,让编程更有乐趣(魔方linux)
- Redis编程指南入门进阶与应用(关于redis书籍)
- javascript编程起步(第五课)