DIV CSS 佈局教程網

JavaScript 依賴注入詳解:從 AMD 到反射一次看懂
編輯:JavaScript綜合知識     

電腦程式設計的世界,本質上就是不斷抽象、再將這些抽象組織起來的過程。JavaScript 也不例外——我們寫應用時幾乎都會用到別人的程式碼,像是各種開源庫與框架。隨著專案越長越大,需要依賴的模組也越來越多,如何有效組織這些依賴就成了一個關鍵問題,而依賴注入正是為了解決它而生。

你可能在 AngularJS 這類框架裡聽過「依賴注入」,但它並不新鮮,早在 PHP 等語言裡就行之有年,而且遠沒有想像中那麼複雜。本文就帶你從概念到實作,寫出「依賴注入風格」的程式碼。

目標設定

假設我們有兩個模組:一個負責發送 Ajax 請求(service),一個負責路由(router)。

代碼如下:
var service = function() {
return { name: 'Service' };
}
var router = function() {
return { name: 'Router' };
}

接著我們寫一個函式來使用這兩個模組:

代碼如下:
var doSomething = function(other) {
var s = service();
var r = router();
};

這樣寫雖然能跑,但卻相當不靈活。如果哪天要把 service 換成 ServiceXML 或 ServiceJSON,或為了測試想改用假的模組,難道只能一個個去改函式本體嗎?最直覺的做法,是把依賴當成參數傳進來:

代碼如下:
var doSomething = function(service, router, other) {
var s = service();
var r = router();
};

但這又帶來新問題:假如整個專案到處都在呼叫 doSomething,某天要新增第三個依賴,難不成要改遍所有呼叫處?這正是依賴注入器要解決的痛點。於是我們定下目標:

 

1. 應該能夠註冊依賴項
2. 依賴注入器接收一個函式,並返回一個能取得所需資源的函式
3. 程式碼要簡單友好,別太複雜
4. 應保持傳入函式的作用域
5. 傳入的函式除了依賴項,還能接收自訂參數

requirejs/AMD 方法

大名鼎鼎的 requirejs 就是解決依賴注入的好幫手:

代碼如下:
define(['service', 'router'], function(service, router) {
// ...
});

它的思路是:先描述需要的模組,再寫自己的函式,而參數順序很重要。我們來打造一個能提供類似語法的 injector 模組:

代碼如下:
var doSomething = injector.resolve(['service', 'router'], function(service, router, other) {
expect(service().name).to.be('Service');
expect(router().name).to.be('Router');
expect(other).to.be('Other');
});
doSomething("Other");

這裡用到了 expect.js 斷言庫來確保程式碼正確,隱約帶點 TDD(測試驅動開發)的味道。

 

現在正式動工。首先讓 injector 成為一個單例,這樣應用的各個環節都能共用同樣的功能:

