Java避坑规范-常量命名

最新推荐文章于 2024-04-04 12:40:26 发布

JOJOYYDSA

最新推荐文章于 2024-04-04 12:40:26 发布

阅读量181

点赞数

分类专栏： Java避坑规范文章标签： java

本文链接：https://blog.csdn.net/JOJOYYDSA/article/details/122268354

版权

本文介绍了Java编程中关于常量命名的强制性和推荐性规范，包括禁止使用魔法值，避免使用小写字母'l'作为long类型后缀，常量的分类管理以及常量的复用层次。建议将常量按功能归类，如CacheConsts和ConfigConsts，以提高代码的可读性和可维护性。此外，推荐使用enum类型来定义具有固定范围和额外信息的变量，如表示一年四季的枚举。

摘要由CSDN通过智能技术生成

1. 【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
反例：String key = "Id#taobao_" + tradeId;
cache.put(key, value);
// 缓存 get 时，由于在代码复制时，漏掉下划线，导致缓存击穿而出现问题

2. 【强制】在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数
字 1 混淆，造成误解。
说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2。

3. 【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。
正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

4. 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、
包内共享常量、类内共享常量。
1）跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。
2）应用内共享常量：放置在一方库中，通常是子模块中的 constant 目录下。
反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了