最新发布《数智时代的AI人才粮仓模型解读白皮书(2024版)》,立即领取! 了解详情
写点什么

改善代码质量的 6 种重构模式

  • 2014-02-04
  • 本文字数:1404 字

    阅读完需:约 5 分钟

Kumar 是位涉猎广泛的软件工程师,对很多技术领域都有非常高的热情,如 Java/JEE、PHP、.NET、C/C++ 等程序设计语言、移动编程语言、应用安全、云计算、API、移动应用、Google Glass、大数据等等,其 Twitter 帐号是 @eajitesh。近日,Kumar 撰写了一篇文章,谈到了常见的代码坏味道以及改善代码质量的6 种重构模式,并对每种重构模式的使用场景进行了详尽的论述与讨论。

最近一段时间,我参与了几次代码审查,发现了5 种出现次数较多的代码坏味道,总结如下:

1. 过大的类:由于开发者没能很好地理解“单一职责原则”这一编码规则而导致类的规模过于庞大。由于在同一个类中存在着完成各种不相关功能的各种方法,因此这样的类随着时间的流逝会变得越来越大。

2. 过长的方法:由于如下几个原因,我们发现有些方法显得太长了:

  • 在同一个方法中,几个代码块实现了不相关 / 多个功能。这主要是由于开发者不理解单一职责原则所导致的。
  • 同一个方法中存在多个条件。我们发现在过长的方法中,这种情况是非常普遍的。这可以归结为由于开发者缺乏对 McCabe 代码复杂度和单一职责原则概念的理解所造成的。

3. 方法参数:有时方法会彼此传递几个参数进行相互的调用。这时,如果修改了参数列表中的一个参数,那就需要修改几个方法签名。

4. 遍布在各处的字面常量:有一些程序员新手会使用字面常量值(大多数是数字),在使用的时候心里对这些常量值有着确切的定义,但却没有将其赋给具名的常量。这会严重降低代码的可读性和可理解性。

5. 含糊不清的方法名:很多时候,下面这样的方法名会严重影响到代码的可读性与可理解性:

  • 没有任何意义、含糊不清的名字
  • 只是一个技术上的名字,与问题域没有任何关联关系。

根据上面所讨论的代码坏味道,下面给出可以有效解决这些问题的 6 种重构模式,合理使用这些模式能够帮你解决大多数的代码质量问题并成为一名更优秀的开发者。

1. 抽取类与移动方法:如上所述,诸如过大的类等代码坏味道可以通过将类划分为恰当数量的小类来解决。在这些新类中,我们需要将原来的类中的一些属性和方法移动过来。除此之外,有时类中还会包含大量的方法,这些方法会被其他类所用,这种方法也可以移动到恰当的新类当中。

2. 抽取方法:就像上面所介绍的,诸如过长的方法这种代码坏味道可以通过将原来方法中的代码抽取到新方法中来解决。

3. 分解条件:很多时候,过长的方法实际上包含了过多的条件语句(if-else)。我们应该将这些条件抽取出来放到单独的方法当中,这会让代码的可读性与可理解性上一个新台阶。

4. 引入参数对象 / 保留整个对象:在代码审查过程中,我发现将多个参数传递到方法中是一个很普遍的现象。如果要增加或是删除方法中的参数,那这么做就会引发问题。在这种情况下,我们建议将相关的参数组织为一个对象(引入参数对象),将对象而不是单独的参数传递到方法中去。

5. 使用符号常量代替魔数:对于那些有确切含义并在很多地方使用的字面常量值来说,你应该将其赋给具名的常量。这会增强代码的可读性与可理解性。

6. 重命名方法:含糊不清的方法名会影响到代码的可读性。我们应该使用有意义的方法名,与业务领域的术语相关,并且能够帮助开发者理解业务上下文中的代码。这是需要技巧的,需要开发者与业务分析师紧密配合来清楚地理解代码所要满足的业务需求。有趣的是,这种重构模式看起来似乎很简单,但实际上却经常被很多开发者所忽视。值得一提的是,很多 IDE 都提供了重命名这个重构选项,值得你尝试一下。

2014-02-04 12:073149
用户头像

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

关注

评论

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

如何定义错误码

编号94530

Java 错误码 错误处理

在全面拥抱人工智能前,这 6 步您的公司做到了吗?| 云途专栏

亚马逊云科技 (Amazon Web Services)

Python基础之:Python中的模块

程序那些事

Python Python3 程序那些事

NoCode 实战 | 零代码应用开发,轻松搞定任务跟踪管理难题(上)

亚马逊云科技 (Amazon Web Services)

用 Redis 实现消息队列是一个好主意么?

escray

redis 学习 极客时间 3月日更 Redis 核心技术与实战

镜像仓库学习笔记

lenka

3月日更

异步机制和CPU架构对 Redis 性能的影响

escray

redis 学习 极客时间 3月日更 Redis 核心技术与实战

【LeetCode】删除排序链表中的重复元素 IIJava题解

Albert

算法 LeetCode 3月日更

一段java代码执行旅程

华为云开发者联盟

JVM class 指令 java代码 java栈

智慧公安信息化管理系统,重点人员管控系统的搭建

13828808769

智慧交通

Wireshark数据包分析学习笔记Day21

穿过生命散发芬芳

Wireshark 数据包分析 3月日更

初识Golang之声明函数

Kylin

3月日更 21天挑战 Go 语言

华为云PB级数据库GaussDB(for Redis)揭秘第六期:Feed流场景中的应用

华为云开发者联盟

数据库 redis 华为云 GaussDB Feed流

区块链六大应用场景,推动政府信息化发展

13828808769

区块链+ #区块链#

第十二周作业

MR.X

亚马逊云科技和德甲为 2021 赛季新推出三项赛况统计数据,强化实时比赛分析

亚马逊云科技 (Amazon Web Services)

看东鹏饮料如何从150亿条数据中洞察先机 | 精选案例

亚马逊云科技 (Amazon Web Services)

区块链BaaS应用平台搭建,助力企业运用区块链解决业务问题

13828808769

区块链 区块链+ 区块链发展 #区块链#

Rust从0到1-基础概念-数据类型

rust 数据类型

Worktile 前端工程化之路

PingCode研发中心

大前端

分布式锁的实现方案

360技术

搞懂 ZooKeeper 集群的数据同步

HelloGitHub

Java zookeeper ZooKeeper原理

网络连接之协议栈

Kylin

协议栈 3月日更 21天挑战 网络连接

数据去哪了?:从一次生产事故聊聊并发编程原子性问题

海拉鲁

Java 并发编程 多线程

QCon全球软件开发大会:推动创新,实现技术落地

博文视点Broadview

Redis - 缓存穿透、缓存击穿、缓存雪崩

insight

redis 3月日更

[译]用@WebMvcTest测试MVC Web Contorller

麦芽面包

spring unittest

设计与思考,关于资源和生命周期

程序员架构进阶

设计实践 生命周期 28天写作 3月日更 池化技术

通俗讲解分布式锁,看完不懂算我输

Java小咖秀

Java 分布式 多线程 并发

Gas费用持续攀升!NA公链NAC公链如何破解高额Gas费用的困局?

区块链第一资讯

基于深度学习的两种信源信道联合编码

华为云开发者联盟

深度学习 通信 编码 信源编码 信道编码

改善代码质量的6种重构模式_架构_张龙_InfoQ精选文章