代码整洁之道(重构)


Posted in Javascript onOctober 25, 2018

前言

之前也介绍过我们团队的前端项目从零开始经历8个月迭代业务代码10万行(仅为产品长期规划需求的20%),至今仍然在不断迭代的过程。

团队成员除了设计好的架构来管理这种复杂度极高的前端应用,还开始补充设计模式以及重构方面的知识,目的是为了让项目代码在不断迭代的过程中优化项目代码,保持代码的新鲜度,鲁棒性,可维护性… 让后续加入的团队新人也可以快速加入我们的产品开发中

PS:  不管对于何种语言,重构都是软件开发过程中不可或缺的一部分。如果已经了解重构的基础,可以直接跳往至文章后面的重构案例部分。

重构背景

“如果尿布臭了,就换掉它”。

  • 随着业务需求的不断加入,代码随着时间的推移变得越来越糟。
  • 这其中可能包括以下坏味道(仅列举):
    • 重复的代码
    • 过长的函数
      • 遵循一条原则: 每当感觉需要注释来说明什么的时候,可以尝试将需要说明的东西写进一个函数中
    • 冗赘类
      • 当子类没有做足够的工作的时候,或者说在可见的预期内,不会有新的情况出现,考虑将类内联化。
    • 过长的类
      • 这种情况容易出现冗余代码。比如如果类内出现了多个变量带有相同的前缀或者后缀,这意味着你可以考虑把他们提炼到某个组件内,或者考虑这个组件是否可以成为子类,使用提炼类的手法来重构。

什么是重构

我们回过头来看一下"什么是重构"

  • 不改变软件可观察行为的前提下,改善其内部结构
  • 以提高理解性和降低修改成本

摘自《重构 - 改善既有代码的设计》(下面简称《重构》)

何时重构?

我们需要明确的一点是: 重构不是一件应该特地拨出一段时间来做的事情。重构不是目的,但是重构可以帮助你把事情做好。

事不过三,三则重构

  • 重复性工作,既有的代码无法帮助你轻松添加新特性时
  • 修补bug时,排查逻辑困难
  • code review 可以让他人来复审代码检查是否具备可读性,可理解性
  • 太多的代码无注释,已然连自己都无法快速理清代码逻辑

重构的衡量指标

  • 数量: 代码的行数
  • 质量: 代码复杂度,耦合度,可读性,架构依赖复杂度等
  • 成本: 花费的时间
  • 回报(成果):  支持后续功能的快速叠加,解决现有因代码设计问题无法优化的矛盾等

抓重点 抓重点啦

说了这么多废话,其实大家都明白没有与实践结合的理论都是空虚的。

但是 重构和 设计模式一样,也是需要一个"学习——领悟——突破"的过程。第一步的学习让你了解基本的重构手法,第二步的实践勾起你对重构手法的回忆以及重温应用,第三步的应用以及实践经验激发你的思考,领悟以及总结,以致于灵活运用。
但凡是人,总是在不断学习,不断温习,以达到具体场景具体应用,灵活自如。

重构是一个很大的话题,《重构》作者本人也是经历了N多的项目,以及多年的经验才总结出来的重构技巧。

重构技巧

《重构》一书作者总结的重构手法实在是太多了,只能通过图片来展示一下所有作者总结的重构列表。
具体的补充,大家可以看看《重构》一书。

代码整洁之道(重构)

代码整洁之道(重构)

重构的实践

作者推荐的一种做法:

  • 随机挑选一个目标 先给自己选择一个目标(譬如“去掉一堆不必要的子类”),然后朝着目标前进,每一步走得小而坚定
  • 没把握就停下来 当你无法证明自己所做的一切能够保证原有程序的逻辑和语义时,请你停下来思考:既有的重构是改善了还是毫无成果需要撤销。
  • 保证每次重构后的测试都能正常跑通

作为开发者, 应当把重构作为开发的一部分,一边开发一边重构。在快速堆叠代码,实现基本需求功能的基础上,写好测试用例,保证功能不变,逐步重构。
这也是我们团队要求每个人都掌握重构这门必备技能的原因。优秀的程序员应当尽量避免低质量的代码。

重构案例

故事场景

有三种类型的电影,顾客可以进行租赁

租赁规则

价格计算规则:

普通片儿 —— 起步价2¥,超过2天的部分每天每部电影收费1.3元
新片儿    —— 每天每部3元
儿童片    —— 起步价2¥,超过3天的部分每天每部电影收费0.8元

