[轉] 細數Javascript技術棧中的四種依賴注入

作為物件導向程式設計中實現控制反轉（Inversion of Control，下文稱IoC）最常見的技術手段之一，依賴注入（Dependency Injection，下文稱DI）可謂在OOP程式設計中大行其道經久不衰。比如在J2EE中，就有大名鼎鼎的執牛耳者Spring。Javascript社群中自然也不乏一些積極的嘗試，廣為人知的AngularJS很大程度上就是基於DI實現的。遺憾的是，作為一款缺少反射機制、不支援Annotation語法的動態語言，Javascript長期以來都沒有屬於自己的Spring框架。當然，伴隨著ECMAScript草案進入快速迭代期的春風，Javascript社群中的各種方言、框架可謂群雄並起，方興未艾。可以預見到，優秀的JavascriptDI框架的出現只是早晚的事。

本文總結了Javascript中常見的依賴注入方式，並以inversify.js為例，介紹了方言社群對於Javascript中DI框架的嘗試和初步成果。文章分為四節：

一. 基於Injector、Cache和函式引數名的依賴注入

二. AngularJS中基於雙Injector的依賴注入

三. TypeScript中基於裝飾器和反射的依賴注入

四. inversify.js——Javascript技術棧中的IoC容器

一. 基於Injector、Cache和函式引數名的依賴注入

儘管Javascript中不原生支援反射(Reflection)語法，但是Function.prototype上的toString方法卻為我們另闢蹊徑，使得在執行時窺探某個函式的內部構造成為可能：toString方法會以字串的形式返回包含function關鍵字在內的整個函式定義。從這個完整的函式定義出發，我們可以利用正規表示式提取出該函式所需要的引數，從而在某種程度上得知該函式的執行依賴。 比如Student類上write方法的函式簽名write(notebook, pencil)就說明它的執行依賴於notebook和pencil物件。因此，我們可以首先把notebook和pencil物件存放到某個cache中，再通過injector（注入器、注射器）向write方法提供它所需要的依賴：

var cache = {};
// 通過解析Function.prototype.toString()取得引數名
function getParamNames(func) {
    // 正規表示式出自http://krasimirtsonev.com/blog/article/Dependency-injection-in-JavaScript
    var paramNames = func.toString().match(/^function\s*[^\(]*\(\s*([^\)]*)\)/m)[1];
    paramNames = paramNames.replace(/ /g, '');
    paramNames = paramNames.split(',');
    return paramNames;
}
var injector = {
    // 將func作用域中的this關鍵字繫結到bind物件上，bind物件可以為空
    resolve: function (func, bind) {
        // 取得引數名
        var paramNames = getParamNames(func);
        var params = [];
        for (var i = 0; i < paramNames.length; i++) {
            // 通過引數名在cache中取出相應的依賴
            params.push(cache[paramNames[i]]);
        }
        // 注入依賴並執行函式
        func.apply(bind, params);
    }
};
  
function Notebook() {}
Notebook.prototype.printName = function () {
    console.log('this is a notebook');
};
  
function Pencil() {}
Pencil.prototype.printName = function () {
    console.log('this is a pencil');
};
  
function Student() {}
Student.prototype.write = function (notebook, pencil) {
    if (!notebook || !pencil) {
        throw new Error('Dependencies not provided!');
    }
    console.log('writing...');
};
// 提供notebook依賴
cache['notebook'] = new Notebook();
// 提供pencil依賴
cache['pencil'] = new Pencil();
var student = new Student();
injector.resolve(student.write, student); // writing...
複製程式碼

有時候為了保證良好的封裝性，也不一定要把cache物件暴露給外界作用域，更多的時候是以閉包變數或者私有屬性的形式存在的：

function Injector() {
    this._cache = {};
}
 
Injector.prototype.put = function (name, obj) {
    this._cache[name] = obj;
};
 
Injector.prototype.getParamNames = function (func) {
    // 正規表示式出自http://krasimirtsonev.com/blog/article/Dependency-injection-in-JavaScript
    var paramNames = func.toString().match(/^function\s*[^\(]*\(\s*([^\)]*)\)/m)[1];
    paramNames = paramNames.replace(/ /g, '');
    paramNames = paramNames.split(',');
    return paramNames;
};
 
Injector.prototype.resolve = function (func, bind) {
    var self = this;
    var paramNames = self.getParamNames(func);
    var params = paramNames.map(function (name) {
        return self._cache[name];
    });
    func.apply(bind, params);
};
 
