Java 开发技巧:减少魔法值的使用

简介: 代码中有魔法值会造成代码可读性低(与代码量成正比)。还会造成维护困难,改动一个数值便要大动干戈,牵一发而动全身。应当尽力消灭或减少魔法值,提高维护效率和代码可读性。

前言

代码中有魔法值会造成代码可读性低(与代码量成正比)。还会造成维护困难,改动一个数值便要大动干戈,牵一发而动全身。应当尽力消灭或减少魔法值,提高维护效率和代码可读性。


1 魔法值

在Java开发中,Java魔法值又叫做魔法数值、魔法数字、魔法值。当我们开发或重构老代码中遇到了类似这种写法:

publicvoidattend(Stringvalue) {
if ("0".equals(value)) {
// TODO    } elseif ("1".equals(value)) {
// TODO    } else {
// TODO    }
}


脑壳疼!从 Java语法上无懈可击,但是从业务上却让人无法理解其中的含义。上面看到的字符窜的 "0""1" 统称为魔法值 。


2 魔法值的处理方式

上面的代码我们往往需要通过上下文推断出来,如果是非常复杂的业务或者十年前的代码那就更惨了,搞不好文档也没有。所以我们要尽量避免出现魔法值。今天就来讲几种避免魔法值的操作。


2.1 静态常量

如果该值的作用域在一个类中或者同一个包下,一般可以使用静态常量来解决。

privatestaticfinalStringFEMALE="0";
privatestaticfinalStringMALE="1";
publicvoidattend(Stringvalue) {
if (FEMALE.equals(value)) {
// TODO        } elseif (MALE.equals(value)) {
// TODO        } else {
// TODO        }
    }
}


是不是清晰了许多,原来 0 和 1 代表的是性别(当然需要配合你良好的变量命名习惯)。


2.2 使用接口

既然我们使用了静态常量那么我们可以将魔法值封装入接口也是可以的。

publicinterfaceGender {
StringFEMALE="0";
StringMALE="1";
}


2.3 使用枚举

接口的意义在于提供抽象的功能而不是存储一些常量值,显然违背了接口设计的初衷。所以jdk1.5引入了枚举类型enum。很多情况这种写法就够用了,你可以通过 GenderEnum.MALE.ordinal() 获取对应枚举的数字序号,也可以通过GenderEnum.MALE.name()获取对应枚举的字符串名称。他们大多数情况下都可以用来进行一些逻辑标识。但是满足不了我们上面最初的设计,我们需要来改造一下枚举类的构造函数。

publicenumGenderEnum {
FEMALE("0"),
MALE("1");
privatefinalStringvalue;
GenderEnum(Stringvalue) {
this.value=value;
    }
publicStringvalue() {
returnthis.value;
    }
}


这样改写之后我们就能通过 value() 方法拿到具体的值了。

自己再增加点需求,以达到你的枚举更加友好的可读性。参考如下代码片段:

publicenumGenderEnum {
UNKNOWN("-1", "未知"),
FEMALE("0", "女性"),
MALE("1", "男性");
privatefinalStringvalue;
privatefinalStringdescription;
GenderEnum(Stringvalue, Stringdescription) {
this.value=value;
this.description=description;
    }
publicStringvalue() {
returnthis.value;
    }
publicStringdescription() {
returnthis.description;
    }
}


description值不但可以帮助我们知道该枚举的实际代表意义,甚至可以作为一种说明返回给前端业务。


2.4 内部类

publicclassResponseMessage {
publicstaticfinalclassStatus {
publicstaticfinalStringSUCCESS="SUCCESS";
publicstaticfinalStringWARN="WARN";
publicstaticfinalStringERROR="ERROR";
publicstaticfinalStringFAIL="FAIL";
publicstaticfinalIntegerENABLE=0;
publicstaticfinalIntegerDISABLE=1;
    }
}


通过 [类名.内部类名.属性] 访问和调用,例如:

ResponseMessage.Status.ENABLE、

ResponseMessage.Status.SUCCESS、

ResponseMessage.Status.WARN


小贴士:枚举尽量不要使用中文声明,如 FEMALE 直接声明为 「女性」。另外枚举是单例的,因此无法 clone 和反序列化。


3 总结

对于魔法值在业务逻辑上面好像没有什么太大的影响,也不是很致命的问题,他不影响我们的代码运行,也不影响我们代码的使用。但是为了遵循规范,有效避免一些不必要的问题时,提升我们的开发效率和提高可读性。用常量或者参数,有如下好处:


1)代码更容易看懂,代码逻辑更清晰

看到代码就知道意义。业务逻辑中常用数字代表特定的意义。比如1:开启,0:关闭;1:男性,0:女性。如果直接看到数字,什么鬼?我都不知道是什么。


2)代码维护和优化更容易

如果随便用魔法数字,那么如果要修改,我自己都怕,鬼知道,这个魔法参数,和其他代码上的联系。比如,一个地方的数字“1”和另一个地方的数字“1”,这连个“1”他们是亲戚吗?谁知道!


附录-阿里巴巴java开发手册


阿里云「《阿里巴巴Java开发手册(嵩山版)》」

