澳门新葡亰平台官网:angular连串学习笔记,你早晚是闲得蛋疼才重构的吗

你一定是闲得蛋疼才重构的吧

2018/07/25 · 基础技术 ·
重构

原文出处: 奇舞团 –
hxl   

随着“发布”进度条走到100%,重构的代码终于上线了。我露出了老母亲般的围笑……

最近看了一篇文章,叫《史上最烂的开发项目长啥样:苦撑12年,600多万行代码》,讲的是法国的一个软件项目,因为各种奇葩的原因,导致代码质量惨不忍睹,项目多年无法交付,最终还有公司领导入狱。里面有一些细节让人哭笑不得:一个右键响应事件需要花45分钟;读取700MB的数据,需要花7天时间。足见这个软件的性能有多糟心。

如果让笔者来接手这“坨”代码,内心早就飘过无数个敏感词。其实,笔者自己也维护着一套陈酿了将近7年的代码,随着后辈的添油加醋……哦不,添砖加瓦,功能逻辑日益复杂,代码也变得臃肿,维护起来步履维艰,性能也不尽如人意。终于有一天,我听见了内心的魔鬼在呼唤:“重构吧~~”

重构是一件磨人的事情,轻易使不得。好在兄弟们齐心协力,各方资源也配合到位。我们小步迭代了大半年,最后一鼓作气,终于完成了。今天跟大家分享一下这次重构的经验和收益。

现前端框架情况,
angular、vue(比较火)、react。react因前段时间license协议,百度要求内部停止使用react。

挑战

此次重构的对象是一个大型单页应用。它实现了云端文件管理功能,共有10个路由页面,涉及文件上传、音视频播放、图片预览、套餐购买等几十个功能。前端使用QWrap、jQuery、RequireJS搭建,HTML使用PHP模板引擎Smarty编写。

我们选择了Vue.js、vue-router、vuex来改造代码,用webpack完成模块打包的工作。仿佛一下子从原始社会迈向了新世纪,是不是很完美?

澳门新葡亰平台官网 1

(图片来自网络)

由于项目比较庞大,为了快速迭代,重构的过渡期允许新旧代码并存,开发完一部分就测试上线一部分,直到最终完全替代旧代码。

然鹅,我们很快就意识到一个问题:重构部分跟新增需求无法保证一致。比如重构到一半,线上功能变了……产品不会等重构完再往前发展。难不成要在新老代码中并行迭代相同的需求?

别慌,一定能想出更高效的解决办法。稍微分析一下,发现我们要处理三种情况:

1. 产品需要新增一个功能。比如一个活动弹窗或路由页面。

解决方法:新功能用vue组件实现,然后手动加载到页面。比如:

JavaScript

const wrap = document.createElement(‘div’)
document.body.appendChild(wrap) new Vue({ el: wrap, template: ‘<App
/>’, components: { App } })

1
2
3
4
5
6
7
const wrap = document.createElement(‘div’)
document.body.appendChild(wrap)
new Vue({
  el: wrap,
  template: ‘<App />’,
  components: { App }
})

如果这个组件必须跟老代码交互,就将组件暴露给全局变量,然后由老代码调用全局变量的方法。比如:

JavaScript

// someApp.js window.someApp = new Vue({ … methods: { funcA() { // do
somthing } } })

1
2
3
4
5
6
7
8
9
// someApp.js
window.someApp = new Vue({
  …
  methods: {
    funcA() {
      // do somthing
    }
  }
})

JavaScript

// 老代码.js … window.someApp.funcA()

1
2
3
// 老代码.js
window.someApp.funcA()

注意:全局变量名需要人工协调,避免命名冲突。PS:这是过渡期的妥协,不是最终状态

新增一个路由页面时更棘手。聪明的读者一定会想到让新增的路由页面独立于已有的单页应用,单独分配一个URL,这样代码会更干净。

假如新增的路由页面需要实现十几个功能,而这些功能已经存在于旧代码中呢?权衡了需求的紧急性和对代码整洁度的追求,我们再次妥协(PS:这也是过渡期,不是最终状态)。大家不要轻易模仿,如果条件允许,还是新起一个页面吧,心情会舒畅很多哦。

2. 产品需要修改老代码里的独立组件。

解决方法:如果这个组件不是特别复杂,我们会以“夹带私货”的方式重构上线,这样还能顺便让测试童鞋帮忙验一下重构后有没有bug。具体实现参考第一种情况。

3. 产品需要修改整站的公共部分。

我们的网站包含好几个页面,此次重构的单页应用只是其中之一。它们共用了顶部导航栏。在这些页面模板中通过Smarty的include语法加载:

JavaScript

{%include file=”topPanel.inc”%}

1
{%include file="topPanel.inc"%}

产品在一次界面改版中提出要给导航栏加上一些功能的快捷入口,比如导入文件,购买套餐等。而这些功能在单页应用中已经用vue实现了。所以还得将导航栏实现为vue组件。

为了更快渲染导航栏,需要保留它原有的标签,而不是在JS里以组件的形式渲染。所以需要用到特殊手段:

  • 在topPanel.inc里写上自定义标签,对应到vue组件,比如下面代码里的“。当JS未加载时,会立即渲染导航栏的常规标签以及自定义标签。

<div id=”topPanelMountee”> <div id=”topPanel”>
<div>一些页面直出的内容</div> … <import-button>
<button class=”btn-import”> 导入 </button>
</import-button> … </div> </div>

1
2
3
4
5
6
7
8
9
10
11
12
<div id="topPanelMountee">
  <div id="topPanel">
      <div>一些页面直出的内容</div>
      …
      <import-button>
        <button class="btn-import">
          导入
        </button>
      </import-button>
      …
  </div>
</div>
  • 导航栏组件:topPanel.js,它包含了ImportButton等子组件(对应上面的<import-button>)。等JS加载后,ImportButton组件就会挂载到<import-button>上并为这个按钮绑定行为。另外,注意下面代码中的template并不是<App />,而是一个ID选择器,这样topPanel组件就会以#topPanelMountee里的内容作为模板挂载到#topPanelMountee元素中,是不是很机智~

JavaScript

// topPanel.js new Vue({ el: ‘#topPanelMountee’, template:
‘#topPanelMountee’, components: { … ImportButton } })

1
2
3
4
5
6
7
8
9
// topPanel.js
new Vue({
  el: ‘#topPanelMountee’,
  template: ‘#topPanelMountee’,
  components: {
    …
    ImportButton
  }
})

彻底重构后,我们还做了进一步的性能优化。

新的框架层出不穷:它难吗?它写得快吗?可维护性怎样?运行性能如何?社区如何?前景怎样?好就业吗?好招人吗?组建团队容易吗?不管哪个,选择一个实践就好。

进一步优化

一、Angular 基础

1. HTML瘦身

在采用组件化开发之前,HTML中预置了许多标签元素,比如:

JavaScript

<button data-cn=”del” class=”del”>删除</button> <button
data-cn=”rename” class=”rename”>重命名</button> …

1
2
3
<button data-cn="del" class="del">删除</button>
<button data-cn="rename" class="rename">重命名</button>

当状态改变时,通过JS操作DOM来控制预置标签的内容或显示隐藏状态。这种做法不仅让HTML很臃肿,JS跟DOM的紧耦合也让人头大。改成组件化开发后,将这些元素统统删掉。

之前还使用了很多全局变量存放服务端输出的数据。比如:

<script> var SYS_CONF = { userName: {%$userInfo.name%} … }
</script>

1
2
3
4
5
6
<script>
    var SYS_CONF = {
        userName: {%$userInfo.name%}
        …
    }
</script>

随着时间的推移,这些全局变量越来越多,管理起来很费劲。还有一些已经废弃的变量,对HTML的体积做出了“贡献”。所以重构时只保留了必需的变量。更多数据则在运行时加载。

另外,在没有模板字面量的年代,HTML里大量使用了script标签存放运行时所需的模板元素。比如:

<script type=”text/template” id=”sharePanel”> <div
class=”share”> … </div> </script>

1
2
3
4
5
<script type="text/template" id="sharePanel">
    <div class="share">
        …
    </div>
</script>

虽然上线时会把这些标签内的字符串提取成JS变量,以减小HTML的体积,但在开发时,这些script标签会增加代码阅读的难度,因为要不停地切换HTML和JS目录查找。所以重构后删掉了大量的<script>标签,使用vue的<template>以及ES6的模板字面量来管理模板字符串。

1、AngularJS核心

澳门新葡亰平台官网 ,AngularJS 通过 指令 扩展了 HTML,且通过 表达式 绑定数据到
HTML。AngularJS核心是:MVVM、模块化、自动化双向数据绑定、语义化标签、依赖注入等等。

AngularJS更关注数据展示本身,更新时会尽可能减少对DOM的破坏和重构。
注:jQuery是dom驱动,AngularJS是数据驱动。

发表评论

电子邮件地址不会被公开。 必填项已用*标注