var injector = new Injector();
 
var student = new Student();
injector.put('notebook', new Notebook());
injector.put('pencil', new Pencil())
injector.resolve(student.write, student); // writing...
複製程式碼

比如現在要執行Student類上的另一個方法function draw(notebook, pencil, eraser)，因為injector的cache中已經有了notebook和pencil物件，我們只需要將額外的eraser也存放到cache中：

function Eraser() {}
Eraser.prototype.printName = function () {
    console.log('this is an eraser');
};
 
// 為Student增加draw方法
Student.prototype.draw = function (notebook, pencil, eraser) {
    if (!notebook || !pencil || !eraser) {
        throw new Error('Dependencies not provided!');
    }
    console.log('drawing...');
};
 
injector.put('eraser', new Eraser());
injector.resolve(student.draw, student);
複製程式碼

通過依賴注入，函式的執行和其所依賴物件的建立邏輯就被解耦開來了。
當然，隨著grunt/gulp/fis等前端工程化工具的普及，越來越多的專案在上線之前都經過了程式碼混淆(uglify)，因而通過引數名去判斷依賴並不總是可靠，有時候也會通過為function新增額外屬性的方式來明確地說明其依賴：

Student.prototype.write.depends = ['notebook', 'pencil'];
Student.prototype.draw.depends = ['notebook', 'pencil', 'eraser'];
Injector.prototype.resolve = function (func, bind) {
    var self = this;
    // 首先檢查func上是否有depends屬性，如果沒有，再用正規表示式解析
    func.depends = func.depends || self.getParamNames(func);
    var params = func.depends.map(function (name) {
        return self._cache[name];
    });
    func.apply(bind, params);
};
var student = new Student();
injector.resolve(student.write, student); // writing...
injector.resolve(student.draw, student); // draw...
複製程式碼

二. AngularJS中基於雙Injector的依賴注入

熟悉AngularJS的同學很快就能聯想到，在injector注入之前，我們在定義module時還可以呼叫config方法來配置隨後會被注入的物件。典型的例子就是在使用路由時對$routeProvider的配置。也就是說，不同於上一小節中直接將現成物件（比如new Notebook()）存入cache的做法，AngularJS中的依賴注入應該還有一個"例項化"或者"呼叫工廠方法"的過程。
這就是providerInjector、instanceInjector以及他們各自所擁有的providerCache和instanceCache的由來。
在AngularJS中，我們能夠通過依賴注入獲取到的injector通常是instanceInjector，而providerInjector則是以閉包中變數的形式存在的。每當我們需要AngularJS提供依賴注入服務時，比如想要獲取notebook，instanceInjector會首先查詢instanceCache上是存在notebook屬性，如果存在，則直接注入；如果不存在，則將這個任務轉交給providerInjector；providerInjector會將"Provider"字串拼接到"notebook"字串的後面，組成一個新的鍵名"notebookProvider"，再到providerCache中查詢是否有notebookProvider這個屬性，如有沒有，則丟擲異常Unknown Provider異常：

如果有，則將這個provider返回給instanceInjector；instanceInjector拿到notebookProvider後，會呼叫notebookProvider上的工廠方法$get，獲取返回值notebook物件，將該物件放到instanceCache中以備將來使用，同時也注入到一開始宣告這個依賴的函式中。過程描述起來比較複雜，可以通過下面的圖示來說明：

需要注意的是，AngularJS中的依賴注入方式也是有缺陷的：利用一個instanceInjector單例服務全域性的副作用就是無法單獨跟蹤和控制某一條依賴鏈條，即使在沒有交叉依賴的情況下，不同module中的同名provider也會產生覆蓋，這裡就不詳細展開了。

另外，對於習慣於Java和C#等語言中高階IoC容器的同學來說，看到這裡可能覺得有些彆扭，畢竟在OOP中，我們通常不會將依賴以引數的形式傳遞給方法，而是作為屬性通過constructor或者setters傳遞給例項，以實現封裝。的確如此，一、二節中的依賴注入方式沒有體現出足夠的物件導向特性，畢竟這種方式在Javascript已經存在多年了，甚至都不需要ES5的語法支援。希望瞭解Javascript社群中最近一兩年關於依賴注入的研究和成果的同學，可以繼續往下閱讀。

三. TypeScript中基於裝飾器和反射的依賴注入

