重构四要素:目的、对象、时机和方法

目录

1.引言

2.重构的目的:为什么重构(why)

3.重构的对象:到底重构什么(what)

4.重构的时机:什么时候重构(when)

5.重构的方法:应该如何重构(how)

6.思考题


1.引言

        一些软件工程师对为什么要重构(why)、到底重构什么(what)、什么时候重构(when)应该如何重构(how)等问题的理解不深,对重构没有系统行认识、在面对质量不佳的代码时,这些软件工程师没有足够的重构技巧,不能系统地进行重构、为了让读者对有清晰的认识,我们先来了解一下重构的目的、对象、时机和方法。

2.重构的目的:为什么重构(why)

        软件设计专家 Martin Fowler 给出的重构的定义:“重构是一种对软件内部结构的改善,目的是在不改变软件对外部的可见行为的情况下,使其更易理解,修改成本更低。”在这个定义描述中,我们需要关注一点:“重构不改变对外部的可见行为”。注意,这里提到的“外部”是相对而言的。如果我们重构的是函数,那么函数的定义就是对外部的可见行为;如果我们重构的是一个类库,那么类库暴露的 API就是对外部的可见行为。在了解了重构的定义之后,我们探讨一下为什么要进行代码重构。

        首先,重构是保证代码质量的有效手段,可有效避免代码质量下滑。随着技术的更新、需求的变化和人员的流动,代码质量可能存在下降的情况。如果此时没有人为代码的质量负责那么代码就会变得越来越混乱。当代码混乱到一定程度之后,项目的维护成本高于重新开发-套新代码的成本,此时再去重构就不现实了。

        其次,高质量的代码不是设计出来的,而是迭代出来的。我们无法完全预测未来的需求也没有足够的精力和资源提前实现“未来可能需要实现的需求”,这就意味着,随着产品的选代、项目的推进和系统的演进,重构代码是不可避免的。

        最后,重构是避免过度设计的有效手段,可以兜底暂时不完善的设计。在代码的维护过程中,当遇到问题时,我们再对代码进行重构,这样能有效避免前期的过度设计。

        实际上,重构对软件工程师的技术成长也有重要意义。重构是设计原则和设计模式,以及代码规范等理论知识的重要应用场景。重构的过程能够锻炼我们熟练使用这些理论知识的能力。除此之外,重构能力是衡量软件工程师编码能力的重要手段。作者听过这样一句话:“初级软件工程师开发代码,高级软件工程师设计代码,资深软件工程师重构代码”,这句话的意思是:初级软件工程师在已有代码框架下修改、添加功能代码;高级软件工程师从零开始设计代码结构,搭建代码框架;而资深软件工程师为代码质量负责,能够及时发现代码中存在的间题,有针对性地对代码进行重构,时刻保证代码质量处于可控状态。

3.重构的对象:到底重构什么(what)

        根据重构的规模,我们可以将重构笼统地分为大规模高层次重构(以下简称“大型面构”)和小规模低层次重构(以下简称”小型重构”)。

        大型重构是指对顶层代码设计的重构包括对系统、模块、代码结构、类之间关系等的重构,大型重构的手段包括分层、模块化、解耦和抽象可复用组件等。大型重构的工具包括之前介绍的设计原则和第设计模式。大型重构涉及的代码改动较多,影响因此,其难度较大,耗时较长,引入bug的风险较高。

        小型重构是指对代码细节的重构,主要是针对类、函数和变量等级别的重构,如规范命名、规范注释、消除超大类或函数、提取重复代码等。小型重构主要是通过之间介绍的规范来实现。小型重构需要修改之处集中,过程简单,可操作性较强,耗时较短,引入bug风险较低。读者只要熟练掌握各种代码规范,就可以在小型重构时得心应手。

4.重构的时机:什么时候重构(when)

        在代码“烂”到一定程度之后,我们才进行重构吗?当然不是。如果代码已经出现维护难、bug频发等严重问题,那么重构已为时晚矣。

        因此,我们不提倡平时不注重代码质量,随意添加或删除代码,实在维护不了了就重构甚至重写的行为。我们不要寄希望于代码“烂”到一定程度后通过重构解决所有问题。我们须探索一个可持续、可演进的重构方案。这个重构方案就是持续重构。

        我们要培养持续重构的意识。我们应该像把单元测试、CodeReview(代码评审)作为开发的一部分一样,把持续重构也作为开发的一部分。如果持续重构成为一种开发习惯,并在队内形成共识,那么代码质量就有了保障。

