在angularJS項(xiàng)目開(kāi)發(fā)中遇到使用表格的場(chǎng)景,于是引入了號(hào)稱angularJS中擴(kuò)展性最好的表格smart-table組件剪芍,代碼只有四五百行韧掩,功能只提供了渲染、數(shù)據(jù)項(xiàng)選擇坊谁、排序等等簡(jiǎn)單的功能滑臊。而我的任務(wù)是給表格加入加載狀態(tài)監(jiān)控、全選雇卷、更多按鈕等等功能关划,這過(guò)程涉及到angularJS組件的復(fù)用。
我們都熟悉jQuery組件開(kāi)發(fā)模式贮折,定義組件類调榄,在該組件類的原型鏈上添加方法,然后在jQuery上綁定相應(yīng)的入口函數(shù)每庆,大致如下:
(function ($) {
function Dropdown (options) { /* ... */ }
Dropdown.prototype.close = function () {};
Dropdown.prototype.open = function () {};
$.fn.dropdown = function (options) {
// 觸發(fā)行為
if (typeof options === 'string') {
this.data('dropdown')[options]();
// 實(shí)例化
} else {
this.data('dropdown', new Dropdown(options));
}
};
$.fn.dropdown.Constructor = Dropdown;
})(jQuery);
我們定義了一個(gè)下拉框組件缤灵,匿名函數(shù)中定義組件類Dropdown蓝晒,而組件的方法都添加到Dropdown類原型鏈中鸽斟,接著我們通過(guò)jQuery的原型鏈$.fn.dropdown
將入口函數(shù)暴露出去富蓄,入口函數(shù)用于處理組件的創(chuàng)建和動(dòng)作分發(fā),最后通過(guò)Constructor屬性將構(gòu)造函數(shù)暴露出去灭红。
jQuery插件的復(fù)寫(xiě)很簡(jiǎn)單口注,直接對(duì)類方法進(jìn)行改寫(xiě):
var proto = $.fn.dropdown.Constructor.prototype;
proto.close = function () {};
然而angularJS不像jQuery簡(jiǎn)單的暴露,angularJS層層封裝使得在外部進(jìn)行復(fù)寫(xiě)變得困難娇斑。下面通過(guò)標(biāo)簽頁(yè)組件和彈窗組件的例子材部,分別從控制器,指令和作用域三個(gè)層面介紹苦丁,如何在盡可能不改動(dòng)源碼的前提下進(jìn)行angularJS組件的復(fù)用物臂。
控制器繼承
我們常用控制器來(lái)寫(xiě)具體頁(yè)面的業(yè)務(wù)邏輯棵磷,很少涉及到其中this的使用,這往往讓我們忘記仪媒,angularJS控制器是一個(gè)類规丽。而在angularJS組件開(kāi)發(fā)中撇贺,控制器中定義的是了整個(gè)組件的核心代碼,比如一個(gè)簡(jiǎn)單的標(biāo)簽頁(yè)組件:
<tab-box>
<tab name="tabA">標(biāo)簽頁(yè)A</tab>
<pane name=tabA>
標(biāo)簽頁(yè)A內(nèi)容
</pane>
</tab-box>
標(biāo)簽頁(yè)組件包含了tab-box艘狭、tab、pane三個(gè)指令遵倦,分別是標(biāo)簽頁(yè)容器官撼,標(biāo)簽,標(biāo)簽頁(yè)內(nèi)容塊掠哥,其定義如下:
app.directive('tabBox', function () {
return {
controllerAs: 'tabBoxCtrl',
controller: function ($scope) {
$scope.state = {
page: null
};
this.setPage = function (page) {
$scope.state = page;
}
}
};
});
app.directive('tab', function () {
return {
require: 'tabBox',
link: function (scope, $elem, attr, ctrl) {
$elem.on('click', function () {
ctrl.setPage(attr.name);
});
}
};
});
上面的代碼所做的事情是:父指令的控制器tabBoxCtrl明確的定義作用域結(jié)構(gòu)秃诵,并暴露出一個(gè)setPage方法菠净,用于標(biāo)簽頁(yè)的切換,而tab指令中則使用require指明和父指令之間的依賴關(guān)系牵咙,link函數(shù)的第四個(gè)參數(shù)中可以拿到tabBoxCtrl的實(shí)例煞抬,從而在tab指令后續(xù)的點(diǎn)擊事件中,便可以調(diào)用到父指令控制器中的方法setPage
tab-box是標(biāo)簽頁(yè)的最頂層指令战坤,即父指令残拐,其中定義的控制器tabBoxCtrl統(tǒng)一負(fù)責(zé)作用域和暴露方法,而tab子指令中則使用父指令暴露出來(lái)的方法囊卜,而不是直接操作作用域错沃。
以上是angularJS組件開(kāi)發(fā)的簡(jiǎn)單流程。當(dāng)我們引入第三方組件玉掸,我們希望在原組件的基礎(chǔ)上構(gòu)建一個(gè)新的組件醒叁,我們只需要保留原組件的核心邏輯。我們可以采用控制器繼承的方法啊易,通過(guò)$controller服務(wù)將指定控制器進(jìn)行實(shí)例化,該指定控制器的行為和狀態(tài)就能夠完美的拷貝下來(lái)篮奄。
比如我們要修改tab-box組件的行為垦垂,我們希望標(biāo)簽頁(yè)在鼠標(biāo)懸浮的時(shí)候進(jìn)行標(biāo)簽頁(yè)切換劫拗。我們可以新建另一個(gè)指令my-tab-box,直接復(fù)用tab-box控制器的主邏輯:
app.directive('myTabBox', function () {
return {
controller: function ($scope, $controller) {
// 實(shí)例化控制器
var parent = $controller('tabBoxCtrl', {
$scope: $scope
});
angular.extend(this, parent);
// 新增方法
this.myMethod = function () {};
}
};
});
app.directive('myTab', function () {
return {
require: 'myTabBox',
link: function (scope, $elem, attr, ctrl) {
$elem.on('hover', function () {
// 依舊可以調(diào)用setPage方法
ctrl.setPage(attr.name);
});
}
};
});
以上代碼我們創(chuàng)建了一個(gè)新的組件my-tab-box憔足,在控制器中通過(guò)$controller實(shí)例化父控制器酒繁,并通過(guò)angular.extend將父控制器的方法綁定到了當(dāng)前控制器的上下文中州袒。這過(guò)程中,my-tab-box的狀態(tài)和行為就完全拷貝了tab-box了郎哭。正是如此夸研,之后的myTab子指令中,我們可以調(diào)用到setPage方法悼沈。
這種方式適用于僅復(fù)用原組件的主邏輯和方法姐扮。除此之外,我們很可能需要直接復(fù)用原組件杯缺,只修改其中少量功能睡榆。
指令復(fù)寫(xiě)
angularJS中,同名指令是可以多次定義塘揣,按照定義的先后順序依次執(zhí)行宿崭。
上述tab-box的復(fù)用中,如果僅僅是標(biāo)簽頁(yè)的點(diǎn)擊事件改成了鼠標(biāo)懸浮事件葡兑,我們可以通過(guò)指令二次定義的方式讹堤,對(duì)指令行為進(jìn)行修改:
// 在外部再次定義tab指令
app.directive('tab', function () {
return {
require: 'tabBox',
link: function (scope, $elem, attr, ctrl) {
$elem
.off('click')
.on('hover', function () {
ctrl.setPage(attr.name);
});
}
};
});
在angularJS解析tab指令時(shí),會(huì)按照源碼中的第一次定義為標(biāo)簽綁定點(diǎn)擊事件疑务,接著執(zhí)行外部復(fù)寫(xiě)代碼中第二次定義梗醇,為標(biāo)簽解除點(diǎn)擊事件綁定,并綁定鼠標(biāo)懸浮事件温鸽。
多次定義指令的方式還可以直接改寫(xiě)控制器手负。
在控制器繼承的介紹中虫溜,我們提到了使用$controller對(duì)tab-box標(biāo)簽頁(yè)組件的邏輯進(jìn)行復(fù)用晃洒,重新開(kāi)發(fā)一個(gè)新的組件,但如果我們希望直接修改tab-box的行為,而不是重新開(kāi)發(fā)一個(gè)新的組件崔梗,那么我們可以通過(guò)指令來(lái)對(duì)控制器進(jìn)行修改迷守。比如tab-box指令新增一個(gè)方法:
app.directive('tabBox', function () {
return {
require: '^tabBox',
link: function (scope, $elem, attr, ctrl) {
// 新增方法
ctrl.newMethod = function () {};
}
};
});
以上,我們?cè)谕獠看a中對(duì)tabBox進(jìn)行再次聲明凯力,通過(guò)require:'^tabBox'
,讓tabBox依賴于其本身拗秘,從而我們就可以拿到tabBox本身的控制器實(shí)例(link函數(shù)的第四個(gè)參數(shù))祈惶,之后,我們就可以在這個(gè)實(shí)例上進(jìn)行功能擴(kuò)展或者功能改寫(xiě)了凡涩。
封裝
組件開(kāi)發(fā)還有種情況是疹蛉,我們只需要對(duì)組件進(jìn)行封裝氧吐,而不需要改寫(xiě)組件的行為,比如我們頁(yè)面使用統(tǒng)一界面的趨勢(shì)圖座慰,我們只需對(duì)highcharts提供統(tǒng)一的參數(shù)翠拣,這些代碼封裝成一個(gè)trendChart組件,每次調(diào)用只需要傳入相應(yīng)的數(shù)據(jù)trendChart.update(data)
蛮粮,而不需要在業(yè)務(wù)代碼中重復(fù)編寫(xiě)相關(guān)公共的配置項(xiàng)谜慌。
在angularJS項(xiàng)目開(kāi)發(fā)中,引入了angular-bootstrap庫(kù)提供的彈窗組件变泄,其調(diào)用方式是:
app.controller('myCtrl', function ($scope, $uibModal) {
$uibModal.open({
templateUrl: 'myWindow.html',
scope: $scope
});
});
由于項(xiàng)目中彈窗分成頭部妨蛹、主體晴竞、底部三個(gè)部分,彈窗的模版需要進(jìn)行統(tǒng)一的改寫(xiě)颤难,我們可以新建一個(gè)服務(wù)myModal對(duì)$uibModal進(jìn)一步封裝:
app.factory('myModal', function ($uibModal) {
return {
open: function (options) {
var scope = options.scope;
// 錯(cuò)誤的將自定義數(shù)據(jù)綁定到了原作用域上
scope.newData = {};
// 錯(cuò)誤的將自定義操作綁定到了原作用域上
scope.newMethod = function () {};
$uibModal.open(options);
}
};
});
由于我們需要改動(dòng)模版,其中又有新增的邏輯代碼瘤袖,這處理過(guò)程中自定義操作和自定義數(shù)據(jù)都需要保存到作用域下昂验,就想上述代碼中既琴,自定義數(shù)據(jù)和操作都綁定到了options.scope
中泡嘴,然而options.scope
是外層的作用域(控制器中存放業(yè)務(wù)邏輯的作用域),組件的數(shù)據(jù)就污染了當(dāng)前存放業(yè)務(wù)邏輯的作用域磺箕,特別是觸發(fā)多層彈窗組件時(shí)抛虫,數(shù)據(jù)就會(huì)互相污染建椰。所以我們希望每個(gè)彈窗都有自己的作用域,而且彈窗的作用域繼承于原作用域屠列。所以我們應(yīng)該使用原作用域創(chuàng)建一個(gè)子作用域:
app.factory('myModal', function ($uibModal) {
return {
open: function (options) {
// 創(chuàng)建子作用域
var scope = options.scope.$new();
// 在子作用域中存儲(chǔ)數(shù)據(jù)和操作
scope.newData = {};
scope.newMethod = function () {};
options.scope = scope;
$uibModal.open(options);
}
};
});
通過(guò)$new
方法伞矩,我們能創(chuàng)建一個(gè)繼承原作用域的子作用域乃坤,現(xiàn)在我們自定義的數(shù)據(jù)和方法都存儲(chǔ)到了子作用域中,而沒(méi)有污染到原作用域蝌诡。
梳理一下封裝的過(guò)程:控制器在調(diào)用彈窗時(shí)枫吧,控制器的作用域傳給了myModal中,myModal服務(wù)使用該作用域生成了一個(gè)子作用域颁湖,而子作用域會(huì)傳給$uibModal
組件,$uibModal
拿到子作用域后抢蚀,再生成一個(gè)子作用域镰禾,所以這里面一共有三個(gè)作用域吴侦,他們的關(guān)系是:控制臺(tái)作用域->myModal存儲(chǔ)數(shù)據(jù)作用域->$uibModal
作用域。
在angularJS中劫樟,作用域的繼承是通過(guò)原型鏈來(lái)實(shí)現(xiàn)的织堂,我們要注意到的是叠艳,myModal自定義作用域是作為中間層出現(xiàn)的,如果其中某些數(shù)據(jù)項(xiàng)覆蓋了頂層作用域附较,那么作為最底層作用域的$uibModal
彈窗闽烙,其內(nèi)部對(duì)應(yīng)的數(shù)據(jù)就無(wú)法訪問(wèn)到頂層作用域黑竞。所以我們?cè)谏婕暗阶饔糜蚶^承的封裝時(shí),用來(lái)存儲(chǔ)中間操作和狀態(tài)的作用域扎酷,其名下開(kāi)辟的存儲(chǔ)空間一定是越少越好遏匆,而且名稱也是越特殊越好,下面是相應(yīng)的改寫(xiě):
app.factory('myModal', function ($uibModal) {
return {
open: function (options) {
var scope = options.scope.$new();
// 取用特殊名稱凡纳,避免覆蓋父作用域
scope._modalData_ = {};
// 不要開(kāi)辟太多存儲(chǔ)空間荐糜,通常方法、狀態(tài)延塑、數(shù)據(jù)各一個(gè)足矣
scope._modalMethod_ = {
newMethod: function () {}
};
options.scope = scope;
$uibModal.open(options);
}
};
});