博主本身對於Javascript的各種方言的學習並不是特別熱情，尤其是現在EMCAScript提案、草案更新很快，很多時候藉助於polyfill和babel的各種preset就能滿足需求了。但是TypeScript是一個例外（當然現在Decorator也已經是提案了，雖然階段還比較早，但是確實已經有polyfill可以使用）。上文提到，Javascript社群中遲遲沒有出現一款優秀的IoC容器和自身的語言特性有關，那就依賴注入這個話題而言，TypeScript給我們帶來了什麼不同呢？至少有下面這幾點：

• TypeScript增加了編譯時型別檢查，使Javascript具備了一定的靜態語言特性
• TypeScript支援裝飾器（Decorator）語法，和傳統的註解（Annotation）頗為相似
• TypeScript支援元資訊（Metadata）反射，不再需要呼叫Function.prototype.toString方法 下面我們就嘗試利用TypeScript帶來的新語法來規範和簡化依賴注入。這次我們不再向函式或方法中注入依賴了，而是向類的建構函式中注入。 TypeScript支援對類、方法、屬性和函式引數進行裝飾，這裡需要用到的是對類的裝飾。繼續上面小節中用到的例子，利用TypeScript對程式碼進行一些重構：

class Pencil {
    public printName() {
        console.log('this is a pencil');
    }
}
 
class Eraser {
    public printName() {
        console.log('this is an eraser');
    }
}
 
class Notebook {
    public printName() {
        console.log('this is a notebook');
    }
}
 
class Student {
    pencil: Pencil;
    eraser: Eraser;
    notebook: Notebook;
    public constructor(notebook: Notebook, pencil: Pencil, eraser: Eraser) {
        this.notebook = notebook;
        this.pencil = pencil;
        this.eraser = eraser;
    }
    public write() {
        if (!this.notebook || !this.pencil) {
            throw new Error('Dependencies not provided!');
        }
        console.log('writing...');
    }
    public draw() {
        if (!this.notebook || !this.pencil || !this.eraser) {
            throw new Error('Dependencies not provided!');
        }
        console.log('drawing...');
    }
}
複製程式碼

下面是injector和裝飾器Inject的實現。injector的resolve方法在接收到傳入的建構函式時，會通過name屬性取出該建構函式的名字，比如class Student，它的name屬性就是字串"Student"。再將Student作為key，到dependenciesMap中去取出Student的依賴，至於dependenciesMap中是何時存入的依賴關係，這是裝飾器Inject的邏輯，後面會談到。Student的依賴取出後，由於這些依賴已經是建構函式的引用而非簡單的字串了（比如Notebook、Pencil的建構函式），因此直接使用new語句即可獲取這些物件。獲取到Student類所依賴的物件之後，如何把這些依賴作為建構函式的引數傳入到Student中呢？最簡單的莫過於ES6的spread操作符。在不能使用ES6的環境下，我們也可以通過偽造一個建構函式來完成上述邏輯。注意為了使instanceof操作符不失效，這個偽造的建構函式的prototype屬性應該指向原建構函式的prototype屬性。

var dependenciesMap = {};
var injector = {
    resolve: function (constructor) {
        var dependencies = dependenciesMap[constructor.name];
        dependencies = dependencies.map(function (dependency) {
            return new dependency();
        });
        // 如果可以使用ES6的語法，下面的程式碼可以合併為一行：
        // return new constructor(...dependencies);
        var mockConstructor: any = function () {
            constructor.apply(this, dependencies);
        };
        mockConstructor.prototype = constructor.prototype;
        return new mockConstructor();
    }
};
function Inject(...dependencies) {
    return function (constructor) {
        dependenciesMap[constructor.name] = dependencies;
        return constructor;
    };
}
複製程式碼

injector和裝飾器Inject的邏輯完成後，就可以用來裝飾class Student並享受依賴注入帶來的樂趣了：

// 裝飾器的使用非常簡單，只需要在類定義的上方新增一行程式碼
// Inject是裝飾器的名字，後面是function Inject的引數
@Inject(Notebook, Pencil, Eraser)
class Student {
    pencil: Pencil;
    eraser: Eraser;
    notebook: Notebook;
    public constructor(notebook: Notebook, pencil: Pencil, eraser: Eraser) {
        this.notebook = notebook;
        this.pencil = pencil;
        this.eraser = eraser;
    }
    public write() {
        if (!this.notebook || !this.pencil) {
            throw new Error('Dependencies not provided!');
        }
        console.log('writing...');
    }
    public draw() {
        if (!this.notebook || !this.pencil || !this.eraser) {
            throw new Error('Dependencies not provided!');
        }
        console.log('drawing...');
    }
}
var student = injector.resolve(Student);
console.log(student instanceof Student); // true
student.notebook.printName(); // this is a notebook
student.pencil.printName(); // this is a pencil
student.eraser.printName(); // this is an eraser
student.draw(); // drawing
student.write(); // writing
複製程式碼