5.重构的方法:应该如何重构(how)

        前面提到,按照重构的规模,我们可以将重构笼统地分为大型重构和小型重构。对于这两种不同规模的重构,我们要区别对待。

        大型重构涉及的代码较多,如果原有代码的质量较差,耦合度较高,那么重构时往往牵一发而动全身,程序员本来觉得可以很快完成的重构,结果有可能代码越改问题越多,导致短时间内无法完成重构,而新业务的开发又与重构冲突,最终,重构只能半途而废,程序员无奈地撤消之前所有的改动。

        因此,在进行大型重构时,我们要提前制订完善的重构计划,有条不素地分阶段进行。每个阶段完成一小部分代码的重构,然后提交、测试和运行,没有问题之后,再进行下一阶段的宣构,保证代码仓库中的代码一直处于可运行的状态。在大型重构的每个阶段,我们都要控制重构影响的代码的范围,考虑如何兼容旧的代码逻辑,必要的时候提供实现兼容的过渡代码只有这样,我们才能让每一个阶段的重构都不会耗时太长(最好一天就能完成),不与新功能的开发冲突。

        大型重构一定是有组织的、有计划的和谨慎的,需要经验丰富、业务熟练的资深工程师主导,而小型重构的影响范围小,改动耗时短,因此,只要我们愿意并且有时间,随时都可以进行小型重构,实际上,除利用人工方式发现代码的质量问题以外,我们还可以借助成熟的代码分析工具(如Checkstyle、FindBugs和PMD等)自动发现代码中存在的问题,然后有针对性地进行重构。

        在项目开发中;资深软件工程师、项目管理者要担负重构的责任,经常重构代码,保证代码的质量处于可控状态,避免引发“破窗效应”(只要一个人向项目中随意添加质量不高的代码,就会有更多的人往项目中添加更多质量不高的代码)。除此之外,我们要在团以内都营造一种追求代码质量的氛围,以此来驱动团队成员主动关注代码质量,进行持续重构。

6.思考题

        在重构代码时,你们遇到过哪些问题?在代码重构方面,读者有什么经验教训?

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/837068.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

3.使用uView让tabbar更优雅

文章目录 1. 使用uView让tabbar更优雅1.1. 怎么才优雅?1.2. uView的tabbar合适吗?1.3. 引入项目过程1.3.1. 修改pages.json1.3.2. 把demo里面的pages先拷贝过来1.3.3. 引入tabbar的图片1.3.4. 运行 1.4. 我们自己的项目适配 1. 使用uView让tabbar更优雅 …

【算法】滑动窗口——最小覆盖子串

本节博客是对“最小覆盖子串”题目由暴力求解到滑动窗口的思路解析,有需要借鉴即可。 目录 1.题目2.滑动窗口解法3.总结 1.题目 题目链接:LINK 这个题目是困难难度,感觉是一个中等题目的感觉。 首先我肯定想到的是暴力求解的方法&#xff…

C++:STL-string

前言 本文主要介绍STL六大组件中的容器之一:string,在学习C的过程中,我们要将C视为一个语言联邦(摘录于Effective C条款一)。如何理解这句话呢,我们学习C,可将其分为四个板块;分别为…

数据降维-主成分分析PCA

1.背景: 在以前计算能力还很弱的年代,我们要分析经济数据是一件很困难的事情,所以我们需要对指标特征进行降维; 2.数据降维的意义: 一般我们降维的特征数据彼此之间是存在一定的相关性的, 二维降至一维…

2024年区块链、信号处理与航空航天国际学术会议(ICBSPA 2024)

2024年区块链、信号处理与航空航天国际学术会议(ICBSPA 2024) 2024 International Conference on Blockchain, Signal Processing, and Aerospace 一、【会议简介】 随着科技的飞速发展,区块链、信号处理与航空航天等领域的交叉融合正成为推动科技进步的…

【代码随想录】【动态规划】背包问题 - 完全背包

完全背包 模板:完全背包问题 问题描述 完全背包问题与01背包问题唯一的区别在于: 在01背包中:每个物品只有一个,要么放入背包,要么不放入背包在完全背包中:每个物品有无限多个,可以不放入背…

2d激光slam中的常用地图介绍

2d激光slam中最常用的是栅格地图,用于保存建图后的地图。实际应用中的栅格地图也有很多类型和不同用处,下面根据使用经验一一介绍。 局部子地图,由一系列小栅格地图组成,每个栅格地图负责记录保存局部轨迹,通常用三个局…

卓豪Zoho CRM怎么收费?多少钱一年?

