AI实践哪家强?来 AICon, 解锁技术前沿,探寻产业新机! 了解详情
写点什么

Java 开发中常见的危险信号(上)

  • 2013-12-15
  • 本文字数:2096 字

    阅读完需:约 7 分钟

Dustin Marx 是一位专业软件开发者,从业已经有 17 年的时间,他拥有电子工程学士学位,还是一位 MBA。Dustin 维护着一个博客,专门介绍软件开发的各个主题。近日,他撰文谈到了Java 开发中常见的危险信号,提出了在日常的Java 开发中我们需要尽力避免的一些不正确的做法。

经过多年的开发、阅读、回顾并维护了数万行的Java 代码后,我经常会看到Java 代码中出现的某些“危险信号”,这些信号经常(但也许并不总是)暗示着代码出现了某些问题。我这里所要谈的并不是那些总是错误的实践,而是想要谈谈在某些场景下可能是恰当,但通常却会导致问题的一些实践。这些“危险信号”有时可能并没有问题,但却会造成问题的积累,并最终导致问题的产生。这里我总结出了一些“危险信号”,并且谈谈在哪些情况下他们是没有问题的,在哪些情况下则会导致问题。

这里将要谈及的很多“危险信号”通常都会收到来自于 FindBugs 等代码分析工具所发出的警告信息,流行的 Java IDE 也会将它们标记出来。不过,我发现有不少开发者会忽略掉这些来自于工具与 IDE 的警告信息,要么是因为他们关掉了提示信息,要么是出于自身的开发习惯或是不理解与这些警告信息所关联的风险,因此会忽略掉警告信息。

对引用使用 ==(而不是.equals)

很多 Java 开发者都知道使用 == 比较原生类型数据,使用.equals 比较引用类型数据。这是一条很容易记住的简单原则,Java 开发者这么用也没什么问题。有时使用 == 来比较标准的 Java 类型引用(String、Integer、Long 等等)也没问题,不过这要取决于被缓存的值的大小,因此这么做并不是一个好的做法。有时,我们需要检查标识的相等性而不是内容的相等性,在这种情况下使用== 来比较引用就很适合了。相对而言,我更喜欢Groovy 的处理方式,== 类似于.equals,而=== 则是更加严格地比较标识。同理,使用!= 来比较两个引用也是一个“危险信号”,因为如果待比较的两个对象不共享相同的标识(内存地址),即便他们拥有相同的内容也总是会返回true。

对枚举使用.equals(而不是==)

坦率地说,对于枚举,Java 开发者使用== 还是.equals 都没有太大关系。不过,我更倾向于对枚举使用== 。这么做最重要的原因就是对枚举使用== 可以防止不小心将枚举与不相关的对象进行比较(永远不会相等)。Object.equals(Object) 方法可以接收任意对象,这意味着编译器并不会强制限定传进来的对象要与被比较的对象是相同的类型。一般来说,我更喜欢静态的编译期问题检测而非动态运行期的问题检测,对枚举使用== 可以满足这个要求。同理,在比较枚举时,!= 与!.equals 也是一样的。

魔数与字符串字面值

我经常会在Java 代码中看到有人使用“魔数”和字符串字面值。他们对于未来的维护来说是一种“危险信号”,让我十分怀疑应用的正确性。在单个位置处将其标识为常量(如果可能用枚举来表示更佳),这么做可以改善未来的维护,并且让我可以更加自信地相信使用这些值的所有代码都在使用着相同的值。除此之外,在一个地方定义好常量与枚举可以更方便地使用IDE 的“查找使用”特性来找到所有使用这些常量的地方。

字符串常量

在看到有限的相关字符串常量时,我就在想使用枚举应该更加适合。对于高度内聚的字符串常量的情况来说更是如此,因为枚举可以更好地表达出这些字符串所表示的概念。相比于字符串常量来说,枚举提供了编译期的静态类型安全与潜在的性能优势。对于程序的正确性来说,编译期的安全是最吸引我的地方。

使用Java 的“goto”

很少有人会使用标签代码,如果使用了那也说明用法不当。换句话说,如果使用了也是滥用而已。在大多数情况下,使用 Java 的“goto”会造成代码的可读性极差。

根据作用域来确定恰当的变量引用

