【代码规范】公共常量封装:接口、枚举还是普通类

2024-08-22 01:38

本文主要是介绍【代码规范】公共常量封装:接口、枚举还是普通类,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1. 背景

虽然项目组定义了软件开发规范,包括了技术选型、接口规范等,但是在实际执行中还是存在一些不足。本文所记录的常量封装就是其中一个问题,目前项目中关于常量的封装存在3种形式,比较混乱。通过查阅相关资料,对使用目的、各封装形式的优缺点进行分析,给出常量封装的推荐使用规范。

2. 3种封装形式

  • 普通类
public class ErrorCodeConstant {public final static String PARAMTER_ERROR = "10001";public final static String URL_IS_EMPTY = "10002";
}

使用final static来修饰公用常量,直接通过类名.变量名的形式访问

  • 接口
public interface ErrorCodeConstant {String PARAMTER_ERROR = "10001";String URL_IS_EMPTY = "10002";
}

接口的变量默认是public final static修饰的,所以使用接口来封装常量,看起来比较简洁,也用很多开源项目使用接口来封装公用常量,如阿里巴巴的fastjson。但很多人认为这是Bad-Practice,一种反模式的实践,因为接口一般是一类方法的抽象,需要通过实现类来实现功能,用来封装常量不符合设计初衷。

  • 枚举

在这里插入图片描述
在java 1.5中引入了枚举类,提供了一种更好的封装公用常量的形式。跟接口和普通量相比,枚举类不仅能定义常量,而且能定义相关方法,使用常量的使用更加灵活。
枚举类基础可参考链接:https://blog.csdn.net/testcs_dn/article/details/78604547

3. 应用场景

“任何脱离实际应用场景的分析都是瞎扯淡”    -- 佚名

正如某位大师所说,我们分析问题需要从根源出发,根据我们的使用场景来选择合适的常量封装形式。
使用常量的场景:

  1. 简单的公有常量定义,如系统常量标识,则直接使用枚举类

这篇关于【代码规范】公共常量封装:接口、枚举还是普通类的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1094877

相关文章

Java中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示

Visual Studio 2022 编译C++20代码的图文步骤

《VisualStudio2022编译C++20代码的图文步骤》在VisualStudio中启用C++20import功能,需设置语言标准为ISOC++20,开启扫描源查找模块依赖及实验性标... 默认创建Visual Studio桌面控制台项目代码包含C++20的import方法。右键项目的属性:

Golang如何对cron进行二次封装实现指定时间执行定时任务

《Golang如何对cron进行二次封装实现指定时间执行定时任务》:本文主要介绍Golang如何对cron进行二次封装实现指定时间执行定时任务问题,具有很好的参考价值,希望对大家有所帮助,如有错误... 目录背景cron库下载代码示例【1】结构体定义【2】定时任务开启【3】使用示例【4】控制台输出总结背景

MySQL数据库的内嵌函数和联合查询实例代码

《MySQL数据库的内嵌函数和联合查询实例代码》联合查询是一种将多个查询结果组合在一起的方法,通常使用UNION、UNIONALL、INTERSECT和EXCEPT关键字,下面:本文主要介绍MyS... 目录一.数据库的内嵌函数1.1聚合函数COUNT([DISTINCT] expr)SUM([DISTIN

C++11作用域枚举(Scoped Enums)的实现示例

《C++11作用域枚举(ScopedEnums)的实现示例》枚举类型是一种非常实用的工具,C++11标准引入了作用域枚举,也称为强类型枚举,本文主要介绍了C++11作用域枚举(ScopedEnums... 目录一、引言二、传统枚举类型的局限性2.1 命名空间污染2.2 整型提升问题2.3 类型转换问题三、C

Java实现自定义table宽高的示例代码

《Java实现自定义table宽高的示例代码》在桌面应用、管理系统乃至报表工具中,表格(JTable)作为最常用的数据展示组件,不仅承载对数据的增删改查,还需要配合布局与视觉需求,而JavaSwing... 目录一、项目背景详细介绍二、项目需求详细介绍三、相关技术详细介绍四、实现思路详细介绍五、完整实现代码

Go语言代码格式化的技巧分享

《Go语言代码格式化的技巧分享》在Go语言的开发过程中,代码格式化是一个看似细微却至关重要的环节,良好的代码格式化不仅能提升代码的可读性,还能促进团队协作,减少因代码风格差异引发的问题,Go在代码格式... 目录一、Go 语言代码格式化的重要性二、Go 语言代码格式化工具:gofmt 与 go fmt(一)

SpringBoot+Redis防止接口重复提交问题

《SpringBoot+Redis防止接口重复提交问题》:本文主要介绍SpringBoot+Redis防止接口重复提交问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不... 目录前言实现思路代码示例测试总结前言在项目的使用使用过程中,经常会出现某些操作在短时间内频繁提交。例

Python中对FFmpeg封装开发库FFmpy详解

《Python中对FFmpeg封装开发库FFmpy详解》:本文主要介绍Python中对FFmpeg封装开发库FFmpy,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录一、FFmpy简介与安装1.1 FFmpy概述1.2 安装方法二、FFmpy核心类与方法2.1 FF

HTML5实现的移动端购物车自动结算功能示例代码

《HTML5实现的移动端购物车自动结算功能示例代码》本文介绍HTML5实现移动端购物车自动结算,通过WebStorage、事件监听、DOM操作等技术,确保实时更新与数据同步,优化性能及无障碍性,提升用... 目录1. 移动端购物车自动结算概述2. 数据存储与状态保存机制2.1 浏览器端的数据存储方式2.1.