代码整洁之道(重构)


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 Konami Code 实现代码
Jul 29 Javascript
基于jquery的Repeater实现代码
Jul 17 Javascript
Js切换功能的简单方法
Nov 23 Javascript
JavaScript执行效率与性能提升方案
Dec 21 Javascript
jquery入门—访问DOM对象方法
Jan 07 Javascript
js获取微信版本号的方法
May 12 Javascript
jQuery实现Tab菜单滚动切换的方法
Sep 21 Javascript
jquery判断密码强度的验证代码
Apr 22 Javascript
js实现input密码框提示信息的方法(附html5实现方法)
Jan 14 Javascript
点击页面任何位置隐藏div的实现方法
Sep 05 Javascript
vue 基于element-ui 分页组件封装的实例代码
Dec 10 Javascript
Vuerouter的beforeEach与afterEach钩子函数的区别
Dec 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
模拟OICQ的实现思路和核心程序(一)
2006/10/09 PHP
PHP自毁程序(慎用)
2015/07/09 PHP
php给图片添加文字水印方法汇总
2015/08/27 PHP
PHP实现补齐关闭的HTML标签
2016/03/22 PHP
详解CSS样式中的 !important * _ 符号
2021/03/09 HTML / CSS
jquery实现奇偶行赋值不同css值
2012/02/17 Javascript
JS分页效果示例
2013/10/11 Javascript
实例讲解JS中数组Array的操作方法
2014/05/09 Javascript
浅析Node在构建超媒体API中的作用
2014/07/30 Javascript
js函数与php函数的区别实例浅析
2015/01/12 Javascript
JS右下角广告窗口代码(可收缩、展开及关闭)
2015/09/04 Javascript
JavaScript中Window对象的属性及事件
2015/12/25 Javascript
JS插件overlib用法实例详解
2015/12/26 Javascript
使用AJAX实现Web页面进度条的实例分享
2016/05/06 Javascript
jQuery密码强度验证控件使用详解
2017/01/05 Javascript
echarts饼图扇区添加点击事件的实例
2017/10/16 Javascript
jquery获取transform里的值实现方法
2017/12/12 jQuery
vue自定义全局组件(自定义插件)的用法
2018/01/30 Javascript
JS实现字符串中去除指定子字符串方法分析
2018/05/17 Javascript
关于在vue 中使用百度ueEditor编辑器的方法实例代码
2018/09/14 Javascript
Vue面试题及Vue知识点整理
2018/10/07 Javascript
小程序根据手机机型设置自定义底部导航距离
2019/06/04 Javascript
Vue页面刷新记住页面状态的实现
2019/12/27 Javascript
用pickle存储Python的原生对象方法
2017/04/28 Python
Django中的CBV和FBV示例介绍
2018/02/25 Python
Selenium的使用详解
2018/10/19 Python
python爬虫之urllib库常用方法用法总结大全
2018/11/14 Python
浅谈keras中的Merge层(实现层的相加、相减、相乘实例)
2020/05/23 Python
Python使用pyenv实现多环境管理
2021/02/05 Python
全球虚拟主机商:HostGator
2017/02/06 全球购物
《最佳路径》教学反思
2014/04/13 职场文书
党员活动总结
2015/02/04 职场文书
碧霞祠导游词
2015/02/09 职场文书
新手必备之MySQL msi版本下载安装图文详细教程
2021/05/21 MySQL
Python编写nmap扫描工具
2021/07/21 Python
Jedis操作Redis实现模拟验证码发送功能
2021/09/25 Redis