链接:https://developer.aliyun.com/ebook/394?spm=a2c6h.14164896.0.0.292c1994WVcu2x


阿里云「《阿里巴巴Java开发手册(泰山版)》」

链接:https://developer.aliyun.com/ebook/330?spm=a2c6h.14164896.0.0.292c1994WVcu2x


阿里云「《阿里巴巴Java开发手册(华山版)》」

链接:https://developer.aliyun.com/ebook/7413?spm=a2c6h.14164896.0.0.62651994ULUDwQ


阿里云「《阿里巴巴Java开发手册(终极版)》」

链接:https://developer.aliyun.com/ebook/386?spm=a2c6h.14164896.0.0.292c1994WVcu2x


2020版

链接: https://pan.baidu.com/s/1Zls_FUBKfGksU1GR3BGGGA

密码: titz


2019版

链接: https://pan.baidu.com/s/1cvCVQvjmxVlMwzd7mxDZqg

密码: j74h


2018版

链接: https://pan.baidu.com/s/1FbabpNhLxppUbj8NqknTZQ

密码: mm7r


2017版

链接: https://pan.baidu.com/s/1EsoDXp6cBalFJt1XNbvhTw

密码: 6u6l

相关文章
|
1月前
|
Java
Java开发实现图片URL地址检验,如何编码?
【10月更文挑战第14天】Java开发实现图片URL地址检验,如何编码?
69 4
|
10天前
|
Java API Maven
如何使用Java开发抖音API接口?
在数字化时代,社交媒体平台如抖音成为生活的重要部分。本文详细介绍了如何用Java开发抖音API接口,从创建开发者账号、申请API权限、准备开发环境,到编写代码、测试运行及注意事项,全面覆盖了整个开发流程。
53 10
|
1月前
|
监控 Java 测试技术
Java开发现在比较缺少什么工具?
【10月更文挑战第15天】Java开发现在比较缺少什么工具?
36 1
|
1月前
|
Java
Java开发实现图片地址检验,如果无法找到资源则使用默认图片,如何编码?
【10月更文挑战第14天】Java开发实现图片地址检验,如果无法找到资源则使用默认图片,如何编码?
59 2
|
16天前
|
SQL 安全 Java
安全问题已经成为软件开发中不可忽视的重要议题。对于使用Java语言开发的应用程序来说,安全性更是至关重要
在当今网络环境下,Java应用的安全性至关重要。本文深入探讨了Java安全编程的最佳实践,包括代码审查、输入验证、输出编码、访问控制和加密技术等,帮助开发者构建安全可靠的应用。通过掌握相关技术和工具,开发者可以有效防范安全威胁,确保应用的安全性。
34 4
|
18天前
|
缓存 监控 Java
如何运用JAVA开发API接口?
本文详细介绍了如何使用Java开发API接口,涵盖创建、实现、测试和部署接口的关键步骤。同时,讨论了接口的安全性设计和设计原则,帮助开发者构建高效、安全、易于维护的API接口。
47 4
|
28天前
|
开发框架 JavaScript 前端开发
HarmonyOS UI开发:掌握ArkUI(包括Java UI和JS UI)进行界面开发
【10月更文挑战第22天】随着科技发展,操作系统呈现多元化趋势。华为推出的HarmonyOS以其全场景、多设备特性备受关注。本文介绍HarmonyOS的UI开发框架ArkUI,探讨Java UI和JS UI两种开发方式。Java UI适合复杂界面开发,性能较高;JS UI适合快速开发简单界面,跨平台性好。掌握ArkUI可高效打造符合用户需求的界面。
87 8
|
23天前
|
SQL Java 程序员
倍增 Java 程序员的开发效率
应用计算困境:Java 作为主流开发语言,在数据处理方面存在复杂度高的问题,而 SQL 虽然简洁但受限于数据库架构。SPL(Structured Process Language)是一种纯 Java 开发的数据处理语言,结合了 Java 的架构灵活性和 SQL 的简洁性。SPL 提供简洁的语法、完善的计算能力、高效的 IDE、大数据支持、与 Java 应用无缝集成以及开放性和热切换特性,能够大幅提升开发效率和性能。
|
24天前
|
存储 Java 关系型数据库
在Java开发中,数据库连接是应用与数据交互的关键环节。本文通过案例分析,深入探讨Java连接池的原理与最佳实践
在Java开发中,数据库连接是应用与数据交互的关键环节。本文通过案例分析,深入探讨Java连接池的原理与最佳实践,包括连接创建、分配、复用和释放等操作,并通过电商应用实例展示了如何选择合适的连接池库(如HikariCP)和配置参数,实现高效、稳定的数据库连接管理。
44 2
|
24天前
|
监控 Java 数据库连接
在Java开发中,数据库连接管理是关键问题之一
在Java开发中,数据库连接管理是关键问题之一。本文介绍了连接池技术如何通过预创建和管理数据库连接,提高数据库操作的性能和稳定性,减少资源消耗,并简化连接管理。通过示例代码展示了HikariCP连接池的实际应用。
19 1
下一篇
无影云桌面