卓豪Zoho CRM作为一款功能强大且高度可定制的企业级客户关系管理系统,其收费标准因版本不同而有所差异,旨在满足不同规模及需求的企业。Zoho CRM提供多种套餐选择,包括但不限于免费版、标准版、专业版、企业版以及旗舰版。每种版本都包含了核…

基于Springboot的大学生平时成绩量化管理系统(有报告)。Javaee项目,springboot项目。

演示视频: 基于Springboot的大学生平时成绩量化管理系统(有报告)。Javaee项目,springboot项目。 项目介绍: 采用M(model)V(view)C(controller)三…

Docker Dockerfile如何编写?

Dockerfile 是一个用来构建镜像的文本文件,文本内容包含了一条条构建镜像所需的指令和说明。 1.指令说明 FROM,构建镜像基于哪个镜像 MAINTAINER,镜像维护者姓名或邮箱地址 RUN,构建镜像时运行的指令 CMD,运行容器时执…

娱乐营销的新玩法:Kompas.ai如何让内容更加趣味化

在数字化时代,内容营销已成为品牌与消费者沟通的重要桥梁。然而,随着信息的爆炸式增长,用户的注意力越来越分散,传统的营销方式已经难以吸引用户的兴趣。在这种背景下,娱乐营销应运而生,它通过将娱乐元素融…

数据库和Redis数据不一致的问题

目录 1. 延迟双删策略 2. 使用消息队列(MQ) 3. 引入分布式锁 4. 先更新数据库,再删除缓存 5. 设置缓存过期时间 6. 使用Redis事务 7. 监控和报警机制 数据库和Redis数据不一致的问题,主要源于Redis和数据库的异步写入机制。…

【设计模式】桥接模式-学习记录

概念 桥接模式是一种结构型设计模式,其UML图像一座桥,通过抽象部分与实现部分分离,使它们可以独立变化,从而达到降低系统低耦合的目的。桥接模式只要目的是通过组合建立两个类之间的联系,而不是继承的方式。 基本结构…

华东政法大学公布2024《负面清单期刊目录》,附目录

近日,华东政法大学公布2024《负面清单期刊目录》,包括《齐齐哈尔大学学报(哲学社会科学版)》《景德镇学院学报(社科)》《九江学院学报(社科)》《北京印刷学院学报》《江西电力职业技术学院学报》《中国多媒体与网络教学学报》《吉林省教育学院学报》《开…

Poetry Camera照相机将照片转换成诗歌并打印出来;吴恩达新课程深入了解Mistral;科学研究AI小助手data-to-paper

✨ 1: Poetry Camera 将拍摄的照片转换成诗歌并打印出来 Poetry Camera——一个能够把它所见之物转化成诗歌并打印出来的相机。你在一个美丽的公园,或者是一个充满故事的老街道。只要用Poetry Camera拍下这一刻,它就能立刻给你一首关于这个场景的诗。 …

【JAVA进阶篇教学】第十五篇:Java中AQS讲解

博主打算从0-1讲解下java进阶篇教学,今天教学第十五篇:Java中AQS讲解。 在Java并发编程中,AQS(AbstractQueuedSynchronizer)是一个重要的框架,用于实现同步器和锁的基础。它提供了一种灵活的方式来实现各种…

浏览器不兼容 replaceAll 方法问题解决

问题 在一些较旧版本的浏览器中可能会出现 replaceAll 方法不兼容,提示replaceAll 方法 undefined 的问题。浏览器版本兼容情况如下图所示: 解决 可以通过 replace 正则表达式 的方法来代替 replaceAll 方法: let str "我是一段文本…

CorelDRAW2024设计新境界,等你解锁!

CorelDRAW,这款由加拿大Corel公司开发的平面设计软件,自从1989年问世以来,就以其强大的功能和用户友好的界面,在全球设计师中享有极高的声誉。今天,我们要聊的主角是它的最新版本——CorelDRAW 2024。 CDR永久版安装包…

材料物理 笔记-8

原内容请参考哈尔滨工业大学何飞教授:https://www.bilibili.com/video/BV18b4y1Y7wd/?p12&spm_id_frompageDriver&vd_source61654d4a6e8d7941436149dd99026962 或《材料物理性能及其在材料研究中的应用》(哈尔滨工业大学出版社) ——…

从零学算法6

6. Z 字形变换 将一个给定字符串 s 根据给定的行数 numRows ,以从上往下、从左到右进行 Z 字形排列。 比如输入字符串为 “PAYPALISHIRING” 行数为 3 时,排列如下: P A H NA P L S I I GY I R之后,你的输出需要从左往右…