YY游戲云平臺控制臺實踐詳解
大小:0.5 MB 人氣: 2017-10-11 需要積分:1
標簽:云平臺控制臺(1589)
導語:云平臺控制臺,是一個典型的管控CRUD系統,用于管理各種IaaS資源。為了使前端能達到仿客戶端體驗,同時保障代碼架構清晰規范,易維護,最終多玩YY選擇了AngularJS(1.x)作為云控制臺的前端框架。本文主要圍繞AngularJS(1.x),介紹多玩YY在開發控制臺過程中的點點滴滴。為什么選擇AngularJS
輕松構建單頁面應用
可以說,這是我們最終選擇AngularJS的重要原因,如果你希望構建一個結構清晰、可維護、開發效率高、體驗好的單頁應用,AngularJS是相當不錯的框架。
單頁面應用的魅力
什么是單頁面應用?單頁應用,指一種基于Web的應用或者網站,頁面永遠都是局部更新元素,而不是整頁刷新,給用戶的感覺就像整個網站都是一個頁面。當用戶點擊某個菜單或者按鍵時,不會跳轉到其他頁面,前端會從后端獲取對應頁面的數據而不是HTML,之后在頁面中需要更新內容的地方,局部動態刷新,而如果是傳統的多頁網站,當用戶訪問不同的頁面時,服務器會直接返回一個HTML,然后瀏覽器負責將這個HTML展現給用戶。目前,大部分云控制臺,都是單頁應用架構,單頁應用能帶來一種更近似客戶端,而不是網頁的體驗。單頁面應用網站,在體驗方面,具有如下優點:
做“頁面跳轉”時,永遠都是局部動態刷新,用戶不會感覺整個屏幕閃了一下,而僅僅是需要變化的區域做了局部刷新。例如兩個不同的頁面,假設頁面元素都是一樣的,只是元素中的文字不一樣(例如每個頁面都有一個面包屑,一排按鈕及一個表格,這幾個元素的布局也是一樣的),當用戶跳轉到另外一個頁面時,會看到整個頁面并沒有重新渲染,只是文字發生了變化。簡單地說,這有點類似使用App,永遠都是局部發生變化,你見過哪個App,當點擊到不同的功能視圖時,整個屏幕會白屏閃一下的么?
URL可收藏,可回退。如果瀏覽器的URL一直不變,那還不能稱為真正的單頁應用。不同的功能,不同的資源頁面,對應的URL是不一樣的。當用戶跳轉到另外的功能時,會發現URL會變成對應的值;通過回退鍵,也可以回到之前瀏覽的頁面。這個特性有什么用呢?如果URL不會隨著功能而變化,當用戶刷新當前頁面時,就會回到之前的默認頁面,而不是預期的當前功能頁面,同樣的,URL也不具備可收藏性,因為點開之前收藏的URL,永遠都是網站的默認頁面。這對一些強交互的管控系統來說,體驗不好。
功能切換時快速流暢。快速流暢主要因為兩個原因:一是頁面都是局部刷新,從用戶感官來說更快;二是和后臺通信的內容,都是數據,而不是頁面模板,請求量更少;而傳統網站,在訪問不同頁面時,服務端返回的是HTML,體積更大,而且還需要一直重復加載Java、CSS文件。
因為網站的單頁化,可以更好地使用全局類的交互(做頁面切換時,需要一直保持不變的交互)。例如,頁面上需要顯示某次耗時操作的進度,例如上傳文件進度,耗時操作的當前狀態等,你可以在頁面最右側固定顯示進度。當用戶訪問單頁應用時,他會明白,當點擊其他模塊時,這個右側的通知欄不會消失,會固定顯示。而如果是多頁網站,用戶則會困惑,擔心自己跳轉到其他頁面后,進度通知就會消失。
AngularJS是開發單頁應用的利器
單頁面應用對于代碼分層,結構清晰有更高的要求,而AngularJS是一個MVVM框架,其自身的約定,減少了我們寫出“一鍋粥”代碼的可能性(在下面討論“編寫更易維護的代碼”時會詳述)。
AngularJS的著名第三方組件UI-Router,是一個控制頁面路由的組件,它支持我們快速搭建單頁應用(AngularJS本身的路由功能也可以,但功能會稍微弱一些)。
AngularJS的檢查更新機制,使頁面刷新時更加快速自然。 當數據“可能”發生變化時,AngularJS會檢查出所有變化的元素,再“一次性”刷新所有變化的UI元素。
編寫更易維護的代碼
很多人經常會抱怨,不同水平的人湊在一起寫Java,到最后項目經常就是一鍋粥,同一個Java文件里面,各種各樣的邏輯都混在一起,要增刪功能,簡直是惡夢。無規矩不成方圓。作為框架,AngularJS無疑能大大改善這種狀況,使得項目整體的分層明了,職責清晰。在筆者看來,AngularJS能夠幫助我們編寫更易維護的代碼,一是因為其“關注點分離”的理念,二是因為其強大的特性為項目節省了不少代碼量,從而降低程序員犯錯的概率。
關注點分離
關注點分離是AngularJS的一大設計哲學。所謂關注點分離,指的是各個邏輯層職責清晰明確。例如,當你需要修改甚至替換展現層時,無需關注業務層是怎么實現的。在AngularJS中,服務層(Ajax請求)- 業務層(Controller)- 展現層(HTML 模板)- 交互層(animation)這些都有對應的基礎組件。不同組件職責不同,也很難將本屬于B組件的職責放到A組件上去實現。舉幾個例子:
HTML及Controller需要協同工作,但職責分明。視圖、交互層面的邏輯,例如展示隱藏某些元素,是HTML模板的職責,Controller只能用于數據初始化。如果你反其道而行,想在Controller中做HTML模板做的事情,將會非常別扭。這一點非常重要,傳統的Java代碼,經常會出現的情況,就是Java里面會有大量DOM操作的邏輯,同時還有大量數據操作相關的邏輯,這些邏輯耦合到一起,當需要單獨重構數據層或者視圖層時(例如項目UI改版),都會捉襟見肘,同時,由于Java代碼量的迅速膨脹,維護起來也會很麻煩。
你無法將后臺通信邏輯放到Controller中實現,而要放到Factory中。后臺通信邏輯,一般要做成公用的。而由于Controller之間是不能相互調用的,所以你也不可能將后臺通信邏輯放到其中一個Controller,然后其他Controller來調用這個Controller暴露的接口。唯一的辦法,就是將后臺通信邏輯放到Factory或者Service中。
Filter及Directive看似都可以用于數據轉換,但實則不同。由于Filter只能做數據格式化,不支持引入模板,所以公用的UI交互,涉及到DOM元素或者需要引入HTML模板時時,也只能通過Directive來實現。
綜上所述,AngularJS項目,其展現層、交互層的邏輯,都是在HTML或者指令中,服務層(后臺通信),只適合出現在Factory(或者Service)中,而業務層則由Controller來負責。這樣每層的邏輯都是輕薄的,而不是糾結在一起。 如果你只是要優化展示邏輯,那改改HTML就可以了,不用去管Controller是怎么寫的。這一點我們有親身體會。項目開發過程中,我們重構了視覺效果,所有的HTML都要重寫。但在重構時,我們的Controller、后臺通信(Service)、Filter基本都不用改,只要改HTML就行了。而如果項目是用jQuery寫的,顯然不可能做到,你需要重新為新的HTML增加一些可供jQuery選擇器使用的class或id,然后需要在Java里面綁定事件,根據新的CSS樣式名來寫新的交互效果,而在AngularJS上,有些不用做了(例如為了jQuery選擇器,而為HTML元素增加新的class、id;在Java中綁定事件),有些(例如交互效果)則只要改HTML就行,而不是改Java。
AngularJS為我們省去的代碼量
對于任何項目來說,代碼臃腫、冗余是可維護性的天敵。因此,實現同樣的功能,代碼量越少,抽象度越高,冗余度越低,在某種程度上意味著項目更方便維護。而能減少代碼量,也是AngularJS被推崇的一大優點。讓我們來看看,它是如何減少了代碼量的:
首先,作為一個大而全的框架(雙刃劍,有利有弊),AngularJS提供的諸多特性,使我們可以更專注于業務代碼的編寫。
其次,AngularJS雙向數據綁定的特性,將我們從大量的值綁定代碼中解放出來。和jQuery對比,AngularJS不用為了選擇某個元素,而刻意為HTML加上一些跟樣式無關的class、2-2-2. id;不用寫一堆從HTML元素中取值,設值的代碼;不用在Java代碼中綁定事件;不用在Java值發生變化時寫代碼去更新HTML對應的值。雙向數據綁定,讓我們告別很多簡單無趣的綁定事件、綁定值的代碼。
Directive、Filter、Factory等,天然的就是一個個可以復用的組件,減少了冗余重復代碼。一些需要公用的邏輯,如果放在Controller中,都會相當別扭,就這樣被AngularJS“逼著”,把公用邏輯都放到Directive、Filter、Factory中去。
開發心得總結
我理解的AngularJS基礎組件
化繁為簡,幾大基礎組件的使用場景
首先我們需要理清AngularJS幾個組件的使用場景。AngularJS的一個毛病,就是新概念,新特性太多,新手一下子要了解這么多,學習曲線略陡。為了幫助大家理解,總結下我理解的幾大組件使用場景。
請求資源與數據緩存的東西放進Service。Factory、Service本質上都是Provider的語法糖,兩者只是使用方式有所不同,建議大家直接都用Service,ES6 class更容易,之后想平滑遷移到Angular2也會更容易,同時也能避免團隊成員在選擇Service還是Factory時產生困惑。
數據需要格式化的東西用Filter處理。例如把status值轉化為中文值,把時間戳轉成時間字符串之類。
需要公用的DOM操作,放在指令中去寫。另外,如果需要引入jQuery組件,也可以寫個指令把jQuery組件初始化代碼放進去。
Controller與視圖按照一對一的關系維護,在Controller內初始化Scope對象與在Scope上添加方法(行為),為ViewModel做賦值。其他所有過程都不應該出現在Controller中。Controller中不應該出現和頁面展示、交互相關的代碼。例如展示隱藏某些元素之類,這些應該是HTML模板或者指令負責。代碼越薄越好。
全局常量值放到Constant。
指令(Directive)魔法
指令這個特性,用“魔法”一詞來形容它,都不為過。
解決的痛點:一言以蔽之,指令提供了一套前端組件化的方法及約定,這使得編寫,使用UI組件更加方便了。相對于jQuery,它解決了以下痛點:
動態生成了HTML元素后,不用再手動去為其加上Java特性。舉個例子:HTML原生的checkbox框比較丑,在jQuery時代,可以將checkbox替換成自定義的效果,如果是頁面一開始就有的checkbox,我們可以在document.ready的時候調用自定義checkbox的初始化方法。但是,如果這個checkbox是動態生成的,在每個動態生成checkbox的地方,我們都得去調用checkbox的初始化方法,相當麻煩。但用了AngularJS的指令,就不會有這個問題了,只要在模板的chceckbox中加上指令,不管這個模板是動態變化的還是靜態的,無需通過業務代碼來逐個調用初始化方法,呈現給用戶的,就已經是AngularJS替換后的checkbox效果。
一個組件的HTML和Java,是一個整體,而不是割裂的(題外話,這一點React做得比Angular1.x還要好)。基于jQuery的UI組件,其引入方法,經常是這樣的,首先,要求你自己copy一段指定的HTML,然后再調用初始化方法。而指令則支持定義對應的模板HTML,用戶在引入時,可能只要寫一個指令標簽,就會自動生成N行的HTML及綁定對應的Java效果。當然,理論上jQuery也能做到這樣,但是會比Angular的實現麻煩許多。
應用、移除UI特性時方便直觀。假設有這么一個需求,給一個普通輸入框增加輸入限制,只能輸入特定字符(如字母數字),寫好對應指令,只要給這個input輸入框加上這個指令標簽,就能馬上應用這個特性,之后要移除,只要把標簽去掉就好。相比之下,jQuery就會麻煩多。jQuery下,一般是通過元素選擇器來綁定Java效果。因此,在添加該特性時,你需要考慮給對應的輸入框指定一個合適的元素選擇器。移除特性時,你要考慮:有可能你在動態生成輸入框的地方,都加了這些初始化代碼,這些Java都需要移除;如果元素選擇器用的是class,得考慮是不是其他輸入框也有這個class,如果是,那么移除代碼時也會影響到其他輸入框。
技巧
如果你迫不得已需要引入jQuery組件,你可以寫一個指令把它包裝起來,在該指令中初始化組件。
要注意require參數中的值是駝峰的,在HTML中就得轉成對應的中劃線命名,例如有require參數phoneKey,那么HTML中應為phone-key=”xxx”。雖然這個道理很淺顯,但經常一不小心就會弄錯了,然后發現在指令內部怎么著都拿不到require參數。
如果你在link中加了elm.bind(‘click’),當click回調函數中,作用域的值發生變化,記得調用scope.$apply(),否則值變化不會生效。
文件、目錄約定
目錄結構
第三方庫、CSS、圖片放置到哪個目錄,不在本文討論范圍,這里略過。需要進一步說明的,是業務代碼目錄。
我們將系統自身的Java、HTML模板都放在pages目錄,其中子目錄common放置公用的Java及模板;其他子目錄,以功能模塊名作為目錄名,然后將這個模塊相關的Java及模板放在其中。這樣開發同個模塊功能時,可以方便地在HTML及對應Java之間切換。有些代碼規范可能還會建議在模塊這一級目錄下,再根據AngularJS的幾大組件Controller、Filter、Service等,創建不同的子目錄,例如模塊A/controller,模塊A/service之類,我們則將所有Java及HTML放在同一級,這樣做主要有幾個原因:
我們的項目,平均每個模塊只有十來個文件,特別是每個模塊一般只有一個Filter及Service,為了這一個文件創建一個目錄,顯得多此一舉。
通過文件名,已經可以很方便地區分不同的Java組件類型及HTML模板類型,同時,由于IDE一般會按照文件名字母排序,所以相同功能的Java及HTML會挨在一起,查找對應的模板或Java代碼會方便很多。
文件名約定
這個約定對于Angular來說,特別重要。具體的約定是:
例如,為“防火墻”模塊開發“創建防火墻”的功能,它的Controller,對應的Java為:firewall.create.ctrl.js,對應的HTML模板為:
firewall.create.ctrl.HTML。為了文件名書寫的方便,定義了組件的簡寫:controller -》 ctrl ;factory,service -》 svr ; filter-》 fil ; directive -》 dire。
這樣約定有兩個顯而易見的優點:
通過文件名,就能知道對應模塊、AngularJS基本組件類型、是模板HTML還是Java 。
相同功能的Java及HTML,會挨在一起(如果IDE是按照文件命名排序)。
與后端服務器通信
根據后臺接口規范,結合AngularJS自身能力,我們做了一些封裝,使接口請求邏輯變得非常簡單。具體問題具體分析,先看看我們的后臺接口的標準響應格式是怎樣的,前端會按照這個接口返回格式做一些定制:
{ errno:0, errmsg:“”, data:[ { id:“test”, name:“test”} ] }
我們項目服務端的標準響應是一個json,通過errno描述此次請求的結果碼,通過errmsg描述出錯的原因(假如請求出錯的話),通過data返回正常數據。
出錯處理
當接口返回的errno!=0時,說明接口返回異常(系統異常或用戶輸入錯誤),這時我們希望能彈框提示用戶“出錯了”。顯然,如果在每個接口請求邏輯中,都去寫這個邏輯,會非常累贅,所幸AngularJS提供了攔截器的功能,我們只要寫一個攔截器,就可以對所有的異常返回做統一處理。 首先,我們需要顯式地拋出HTTP錯誤。因為當后臺邏輯出錯或者用戶輸入參數有誤時,返回的HTTP狀態碼都是200(這只是我們項目的約定),AngularJS并不會認為200是出錯的情況,因此,我們需要做點小動作。
$httpProvider.defaults.transformResponse.push(function(responseData){if(responseData.errno != 0) { throwresponseData; } …… });
AngularJS的$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函數中寫錯誤處理邏輯呢?這是因為,接口正常時,AngularJS會依次調用transformResponse函數,再調用interceptors的responseError。但是,某些異常情況,并不會調用transformResponse邏輯,例如,當URL不存在時,Web容器默認返回的404頁面,或者當程序出錯時,系統代碼未處理這個錯誤,Web容器會返回默認的500頁面,這時均會直接進入interceptors的responseError中。因此,為了覆蓋所有的異常情況,需要在transformResponse中拋出異常,然后由responseError統一處理。
2 響應內容格式化
由于前端關心的數據,是放在響應內容的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)) { returnresponseData.data; } else{ returnresponseData } } else{ throwresponseData; } } else{ returnresponseData; } });
3 對$resource做進一步封裝
項目中每個模塊,都創建了對應的service文件,用于與后臺進行通信。例如“硬盤”模塊,對應DiskSvr,“防火墻“模塊,對應FirewallSvr。這樣劃分后,前端所有的后臺請求邏輯,找起來會很方便。
在封裝后臺通信邏輯時,我們用到$resource,這是AngularJS自身的一個組件,當你的后臺接口符合RESTFul規范時,你可以很方便地使用resource和后臺進行通信。而由于我們的后臺并不是完整的RESTFul實現,我們需要做一些簡單的封裝。示意代碼如下:
app.factory(“DiskSvr”, function(){varurl = “schedule/disk”; varcustomAPI = { clone: { method: “post”} } returngetApi(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); } }); //所有的vardefaultAPI = { 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)); }
上面的代碼,主要做了這些事情:
為所有的svr注入了每個模塊接口都必備的,最基礎的增刪改查四個接口。這樣就無需在每個svr中加入這些接口。例如,在業務邏輯中調用DiskSvr.create(),就會用post請求調用schedule/disk/create接口。
簡化了新增接口的配置。新增一個接口,只要配置對應的HTTP方法及名字即可。
通過引用$resource組件、進一步封裝及svr文件,在業務Controller中,不會看到任何的和后臺通信的基礎代碼,如果在這個Controller中你需要和后臺通信,你只需注入響應的svr,然后調用對應方法即可。
4 注入請求header頭
在我們的項目中,約定了所有的請求都要在header中帶上一些相同的信息,這對AngularJS來說,是非常簡單的事情: 執行以下代碼后,之后所有的HTTP請求都會帶上名為project的header信息:
Controller間通信問題
Controller調用
假設controllerA希望調用controllerB的某個函數,告訴同伴Controller,我的某個你所關心的東西改變了,要怎么做呢?舉具體業務場景,有兩個Controller,一個是主頁Controller,另外主頁上有個彈框表單,這個彈框表單也有個Controller,用戶成功提交了這個表單后,彈框Controller需要告知主頁Controller,“哥們,請更新主頁上的某項數據”。建議的做法,是用AngularJS的消息機制。例如,上面的例子中,彈框Controller是主頁Controller的子Controller。那么彈框Controller可以往上冒泡傳遞消息:
其父Controller去捕獲這個消息:
這是一種很好的解耦辦法,假設這兩個Controller是由兩個開發負責的,那么我開發我的Controller,你開發你的,我不用去關心你那邊的邏輯。
2 數據共享
多個Controller之間要共享數據,要怎么做呢? 最簡單但也不推薦的一個做法,就是把數據塞到rootscope中,但是,這就像Java的全局變量,野蠻不好控制。 這里推薦下我們的做法:寫一個專門用于存儲、設置共享數據的共享數據Facoty。在里面定義set方法,所有的共享變量,都需要經過set方法來設置。然后取數據則通過DATA變量獲取。 偽代碼如下:
app.factory(‘ShareSvr’, function(){varshareData = { peopleNum } return{ DATA:shareData, setPepleNum:function(num){shareData.peopleNum = num; } } }); app.controller(‘TestController’,function(ShareSvr){varself = this; this.DATA = ShareSvr.DATA; }
這里并沒有要求DATA值只能通過galert(“Hello CSDN”);et方法獲取,是為了之后在Controller對應的視圖HTML中取值方便些。
第三方 庫/資源 推薦
UI Router
路由(route),幾乎所有的MVC框架都應該具有的特性,它是前端構建單頁面應用(SPA)必不可少的組成部分。相比原生的ngRouter,UI Router功能更加強大,具備多視圖,嵌套路由等特性,可以解決路由大部分的應用場景。
ngDialog
一個彈框控件,功能強大,我比較喜歡的地方,是它沒有寫死彈框的HTML、可以很方便地定義自己想要的彈框模板。例如,我們項目就通過它做了兩種彈框,一種是普通彈框,一種是側拉框(從屏幕右側滑出,占滿瀏覽器高度,寬度占滿一半屏幕(或者其他自定義寬度)。
Angular-filter
提供了很多實用的filter,string類、math類,集合類等。
w5c-validator
基于Angular.js原有的表單驗證,統一驗證規則和提示信息,在原有的基礎上擴展了一些錯誤提示的功能,讓大家不用在每個表單上寫一些提示信息的模板,專心的去實現業務邏輯,國人出品。
ng-table
輕量,功能強大的表格組件。可以很方便地修改表格的樣式、交互效果。
?
非常好我支持^.^
(0) 0%
不好我反對
(0) 0%