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

2024-09-06 23:38

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

读后感

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

我所理解的“好”代码

核心目标

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

  • 易于未来的工作

具体的方面

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

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

目标特征

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

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

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

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

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

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

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

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

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


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

后记

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

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



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

相关文章

Mysql中设计数据表的过程解析

《Mysql中设计数据表的过程解析》数据库约束通过NOTNULL、UNIQUE、DEFAULT、主键和外键等规则保障数据完整性,自动校验数据,减少人工错误,提升数据一致性和业务逻辑严谨性,本文介绍My... 目录1.引言2.NOT NULL——制定某列不可以存储NULL值2.UNIQUE——保证某一列的每一

Spring Boot 与微服务入门实战详细总结

《SpringBoot与微服务入门实战详细总结》本文讲解SpringBoot框架的核心特性如快速构建、自动配置、零XML与微服务架构的定义、演进及优缺点,涵盖开发环境准备和HelloWorld实战... 目录一、Spring Boot 核心概述二、微服务架构详解1. 微服务的定义与演进2. 微服务的优缺点三

Python实现MQTT通信的示例代码

《Python实现MQTT通信的示例代码》本文主要介绍了Python实现MQTT通信的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录1. 安装paho-mqtt库‌2. 搭建MQTT代理服务器(Broker)‌‌3. pytho

MySQL进行数据库审计的详细步骤和示例代码

《MySQL进行数据库审计的详细步骤和示例代码》数据库审计通过触发器、内置功能及第三方工具记录和监控数据库活动,确保安全、完整与合规,Java代码实现自动化日志记录,整合分析系统提升监控效率,本文给大... 目录一、数据库审计的基本概念二、使用触发器进行数据库审计1. 创建审计表2. 创建触发器三、Java

Java通过驱动包(jar包)连接MySQL数据库的步骤总结及验证方式

《Java通过驱动包(jar包)连接MySQL数据库的步骤总结及验证方式》本文详细介绍如何使用Java通过JDBC连接MySQL数据库,包括下载驱动、配置Eclipse环境、检测数据库连接等关键步骤,... 目录一、下载驱动包二、放jar包三、检测数据库连接JavaJava 如何使用 JDBC 连接 mys

JavaSE正则表达式用法总结大全

《JavaSE正则表达式用法总结大全》正则表达式就是由一些特定的字符组成,代表的是一个规则,:本文主要介绍JavaSE正则表达式用法的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录常用的正则表达式匹配符正则表China编程达式常用的类Pattern类Matcher类PatternSynta

Java中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示

Visual Studio 2022 编译C++20代码的图文步骤

《VisualStudio2022编译C++20代码的图文步骤》在VisualStudio中启用C++20import功能,需设置语言标准为ISOC++20,开启扫描源查找模块依赖及实验性标... 默认创建Visual Studio桌面控制台项目代码包含C++20的import方法。右键项目的属性:

MySQL数据库的内嵌函数和联合查询实例代码

《MySQL数据库的内嵌函数和联合查询实例代码》联合查询是一种将多个查询结果组合在一起的方法,通常使用UNION、UNIONALL、INTERSECT和EXCEPT关键字,下面:本文主要介绍MyS... 目录一.数据库的内嵌函数1.1聚合函数COUNT([DISTINCT] expr)SUM([DISTIN

Java实现自定义table宽高的示例代码

《Java实现自定义table宽高的示例代码》在桌面应用、管理系统乃至报表工具中,表格(JTable)作为最常用的数据展示组件,不仅承载对数据的增删改查,还需要配合布局与视觉需求,而JavaSwing... 目录一、项目背景详细介绍二、项目需求详细介绍三、相关技术详细介绍四、实现思路详细介绍五、完整实现代码