《Web前端开发最佳实践》——2.2 前端代码重构

2.2 前端代码重构

代码重构是业内经常讨论的一个热门话题。重构指的是在不改变代码外部行为的情况下进行源代码修改,重构之前需要考虑的是重构后如何才能保证外部行为不改变。对于后端代码来说,可以通过大量的自动化测试来确保重构后的代码逻辑,可对于普遍缺乏自动化测试的前端代码来说,重构之前一定要考虑再三才能下手。
我曾经有一次不算太成功的前端重构经历,所幸的是没有导致太大的问题,但教训是惨痛的。此次重构的项目本身没有足够的自动化测试,尤其是针对前端的自动化测试,其实在重构之前也预想到了重构的风险。先来介绍重构之前项目存在的问题:项目的前端代码没有统一的规范,不同人员开发的模块对应的代码风格完全不同,即使有相同的逻辑也是由完全不同的代码实现的;而且,不同模块的代码写到了相同的代码文件中,使得文件的代码量很大;项目的功能较多,前端代码量大,代码的文件也多,又由于需求变更频繁,因此代码中的无用代码量较大;网站首页加载时间过长,平均加载时间超过5秒;部分动态模块的加载会导致页面“假死”。总体来说,项目代码存在的问题就是维护性差和性能差,如果要持续地添加新功能,就有必要重构现有的代码。
鉴于项目代码的实际情况,并且考虑到缺乏足够的自动化测试,因此,我权衡再权衡,最终决定先尝试对前端的部分代码进行重构。重构的过程主要分为如下几个步骤。
1)删除无用代码,精简代码。无用的代码主要集中在CSS和JavaScript文件中,包括已经不起作用的CSS样式和废弃的JavaScript函数。这个重构过程是比较麻烦的,因为修改的过程需要小心翼翼,不停地查看函数和变量在上下文的调用关系,以免错删代码。总体来说,这个阶段的重构还是利大于弊,虽然后续发现了一些由于误删而导致的Bug,但是删除了废弃的代码,提高了后续的可维护性。
2)前端代码规范化。页面的HTML标签中还有大量的内联CSS样式,有些页面的head部分也有CSS样式,需要把这些CSS放到独立的文件中;调整代码的层次缩进格式,不同层级按照4个空格来缩进;更改标准已不推荐的标签,如< center >、< b >等,改为由CSS样式控制;统一命名规则,这里主要涉及HTML中的id和class名称;另外,在JavaScript中集中定义局部变量,并把部分全局变量转变为局部变量,缩小变量的作用域。
3)整理基础类库。网站初期为了加快开发的进度而引入了多个框架,其中包括Ext JS、jQuery以及多个jQuery插件。Ext JS和jQuery中重复的功能较多,项目中很多相同的实现使用的是不同类库中的功能,如DOM选择、AJAX请求等。部分jQuery的UI插件的功能也和Ext JS中的功能重复。鉴于项目的状况,只能保守选择同时保留Ext JS和jQuery。重构的内容是统一UI插件的使用、统一基础方法的使用。
4)前端代码模块化。按照模块归类CSS代码,放到模块对应的单独CSS文件中;按照模块分离JavaScript代码,按照模块定义不同的命名空间;将JavaScript代码中的公共方法归类到独立的共通文件中,同时引入面向对象的思想来重构JavaScript代码,进一步明确公有接口和私有接口。
5)提高页面加载性能。将部分不影响首页展示的JavaScript文件延迟到页面加载后加载;删除页面中初始隐藏的区域,改为通过JavaScript按需动态生成;页面中的部分图片延迟加载;调整CSS和JavaScript文件的引用顺序,即CSS在前JavaScript在后;给静态文件设置缓存;使用CSS Sprite,合并首页背景图;合并和压缩发布后的CSS和JavaScript代码文件。
从上面的重构内容可以看到,这次重构的目的是明确的,即提高前端代码的可维护性和性能。从中也暴露了重构过程中的一些问题:最主要的问题还是低估了重构的风险,导致后续发现了不少新Bug;没有足够的自动化测试,而冒然去修改代码,很难保证最终修改代码的正确性;其次是对于性能优化,事先没有量化,没有做任何性能方面的监控,没有抓住性能主要的瓶颈,所以性能部分的重构就显得比较盲目。
有了这次的重构实践经历,再加上学习业内的一些经验,我归纳了如下的前端重构最佳实践。

  • 重构前一定要预估风险,如果没有足够的自动化测试,最好是先完善自动化测试代码。
  • 重构的目的和范围要明确,切忌盲目修改。前端代码的重构目的主要是提高代码的可维护性、可读性和性能。
  • 最好是先易后难,循序渐进。首先修改诸如命名、格式等不涉及具体逻辑的内容,然后考虑模块化和性能提升等与具体逻辑相关的内容。
  • 重构过程中要持续测试,在多个浏览器中测试,确保重构的部分功能正确。切忌在大量重构后再进行测试,因为大量重构后基本很难记得重构的逻辑,也就有可能遗漏部分测试用例。
  • 如果是性能提升,要事先检测网站的整体性能并量化,找出性能瓶颈。重构过程中要持续监控性能,并对比性能提升的效果。
时间: 2024-08-31 22:11:43

《Web前端开发最佳实践》——2.2 前端代码重构的相关文章

《Web前端开发最佳实践》——第2章 高效Web前端开发2.1 前端代码的结构组织和文件的命名