积分计算规则:

每借一部电影积分加1,新片每部加2

原始代码

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
你可能不再需要JQUERY
Mar 09 Javascript
Sample script that displays all of the users in a given SQL Server DB
Jun 16 Javascript
利用javascript移动div层-javascript 拖动层
Mar 22 Javascript
javascript时区函数介绍
Sep 14 Javascript
动态加载js、css等文件跨iframe实现
Feb 24 Javascript
PHP 数组current和next用法分享
Mar 05 Javascript
jQuery实现的图文高亮滚动切换特效实例
Aug 10 Javascript
关于RequireJS的简单介绍即使用方法
Oct 20 Javascript
Vue中保存数据到磁盘文件的方法
Sep 06 Javascript
vue.js+elementUI实现点击左右箭头切换头像功能(类似轮播图效果)
Sep 05 Javascript
JS实现可控制的进度条
Mar 25 Javascript
Vue页面手动刷新,实现导航栏激活项还原到初始状态
Aug 06 Javascript
Vue使用NPM方式搭建项目
Oct 25 #Javascript
小程序云开发实战小结
Oct 25 #Javascript
vue使用原生js实现滚动页面跟踪导航高亮的示例代码
Oct 25 #Javascript
在Bootstrap开发框架中使用dataTable直接录入表格行数据的方法
Oct 25 #Javascript
浅谈高大上的微信小程序中渲染html内容—技术分享
Oct 25 #Javascript
使用ECharts实现状态区间图
Oct 25 #Javascript
jquery使用FormData实现异步上传文件
Oct 25 #jQuery
You might like
php中Array2xml类实现数组转化成XML实例
2014/12/08 PHP
php实现通用的从数据库表读取数据到数组的函数实例
2015/03/21 PHP
PHP匿名函数和use子句用法实例
2016/03/16 PHP
PHP基于GD库的图像处理方法小结
2016/09/27 PHP
完美的php分页类
2017/10/24 PHP
PHP htmlentities()函数用法讲解
2019/02/25 PHP
js 操作select和option常用代码整理
2012/12/13 Javascript
js屏蔽鼠标键盘(右键/Ctrl+N/Shift+F10/F11/F5刷新/退格键)
2013/01/24 Javascript
JQuery DataTable删除行后的页面更新利用Ajax解决
2013/05/17 Javascript
javascript获取select的当前值示例代码(兼容IE/Firefox/Opera/Chrome)
2013/12/17 Javascript
JS获取下拉列表所选中的TEXT和Value的实现代码
2014/01/11 Javascript
轻松创建nodejs服务器(4):路由
2014/12/18 NodeJs
实践中学习AngularJS表单
2016/03/21 Javascript
浅谈jquery设置和获得checkbox选中的问题
2016/08/19 Javascript
Angular 向组件传递模板的两种方法
2018/02/23 Javascript
原生js代码能实现call和bind吗
2019/07/31 Javascript
浅析 Vue 3.0 的组装式 API(一)
2020/08/31 Javascript
JavaScript canvas实现文字时钟
2021/01/10 Javascript
python实现zencart产品数据导入到magento(python导入数据)
2014/04/03 Python
python计算N天之后日期的方法
2015/03/31 Python
Python 实现文件的全备份和差异备份详解
2016/12/27 Python
Python 由字符串函数名得到对应的函数(实例讲解)
2017/08/10 Python
python 识别图片中的文字信息方法
2018/05/10 Python
浅谈python中requests模块导入的问题
2018/05/18 Python
python设置环境变量的作用和实例
2019/07/09 Python
Python实现决策树并且使用Graphviz可视化的例子
2019/08/09 Python
AmazeUI图片轮播效果的示例代码
2020/08/20 HTML / CSS
HTML5适合的情人节礼物有纪念日期功能
2021/01/25 HTML / CSS
Java中有几种方法可以实现一个线程?用什么关键字修饰同步方法?stop()和suspend()方法为何不推荐使用?
2015/08/04 面试题
解释DataSet(ds) 和 ds as DataSet 的含义
2014/07/27 面试题
销售顾问岗位职责
2014/02/25 职场文书
学校清明节活动总结
2014/07/04 职场文书
2015年计生工作总结范文
2015/04/24 职场文书
骆驼祥子读书笔记
2015/06/26 职场文书
2015年学校教研室主任工作总结
2015/07/20 职场文书
2016年优秀教师先进事迹材料
2016/02/26 职场文书