“AI 技术+人才”如何成为企业增长新引擎?戳此了解>>> 了解详情
写点什么

改善代码质量的 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:073136
用户头像

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

关注

评论

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

教你实现一个 iOS 重签名工具

37手游iOS技术运营团队

ios xcode

Java Jackson 中的 JsonNode 和 ObjectNode

HoneyMoose

ReactNative进阶(四):ReactNative 原理剖析之JS 层渲染 diff 算法

No Silver Bullet

React Native 渲染性能 1月月更

netty系列之:真正的平等–UDT中的Rendezvous

程序那些事

Java Netty 程序那些事 1月月更

倒计时1天 | 超百位技术大咖齐聚开发者大会,与全球开发者一起“数聚未来”

OceanBase 数据库

OceanBase 开源 开发者大会

盘点 2021| 不忘初心,未来之路,与君共勉

法医

前端 盘点 2021

Kafka往事——揭露Kafka推出Kafka Streams背后原因

Kafka中文社区

【LeetCode】奇偶树Java题解

Albert

算法 LeetCode 1月月更

杜甫草堂

wood

300天创作

AWS 上传的 S3 文件重新载入的时候简体中文显示乱码

HoneyMoose

面试突击13:方法优先调用可选参数还是固定参数?

王磊

java面试 2022

【LeetCode】 替换所有的问号Java题解

Albert

算法 LeetCode 1月月更

一篇从购买服务器到部署博客代码的详细教程

冴羽

nginx 前端 后端 博客 博客搭建

一个cpp协程库的前世今生(十一)等待与返回值

SkyFire

c++ cocpp

使用LNMP环境部署码云测试项目

咿呀呀

lnmp

Kubernetes生态,从繁荣走向碎片化

巨子嘉

容器 云原生

阿里云万郁香:多样付费选择构筑成本最优的弹性体验

阿里云弹性计算

阿里云 年度峰会 付费方式

关于ant design pro的权限方案设计

袋鼠云数栈

大数据

数据分析人员需要掌握SQL到什么程度?3个常考题目刷一刷

博文视点Broadview

工作中遇到的50个JavaScript的基础知识点

Sunshine_Lin

面试 前端 进阶 基础

明道云虹桥演示中心,欢迎进店!

明道云

kubelet 的主动驱逐POD

Geek_f24c45

Kubernetes kubelet

Apache APISIX 结合 Authing 实现集中式身份认证管理

API7.ai 技术团队

api 网关 Apache APISIX Authing 身份验证

设计模式【8】-- 手工耿教我写装饰器模式

秦怀杂货店

Java 设计模式 装饰器

服务发现与配置管理高可用最佳实践

阿里巴巴云原生

阿里云 微服务 高可用 云原生 MSE

《LeetCode刷题》数组与队列

IT蜗壳-Tango

IT蜗壳教学 1月月更

一键抠除路人甲,昇腾CANN带你识破神秘的“AI消除术”

华为云开发者联盟

CANN 昇腾 图像消除 智能实例分割 CRA算法

Java Jackson 中的 mapper

HoneyMoose

error: ‘slots_reference’ was not declared in this scope

Ayosh

OpenCV

开源实践 | 携程在 OceanBase 的探索与实践

OceanBase 数据库

OceanBase 开源 客户案例 携程

Spring Boot工程中如何优雅地处理异常

sean77

spring 整洁代码

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