为什么阿里巴巴Java开发手册中不允许魔法值出现在代码中?-阿里云开发者社区

开发者社区> 优惠码领取> 正文

为什么阿里巴巴Java开发手册中不允许魔法值出现在代码中?

简介:
+关注继续查看

为什么阿里巴巴Java开发手册中不允许魔法值出现在代码中?

在阅读《阿里巴巴Java开发手册》时,发现有一条关于关于常量定义的规约,具体内容如下:

图中的反例是将数据缓存起来,并使用魔法值加链路 id 组成 key,这就可能会出现其他开发人员在复制粘贴的时候,少复制 _ 的情况发生,这种错误很难去检查到,因为读取缓存不存在,可能会去数据库读取,很难察觉到。

如果在生产环境中,大量的请求进来,缓存全部失效,直接请求数据库,导致数据库连接过多,查询效率变低的问题发生,因此看来魔法值确实应该避免出现在代码中。

另外在 《Clean Code》 和 《重构》 等书中也提到了类似的问题,在代码中出现原始形态数字通常来说是坏现象,应该用命名良好的常量类隐藏它。

静态常量取代魔法值#
像下面这个例子:

Copy
if (billCount > 75) {

//todo

} else {

//todo

}
如果在不了解这块的业务的同事,在读到这块代码的时候,可能会想,75 是什么鬼,为啥和这个数比较,背后深藏着什么秘密吗?可能只有当时的开发人员记得了,导致代码可读性和可维护性极差。

如果声明一个常量,来替换该魔法值,可能就会使代码的可读性和可维护性大大增加。

Copy
static final Integer BASIC_BILL_COUNT = 75;
还有些魔法表达式,比如:

Copy
if (value > 60 && value <= 80 && type = 1) {

// todo

}
比如这个表达式是表示状态为正常且项目活跃,就可以定义:

Copy
boolean isActiveProject = value > 60 && value <= 80 && type = 1;
这样是不是可读性就提高了,一眼就可以看出来这块代码的逻辑。

枚举类取代魔法值#
还有一种消除魔法值的方式是使用枚举类代替,下面让我们举个例子:

Copy
if (eventId == 1) {

System.out.println("睡觉");

} else if (eventId == 2) {

System.out.println("吃饭");

} else if (eventId == 3) {

System.out.println("打豆豆");

}
如上代码是针对事件 id 去执行相应的事件,如果事件比较少,大家还可以勉强记住每个 eventId 对应的含义,但是随着事件 id 的增多,很可能会发生,新来的员工把事件 id 给搞混了,导致执行错误的事件,发生 bug。

那么我们可以使用枚举类来表示相应的事件:

Copy
public enum EventEnum {

/**
 * 睡觉
 */
SLEEP_EVENT(1, "睡觉"),

/**
 * 吃饭
 */
EAT_EVENT(2, "吃饭"),

/**
 * 打豆豆
 */
FIGHT_PEA_EVENT(3, "打豆豆");

private int eventId;
private String desc;

EventEnum(int eventId, String desc) {
    this.eventId = eventId;
    this.desc = desc;
}

public int getEventId() {
    return eventId;
}

public String getDesc() {
    return desc;
}

}
修改完之后的代码如下:

Copy
if (eventId == EventEnum.SLEEP_EVENT.getEventId()) {

System.out.println("睡觉");

} else if (eventId == EventEnum.EAT_EVENT.getEventId()) {

System.out.println("吃饭");

} else if (eventId == EventEnum.FIGHT_PEA_EVENT.getEventId()) {

System.out.println("打豆豆");

}
是不是可读性急剧提升,还不快看看自己代码中有没有这样的魔法值出现,有的话赶紧改造起来。

还有如果你需要在不同的地点引用同一数值,魔法数会让你烦恼不已,因为一旦这些数字发生改变,就必须在程序中找到所有的魔法值,并将它们全部修改一遍,这样就太费时费力了。

其实不只是 Java 不应该在代码中使用魔法值,其他语言亦是如此。

