我在大厂做 CR——为什么建议使用枚举来替换布尔值
使用枚举替换布尔值主要基于以下几个原因
● 可读性
● 可拓展性
● 安全防控
可读性
我们会定义
boolean类型(true或false)作为方法参数,虽然比较简洁,但有时候参数的含义往往不够清晰,造成阅读上的障碍,
比如:参数可能表示“是否开启某个功能”,但仅凭 true 和 false 并不能一眼看出其真实意图:
setDisable(false):到底是禁用还是启用 --!
setInvalid(false):到底是无效还是有效 --!
相信我,这种“绕弯”的“双重否定”表达方式,一定会耗费你不多的脑细胞一会儿:)
当然你可能会说:“不使用否定的名词”,换成“直接表达”,setEnable(true),这一眼能识别是启用,非常直观;
是的,没错,但在我 10 余年的编程生涯里,相信我 setDisable(false) 遇到过无数次;
再举个例子:
下面代码你能“一眼知道”参数 true 代表什么含义吗?
public static void main(String[] args) {
convert("12.3456", 2, true);
}
/**
* 将字符串转换成指定小数位数的值
*
* @param value
* @param scale
* @param enableHalfUp 是否需要四舍五入
* @return
*/
public static String convertToValue(String value, int scale, boolean enableHalfUp) {
if (enableHalfUp){
//将字符串"四舍五入"换成指定小数位数的值
}else{
//将字符串"截断"换到指定小数位数的值
}
}
当然,现在 IDE 都有比较好的提示,但从“可读性”角度,是不是只能进入到方法定义看注释去了解,甚至没有注释还得去翻代码去研究这个 boolean 到底是啥语义,参数再爆炸下,你能知道每个 boolean 类型参数代表什么吗?
convert("12.3456", 2, true,false,true,false,true);
这里额外扩展一句,木宛哥搞过一段时间的 iOS 开发,如果是 Objective-C 语言,方法命名采用了较为直观的格式,可以包含多个参数名称“线性叙事”,以提高可读性。这种情况,boolean 变量前往往有“名词修饰”,会容易理解,如下所示:
[NSString stringWithCString:"something" enableASCIIStringEncoding:true]
再从 OC 语言回过来,对于这个问题,让看看 JDK 是怎么设计的
public static void main(String[] args) {
BigDecimal value = new BigDecimal("12.34567");
//四舍五入到两位小数
BigDecimal roundedValue = value.setScale(2, RoundingMode.HALF_UP);
System.out.println(roundedValue);
}
看到了没,BigDecimal 的 setScale 方法,通过定义枚举:RoundingMode 代表转换规则,看到:RoundingMode.HALF_UP 一眼就知道要四舍五入,根本不需要看代码。
这样增加了可读性的,同时定义了枚举也支持更多扩展,如下马上引入第二点好处:可扩展;
可扩展性
如果未来需要增加更多状态,使用
boolean会受到扩展的限制
例如,如果当前有两个状态:enable(开)和 disable(关),而将来需要添加待机状态,使用 boolean 就显得不够灵活。枚举则很容易扩展,能够清晰地表示更多的状态。
使用 boolean 表达功能状态:
public void configureFeature(boolean enable) {
if (enable) {
// 开启功能
} else {
// 关闭功能
}
}
使用枚举表达功能状态:
public enum FeatureMode {
ENABLED,
DISABLED,
MAINTENANCE
}
public void configureFeature(FeatureMode mode) {
switch (mode) {
case ENABLED:
// 开启功能
break;
case DISABLED:
// 关闭功能
break;
case MAINTENANCE:
// 维护状态
break;
default:
throw new IllegalArgumentException("Unknown mode: " + mode);
}
}
类型安全
错误的使用 Boolean 包装类,有可能会引发空指针异常;
先抛一个问题:包装类 Boolean 有几种“值”?
Boolean 是包含两个值的枚举:Boolean.TRUE 和 Boolean.FALSE;但别忘了,还可以是 null;
一个真实的线上故障,Boolean 在某些情况下被错误地使用,可能会造成空指针异常;
例假设你正在修改一个老旧系统的某个方法,这个方法返回 Boolean,有几千行代码:
public static void main(String[] args) {
if (checkIfMatched("Dummy")){
System.out.println("matched");
}
}
/**
* 老旧系统里一个异常复杂的方法,有几千行
* @param str
* @return
*/
public static Boolean checkIfMatched(String str) {
Boolean matched;
//假设此处存在:复杂处理逻辑,暂时用dummy代替
if ("Dummy".equals(str)) {
matched = true;
} else {
matched = false;
}
return matched;
}
目前没问题,但当功能不断迭代后,复杂度也陡然上升,在某个特别的分支里,没有对 Boolean 赋值,至少在编译时是不会报错的:
public static void main(String[] args) {
if (checkIfMatched("Dummy")) {
System.out.println("matched");
}
}
/**
* 老旧系统里一个异常复杂的方法,有几千行
*
* @param str
* @return
*/
public static Boolean checkIfMatched(String str) {
Boolean matched = null;
//假设此处存在:复杂处理逻辑,暂时用 dummy 代替
if ("Dummy".equals(str)) {
//模拟:代码在演进的时候,有可能存在 matched 未赋值情况
if (false) {
matched = true;
}
} else {
matched = false;
}
return matched;
}
这个时候,危险悄然而至,还记得上面的问题吗:
包装类 Boolean 有几种“值”?
现在 checkIfMatched() 方法在不同的情况下,方法会返回三个不同的值:true/false/null
这里 null 是非常危险的,如果上游使用如下方式判断条件,考虑下是否有问题?
if (checkIfMatched("Dummy")) {
System.out.println("matched");
}
首先这里不会编译错误,但此处 if 条件处会自动拆箱,对于 null 值会得到 NullPointerException 异常;
小小总结
再回过头看:“哪些场景建议使用枚举来替换布尔值”,我认为要看功能点的易变程度去综合评估:“越容易变化,越不能让复杂度发散,越要由一处收敛,试想下一个 Boolean 的方法的变动是不是要评估所有上游的业务”;
所以并不是完全推翻布尔值,木宛哥在此也只是抛出一些代码的优化手段仅供参考。
我在大厂做 CR——为什么建议使用枚举来替换布尔值的更多相关文章
- 编写高质量代码改善C#程序的157个建议——建议28:理解延迟求值和主动求值之间的区别
建议28:理解延迟求值和主动求值之间的区别 要理解延迟求值(lazy evaluation)和主动求值(eager evaluation),先看个例子: List<, , , , , , , , ...
- Qt程序调试之Q_ASSERT断言(它是一个宏,接受布尔值,当其中的布尔值为真时,便什么也不做)
在使用Qt开发大型软件时,难免要调试程序,以确保程序内的运算结果符合我们的预期.在不符合预期结果时,就直接将程序断下,以便我们修改. 这就用到了Qt中的调试断言 - Q_ASSERT. 用一个小例子来 ...
- sqlHelper做增删改查,SQL注入处理,存储值,cookie,session
一.存储值 eg:登录一个页面,在进入这个页面之前你怎么知道它登没登录呢?[在登录成功之后我们把状态保存起来] 存储值得方式有两种,一种是cookie,一种是session 1.1区别: 代码: if ...
- 建议3:正确处理Javascript特殊值---(1)正确使用NaN和Infinity
NaN时IEEE 754中定义的一个特殊的数量值.他不表示一个数字,尽管下面的表达式返回的是true typeof(NaN) === 'number' //true 该值可能会在试图将非数字形式的字符 ...
- Android Fragment 生命周期及其API使用(建议使用自定义View替换Fragment)
我为什么不主张使用Fragment Fragment:( Fragment就相当于一个有生命周期的View,它的生命周期被所在的Activity的生命周期管理 ) 生命周期回调说明: onAttach ...
- Android Fragment 生命周期及其正确使用(建议使用自定义View替换Fragment)
使用Fragment 官方例子中显示: 例如:一个学生Fragment,需要传入studentId,进行http请求显示,那么setArguments后防止杀掉Fragment后,参数为0,显示不了数 ...
- javascript做的一个根据table中某个td的值为日期时的倒计时
JavaScript代码: <script> window.onload = window.onload = function () { getTdValue(); } //根据传过来的天 ...
- 记录要做的事情,把sql字符串替换写成工具网页。
之前使用的是java的本地控制台进行sql占位符的替换. 现在我想换个方式,想到了两种. 第一种是使用java +jsp进行替换,前台输出. 第二种是把java代码改成js代码,反正也不用访问数据库. ...
- Enum(枚举类型)的基本应用
一.前言 在我们日常的开发过程中,我们经常定义使用常量:在Effective Java建议用枚举来替换常量的使用,提高我们代码的质量,总结一下枚举定义常量的基本使用 二.枚举类型说明 1.枚 ...
- Java 相关注意事项小结
程序是一系列有序指令的集合: Java主要用于开发两类程序: 1)桌面应用程序2)Internet应用程序1,Java程序:三步走,编写--编译--运行:2,使用记事本开发:1)以.java为后缀名保 ...
随机推荐
- chatgpt的api联网报错问题解决:openai公司的api联网报错解决
chatgpt是啥,这里不讲,openai是啥这里也不讲.要知道我们不论是通过网页web使用chatgpt还是使用api方式通过客户端使用chatgpt都是需要使用外国IP的, 为啥我们不能访问ope ...
- 【转载】sun的rpc ——rpcbind(nfs文件系统中的rpc)
原文地址: https://blog.csdn.net/wangpeng138375/article/details/8169071 ================================= ...
- Ubuntu系统下python模块graphviz运行报错:graphviz.backend.execute.ExecutableNotFound: failed to execute PosixPath(‘dot‘)
代码中需要运行python模块graphviz,安装: pip install graphviz 运行后报错: graphviz.backend.execute.ExecutableNotFound: ...
- mendeley存储是有限的吗
用了mendeley好多年,总是有一个疑问,那就是这东西的云存储空间是不是有限的,如果是有限的话那么上限是多少?这东西不论是app还是桌面端都没有这个空间信息的大小,但是这东西必然是有上限的,那么这个 ...
- TGI 多-LoRA: 部署一次,搞定 30 个模型的推理服务
你是否已厌倦管理多个 AI 模型所带来的复杂性和高成本? 那么, 如果你可以部署一次就搞定 30 个模型推理服务会如何? 在当今的 ML 世界中,哪些希望充分发挥其数据的价值的组织可能最终会进入一个& ...
- Unreal使用GooglePAD生成AAB包,并加在fast-follow资源
1.修改obbfilter,设置需要添加到obb的pak文件 2.修改项目设置,打AAB包 3.cook stage生成所有Paks文件 4.将部分pak文件拷贝到Intermediate/Andro ...
- LLM大模型部署实战指南:Ollama简化流程,OpenLLM灵活部署,LocalAI本地优化,Dify赋能应用开发
LLM大模型部署实战指南:Ollama简化流程,OpenLLM灵活部署,LocalAI本地优化,Dify赋能应用开发 1. Ollama 部署的本地模型() Ollama 是一个开源框架,专为在本地机 ...
- manim 中的三维视角
今天研究了一下 manim 中的 ThreeDAxes 和 set_camera_orientation 这里记录一下视角. manim 中的 3D 坐标系是笛卡尔的三维坐标系,属于右手坐标系,即右手 ...
- mysql外键设置失败踩坑记录
把表里面的数据清空再添加 原因 因为外键一定要对应外面那个表的数据,现在添加外键会导致这个外键的值为空,违反了键的非空约定 理解为已有的数据突然多出来个字段,但是不知道值是什么,那就为空了 主键和外键 ...
- Kubernetes-7:Pod健康检查原理-探针(就绪检测、存活检测)
探针-就绪探测.存活探测 探针是由kubelet对容器执行的定期诊断,要执行诊断,kubelet调用由容器实现的Handler,有三种类型的处理程序: ExecActive:在容器内执行指定命令,若命 ...