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

2024-09-06 23:38

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

读后感

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

我所理解的“好”代码

核心目标

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

  • 易于未来的工作

具体的方面

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

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

目标特征

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

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

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

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

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

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

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

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

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


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

后记

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

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



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

相关文章

SpringBoot+RustFS 实现文件切片极速上传的实例代码

《SpringBoot+RustFS实现文件切片极速上传的实例代码》本文介绍利用SpringBoot和RustFS构建高性能文件切片上传系统,实现大文件秒传、断点续传和分片上传等功能,具有一定的参考... 目录一、为什么选择 RustFS + SpringBoot?二、环境准备与部署2.1 安装 RustF

Python实现Excel批量样式修改器(附完整代码)

《Python实现Excel批量样式修改器(附完整代码)》这篇文章主要为大家详细介绍了如何使用Python实现一个Excel批量样式修改器,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一... 目录前言功能特性核心功能界面特性系统要求安装说明使用指南基本操作流程高级功能技术实现核心技术栈关键函

Python中logging模块用法示例总结

《Python中logging模块用法示例总结》在Python中logging模块是一个强大的日志记录工具,它允许用户将程序运行期间产生的日志信息输出到控制台或者写入到文件中,:本文主要介绍Pyt... 目录前言一. 基本使用1. 五种日志等级2.  设置报告等级3. 自定义格式4. C语言风格的格式化方法

Spring 依赖注入与循环依赖总结

《Spring依赖注入与循环依赖总结》这篇文章给大家介绍Spring依赖注入与循环依赖总结篇,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1. Spring 三级缓存解决循环依赖1. 创建UserService原始对象2. 将原始对象包装成工

Redis实现高效内存管理的示例代码

《Redis实现高效内存管理的示例代码》Redis内存管理是其核心功能之一,为了高效地利用内存,Redis采用了多种技术和策略,如优化的数据结构、内存分配策略、内存回收、数据压缩等,下面就来详细的介绍... 目录1. 内存分配策略jemalloc 的使用2. 数据压缩和编码ziplist示例代码3. 优化的

Python 基于http.server模块实现简单http服务的代码举例

《Python基于http.server模块实现简单http服务的代码举例》Pythonhttp.server模块通过继承BaseHTTPRequestHandler处理HTTP请求,使用Threa... 目录测试环境代码实现相关介绍模块简介类及相关函数简介参考链接测试环境win11专业版python

Python从Word文档中提取图片并生成PPT的操作代码

《Python从Word文档中提取图片并生成PPT的操作代码》在日常办公场景中,我们经常需要从Word文档中提取图片,并将这些图片整理到PowerPoint幻灯片中,手动完成这一任务既耗时又容易出错,... 目录引言背景与需求解决方案概述代码解析代码核心逻辑说明总结引言在日常办公场景中,我们经常需要从 W

使用Spring Cache本地缓存示例代码

《使用SpringCache本地缓存示例代码》缓存是提高应用程序性能的重要手段,通过将频繁访问的数据存储在内存中,可以减少数据库访问次数,从而加速数据读取,:本文主要介绍使用SpringCac... 目录一、Spring Cache简介核心特点:二、基础配置1. 添加依赖2. 启用缓存3. 缓存配置方案方案

MySQL的配置文件详解及实例代码

《MySQL的配置文件详解及实例代码》MySQL的配置文件是服务器运行的重要组成部分,用于设置服务器操作的各种参数,下面:本文主要介绍MySQL配置文件的相关资料,文中通过代码介绍的非常详细,需要... 目录前言一、配置文件结构1.[mysqld]2.[client]3.[mysql]4.[mysqldum

MySQL中查询和展示LONGBLOB类型数据的技巧总结

《MySQL中查询和展示LONGBLOB类型数据的技巧总结》在MySQL中LONGBLOB是一种二进制大对象(BLOB)数据类型,用于存储大量的二进制数据,:本文主要介绍MySQL中查询和展示LO... 目录前言1. 查询 LONGBLOB 数据的大小2. 查询并展示 LONGBLOB 数据2.1 转换为十