用 AngularJS 做單頁應用,動機通常是想讓站內所有頁面都走 Route、盡量不出現 location.href 那種整頁跳轉。好處很明顯,但問題會隨時間浮現:功能越加越多,controller 也越寫越多,最後不得不把所有 controller 當成全域模組一次載入——否則使用者在任一頁面按 F5 重新整理,route 就可能找不到對應的 controller 而報錯。
結果就是首屏得先下載一整包 JS,手機網路的初次開啟體感特別慢。本文記錄一種把 controller 改成模組化、按需載入的做法。
在 app.js 中攔下 Angular 內建的註冊器,改由我們自己的 app.register 代為註冊:
app.config(function($controllerProvider, $compileProvider, $filterProvider, $provide) {
app.register = {
controller: $controllerProvider.register,
directive: $compileProvider.directive,
filter: $filterProvider.register,
factory: $provide.factory,
service: $provide.service
};
});
利用 resolve 搭配 $q 的 deferred 物件,可以讓路由切換「等」到依賴腳本載入完成。這裡用 $script(Script.js)負責動態載入:
$routeProvider.when('/:plugin', {
templateUrl: function(rd) {
return 'plugin/' + rd.plugin + '/index.html';
},
resolve: {
load: function($q, $route, $rootScope) {
var deferred = $q.defer();
var dependencies = [
'plugin/' + $route.current.params.plugin + '/controller.js'
];
$script(dependencies, function () {
$rootScope.$apply(function() {
deferred.resolve();
});
});
return deferred.promise;
}
}
});
對應的 controller.js 改用前面抽出的 register 註冊:
app.register.controller('MyPluginCtrl', function ($scope) {
// ...
});
這樣就能在進入路由時才去抓該路由依賴的 JS。問題是——如果站內有幾十條 route,每一條都這樣寫一大段,既難看又難維護。於是我們再收一刀。
app.config(function($controllerProvider, $compileProvider, $filterProvider, $provide) {
app.register = {
controller: $controllerProvider.register,
directive: $compileProvider.directive,
filter: $filterProvider.register,
factory: $provide.factory,
service: $provide.service
};
app.asyncjs = function (js) {
return ["$q", "$route", "$rootScope", function ($q, $route, $rootScope) {
var deferred = $q.defer();
var dependencies = js;
if (Array.isArray(dependencies)) {
for (var i = 0; i < dependencies.length; i++) {
dependencies[i] += "?v=" + v; // v 為版本號,用來破壞快取
}
} else {
dependencies += "?v=" + v;
}
$script(dependencies, function () {
$rootScope.$apply(function () {
deferred.resolve();
});
});
return deferred.promise;
}];
};
});
路由設定瞬間變乾淨:
$routeProvider.when('/:plugin', {
templateUrl: function(rd) {
return 'plugin/' + rd.plugin + '/index.html';
},
resolve: {
load: app.asyncjs('plugin/controller.js')
}
});
只要把原本一整包 controller.js 依模組拆成多個檔案,再為各路由標上依賴,就能有效縮短首屏載入時間。同樣的手法也適合其他按需使用的腳本,例如日期選擇器:
$routeProvider.when('/:plugin', {
templateUrl: function(rd) {
return 'plugin/' + rd.plugin + '/index.html';
},
resolve: {
load: app.asyncjs(['plugin/controller.js', 'plugin/jquery.ui.datepicker.js'])
}
});
值得一提的是,$script 會自行判斷腳本是否已載入過——若已載入就直接回報成功。也就是說,只有第一次進入日期選擇畫面時才會真的發出請求,離開再回來不會重複下載。
· 版本號別寫死。?v= 的用意是讓部署後能強制更新快取,建議由建置流程注入,而不是手寫在程式碼裡。
· 非同步註冊的時機。controller 是在腳本載入後才註冊進 Angular,若模板在註冊完成前就嘗試綁定,仍可能出現未知 identifier 的錯誤。resolve 的 promise 正是用來守住這個時序的關鍵,別繞過它。
· 權衡。按需載入省的是首屏頻寬,代價是多了一些請求與複雜度。若你的 controller 總量不大,先打包反而是更好的選擇;路由多、模組差異大時,這個模式才真正划算。