你的代码有重复吗?

简介: 本文作者为来自 SoftwareYoga.com 的软件架构师、敏捷与 DevOps 开发流程践行者 Deepak Karanth,文章主要介绍了 DRY 原则的诸多优点。

【编者按】本文作者为来自 SoftwareYoga.com 的软件架构师、敏捷与 DevOps 开发流程践行者 Deepak Karanth,文章主要介绍了 DRY 原则的诸多优点。

本文系国内 ITOM 管理平台 OneAPM 编译呈现。以下为正文:

“避免重复代码”(DRY) 是软件发展的一项原则,其主旨是减少代码重复现象。

“所有内容写两遍”(WET) 则是上述原则的反义缩写,意指不遵守 DRY 原则的代码。

开发人员应当以其中哪个原则为目标本应是显而易见的。但是,也许这个时候已经有人开始拿出证据来证明我是错的。

在本文中,我们会逐一讨论编写代码时遵循 DRY 原则的好处。首先,我们先举一个简单的例子来说明 DRY 原则的基本优势。

DRY 原则 - 简单例子

假设你的代码中有很多地方需要根据当前用户的角色来执行。比如:只有编辑或管理员才可以执行 createPage() 函数,只有管理员才可执行 deletePage() 函数。

在creatPage(创建页面)和 deletePage(删除页面)函数检查用户的角色时,我们可以使用下面这个 isPermitted() 单一函数,而不是分别开展用户角色检查的逻辑。

//get the current Subject
Subject currentUser = context.getSubject();

if (isPermitted(currentUser)) {    
 //allow execution of deletePage} 
 else {    
 //block execution
}

将 isPermitted() 的逻辑固定在一个地方,就可以避免重复,同时反复利用代码。另外一个优势就是逻辑的独立性,即 createPage() 和 deletePage() 无需知道如何检查权限。

当然,DIY 原则的优势远不止这样。

DRY 原则的优势

可维护性

DRY 原则的最大优势是可维护性。如果检查权限的逻辑在整段代码中重复很多次,在重复代码中出现的问题将很难修复。修复一段代码中的某个问题后,很容易忘记修复其他重复代码中同样存在的问题。同样,如果需要修改逻辑,就得四处复制粘贴。如果使用不重复的代码,只需在一处维护代码即可。新的逻辑和漏洞修复都只需在一处进行,不必再四处徘徊。通过这种方式开发的软件既稳定又可靠。

可读性高

大多数情况下,遵循 DRY 原则的代码更容易阅读。这并不是因为 DRY 原则本身,而是因为开发人员在代码中投入了更多精力,让它符合一定的原则(比如 DRY 原则)。

重复使用

DRY 原则始终提倡二次利用代码,这是因为我们会将2个或2个以上重复代码实例并入一个代码块。可重用代码缩短了开发时间,因此从长远看,可重用代码是有回报的。

成本合理

如果想说服管理层用更多的时间来提高代码质量,就可以用“成本”这个理由。代码越长,成本越高。代码越长,维护代码、修复漏洞所需的人手和时间也越多。代码越长,开发时间和漏洞也越多,结果就是客户非常不满。无庸赘述。

测试方便

这里我们讨论的是模块测试和集成测试,而不是手动测试。测试时需要覆盖的路径和功能越多,为测试而编写的代码就会越长。如果代码不重复,就只需要测试一个主路径。当然,不同的行为仍然需要接受测试。

注意事项

虽然 DRY 原则好处多多,但还是有几个小缺陷。

  1. 不是所有代码都需要整合成一段。有时候2段代码看上去差不多,但却存在细微差异。什么时候应当将代码段整合成一段,什么时候又应当让它们保持分离状态,都需要仔细斟酌。
  2. 如果代码太过简略,会让人难以理解。我曾见过开发人员在只有一个代码块实例时,还要贯彻 DRY
    原则。虽然我欣赏他们希望让代码更出色、可重用率更高的想法和远见,但是我只有在需要二次利用代码时才会去遵循 DRY 原则。
  3. 人们经常会忽略的是,DRY 原则并不仅仅适用于代码,它还可以同等地应用到数据库设计、文档编写、代码测试等方面。

本文转自 OneAPM 官方博客

原文地址:https://dzone.com/articles/is-your-code-dry-or-wet

相关文章
每次生成代码注释后 然后把生成的代码插入原代码位置后 方法原来的注解就会错位
每次生成代码注释后 然后把生成的代码插入原代码位置后 方法原来的注解就会错位
39 1
【BUG】循环中重复使用对象一定要注意
【BUG】循环中重复使用对象一定要注意
|
6月前
|
机器学习/深度学习 Python
获取重复的文件
使用 Python 3.10+ 的程序找出图片样本中的重复文件,依赖包 `NStudyPy`。通过计算文件的 MD5 值来识别重复项。核心函数 `get_repeat_file` 接受路径和递归选项,返回一个字典,键为 MD5,值为相同 MD5 的文件列表。`get_file_list` 和 `get_md5` 函数留待后续解释。安装 `NStudyPy`:`pip install -U NStudyPy`。
49 2
|
消息中间件 数据采集 Kafka
每次join之后没有正确处理数据的重复或缺失情况
每次join之后没有正确处理数据的重复或缺失情况
128 1
|
开发工具
代码重构之重复代码处理
介绍使用IDEA去重构重复的代码块
代码重构之重复代码处理
|
设计模式 消息中间件 JavaScript
干掉 “重复代码”,这三种方式绝了!
干掉 “重复代码”,这三种方式绝了!
36965 2
干掉 “重复代码”,这三种方式绝了!
|
算法
【递归可以干什么】1#重复执行某种模式
【递归可以干什么】1#重复执行某种模式
86 0
|
设计模式 JavaScript 前端开发
如何优雅的消除系统重复代码
在程序猿的日常工作中,不仅要跟随业务侧的发展不断开发新的需求,同时也需要维护老的已有平台。无论是开发新需求还是维护老系统,我们都会遇到同样一个问题,系统中总是充斥着很多重复的代码。
29578 11
如何优雅的消除系统重复代码
|
设计模式 算法 Java
干掉 “重复代码” 的技巧有哪些
软件工程师和码农最大的区别就是平时写代码时习惯问题,码农很喜欢写重复代码而软件工程师会利用各种技巧去干掉重复的冗余代码。
137 0
干掉 “重复代码” 的技巧有哪些
排列的时候如何避免重复?
排列的时候如何避免重复?
96 0