您可以捐助,支持我们的公益事业。

1元 10元 50元





认证码:  验证码,看不清楚?请点击刷新验证码 必填



  要资料 文章 文库 Lib 视频 Code iProcess 课程 认证 咨询 工具 讲座吧   成长之路  
会员   
 
   
 
  
每天15篇文章
不仅获得谋生技能
更可以追随信仰
 
 
     
   
 订阅
  捐助
使用Angular开发“云平台控制台”的实践总结
 
作者:lizeyang 来源:c博客 知识库 发布于:2016-8-18
来自于要资料   603 次浏览     评价:      
 

前言

笔者目前在互联网公司负责开发私有云平台。云平台控制台,是一个典型的管控CRUD系统,用于管理各种IaaS资源。为了让前端能达到仿客户端体验,同时保障代码架构清晰规范,易维护,最终我们选择了Angular(1.X)`作为云平台控制台的前端框架。本文主要围绕Angular,介绍我们在开发控制台过程中的点点滴滴。

1 为什么选择Angular

1.1 轻松构建SAP(single application page,单页面应用)

可以说,这是我们最终选择了Angular的重要原因,如果你希望构建一个结构清晰,可维护,开发效率高,体验好的单页应用,Angular是相当不错的一个框架。

单页面应用的魅力

什么是单页面应用?Single Page Application指一种基于web的应用或者网站,页面永远都是局部更新元素,而不是整页刷新。当用户点击某个菜单或者按键时,不会跳转到其他的页面,前端会从后端获取对应页面的数据而不是html,之后在页面中需要更新内容的地方,局部动态刷新,而如果是多页网站,当用户访问不同的页面时,服务器会直接返回一个html,然后浏览器直接将这个html展现给用户。现在大部分云控制台,都是单页应用架构,单页应用能带来一种更近似客户端,而不是网页的体验。

单页面应用网站,在体验方面,具有如下优点:

1. 做“页面跳转”时,永远都是局部动态刷新,用户不会感觉整个屏幕闪了一下,而是需要变化的区域做了局部刷新。例如两个不同的页面,假设页面元素都是一样的,只是元素中的文字不一样(例如每个页面都有一个面包屑,一排按钮及一个表格,这几个元素的布局也是一样的),当用户跳转到另外一个页面时,会看到整个页面并没有重新渲染,只是文字发生了变化。简单地说,这有点类似你在使用一个app,永远都是局部发生变化,你见过哪个app,当你点击到不同的功能视图时,整个屏幕会白屏闪一下的么?

2. URL可收藏,可回退。如果浏览器的url一直不变,那还不能称为真正的单页应用。不同的模块,不同的资源页面,对应的url是不一样的。当用户跳转到另外的功能时,会发现url会变成对应的url;通过回退键,也可以回到之前浏览的页面。这个特性有什么用呢?如果url不会随着功能而变化,当用户刷新当前页面时,就会回到之前的默认页面,而不是预期的当前功能页面,同样的,url也不具备可收藏性,因为点开之前收藏的url,永远都是网站的默认页面。这对一些强交互的管控系统来说,体验是不好的。

3. 功能切换时快速流畅。快速流畅主要因为两个原因:1、页面都是局部刷新,从用户感官来说更快;2、和后台通信的内容,都是数据,而不是页面模板,请求量更少;而传统的网站,在访问不同页面时,服务端返回的是html,体积更大,而且还需要一直重复加载js、css文件。

4. 因为网站的单页化,可以更好地使用一些全局类的交互(做页面切换时,可以一直保持不变的交互)。例如,页面上需要显示某次耗时操作的进度,例如上传文件进度,耗时操作的当前状态等,你可以在页面最右侧固定显示进度。当用户访问单页应用时,他会明白,当他点击其他模块时,这个右侧的通知栏不会消失,会固定显示。而如果是多页网站,用户则会困惑,担心自己跳转到其他页面后,这个进度通知就会消失。

为什么Angular是构建SAP的利器

SAP对于代码分层,结构清晰有更高的要求,而Angular是一个MV**框架,其自身的约定,减少了我们写出“一锅粥”代码的可能性(在下面讨论“编写更易维护的代码”时会详述)

Angular的著名第三方组件ui router,是一个控制页面路由的组件,它支持我们快速搭建单页应用(Angular本身的路由功能也可以,但功能会稍微弱一些)

1.2 编写更易维护的代码

很多人经常会抱怨,不同水平的人凑在一起写js,到最后项目经常就是一锅粥,同一个js文件里面,各种各样的逻辑都混在一起,要增删一个功能,都简直是恶梦。无规矩不成方圆。作为一个框架,Angular无疑能大大改善这种状况,使得项目整体的分层明了,职责清晰。

关注点分离

关注点分离是Angular的一大特点。所谓关注点分离,指的是各个逻辑层职责清晰,例如,当你需要修改甚至替换展现层时,你无需去关注业务层是怎么实现的。在Angular中,服务层(Ajax 请求)- 业务层(Controller)- 展现层(HTML 模板)- 交互层(animation)这些都有对应的基础组件。不同组件职责不同,你也很难将本属于B组件的职责放到A组件上去实现。举几个例子:

1. html及controller需要协同工作,但职责分明。视图、交互层面的逻辑,只能放到html模板中,controller只能用于数据初始化,它没有办法去操作dom元素(不用jquery的话)。这一点非常重要,传统的js代码,经常会出现的情况,就是js里面会有大量dom操作的逻辑,同时还有大量数据操作相关的逻辑,这些逻辑耦合到一起,当需要单独重构数据层或者视图层时,都会捉襟见肘,同时,由于代码量的迅速膨胀,维护起来也会很麻烦。

2. 你无法将后台通信逻辑放到controller中实现,而要放到factory中。后台通信逻辑,一般要做成公用的。而由于controller之间是不能相互调用的,所以你也不可能将后台通信逻辑放到其中一个controller,然后其他controller来调用这个controller暴露的接口。你唯一的办法,就是将后台通信逻辑放到factory或者service中。

3. filter及directive看似都可以用于数据转换,但实则不同。由于filter只能做数据格式化,不支持引入模板,所以公用的ui交互,涉及到dom元素或者需要引入html模板时时,你也只能通过directive来实现。

综上所述,Angular项目,其展现层、交互层的逻辑,都是在html或者指令中,服务层(后台通信),只适合出现在facoty(service)中,业务层,只能由controller来负责。这样每层的逻辑都是轻薄的,而不是纠结在一起。

如果你只是要优化展示逻辑,那你改改html就可以了,不用去管controller是怎么写的。这一点我们有亲身体会。项目开发过程中,我们重构了视觉效果,所有的html都要重写。但是,在重构时,我们的controller、后台通信(factory),filter基本都不用改,只要改html就行了。而如果项目是用jquery写的,显然是不可能做到这样的,你需要重新为新的html增加一些可供jquery选择器使用的class或id,然后你需要在js里面绑定事件,根据新的html、css的class等写新的交互效果,而在Angular上,这些事情,有些不用做了(例如为了jquery为html元素新增class,id、在js中绑定事件),有些(例如交互效果)则只要改html就行,而不是改js。

Angular为我们省去的代码量

代码臃肿、繁多也是JS代码混乱,难组织的原因之一。因此,实现同样的功能,代码量越少,抽象程度越高,在某种程度上意味着项目更方便维护。而能减少代码量,也是Angular被推崇的一大优点。让我们来看看,它是如何减少了代码量:

1. 首先,作为一个大而全的框架(双刃剑,有利有弊),Angular提供的诸多特性,使我们可以更专注于业务代码的编写。

2. 其次,Angular双向数据绑定的特性,将我们从大量的绑定代码中解放出来。和jquery对比,Angular不用为了选择某个元素,而刻意为htm加上一些跟样式无关的class,id;不用写一堆从html元素中取值,设值的代码;不用在js代码中绑定事件;不用在js值发生变化时写代码去更新视图html显示的值。双向数据绑定,让我们告别很多简单无趣的绑定事件、绑定值的代码。

3. directive、filter、factory等等,天然的就是一个个可以复用的组件,减少了冗余重复代码。一些需要公用的逻辑,如果放在controller中,都会相当别扭,就这样被Angular“逼着”,把公用逻辑都放到directive、filter、factory中去。

2 开发心得总结

2.1 我理解的Angular基础组件

化繁为简,几大基础组件的使用场景

首先我们需要理清Angular几个组件的使用场景。Angular的一个毛病,就是新概念,新特性太多,新手一下子要了解这么多,学习曲线略陡。为了帮助大家理解,总结下我理解的几大组件使用场景。

1. 请求资源与数据缓存的东西放进Factory。Factory、Service本质上都是Provider的语法糖,两者只是使用方式有所不同,建议大家直接都用Factory,免得两个概念纠缠不清。

2. 数据需要格式化的东西用filter处理。例如把status值转化为中文值,把时间戳转成时间字符串之类。

3. 需要公用的dom操作,放在指令中去写。另外,如果需要引入jquery组件,也可以写个指令把jquery组件初始化代码放进去。

4. controller与视图按照一对一的关系维护,在controller内主要初始化scope对象与在scope上添加方法(行为),为ViewModel做赋值。其他所有过程都不应该出现在 Controller 中。controller中不应该出现和页面展示、交互相关的代码。例如展示隐藏某些元素之类,这些应该是html模板或者指令负责。代码越薄越好。

5. 全局常量值放到constant

指令(directive)魔法

指令这个特性,用“魔法”一词来形容它,都不为过。

解决的痛点

一言以蔽之,指令提供了一套前端组件化的方法及约定,这使得编写,使用ui组件更加方便了。相对于jquery,它解决了以下痛点:

1. 动态生成了html元素后,不用再手动去为其加上js特性。举个栗子:html原生的checkbox框比较丑,在jquery时代,可以将checkbox替换成自定义的效果,如果是页面一开始就有的checkbox,我们可以在document.ready的时候调用自定义checkbox的初始化方法。但是,如果这个checkbox是动态生成的,在每个动态生成checkbox的地方,我们都得去调用checkbox的初始化方法,相当麻烦。但用了Angular的指令,就不会有这个问题了,只要在模板的chceckbox中加上指令,不管这个模板是动态变化的还是静态的,无需通过业务代码来逐个调用初始化方法,呈现给用户的,就已经是替换后的checkbox效果。

2. 一个组件的html和js,是一个整体,而不是割裂的。基于jquery的ui组件,其引入方法,不少是这样的,首先,要求你自己copy一段html,然后再调用初始化方法。而指令则支持定义对应的模板html,用户在引入时,可能只要写一个指令标签,就会自动生成N行的html及绑定对应的js效果。当然,理论上jquery也能做到这样,但是会比Angular的实现麻烦许多。

3. 应用、移除ui特性时方便直观。假设有这么一个需求,给一个普通输入框增加输入限制,只能输入特定字符(如字母数字),写好对应指令,只要给这个input输入框加上这个指令标签,就能马上应用这个特性,之后要移除,只要把标签去掉就好。相比之下,jquery就会麻烦多。jquery下,一般是通过元素选择器来绑定js效果。应用时,你需要考虑给对应的输入框指定一个合适的元素选择器。移除特性时,你要考虑:1、有可能你在多个地方都加了相同的初始化代码,这些js都需要移除;如果元素选择器用的是class,得考虑是不是其他输入框也有这个class,如果是,那么移除代码时也会影响到其他输入框。

技巧

如果你需要引入jquery组件,你可以写一个指令,然后在其中初始化该组件。

要注意require参数中的值是驼峰的,在html中就得转成对应的中划线命名,例如有require参数phoneKey,那么html中应为phone-key=”xxx”。虽然这个道理很浅显,但经常一不小心就会弄错了,然后发现在指令内部怎么着都拿不到require参数。

如果你在link中加了elm.bind(‘click’),当click回调函数中,作用域的值发生变化,记得调用scope.$apply(),否则值变化不会生效

2.2 文件、目录约定

目录结构

第三方库、css、图片放置到哪个目录,不在本文讨论范围,这里略过。需要进一步说明的,是业务代码目录。

.
├── pages
| ├── common
| | |── js
| | |── layout
| | └── template
| ├── 模块A,例如如firewall(云平台中的防火墙模块)
| | |── a.main.ctrl.js
| | |── a.main.html
| | |── a.create.ctrl.js
| | |── a.create.box.html
| | |── a.svr.js
| | └── a.fil.js
| └── 模块B,例如如disk(云平台中的硬盘模块)
└── index.html

我们将系统自身的js、html模板都放在pages目录,其中

- 子目录common:放置公用的js及模板

- 其他子目录,以功能模块名作为目录名,然后将这个模块相关的js及模板放在其中。这样开发同个模块功能时,可以方便地在html及对应js之间切换。有些代码规范可能还会建议在模块这一级目录下,再根据Angular的几大组件controller,filter,service等,创建不同的子目录,例如模块A/controller,模块A/service之类,我们则将所有js及html放在同一级,这样做主要有几个原因:

1. 我们的项目,平均每个模块只有10个文件,特别是每个模块一般只有一个filter及service,为了这一个文件创建一个目录,显得多此一举。

2. 通过文件名,已经可以很方便地区分不同的js组件类型及html模板类型,同时,由于IDE一般会按照文件名字母排序,所以相同功能的js及html会挨在一起,查找对应的模板或js代码会方便很多。

文件名约定

这个约定对于Angular来说,特别重要。具体的约定是:

模块名.功能.组件类型.文件后缀(如firewall.create.ctrl.js)

例如,为“防火墙”模块开发“创建防火墙”的功能,它的controller,对应的js为:firewall.create.ctrl.js,对应的html模板为:firewall.create.ctrl.html。为了文件名书写的方便,定义了组件的简写

- controller -> ctrl

- factory,service -> svr

- filter -> fil

- directive -> dire

这样约定有两个显而易见的优点:

1. 通过文件名,就能知道对应模块、Angular基本组件类型、是模板html还是js

2. 相同功能的js及html,会挨在一起(如果IDE是按照文件命名排序)

2.3 与后端服务器通信

根据后台接口规范,结合Angular自身能力,我们做了一些封装,使接口请求逻辑变得非常简单。具体问题具体分析,先看看我们的后台接口响应的标准格式是怎样的,前端会按照这个接口返回格式做一些定制:

{
errcode:0,
errmsg:"",
data:[
{
id:"test",
name:"test"
}
]
}

我们项目服务端的标准响应是一个json,通过errcode描述此次请求的结果码,通过errmsg描述出错的原因(假如请求出错的话),通过data返回正常数据。

出错处理

当接口返回的errno!=0时,说明接口返回异常(系统异常或用户输入错误),这时我们希望能弹框提示用户“出错了”。显然,如果在每个接口请求逻辑中,都去写这个逻辑,会非常累赘,所幸Angular提供了拦截器的功能,我们只要写一个拦截器,就可以对所有的异常返回做统一处理。

- 首先,我们需要显式地抛出http错误。因为当后台逻辑出错或者用户输入参数有误时,返回的HTTP状态码都是200(这只是我们项目的约定),Angular并不会认为200是出错的情况,因此,我们需要做点小动作。

 $httpProvider.defaults.transformResponse.push(function (responseData) {
if (responseData.errno != 0) {
throw responseData;
}
……
});

Angular的$httpProvider.defaults.transformResponse.push(下面简称transformResponse)函数,可以统一处理所有的http响应。在这里,我们就通过它捕获了所有errno!=0的请求,并往外抛一个exception

- 接着,我们需要在$httpProvider.interceptors捕获这个异常并弹框,代码如下

 $httpProvider.interceptors.push(function () {
return {
responseError: function (response) {
if (response) {
if (response.hasOwnProperty("errmsg")) {
if (response.errno > 0) {
alert(response.errmsg);
} else {
alert("系统维护中,请稍候重试");
}

}
else {
if (response.status == 404) {
alert("抱歉,后台服务出错,找不到对应的接口");
}
else {
alert("抱歉,后台服务出错");
}
}
}
}
}
});

有些人可能会问,为啥不直接在一开始的transformResponse函数中写错误处理逻辑呢?这是因为,某些异常情况,并不会调用transformResponse逻辑,例如,当url不存在时,web容器默认返回的404’页面’,或者当程序出错时,系统代码未处理这个错误,web容器会返回默认的500’页面”,这时均会直接进入interceptors的responseError中。因此,为了覆盖所有的异常情况,需要在transformResponse中抛出异常,然后由responseError统一处理。

响应内容格式化

由于前端关心的数据,是放在响应内容的data属性中。而另外两个属性errno、errmsg,当返回正常数据时,前端是不关心的,为了取数据时更加方便,可以进一步优化transformResponse中的处理。当errno==0时,都返回responseData.data,这样,在业务逻辑里面,就可以直接使用data了,而不用取xxx.data

$httpProvider.defaults.transformResponse.push(function (responseData) {
if (responseData && responseData.hasOwnProperty("errno")
&& responseData.hasOwnProperty("errmsg") && responseData.hasOwnProperty("data")) {
if (responseData.errno == 0) {
if (Angular.isArray(responseData.data) || Angular.isObject(responseData.data)) {
return responseData.data;
} else {
return responseData
}
}
else {
throw responseData;
}
}
else {
return responseData;
}
});

对$resource做进一步封装

项目中每个模块,都创建对应的svr文件,用于与后台进行通信。例如”硬盘”模块,对应DiskSvr,“防火墙“模块,对应FirewallSvr。这样划分后,前端所有的后台请求逻辑,都会很清晰易找。

在封装后台通信逻辑时,我们用到$resource,这是Angular自身的一个组件,当你的后台接口符合RESTFul规范时,你可以很方便地使用$resource和后台进行通信。而由于我们的后台并不是完整的RESTFul实现,我们需要做一些简单的封装。

app.factory("DiskSvr", function () {

var url = "schedule/disk";

var customAPI = {
clone: {
method: "post"
}
}

return getApi(url, customAPI);
});

//公用的,每个Svr都可以用
getApi = function (path, customAPI) {

Angular.forEach(customAPI, function (value, key) {
if (!value.url) {
value.url = util.connectPath(path, key);
} else {
value.url = util.connectPath(path, value.url);
}
});

//所有的
var defaultAPI = {
detail: {
url: baseUrl + "/get"
},
delete: {
url: baseUrl + "/delete",
method: "delete"
},
create: {
url: baseUrl + "/create",
method: "post"
},
update: {
url: baseUrl + "/update",
method: "put"
}
}

return $resource(path, {}, Angular.extend(defaultAPI, customAPI));
}

上面的代码,主要做了这些事情:

1. 为所有的svr注入了每个模块接口都必备的,最基础的增删改查四个接口。这样就无需在每个svr中加入这些接口。例如,在业务逻辑中调用DiskSvr.create(),就会用post请求调用schedule/disk/create接口。

2. 简化了新增接口的配置。新增一个接口,只要配置对应的http方法及名字即可。

3. 通过引用$resource组件、进一步封装及svr文件的约定,在业务controller中,不会看到任何的和后台通信的基础代码,如果在这个controller中你需要和后台通信,你只需注入响应的svr,然后调用对应方法即可。

注入请求header头

在我们的项目中,约定了所有的请求都要在header中带上一些相同的信息,这对Angular来说,是非常简单的事情:

执行以下代码后,之后所有的http请求都会带上名为project的header信息

$http.defaults.headers.common["project"] = "test";

2.4 controller间通信问题

controller调用

假设controllerA希望调用controllerB的某个函数,告诉同伴controller,我的某个你所关心的东西改变了,要怎么做呢?举具体业务场景,有两个controller,一个是主页controller,另外主页上有个弹框表单,这个弹框表单也有个controller,用户成功提交了这个表单后,弹框controller需要告知主页controller更新主页上的某项数据。

建议的做法,是用Angular的消息机制。例如,上面的例子中,弹框controller是主页controller的子controller。那么弹框controller可以往上冒泡传递消息

$scope.$emit(EVENT.MODAL_SUCEESS, {});

其父controller去捕获这个消息

$rootScope.$on(EVENT.MODAL_SUCEESS, function (event, args) {
//****
});

这是一种很好的解耦办法,假设这两个controller是由两个开发负责的,那么我开发我的controller,你开发你的,我不用去关心你那边的逻辑。

数据共享

多个controller之间要共享数据,要怎么做呢?

最简单但也不推荐的一个做法,就是把数据塞到rootscope中,但是,这就像js的全局变量,野蛮不好控制。

这里推荐下我们的做法:写一个专门用于存储、设置共享数据的共享数据facoty。在里面定义set方法,所有的共享变量,都需要经过set方法来设置。然后取数据则通过DATA变量获取。

伪代码如下:

app.factory('ShareSvr', function(){
var shareData = {
peopleNum
}
return {
DATA:shareData,
setPepleNum:function(num){
shareData.peopleNum = num;
}
}
});

app.controller('TestController',function(ShareSvr){
var self = this;
this.DATA = ShareSvr.DATA;
}

这里并没有要求DATA值只能通过get方法获取,是为了之后在controller对应的视图html中取值方便些。

2.5 第三方 库/资源 推荐

ui router

路由(route),几乎所有的MVC(VM)框架都应该具有的特性,它是前端构建单页面应用(SPA)必不可少的组成部分。相比原生的ngRouter,ui router功能更加强大,具备多视图,嵌套路由等特性,可以解决路由大部分的应用场景。

ngDialog

一个弹框控件,功能强大,我比较喜欢的地方,是它没有写死弹框的html、可以很方便地定义自己想要的弹框模板。例如,我们项目就通过它做了两种弹框,一种是普通弹框,一种是侧拉框(从屏幕右侧滑出,占满浏览器高度,宽度占满一半屏幕(或者其他自定义宽度)。

Angular代码规范

https://github.com/johnpapa/angular-styleguide/blob/master/a1/i18n/zh-CN.md

https://github.com/mgechev/Angularjs-style-guide/blob/master/README-zh-cn.md

Angular-filter

提供了很多实用的filter,string类、math类,集合类等等

w5c-validator

基于Angular.js原有的表单验证,统一验证规则和提示信息,在原有的基础上扩展了一些错误提示的功能,让大家不用在每个表单上写一些提示信息的模板,专心的去实现业务逻辑。国人出品

ng-table

轻量,功能强大的表格组件。可以很方便地修改表格的样式、交互效果。

   
 订阅
  捐助
相关文章 相关文档 相关课程



深度解析:清理烂代码
如何编写出拥抱变化的代码
重构-使代码更简洁优美
团队项目开发"编码规范"系列文章
重构-改善既有代码的设计
软件重构v2
代码整洁之道
高质量编程规范
基于HTML5客户端、Web端的应用开发
HTML 5+CSS 开发
嵌入式C高质量编程
C++高级编程
 

Android手机开发(一)
理解Javascript
非典型ajax实践
彻底的Ajax
javascript 使用Cookies
使用 jQuery 简化 Ajax 开发
更多...   

Struts+Spring+Hibernate
基于J2EE的Web 2.0应用开发
J2EE设计模式和性能调优
Java EE 5企业级架构设计
Java单元测试方法与技术
Java编程方法与技术

某航空公司IT部 JavaScript实践
某电视软件 HTML5和JavaScript
中航信 JavaScript高级应用开发
大庆油田 web界面Ajax开发技术
和利时 使用AJAX进行WEB应用开发
更多...   
 
 
 
 
 
每天2个文档/视频
扫描微信二维码订阅
订阅技术月刊
获得每月300个技术资源
 
 

关于我们 | 联系我们 | 京ICP备10020922号 京公海网安备110108001071号