代码整洁之道(重构)


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调试说明
Jun 07 Javascript
javascript Array对象基础知识小结
Nov 16 Javascript
Extjs显示从数据库取出时间转换JSON后的出现问题
Nov 20 Javascript
使用jquery局部刷新(jquery.load)从数据库取出数据
Jan 22 Javascript
js基于面向对象实现网页TAB选项卡菜单效果代码
Sep 09 Javascript
jQuery+css实现的蓝色水平二级导航菜单效果代码
Sep 11 Javascript
jQuery计算文本框字数及限制文本框字数的方法
Mar 01 Javascript
轻松掌握JavaScript状态模式
Sep 07 Javascript
轻松实现js选项卡切换效果
Sep 24 Javascript
loading动画特效小结
Jan 22 Javascript
详解jQuery中的isPlainObject()使用方法
Feb 27 jQuery
iview通过Dropdown(下拉菜单)实现的右键菜单
Oct 26 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或asp创建网页桌面快捷方式的代码
2010/03/23 PHP
浅析十款PHP开发框架的对比
2013/07/05 PHP
php文件上传类完整实例
2016/05/14 PHP
PHP封装返回Ajax字符串和JSON数组的方法
2017/02/17 PHP
jQuery插件PageSlide实现左右侧栏导航菜单
2015/04/12 Javascript
JavaScript获取DOM元素的11种方法总结
2015/04/25 Javascript
jquery实现垂直和水平菜单导航栏
2020/08/27 Javascript
Sortable.js拖拽排序使用方法解析
2016/11/04 Javascript
bootstrap折叠调用collapse()后data-parent不生效的快速解决办法
2017/02/23 Javascript
浅谈Node.js轻量级Web框架Express4.x使用指南
2017/05/03 Javascript
Vue.js实现一个todo-list的上移下移删除功能
2017/06/26 Javascript
基于 Vue 的树形选择组件的示例代码
2017/08/18 Javascript
vue实现选项卡及选项卡切换效果
2018/04/24 Javascript
vue设计一个倒计时秒杀的组件详解
2019/04/06 Javascript
详解Vue-cli3.X使用px2rem遇到的问题
2019/08/09 Javascript
AntV F2和vue-cli构建移动端可视化视图过程详解
2019/10/08 Javascript
JS实现进度条动态加载特效
2020/03/25 Javascript
javascript中正则表达式语法详解
2020/08/07 Javascript
electron踩坑之dialog中的callback解决
2020/10/06 Javascript
在Linux下调试Python代码的各种方法
2015/04/17 Python
Python基础入门之seed()方法的使用
2015/05/15 Python
Python中的fileinput模块的简单实用示例
2015/07/09 Python
Python找出list中最常出现元素的方法
2016/06/14 Python
Python求一批字符串的最长公共前缀算法示例
2019/03/02 Python
详解python中自定义超时异常的几种方法
2019/07/29 Python
tensorflow 保存模型和取出中间权重例子
2020/01/24 Python
Matplotlib 绘制饼图解决文字重叠的方法
2020/07/24 Python
Python实现Appium端口检测与释放的实现
2020/12/31 Python
美体小铺印度官网:The Body Shop印度
2019/10/17 全球购物
美国精品地毯网站:Boutique Rugs
2020/03/04 全球购物
无工作经验者个人求职信范文
2013/12/22 职场文书
《我不是最弱小的》教学反思
2014/02/23 职场文书
党的群众路线教育学习材料
2014/05/12 职场文书
党员干部民主生活会议批评与自我批评材料
2014/09/20 职场文书
nginx前后端同域名配置的方法实现
2021/03/31 Servers
解决IIS7下无法绑定https主机的问题
2022/04/29 Servers