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

2024-09-06 23:38

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

读后感

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

我所理解的“好”代码

核心目标

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

  • 易于未来的工作

具体的方面

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

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

目标特征

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

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

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

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

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

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

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

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

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


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

后记

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

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



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

相关文章

Qt实现网络数据解析的方法总结

《Qt实现网络数据解析的方法总结》在Qt中解析网络数据通常涉及接收原始字节流,并将其转换为有意义的应用层数据,这篇文章为大家介绍了详细步骤和示例,感兴趣的小伙伴可以了解下... 目录1. 网络数据接收2. 缓冲区管理(处理粘包/拆包)3. 常见数据格式解析3.1 jsON解析3.2 XML解析3.3 自定义

利用Python调试串口的示例代码

《利用Python调试串口的示例代码》在嵌入式开发、物联网设备调试过程中,串口通信是最基础的调试手段本文将带你用Python+ttkbootstrap打造一款高颜值、多功能的串口调试助手,需要的可以了... 目录概述:为什么需要专业的串口调试工具项目架构设计1.1 技术栈选型1.2 关键类说明1.3 线程模

Python Transformers库(NLP处理库)案例代码讲解

《PythonTransformers库(NLP处理库)案例代码讲解》本文介绍transformers库的全面讲解,包含基础知识、高级用法、案例代码及学习路径,内容经过组织,适合不同阶段的学习者,对... 目录一、基础知识1. Transformers 库简介2. 安装与环境配置3. 快速上手示例二、核心模

Java的栈与队列实现代码解析

《Java的栈与队列实现代码解析》栈是常见的线性数据结构,栈的特点是以先进后出的形式,后进先出,先进后出,分为栈底和栈顶,栈应用于内存的分配,表达式求值,存储临时的数据和方法的调用等,本文给大家介绍J... 目录栈的概念(Stack)栈的实现代码队列(Queue)模拟实现队列(双链表实现)循环队列(循环数组

Python实现图片分割的多种方法总结

《Python实现图片分割的多种方法总结》图片分割是图像处理中的一个重要任务,它的目标是将图像划分为多个区域或者对象,本文为大家整理了一些常用的分割方法,大家可以根据需求自行选择... 目录1. 基于传统图像处理的分割方法(1) 使用固定阈值分割图片(2) 自适应阈值分割(3) 使用图像边缘检测分割(4)

Windows Docker端口占用错误及解决方案总结

《WindowsDocker端口占用错误及解决方案总结》在Windows环境下使用Docker容器时,端口占用错误是开发和运维中常见且棘手的问题,本文将深入剖析该问题的成因,介绍如何通过查看端口分配... 目录引言Windows docker 端口占用错误及解决方案汇总端口冲突形成原因解析诊断当前端口情况解

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown(MD)因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析

C++使用printf语句实现进制转换的示例代码

《C++使用printf语句实现进制转换的示例代码》在C语言中,printf函数可以直接实现部分进制转换功能,通过格式说明符(formatspecifier)快速输出不同进制的数值,下面给大家分享C+... 目录一、printf 原生支持的进制转换1. 十进制、八进制、十六进制转换2. 显示进制前缀3. 指

使用Python实现全能手机虚拟键盘的示例代码

《使用Python实现全能手机虚拟键盘的示例代码》在数字化办公时代,你是否遇到过这样的场景:会议室投影电脑突然键盘失灵、躺在沙发上想远程控制书房电脑、或者需要给长辈远程协助操作?今天我要分享的Pyth... 目录一、项目概述:不止于键盘的远程控制方案1.1 创新价值1.2 技术栈全景二、需求实现步骤一、需求

Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码

《Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码》:本文主要介绍Java中日期时间转换的多种方法,包括将Date转换为LocalD... 目录一、Date转LocalDateTime二、Date转LocalDate三、LocalDateTim