利用裝飾器，我們還可以實現一種比較激進的依賴注入，下文稱之為RadicalInject。RadicalInject對原始碼的侵入性比較強，不一定適合具體的業務，這裡也一併介紹一下。要理解RadicalInject，需要對TypeScript裝飾器的原理和Array.prototype上的reduce方法理解比較到位。

function RadicalInject(...dependencies){
    var wrappedFunc:any = function (target: any) {
        dependencies = dependencies.map(function (dependency) {
            return new dependency();
        });
        // 使用mockConstructor的原因和上例相同
        function mockConstructor() {
            target.apply(this, dependencies);
        }
        mockConstructor.prototype = target.prototype;
 
        // 為什麼需要使用reservedConstructor呢？因為使用RadicalInject對Student方法裝飾之後，
        // Student指向的建構函式已經不是一開始我們宣告的class Student了，而是這裡的返回值，
        // 即reservedConstructor。Student的指向變了並不是一件不能接受的事，但是如果要
        // 保證student instanceof Student如我們所期望的那樣工作，這裡就應該將
        // reservedConstructor的prototype屬性指向原Student的prototype
        function reservedConstructor() {
            return new mockConstructor();
        }
        reservedConstructor.prototype = target.prototype;
        return reservedConstructor;
    }
    return wrappedFunc;
}
複製程式碼

使用RadicalInject，原建構函式實質上已經被一個新的函式代理了，使用上也更為簡單，甚至都不需要再有injector的實現：

@RadicalInject(Notebook, Pencil, Eraser)
class Student {
    pencil: Pencil;
    eraser: Eraser;
    notebook: Notebook;
    public constructor() {}
    public constructor(notebook: Notebook, pencil: Pencil, eraser: Eraser) {
        this.notebook = notebook;
        this.pencil = pencil;
        this.eraser = eraser;
    }
    public write() {
        if (!this.notebook || !this.pencil) {
            throw new Error('Dependencies not provided!');
        }
        console.log('writing...');
    }
    public draw() {
        if (!this.notebook || !this.pencil || !this.eraser) {
            throw new Error('Dependencies not provided!');
        }
        console.log('drawing...');
    }
}
// 不再出現injector，直接呼叫建構函式
var student = new Student();
console.log(student instanceof Student); // true
student.notebook.printName(); // this is a notebook
student.pencil.printName(); // this is a pencil
student.eraser.printName(); // this is an eraser
student.draw(); // drawing
student.write(); // writing
複製程式碼

由於class Student的constructor方法需要接收三個引數，直接無參呼叫new Student()會造成TypeScript編譯器報錯。當然這裡只是分享一種思路，大家可以暫時忽略這個錯誤。有興趣的同學也可以使用類似的思路嘗試代理一個工廠方法，而非直接代理建構函式，以避免這類錯誤，這裡不再展開。

AngularJS2團隊為了獲得更好的裝飾器和反射語法的支援，一度準備另起爐灶，基於AtScript（AtScript中的"A"指的就是Annotation）來進行新框架的開發。但最終卻選擇擁抱TypeScript，於是便有了微軟和谷歌的奇妙組合。

當然，需要說明的是，在缺少相關標準和瀏覽器廠商支援的情況下，TypeScript在執行時只是純粹的Javascript，下節中出現的例子會印證這一點。

四. inversify.js——Javascript技術棧中的IoC容器

其實從Javascript出現各種支援高階語言特性的方言就可以預見到，IoC容器的出現只是早晚的事情。比如博主今天要介紹的基於TypeScript的inversify.js，就是其中的先行者之一。 inversity.js比上節中博主實現的例子還要進步很多，它最初設計的目的就是為了前端工程師同學們能在Javascript中寫出符合SOLID原則的程式碼，立意可謂非常之高。表現在程式碼中，就是處處有介面，將"Depend upon Abstractions. Do not depend upon concretions."（依賴於抽象，而非依賴於具體）表現地淋漓盡致。繼續使用上面的例子，但是由於inversity.js是面向介面的，上面的程式碼需要進一步重構：

interface NotebookInterface {
    printName(): void;
}
interface PencilInterface {
    printName(): void;
}
interface EraserInterface {
    printName(): void;
}
interface StudentInterface {
    notebook: NotebookInterface;
    pencil: PencilInterface;
    eraser: EraserInterface;
    write(): void;
    draw(): void;
}
class Notebook implements NotebookInterface {
    public printName() {
        console.log('this is a notebook');
    }
}
class Pencil implements PencilInterface {
    public printName() {
        console.log('this is a pencil');
    }
}
class Eraser implements EraserInterface {
    public printName() {
        console.log('this is an eraser');
    }
}
 
class Student implements StudentInterface {
    notebook: NotebookInterface;
    pencil: PencilInterface;
    eraser: EraserInterface;
    constructor(notebook: NotebookInterface, pencil: PencilInterface, eraser: EraserInterface) {
        this.notebook = notebook;
        this.pencil = pencil;
        this.eraser = eraser;
    }
    write() {
        console.log('writing...');
    }
    draw() {
        console.log('drawing...');
    }
}
複製程式碼

由於使用了inversity框架，這次我們就不用自己實現injector和Inject裝飾器啦，只需要從inversify模組中引用相關物件：

import { Inject } from "inversify";
 
@Inject("NotebookInterface", "PencilInterface", "EraserInterface")
class Student implements StudentInterface {
    notebook: NotebookInterface;
    pencil: PencilInterface;
    eraser: EraserInterface;
    constructor(notebook: NotebookInterface, pencil: PencilInterface, eraser: EraserInterface) {
        this.notebook = notebook;
        this.pencil = pencil;
        this.eraser = eraser;
    }
    write() {
        console.log('writing...');
    }
    draw() {
        console.log('drawing...');
    }
}
複製程式碼

這樣就行了嗎？還記得上節中提到TypeScript中各種概念只是語法糖嗎？不同於上一節中直接將constructor引用傳遞給Inject的例子，由於inversify.js是面向介面的，而諸如NotebookInterface、PencilInterface之類的介面只是由TypeScript提供的語法糖，在執行時並不存在，因此我們在裝飾器中宣告依賴時只能使用字串形式而非引用形式。不過不用擔心，inversify.js為我們提供了bind機制，在介面的字串形式和具體的建構函式之間搭建了橋樑：

import { TypeBinding, Kernel } from "inversify";
 
var kernel = new Kernel();
kernel.bind(new TypeBinding<NotebookInterface>("NotebookInterface", Notebook));
kernel.bind(new TypeBinding<PencilInterface>("PencilInterface", Pencil));
kernel.bind(new TypeBinding<EraserInterface>("EraserInterface", Eraser));
kernel.bind(new TypeBinding<StudentInterface>("StudentInterface", Student));
複製程式碼

注意這步需要從inversify模組中引入TypeBinding和Kernel，並且為了保證返回值型別以及整個編譯時靜態型別檢查能夠順利通過，泛型語法也被使用了起來。 說到這裡，要理解new TypeBinding("NotebookInterface", Notebook)也就很自然了：為依賴於"NotebookInterface"字串的類提供Notebook類的例項，返回值向上溯型到NotebookInterface。
完成了這些步驟，使用起來也還算順手：

var student: StudentInterface = kernel.resolve<StudentInterface>("StudentInterface");
console.log(student instanceof Student); // true
student.notebook.printName(); // this is a notebook
student.pencil.printName(); // this is a pencil
student.eraser.printName(); // this is an eraser
student.draw(); // drawing
student.write(); // writing
複製程式碼

最後，順帶提一下ECMAScript中相關提案的現狀和進展。Google的AtScript團隊曾經有過Annotation的提案，但是AtScript胎死腹中，這個提案自然不了了之了。目前比較有希望成為es7標準的是一個關於裝飾器的提案：github.com/wycats/java… 感興趣的同學可以到相關的github頁面跟蹤瞭解。儘管DI只是OOP程式設計眾多模式和特性中的一個，但卻可以折射出Javascript在OOP上艱難前進的道路。但總得說來，也算得上是路途坦蕩，前途光明。回到依賴注入的話題上，一邊是翹首以盼的Javascript社群，一邊是姍姍來遲的IoC容器，這二者最終能產生怎樣的化學反應，讓我們拭目以待。

作者：ralph_zhu

時間：2016-02-23 08:00

原文：www.cnblogs.com/front-end-r…