代碼如下:
var injector = {
dependencies: {},
register: function(key, value) {
this.dependencies[key] = value;
},
resolve: function(deps, func, scope) {

}

這個物件很簡單,只含兩個函式與一個用於儲存的變數。要做的是檢查 deps 陣列,並在 dependencies 裡找答案,其餘則靠 apply 來呼叫 func:

代碼如下:
resolve: function(deps, func, scope) {
var args = [];
for(var i=0; i<deps.length, d=deps[i]; i++) {
if(this.dependencies[d]) {
args.push(this.dependencies[d]);
} else {
throw new Error('Can't resolve ' + d);
}
}
return function() {
func.apply(scope || {}, args.concat(Array.prototype.slice.call(arguments, 0)));
}
}

若要指定作用域,上面的程式碼也能正常運行。這裡 Array.prototype.slice.call 的作用,是把 arguments 轉成真正的陣列。至此程式碼能完美通過測試,但仍有個缺點:我們得把需要的模組寫兩次,順序不能亂,額外參數也永遠排在依賴之後。

反射(reflection)方法

根據維基百科,反射指的是程式能在執行過程中修改自己的結構與行為。在 JavaScript 裡,簡單說就是讀取並分析物件源碼的能力。回到 doSomething,如果你呼叫 doSomething.toString(),會得到:

代碼如下:
"function (service, router, other) {
var s = service();
var r = router();
}"

有了它,我們就能輕鬆取得參數及其名稱——這正是 AngularJS 實作依賴注入的方式。在它的原始碼裡,可以看到這段正規表達式:

代碼如下:
/^functions*[^(]*(s*([^)]*))/m

於是 resolve 可以改成:

 

 

代碼如下:
resolve: function() {
var func, deps, scope, args = [], self = this;
func = arguments[0];
deps = func.toString().match(/^functions*[^(]*(s*([^)]*))/m)[1].replace(/ /g, '').split(',');
scope = arguments[1] || {};
return function() {
var a = Array.prototype.slice.call(arguments, 0);
for(var i=0; i<deps.length; i++) {
var d = deps[i];
args.push(self.dependencies[d] && d != '' ? self.dependencies[d] : a.shift());
}
func.apply(scope || {}, args);
}
}

用這段正規表達式去匹配我們定義的函式,會得到:

代碼如下:
["function (service, router, other)", "service, router, other"]

我們只需要第二項。去掉多餘空格、以逗號切分字串後,就得到了 deps 陣列。修改的部分如下:

代碼如下:
var a = Array.prototype.slice.call(arguments, 0);
...
args.push(self.dependencies[d] && d != '' ? self.dependencies[d] : a.shift());

這裡我們遍歷依賴項,若其中有缺失,就從 arguments 取得;而空陣列呼叫 shift 只會回傳 undefined,不會拋錯。新版 injector 長這樣:

代碼如下:
var doSomething = injector.resolve(function(service, other, router) {
expect(service().name).to.be('Service');
expect(router().name).to.be('Router');
expect(other).to.be('Other');
});
doSomething("Other");

現在依賴項的順序可以隨意調動了。

不過沒有完美的事物。反射法有個致命問題:當程式碼被壓縮簡化後就會出錯,因為參數名稱被改動,依賴項便無法解析,例如:

代碼如下:
var doSomething=function(e,t,n){var r=e();var i=t()}

因此需要像 AngularJS 那樣的解法:

代碼如下:
var doSomething = injector.resolve(['service', 'router', function(service, router) {

}]);

這和最初的 AMD 方案很類似,於是我們把兩者整合,最終程式碼如下:

代碼如下:
var injector = {
dependencies: {},
register: function(key, value) {
this.dependencies[key] = value;
},
resolve: function() {
var func, deps, scope, args = [], self = this;
if(typeof arguments[0] === 'string') {
func = arguments[1];
deps = arguments[0].replace(/ /g, '').split(',');
scope = arguments[2] || {};
} else {
func = arguments[0];
deps = func.toString().match(/^functions*[^(]*(s*([^)]*))/m)[1].replace(/ /g, '').split(',');
scope = arguments[1] || {};
}
return function() {
var a = Array.prototype.slice.call(arguments, 0);
for(var i=0; i<deps.length; i++) {
var d = deps[i];
args.push(self.dependencies[d] && d != '' ? self.dependencies[d] : a.shift());
}
func.apply(scope || {}, args);
}
}
}

這版 resolve 可接受兩個或三個參數。測試如下:

代碼如下:
var doSomething = injector.resolve('router,,service', function(a, b, c) {
expect(a().name).to.be('Router');
expect(b).to.be('Other');
expect(c().name).to.be('Service');
});
doSomething("Other");

你可能注意到兩個逗號之間空空如也——這不是錯誤,而是刻意留給 Other 參數的位置,這就是我們控制參數順序的方式。

 

結語

本文介紹了 JavaScript 中幾種依賴注入的做法,希望幫助你開始使用這個技巧,寫出依賴注入風格的程式碼。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved