JavaScript中的依賴注入詳解

 這篇文章主要介紹了JavaScript中的依賴注入詳解,本文講解了requirejs/AMD方法、反射(reflection)方法等內容,需要的朋友可以參考下

   

計算機編程的世界其實就是一個將簡單的部分不斷抽象，並將這些抽象組織起來的過程。JavaScript也不例外，在我們使用JavaScript編寫應用時，我們是不是都會使用到別人編寫的代碼，例如一些著名的開源庫或者框架。隨著我們項目的增長，我們需要依賴的模塊變得越來越多，這個時候，如何有效的組織這些模塊就成了一個非常重要的問題。依賴注入解決的正是如何有效組織代碼依賴模塊的問題。你可能在一些框架或者庫種聽說過“依賴注入”這個詞，比如說著名的前端框架AngularJS，依賴注入就是其中一個非常重要的特性。但是，依賴注入根本就不是什麼新鮮玩意，它在其他的編程語言例如PHP中已經存在已久。同時，依賴注入也沒有想象種那樣復雜。在本文中，我們將一起來學習JavaScript中的依賴注入的概念，深入淺出的講解如何編寫“依賴注入風格”的代碼。

目標設定

假設我們現在擁有兩個模塊。第一個模塊的作用是發送Ajax請求，而第二個模塊的作用則是用作路由。

代碼如下:
var service = function() {
return { name: 'Service' };
}
var router = function() {
return { name: 'Router' };
}
這時，我們編寫了一個函數，它需要使用上面提到的兩個模塊：
代碼如下:
var doSomething = function(other) {
var s = service();
var r = router();
};
在這裡，為了讓我們的代碼變得有趣一些，這個參數需要多接收幾個參數。當然，我們完全可以使用上面的代碼，但是無論從哪個方面來看上面的代碼都略顯得不那麼靈活。要是我們需要使用的模塊名稱變為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) {
// ...
});
requirejs的思想是首先我們應該去描述所需要的模塊，然後編寫你自己的函數。其中，參數的順序很重要。假設我們需要編寫一個叫做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");
在繼續往下之前，需要說明的一點是在doSomething的函數體中我們使用了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, 0)的作用是將arguments變量轉換為一個真正的數組。到目前為止，我們的代碼可以完美的通過測試。但是這裡的問題是我們必須要將需要的模塊寫兩次，而且不能夠隨意排列順序。額外的參數總是排在所有的依賴項之後。

反射(reflection)方法

根據維基百科中的解釋，反射(reflection)指的是程序可以在運行過程中，一個對象可以修改自己的結構和行為。在JavaScript中，簡單來說就是閱讀一個對象的源碼並且分析源碼的能力。還是回到我們的doSomething方法，如果你調用doSomething.toString()方法，你可以獲得下面的字符串:

代碼如下:
"function (service, router, other) {
var s = service();
var r = router();
}"
這樣一來，只要使用這個方法，我們就可以輕松的獲取到我們想要的參數，以及更重要的一點就是他們的名字。這也是AngularJS實現依賴注入所使用的方法。在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 = {<