项目中常量类(Constant)设计规范:避免散落变量的维护难点

轻强君_2865

轻强君_2865

2026-05-09

724人浏览

原创

统一常量管理需遵循五项规范:类名用“模块名+constants”、包路径严格对应业务层级、常量全大写下划线且带功能前缀、类声明final并含私有构造、常量分组注释隔离。

项目里常量散落在各处,是后期维护最头疼的问题之一。统一设计常量类,不是为了“看起来规范”,而是让状态、配置、命令这些关键值可查、可溯、可约束。

类名与包路径要带业务语义

类名必须是 模块名 + Constants(复数),比如 UserConstants、OrderConstants,不能叫 UserConstant 或 UserConst。单数形式会误导团队以为它只存一个值。

包路径要严格对应模块层级,例如用户模块的常量放在 com.example.user.constant,公共常量统一归到 com.example.common.constant。禁止塞进 util 或 config 这类泛化包里——那等于放弃分类管理。

常量命名必须全大写+下划线,且带功能前缀

所有常量名一律大写,单词间用下划线分隔,如 CACHE_USER_TOKEN、COMMAND_SEARCH_ALL。小写或驼峰命名(如 cacheUserToken)直接视为违规。

前缀不是可选项,而是语义锚点:

  • CACHE_:用于缓存键、缓存过期时间等
  • COMMAND_:用于 MyBatis 的 SQL 命令标识、查询场景标记
  • STATUS_ 或直接按业务含义命名(如 SUPER_ACCOUNT_TYPE):用于状态码、类型枚举值
  • 避免无意义前缀(如 CONST_),它不传递业务信息,反而稀释重点

类结构必须封闭、静态、不可实例化

常量类本质是“数据容器”,不是工具类。所以:

  • 类声明加 final,防止被继承
  • 必须有私有无参构造方法,方法体留空,仅注释“禁止实例化”
  • 每个常量都用 public static final 修饰,三者缺一不可——漏掉 static 就无法直接通过类名调用;漏掉 final 就可能被意外修改

不写构造方法?Java 默认生成 public 构造,别人 new 出来就破坏了设计本意。

按功能分组,用标准注释隔开

把几十个常量堆在一起,没人愿意读。必须按用途划分区块,并用统一格式的分隔注释隔离:

  • // ========== 业务状态常量 ==========
  • // ========== 缓存相关常量 ==========
  • // ========== 查询命令常量 ==========

每组之间空一行,同组内常量按字母或逻辑顺序排列。这样新成员加一个 CACHE_ORDER_DETAIL,一眼就知道该放哪一块,不会随手插在中间。

不复杂但容易忽略。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10657

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7782

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6772

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1144

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

948

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1396

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2809

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20111

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1235

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.7万人学习