总结如何成为“好”代码——读《重构:改善既有代码的设计》有感

2024-09-06 23:38

本文主要是介绍总结如何成为“好”代码——读《重构:改善既有代码的设计》有感,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

读后感

说是“读后感”,其实并不是看得很仔细,尤其是各种代码例子,我基本上是跳过的。个人觉得,重构这件事上,关键是要能嗅出代码,知道什么是代码,这样目标明确后,重构的手段其实是水到渠成的,唯一要注意的就是书中强调的:要以小步为单位稳打稳扎进行。

我所理解的“好”代码

核心目标

那么如何才是“好”代码?书中的答案是:“人们是否能轻而易举地修改”,而我觉得抽象层级更高的描述是:易于未来的工作。“未来的工作”包括了“修改”,也包括其他方面的如“调用”,所以我觉得是个更加准确的描述。

  • 易于未来的工作

具体的方面

对于“未来的工作”,具体可分为:“其他方的调用”、“由于一些原因造成的修改”、“对于新功能的扩展”。当然,在此之前还需要对代码进行“理解”。

  • 理解
  • 调用
  • 修改
  • 扩展

目标特征

而为了能达成核心目标的具体方面,有一些“特征”是代码的目标:

一个具有概括能力的名字可以帮助【理解】代码。

接口/函数【调用】简单,而且它应该不易被误用。

合适的抽象/封装层级。有利于【修改】和【扩展】

我将代码中的“类”、“模块”、“函数”、甚至是一个小的“代码段”,都视作不同级别的“元素”。“元素”的数目不应太多,而且一个“元素”中的内容不能太多,否则不利于【理解】。“元素”的职责单一且明确,之间有较少的牵连,这样【修改】和【扩展】就能变得容易。

代码所代表的“逻辑”,不应有重复,否则【修改】就变得复杂。而且“逻辑”应简短且分支少,否则就难以【理解】。

  • 具有概括能力的名字
  • 调用简单
  • 不容易被误用
  • 合适的抽象/封装层级
  • 没有多余的元素
  • 元素的内容少
  • 元素的职责单一且明确
  • 元素之间有较少的牵连
  • 没有重复的逻辑
  • 逻辑简短
  • 逻辑分支少

尝试用自己的理解梳理书中的内容

在书的第3章,作者讨论了代码的“坏”味道。在我看来,所谓味道就是有悖于某些“目标特征”。
在书的第6~12章,作者讨论了重构的手段。在我看来这些就是为了达成“目标特征”的手段。
在这里插入图片描述


在这里插入图片描述
图中一个“目标特征”相关的内容尽量陈列在了一列。
不过这个图也并不是很精确,更为精确的表示方法应该是用连线表示出对应关系,这种关系很可能是“一对多”的。但那样工作量确实太大,而且可以预见最后图的结果会过于混乱。

后记

我对于 【易于未来的工作】 这一目标的理解,还是比较有自信的。但是关于“具体的方面”以及“目标特征”的总结,可能也并不准确。如果未来有觉得更有道理的理解,可以拐回头看看。

这篇关于总结如何成为“好”代码——读《重构:改善既有代码的设计》有感的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1143441

相关文章

python实现pdf转word和excel的示例代码

《python实现pdf转word和excel的示例代码》本文主要介绍了python实现pdf转word和excel的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录一、引言二、python编程1,PDF转Word2,PDF转Excel三、前端页面效果展示总结一

在MyBatis的XML映射文件中<trim>元素所有场景下的完整使用示例代码

《在MyBatis的XML映射文件中<trim>元素所有场景下的完整使用示例代码》在MyBatis的XML映射文件中,trim元素用于动态添加SQL语句的一部分,处理前缀、后缀及多余的逗号或连接符,示... 在MyBATis的XML映射文件中,<trim>元素用于动态地添加SQL语句的一部分,例如SET或W

使用C#代码计算数学表达式实例

《使用C#代码计算数学表达式实例》这段文字主要讲述了如何使用C#语言来计算数学表达式,该程序通过使用Dictionary保存变量,定义了运算符优先级,并实现了EvaluateExpression方法来... 目录C#代码计算数学表达式该方法很长,因此我将分段描述下面的代码片段显示了下一步以下代码显示该方法如

Python中的可视化设计与UI界面实现

《Python中的可视化设计与UI界面实现》本文介绍了如何使用Python创建用户界面(UI),包括使用Tkinter、PyQt、Kivy等库进行基本窗口、动态图表和动画效果的实现,通过示例代码,展示... 目录从像素到界面:python带你玩转UI设计示例:使用Tkinter创建一个简单的窗口绘图魔法:用

Python中实现进度条的多种方法总结

《Python中实现进度条的多种方法总结》在Python编程中,进度条是一个非常有用的功能,它能让用户直观地了解任务的进度,提升用户体验,本文将介绍几种在Python中实现进度条的常用方法,并通过代码... 目录一、简单的打印方式二、使用tqdm库三、使用alive-progress库四、使用progres

python多进程实现数据共享的示例代码

《python多进程实现数据共享的示例代码》本文介绍了Python中多进程实现数据共享的方法,包括使用multiprocessing模块和manager模块这两种方法,具有一定的参考价值,感兴趣的可以... 目录背景进程、进程创建进程间通信 进程间共享数据共享list实践背景 安卓ui自动化框架,使用的是

SpringBoot生成和操作PDF的代码详解

《SpringBoot生成和操作PDF的代码详解》本文主要介绍了在SpringBoot项目下,通过代码和操作步骤,详细的介绍了如何操作PDF,希望可以帮助到准备通过JAVA操作PDF的你,项目框架用的... 目录本文简介PDF文件简介代码实现PDF操作基于PDF模板生成,并下载完全基于代码生成,并保存合并P

SpringBoot基于MyBatis-Plus实现Lambda Query查询的示例代码

《SpringBoot基于MyBatis-Plus实现LambdaQuery查询的示例代码》MyBatis-Plus是MyBatis的增强工具,简化了数据库操作,并提高了开发效率,它提供了多种查询方... 目录引言基础环境配置依赖配置(Maven)application.yml 配置表结构设计demo_st

SpringCloud集成AlloyDB的示例代码

《SpringCloud集成AlloyDB的示例代码》AlloyDB是GoogleCloud提供的一种高度可扩展、强性能的关系型数据库服务,它兼容PostgreSQL,并提供了更快的查询性能... 目录1.AlloyDBjavascript是什么?AlloyDB 的工作原理2.搭建测试环境3.代码工程1.

Java调用Python代码的几种方法小结

《Java调用Python代码的几种方法小结》Python语言有丰富的系统管理、数据处理、统计类软件包,因此从java应用中调用Python代码的需求很常见、实用,本文介绍几种方法从java调用Pyt... 目录引言Java core使用ProcessBuilder使用Java脚本引擎总结引言python