总结
本文主要介绍了为什么不允许在代码中出现魔法值以及如何将代码中已有的魔法值去除掉。

代码可读性还是比较重要的,你肯定不希望别人在接手你的代码的时候,骂到这数字啥意思,这代码写得跟粑粑一样。

最好的关系就是互相成就,大家的在看、转发、留言三连就是我创作的最大动力。

参考

《Java开发手册》泰山版

作者: 武培轩

出处:https://www.cnblogs.com/wupeixuan/p/13071950.html

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
阿里云服务器怎么设置密码?怎么停机?怎么重启服务器?
如果在创建实例时没有设置密码,或者密码丢失,您可以在控制台上重新设置实例的登录密码。本文仅描述如何在 ECS 管理控制台上修改实例登录密码。
10012 0
分享实录 | 阿里巴巴代码缺陷检测探索与实践
3月3日,阿里巴巴算法工程师别象在云效DevOps交流群中分享了《阿里巴巴代码缺陷检测探索与实践》。从阿里巴巴代码平台在探索缺陷检测和补丁推荐问题时遇到的挑战入手,介绍了目前业界和学术界较为流行的缺陷检测手段,并针对其局限性,提出PRECFIX方法。
4456 0
阿里巴巴Java“代码反潜机”P3C喜提首届中国优秀开源项目二等奖!
P3C是阿里巴巴研发的Java代码规约扫描工具,项目组中一半成员来自云效团队。自17年10月开源到现在,P3C在Github上Star数达12600+,Fork数2700+,插件下载量54.1w+。
1729 0
阿里云服务器端口号设置
阿里云服务器初级使用者可能面临的问题之一. 使用tomcat或者其他服务器软件设置端口号后,比如 一些不是默认的, mysql的 3306, mssql的1433,有时候打不开网页, 原因是没有在ecs安全组去设置这个端口号. 解决: 点击ecs下网络和安全下的安全组 在弹出的安全组中,如果没有就新建安全组,然后点击配置规则 最后如上图点击添加...或快速创建.   have fun!  将编程看作是一门艺术,而不单单是个技术。
10880 0
二路归并排序 代码实例
  感觉好久没有写排序程序了,C语言有qsort()函数,C++有sort()函数,java语言有Arrays类(主要这个不是Array)。今天写了一下归并排序还有点费劲呀。晚上回来写写。   归并排序就是采用分治法进行排序:   (1)将一个数组分成小的2个数组分别进行排序;   (2)之后...
860 0
开发笔记2 | Java 代码规约第1条
说明:内容摘自《阿里巴巴 Java 开发手册》,版权归手册出品团队所有。本文作者根据自己过往的编码经验,对其做一些学习纪要。
1155 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,阿里云优惠总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系.
13810 0
《码出高效:Java 开发手册》正式发布,83行代码计划启动
可爱的Java开发者们,让你们久等了! 9月22日杭州云栖大会,众所期待的新书《码出高效:Java 开发手册》正式发布,并宣布将所有图书收益捐赠于技术公益项目。 本次新书发布,邀请了来自阿里巴巴高年级同学中间件负责人林昊、阿里巴巴研究员刘湘雯、阿里巴研究员刘国华,OpenJDK社区Committer杨晓峰,全栈视障工程师蔡勇斌,电子工业出版社博文视点出版公司总经理郭立以及两位图书作者杨冠宝(孤尽)和高海慧(鸣莎)重磅大咖联合发布,并宣布将图书所有收益均捐赠于技术公益项目“83行代码计划”,第一个“83行代码计划”行动,将围绕着帮助盲人工程师,开发更多无障碍化产品,让盲人上网更便捷。
11600 0
duilib 的IE浏览器控件去边框和去滚动条的代码
转载请说明原出处,谢谢~~         近些天在duilib群里经常有朋友问起,怎么让duilib的IE控件可以去边框,去滚动条的问题,或者是如何去控件IE控件的行为。
1018 0
+关注
优惠码领取
阿里云优惠码阿里云推荐券bieryun.com
193
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载