第2章 高效Web前端开发 本章首先将概述Web前端开发中的相关最佳实践,如前端代码文件组织.前端代码重构.前端框架的选择,以及前端开发过程中实用的开发辅助工具等,帮助读者提高前端开发的效率.好的开发方式在项目中会起到事半功倍的效果,并且可确保开发过程中的代码结构清晰,易维护.本章然后会介绍前端代码的基本命名规范和格式规范,良好的命名规范和规整的格式让代码看起来干净整洁,也体现了开发者良好的职业素养,应该说命名规范.整齐的格式不仅是开发过程中的一种约定,而且是程序员之间良好沟通的桥梁. 2.1

《Web前端开发最佳实践》——3.7 添加必要的&lt; meta&gt;标签

3.7 添加必要的< meta>标签 < meta >标签放置在HTML页面的head中,主要用于标识网站.其中基本上包含了网站的一些描述信息,如简介.作者等.这些信息有助于搜索引擎更准确地识别网页的内容,也有助于第三方工具抓取网站基本信息. 按照W3C的标准介绍,< meta>元素有4个属性:name.http-equiv.content和charset.< meta>标签通过name属性来表述页面文档的元信息,通过http-equiv属性设置HTTP请求

《Web前端开发最佳实践》——导读

前 言 Web前端开发入门难度并不高,但是初学者如果没有一个很好的学习和编码习惯,则开发水平的提高速度会变得很慢.下面几点是影响Web前端开发者技术提高的主要因素. 其一是开发者缺乏良好的实践指导.Web前端兴起的时间不长,很多大学都还没有来得及开一门专门讲解Web前端的课程,因此,大部分的Web前端开发者都是通过自学的方式来了解Web前端相关的技术.开发者学习前端技术的渠道很多,其中很大一部分是通过查找网络资源的方式,而网络上充斥着大量的错误或者过时的实践方法,这些实践方法很容易误导初学者,使

《Web前端开发最佳实践》——3.5 样式与结构分离

3.5 样式与结构分离 网页的结构.表现和行为分离是W3C制定的Web页面标准的精髓,一般的页面结构和表现对应着代码中的HTML和CSS,这意味着在页面中HTML和CSS分离是符合标准的做法.在讨论页面中HTML和CSS组合的最佳实践之前,先来简单说明一下HTML和CSS所有的组合方式.把CSS样式应用于HTML总共有4种方式.(1)在HTML页面中链接一个CSS文件文件以link的形式添加到 部分,在link中可以设置media 属性来表明样式使用的场景.例如,media设置为screen表示

《Web前端开发最佳实践》——2.5 Web前端代码开发和调试

2.5 Web前端代码开发和调试 2.5.1 Web前端集成开发环境 很多集成开发环境(IDE)都集成了前端代码IDE,如Visual Studio.Eclipse等,但在纯粹的前端开发中,这些IDE显得不够强大而且不够轻量.这里推荐两款强大的IDE:Aptana Studio和WebStorm. Aptana Studio是一个开源的Web开发工具,有非常强大的JavaScript编辑器和调试器(见图2-4).它的主要特性包括: JavaScript函数.HTML及CSS的Code Assis

《Web前端开发最佳实践》——2.3 合理使用前端框架

2.3 合理使用前端框架 JavaScript本身是一种很强大的脚本语言,但是JavaScript固有的灵活性和由于使用多浏览器而产生的复杂性,在使用时并不能得心应手.此种状况下,JavaScript框架的重要性就显现出来了.JavaScript框架是JavaScript代码的工具集和函数集,一般包括DOM元素操作.DOM事件的封装.AJAX操作.UI控件封装以及一些功能算法的扩展等,如string.array等的功能扩展.好的JavaScript框架已经经过了大量的功能测试.性能测试,也经过了

《Web前端开发最佳实践》——1.3 规范的Web前端代码:更易维护、更高性能和更安全

1.3 规范的Web前端代码:更易维护.更高性能和更安全 规范的代码,这是所有软件开发中对代码的基本要求,前端开发也是一样的,要求编写规范的HTML.CSS和JavaScript代码. 什么样的前端代码才能称得上规范的代码?探讨这个问题之前,首先需要强调的是规范不是标准,不是放之四海而皆准的,不同的项目中的代码规范是有可能有差异的,比如命名,有些项目规定HTML标签的id必须要以控件的缩写名作为前缀,如按钮的id名以"btn"作为前缀,有些只是规定命名有意义就可以.再比如有些项目规定J

《Web前端开发最佳实践》——第3章 标准的HTML代码3.1 验证代码是否符合标准

第3章 标准的HTML代码 标准的HTML代码指的是HTML代码符合W3C的最新标准,而在页面的HTML代码中包含有任何规范之外的或者是不推荐的标签和属性都是不符合标准的.W3C定义了所有规范的HTML标签及其属性,目前正式的版本是HTML5,HTML5中定义的大部分内容已经被所有的高级浏览器支持,所以并不妨碍在页面中使用这些已经广泛被支持的新标签和新属性.本章将贴近W3C标准,介绍如何构建标准的页面HTML代码. 3.1 验证代码是否符合标准 一个符合W3C标准的网页会有什么重要的意义呢?这是

《Web前端开发最佳实践》——1.2 Web前端开发现状

1.2 Web前端开发现状 前端开发虽然起步时间晚,但是发展势头迅猛,在各种新技术.新标准的推动下,各大互联网公司也开始重视Web产品的前端重构与开发,如淘宝.腾讯.新浪.百度.搜狐等都对自己的网站进行了重构并同时使用了HTML5中的新特性.现在开发的Web新产品的页面交互也越来越丰富,视觉效果也越来越绚丽.互联网公司除了重视前端开发之外,还在积极推动互联网技术的发展,2001-2012年,腾讯.百度及奇虎360公司先后加入了万维网联盟(W3C),共同参与互联网技术标准的研究和制定,促进了国内互