本文記錄一個團隊把大型前端應用從「包著 Angular 的 jQuery 程式」重寫為「真正 Angular 風格」的過程,以及其中幾個必須修正的習慣。
在經歷幾個月的 Angular 開發之後,很難想像沒有資料綁定框架該怎麼寫一個大型前端應用。我們做的是瀏覽器內的圖像編輯器,同一份資料需要以好幾種完全不同的方式呈現:圖層以圖形佔據畫面主體,同時也列在面板清單裡;選取某個圖層時,它的邊緣會出現虛線框,同時清單中的該項會高亮;面板中的圖層尺寸還取決於畫布大小;而面板本身可拖曳、可折疊、可關閉。
若沒有像 Angular 這樣的框架,這種互動密度、資料連動與視圖同步很快就會變成噩夢。改一處模型、所有相關視圖自動更新——聽起來像作弊,但確實如此。新增或刪除一個圖層只是改動一個物件,layer.x += 10 就結束了,不必手動作廢視圖、也不必逐一遍歷 DOM 去修改每個實例。

我們甚至做了鍵盤快捷鍵系統:每個快捷鍵連同它的說明都註冊進一個服務,於是能自動列出「所有快捷鍵及其描述」的說明條;另外還寫了一個 directive,把個別 DOM 元素與快捷鍵綁定,滑鼠停留時跳提示。

甚至連「把 DOM 狀態變成可回溯的歷史紀錄」這種事也做得出來,而且運作良好。老實說,那已經不太像在寫一個網頁,網頁只是媒介而已。
當然,這過程並不總是順利,基本程式碼很容易失控成一團。我們花了幾週重寫整個前端架構,以下是我們修正的幾個典型問題。
這是初學者常犯的寫法:
// 結果會掛在 window.LoginCtrl 上
var LoginCtrl = function ($scope, dep1, dep2) {
// scope 預設值
};
LoginCtrl.prototype.resetPassword = function () {
// 重設密碼按鈕的處理器
};
LoginCtrl.$inject = ['$scope', 'dep1', 'dep2'];
這段程式碼沒有包在閉包裡,所有宣告都落在全域的 window 上。正確做法是使用 Angular 提供的 module API——值得注意的是,當時的官方文件本身也還在推薦全域寫法:
// Angular.js 文件中的範例
var XmplController = function ($scope, greeter, user) {
$scope.greeting = greeter.greet(user.name);
}
改用模組之後:
angular.module('myApp').controller('loginCtrl', [
'$scope', 'dep1', 'dep2',
function ($scope, dep1, dep2) {
'use strict';
// scope 預設值
$scope.resetPassword = function () {
// 重設密碼按鈕的處理器
};
}
]);
用模組式 controller 有個附帶好處:因為處處都需要依賴注入,你會自然地把所有檔案包成自調用函式表達式 (function () { ... })(),避免污染全域。
注意上面範例中,依賴是以「陣列 + 函式」的形式宣告的。Angular 的 module API 允許直接傳函式,也允許傳「依賴名稱陣列 + 函式」。多數文件範例都採用前者,但現實是:如果你沒有在壓縮前跑 ngmin,直接傳函式的寫法會出事。
因為壓縮器會把參數改名成 b、c、d、e,Angular 就再也認不出你要注入什麼,依賴注入當場失效。如果某個語法糖只能在開發時用、上 production 就會壞,那它的可讀性優勢便毫無意義。
我們的應用基本上是「類 Angular 程式」——包在 Angular 裡,但絕大多數 DOM 互動仍由 jQuery 處理。
若重來一次,我不會一開始就引入 jQuery,而會強迫自己改用 angular.element。當 jQuery 存在時,angular.element 會包裝它;不存在時則退回內建的 jqLite。這不是說 jQuery 不好,而是直接使用它,思維就跟 Angular 背道而馳。
一個具體(而且不太好看)的例子,在 controller 裡用 jQuery 做 class 操作:
<div class="foo" ng-controller="fooCtrl"></div>
angular.module('foo').controller('fooCtrl', function ($scope) {
$('.foo').addClass('foo-init');
$scope.$watch('something', function () {
$('.foo').toggleClass('foo-something-else');
});
});
改用 Angular 的方式:
angular.module('foo').controller('fooCtrl', function ($scope, $element) {
$element.addClass('foo-init');
$scope.$watch('something', function () {
$element.toggleClass('foo-something-else');
});
});
更進一步,最後那段 watch 也不該直接操作 DOM(改屬性、加事件監聽器),而應該改用 directive 承接。
我們並不打算完全移除 jQuery,因為還有更要緊的目標——把產品推出來。何況我們仍依賴 jQuery UI 的拖放排序功能,那若自己實作要寫上一大堆程式碼,目前並沒有真正好用的替代品。
所有 controller、service、directive 全塞進同一個大檔案。我們把它拆成「一個檔案一個元件」。
同時也把 CSS 模組化了。我們為每個元件的 class 加上兩個字的命名空間前綴:.pn- 代表 panel、.ly- 代表 layer。這麼做有兩個好處:不必再猜某個 class 屬於哪個元件,也不太會重複命名;而巢狀層級大幅減少,過去寫 #layoutEditor div.layer .handle div 這種選擇器,現在只要 .ly-handle-content。
我們定下的 CSS 命名規則是:
.ly-、.dd-、.dg-.ly-foo-barname 取代巢狀寫法 .ly-foo .bar以「圖層」這個元件為例:
<div class="cv-layer"
ng-repeat="layer in page.layers | reverse"
ap-layer
ng-mousedown="selectLayer(layer.id)"
ng-mouseup="selectLayer(layer.id)"
ng-dblclick="doubleClickLayer(layer)"
ng-hide="layer.invisible"></div>
這裡用 cv-layer 表示它是 canvas 元件的一部分;ngRepeat 為每個圖層建立一個元素,並透過自寫的 reverse filter 讓最上層顯示在最上方;apLayer 負責實際繪製圖層內容(圖片、文字或其他);三個 event 指令把事件代理給圖層選取服務;ngHide 則控制隱藏。
這麼多職責,Angular 卻讓它看起來相當簡單,可讀的 HTML 大致上就說清了它在做什麼。更重要的是,它讓你能把不同關注點分開處理,不必一次把所有事想完。
Angular 不只是要求你寫好程式碼,它更深一層的要求是「讓你去思考」。最後你會得到一個像樣的 server 端等級結構,還是一場難以忍受的 hack 大會,取決於你怎麼選。