我认为这种方式永远都是不恰当的,但它却能运行,甚至有时是被某些 Java 开发者有意而为之。比如说,Java 开发者将传递进方法的变量在方法执行时指向了另一个引用。该变量(临时指向方法参数)指向了另一个引用,直到方法结束为止,这时它脱离了作用域。在这种情况下,在方法签名的参数定义前加上 final 关键字会导致编译器错误,这也是我喜欢在方法参数前加上 final 的原因之一。对于我来说,在方法中声明一个新的局部变量是更加清晰且可读的方式,因为它只能在方法中使用。更为重要的是,作为代码的读者,我不知道是开发者有意希望该参数名只是指向一个不同的值还是引入了 Bug,因为将参数重新指向新的引用实际上会改变调用端的值。如果我看到有人这么写,那么我就会找代码的编写者或是通过单元测试来验证代码的意图。

equals(Object) 与 hashCode() 方法的不匹配

虽然我认为每个 Java 类都应该重写 toString() 方法,但对于 equals(Object) 与 hashCode() 方法来说却并不这么认为。我觉得只有在需要这些方法的场合下才应该重写类中的这两个方法,因为他们的存在暗示着其设计与开发某种程度上的完全改变。特别地,equals 与 hashCode 方法要能满足其意图与契约(位于 Object 类的 API 文档),并且需要保持一致。大多数 IDE 与分析工具都会在其中一个方法重写而另一个没有重写的情况下给出提示。然而,我要确保 equals 与 hashCode 使用的是相同的属性,并且在这两个方法中属性的顺序要保持一致。

2013-12-15 11:094023
用户头像

发布了 88 篇内容, 共 269.2 次阅读, 收获喜欢 8 次。

关注

评论

发布
暂无评论
发现更多内容

安全世界观 | 常见WEB安全问题及防御策略汇总

架构精进之路

安全 8月日更

三维旋转笔记:欧拉角/四元数/旋转矩阵/轴角-记忆点整理

zhoulujun

矩阵旋转 欧拉角 三维旋转 四元数

其实,这就是「幸存者偏差」

非著名程序员

提升认知 认知提升 个人提升 8月日更

毕业感想

薛定谔的指南针

架构实战营

从java注解漫谈到typescript装饰器——注解与装饰器

zhoulujun

Java 注解 装饰器 ts 元数据

设计千万级学生管理系统的考试试卷存储方案-模块四

小牧ah

架构实战营

模块四作业

秀聪

架构训练营

03- 面向复杂度的架构设计

Lane

新手小白花几个月勇敢裸辞转行网络安全

网络安全学海

网络安全 信息安全 转行 渗透测试 安全漏洞

06-高可用复杂度

Lane

毕业设计作业

薛定谔的指南针

架构实战营

架构实战营-毕业设计项目

阿体

手撸二叉树之二叉树中第二小的节点

HelloWorld杰少

数据结构与算法 8月日更

Java架构速成笔记:七大专题,1425页考点,挑战P8岗

Java~~~

Java spring 面试 微服务 架构师

腾讯技术官手撸笔记,全新演绎“Kafka部署实战”,已开源

Java~~~

Java MySQL 面试 MQ 架构师

【架构实战营】毕业设计

swordman

架构实战营

05-高性能复杂度

Lane

架构实战营模块四作业

王晓宇

架构实战营

单向数据流-从共享状态管理:flux/redux/vuex漫谈异步数据处理

zhoulujun

React Redux vuex vue2 状态机

当农产品拥有“身份证”区块链技术如何助力农产品溯源监管?

CECBC

Github访问量破百万!原来是美团大牛的分布式架构实战笔记上线了

Java~~~

Java 面试 分布式 微服务 架构师

记录一次基于Qt的内存数据修改工具开发

星河寒水

qt 内存数据修改 Cheat Engine

13W字!腾讯高工手写“Netty速成手册”,3天能走向实战

Java~~~

Java 面试 微服务 Netty 架构师

04-可扩展架构

Lane

阿里开发人员献礼“Java架构成长笔记”,深入内核,拒绝蒙圈

Java~~~

Java spring 面试 微服务 架构师

初学字典-python

加里都好

微信朋友圈的高性能复杂度分析

Saber

架构实战营

JavaScript 开发人员应该理解的 this

devpoint

JavaScript js变量声明 this 8月日更

Android Jetpack Compose

Changing Lin

8月日更

华为大佬的“百万级”MySQL笔记,基础+优化+架构一键搞定

Java~~~

Java MySQL 数据库 面试 架构师

模块四作业

Mr.He

架构实战营

Java开发中常见的危险信号(上)_Java_张龙_InfoQ精选文章