代码整洁之道(重构)


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 相关文章推荐
List Installed Software Features
Jun 11 Javascript
jQuery Ajax()方法使用指南
Nov 19 Javascript
简单了解Backbone.js的Model模型以及View视图的源码
Feb 14 Javascript
Bootstrap如何创建表单
Oct 21 Javascript
js 点击a标签 获取a的自定义属性方法
Nov 21 Javascript
Vue.js中用v-bind绑定class的注意事项
Dec 13 Javascript
vue移动UI框架滑动加载数据的方法
Mar 12 Javascript
基于vue v-for 多层循环嵌套获取行数的方法
Sep 26 Javascript
JS实现鼠标拖拽盒子移动及右键点击盒子消失效果示例
Jan 29 Javascript
在Vue项目中使用snapshot测试的具体使用
Apr 16 Javascript
JS实现贪吃蛇游戏
Nov 15 Javascript
微信小程序利用button控制条件标签的变量问题
Mar 15 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提取中文首字母
2008/04/09 PHP
PHP 如何利用phpexcel导入数据库
2013/08/24 PHP
PHP SPL标准库之文件操作(SplFileInfo和SplFileObject)实例
2015/05/11 PHP
php代码架构的八点注意事项
2016/01/25 PHP
jquery实现居中弹出层代码
2010/08/25 Javascript
在多个页面使用同一个HTML片段的代码
2011/03/04 Javascript
基于jquery tab切换(防止页面刷新)
2012/05/23 Javascript
javaScript NameSpace 简单说明介绍
2013/07/18 Javascript
特殊情况下如何获取span里面的值
2014/05/20 Javascript
node.js中的定时器nextTick()和setImmediate()区别分析
2014/11/26 Javascript
高性能JavaScript循环语句和条件语句
2016/01/20 Javascript
字符串反转_JavaScript
2016/04/28 Javascript
微信小程序 devtool隐藏的秘密
2017/01/21 Javascript
基于react后端渲染模板引擎noox发布使用
2018/01/11 Javascript
vue-cli开发环境实现跨域请求的方法
2018/04/07 Javascript
JavaScript作用域、闭包、对象与原型链概念及用法实例总结
2018/08/20 Javascript
基于iview的router常用控制方式
2019/05/30 Javascript
[03:18]DOTA2放量测试专访820:希望玩家加入国服大家庭
2013/08/25 DOTA
[01:08]DOTA2次级职业联赛 - Wings 战队宣传片
2014/12/01 DOTA
Python3实战之爬虫抓取网易云音乐的热门评论
2017/10/09 Python
python素数筛选法浅析
2018/03/19 Python
详解django中使用定时任务的方法
2018/09/27 Python
Pytest mark使用实例及原理解析
2020/02/22 Python
如何解决安装python3.6.1失败
2020/07/01 Python
Python3.7安装pyaudio教程解析
2020/07/24 Python
python输入中文的实例方法
2020/09/14 Python
Bose加拿大官方网站:美国知名音响品牌
2019/03/21 全球购物
奥巴马胜选演讲稿
2014/05/15 职场文书
化工专业自荐书
2014/06/16 职场文书
刑事辩护词范文
2015/05/21 职场文书
为自己工作观后感
2015/06/11 职场文书
应收账款管理制度
2015/08/06 职场文书
毕业生就业推荐表自我鉴定
2019/06/20 职场文书
Nginx 负载均衡是什么以及该如何配置
2021/03/31 Servers
MySQL分区表实现按月份归类
2021/11/01 MySQL
阿里云服务器Ubuntu 20.04上安装Odoo 15
2022/05/20 Servers