代码整洁之道(重构)


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 相关文章推荐
javascript window对象属性整理
Oct 24 Javascript
jquery获得下拉框值的代码
Aug 13 Javascript
JavaScript中的this关键字介绍与使用实例
Jun 21 Javascript
JavaScript阻止事件冒泡示例分享
Dec 28 Javascript
js实现带关闭按钮始终显示在网页最底部工具条的方法
Mar 02 Javascript
javascript结合Flexbox简单实现滑动拼图游戏
Feb 18 Javascript
React styled-components设置组件属性的方法
Aug 07 Javascript
Angularjs之ngModel中的值验证绑定方法
Sep 13 Javascript
vue中render函数的使用详解
Oct 12 Javascript
JavaScript数据结构与算法之二叉树插入节点、生成二叉树示例
Feb 21 Javascript
利用JS响应式修改vue实现页面的input值
Sep 02 Javascript
vue-simple-uploader上传成功之后的response获取代码
Sep 07 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知识收集
2012/08/20 PHP
php截取中文字符串不乱码的方法
2013/12/25 PHP
php添加数据到xml文件的简单例子
2016/09/08 PHP
php PDO异常处理详解
2016/11/20 PHP
Yii框架页面渲染操作实例详解
2019/07/19 PHP
php的无刷新操作实现方法分析
2020/02/28 PHP
php生成随机数/生成随机字符串的方法小结【5种方法】
2020/05/27 PHP
Script的加载方法小结
2011/01/12 Javascript
node.js中的buffer.toString方法使用说明
2014/12/14 Javascript
javascript常用经典算法实例详解
2015/11/25 Javascript
原生js获取iframe中dom元素--父子页面相互获取对方dom元素的方法
2016/08/05 Javascript
Thinkjs3新手入门之如何使用静态资源目录
2017/12/06 Javascript
JavaScript对象拷贝与Object.assign用法实例分析
2018/06/20 Javascript
react中实现搜索结果中关键词高亮显示
2018/07/31 Javascript
深入koa-bodyparser原理解析
2019/01/16 Javascript
js实现蒙版效果
2020/01/11 Javascript
基于vue项目设置resolves.alias: '@'路径并适配webstorm
2020/12/02 Vue.js
解析Python中的变量、引用、拷贝和作用域的问题
2015/04/07 Python
Python CSV模块使用实例
2015/04/09 Python
python自定义解析简单xml格式文件的方法
2015/05/11 Python
Python注释详解
2016/06/01 Python
Tensorflow累加的实现案例
2020/02/05 Python
在tensorflow以及keras安装目录查询操作(windows下)
2020/06/19 Python
python 使用csv模块读写csv格式文件的示例
2020/12/02 Python
css3背景图片透明叠加属性cross-fade简介及用法实例
2013/01/08 HTML / CSS
德国在线香料制造商:Gewürzland
2020/03/10 全球购物
高校毕业生自我鉴定
2013/10/27 职场文书
学期研究性学习个人的自我评价
2014/01/09 职场文书
护士岗前培训自我评鉴
2014/02/28 职场文书
外贸员简历中的自我评价
2014/03/04 职场文书
关于运动会的口号
2014/06/07 职场文书
青年志愿者活动方案
2014/08/17 职场文书
民主生活会对照检查材料范文
2014/10/01 职场文书
普通党员个人剖析材料
2014/10/08 职场文书
判缓刑人员个人思想汇报
2014/10/10 职场文书
2019暑假学生安全口号
2019/06/27 职场文书