源代碼
return {
readChartTemplateForCockpit: function (jsonTemplate, exportWebData, datasetLabel, jsonData) {
var params = {};
params.jsonTemplate = jsonTemplate;
params.exportWebData = exportWebData;
params.datasetLabel = datasetLabel;
params.jsonData = jsonData;
if (jsonTemplate && jsonTemplate.CHART) {
jsonTemplate.CHART.outcomingEventsEnabled = true;
}
var deferred = $q.defer();
sbiModule_restServices
.promisePost('1.0/chart/jsonChartTemplate/readChartTemplateForCockpit', '', $httpParamSerializer(params), config)
.then
(
function (response) {
deferred.resolve(response.data);
},
function (response) {
console.log('Error!!!')
}
);
return deferred.promise
},
readChartTemplate: function (jsonTemplate, exportWebData, datasetLabel, jsonData) {
var params = {};
if ((jsonTemplate.CHART.groupCategories || jsonTemplate.CHART.groupSeries || jsonTemplate.CHART.groupSeriesCateg) && jsonTemplate.CHART.VALUES.CATEGORY.groupby != "") {
var arrayOfCateg = [];
arrayOfCateg.push(jsonTemplate.CHART.VALUES.CATEGORY)
if (jsonTemplate.CHART.VALUES.CATEGORY.groupby.indexOf(',') == -1) {
subs = jsonTemplate.CHART.VALUES.CATEGORY.groupby;
}
else {
subs = angular.copy(jsonTemplate.CHART.VALUES.CATEGORY.groupby.substring(0, jsonTemplate.CHART.VALUES.CATEGORY.groupby.indexOf(',')));
}
var groupby = {};
groupby['column'] = subs;
groupby['groupby'] = "";
groupby['name'] = subs;
groupby['groupbyNames'] = "";
groupby['orderColumn'] = jsonTemplate.CHART.VALUES.CATEGORY.orderColumn;
groupby['orderType'] = jsonTemplate.CHART.VALUES.CATEGORY.orderType;
;
groupby['stackedType'] = jsonTemplate.CHART.VALUES.CATEGORY.stackedType;
groupby['stacked'] = jsonTemplate.CHART.VALUES.CATEGORY.stacked;
arrayOfCateg.push(groupby);
delete jsonTemplate.CHART.VALUES.CATEGORY;
jsonTemplate.CHART.VALUES.CATEGORY = arrayOfCateg;
}
params.jsonTemplate = jsonTemplate;
params.exportWebData = exportWebData;
params.datasetLabel = datasetLabel;
params.jsonData = jsonData;
if (jsonTemplate && jsonTemplate.CHART) {
jsonTemplate.CHART.outcomingEventsEnabled = true;
}
var deferred = $q.defer();
sbiModule_restServices
.promisePost('1.0/chart/jsonChartTemplate/readChartTemplate', '?SBI_EXECUTION_ID=' + sbiExecutionId, $httpParamSerializer(params), config)
.then
(
function (response) {
deferred.resolve(response.data);
},
function (response) {
console.log('Error!!!')
}
);
return deferred.promise
},
drilldownHighchart: function (breadcrumb) {
var params = {};
params.breadcrumb = breadcrumb;
var deferred = $q.defer();
sbiModule_restServices
.promisePost('1.0/chart/jsonChartTemplate/drilldownHighchart', '?SBI_EXECUTION_ID=' + sbiExecutionId, $httpParamSerializer(params), config)
.then
(
function (response) {
deferred.resolve(eval("(" + response.data + ")"));
},
function (response) {
console.log('Error!!!')
}
);
return deferred.promise
}
}
deffered的使用說(shuō)明()
- ajax的使用
$.ajax({
url: "test.html",
success: function(){
alert("哈哈描姚,成功了!");
},
error:function(){
alert("出錯(cuò)啦戈次!");
}
});
運(yùn)行代碼示例
在上面的代碼中,$.ajax()接受一個(gè)對(duì)象參數(shù)筒扒,這個(gè)對(duì)象包含兩個(gè)方法:success方法指定操作成功后的回調(diào)函數(shù)怯邪,error方法指定操作失敗后的回調(diào)函數(shù)。
$.ajax()操作完成后花墩,如果使用的是低于1.5.0版本的jQuery悬秉,返回的是XHR對(duì)象,你沒(méi)法進(jìn)行鏈?zhǔn)讲僮鞅ⅲ蝗绻哂?.5.0版本和泌,返回的是deferred對(duì)象,可以進(jìn)行鏈?zhǔn)讲僮鳌?/p>
現(xiàn)在祠肥,新的寫(xiě)法是這樣的:
$.ajax("test.html")
**.done(function(){ alert("哈哈武氓,成功了!"); })**
**.fail(function(){ alert("出錯(cuò)啦仇箱!"); });**
(運(yùn)行代碼示例2)
可以看到县恕,done()相當(dāng)于success方法,fail()相當(dāng)于error方法剂桥。采用鏈?zhǔn)綄?xiě)法以后忠烛,代碼的可讀性大大提高。
三权逗、指定同一操作的多個(gè)回調(diào)函數(shù)
deferred對(duì)象的一大好處美尸,就是它允許你自由添加多個(gè)回調(diào)函數(shù)。
還是以上面的代碼為例斟薇,如果ajax操作成功后师坎,除了原來(lái)的回調(diào)函數(shù),我還想再運(yùn)行一個(gè)回調(diào)函數(shù)奔垦,怎么辦屹耐?
很簡(jiǎn)單,直接把它加在后面就行了。
$.ajax("test.html")
.done(function(){ alert("哈哈惶岭,成功了寿弱!");} )
.fail(function(){ alert("出錯(cuò)啦!"); } )
.done(function(){ alert("第二個(gè)回調(diào)函數(shù)按灶!");} );
(運(yùn)行代碼示例3)
回調(diào)函數(shù)可以添加任意多個(gè)症革,它們按照添加順序執(zhí)行。
四鸯旁、為多個(gè)操作指定回調(diào)函數(shù)
deferred對(duì)象的另一大好處噪矛,就是它允許你為多個(gè)事件指定一個(gè)回調(diào)函數(shù),這是傳統(tǒng)寫(xiě)法做不到的铺罢。
請(qǐng)看下面的代碼艇挨,它用到了一個(gè)新的方法$.when():
.ajax("test1.html"), $.ajax("test2.html"))
.done(function(){ alert("哈哈,成功了韭赘!"); })
.fail(function(){ alert("出錯(cuò)啦缩滨!"); });
(運(yùn)行代碼示例4)
這段代碼的意思是,先執(zhí)行兩個(gè)操作.ajax("test2.html")泉瞻,如果都成功了被济,就運(yùn)行done()指定的回調(diào)函數(shù)箫柳;如果有一個(gè)失敗或都失敗了趾徽,就執(zhí)行fail()指定的回調(diào)函數(shù)沃缘。
五、普通操作的回調(diào)函數(shù)接口(上)
deferred對(duì)象的最大優(yōu)點(diǎn)鞭达,就是它把這一套回調(diào)函數(shù)接口司忱,從ajax操作擴(kuò)展到了所有操作。也就是說(shuō)碉怔,任何一個(gè)操作----不管是ajax操作還是本地操作烘贴,也不管是異步操作還是同步操作----都可以使用deferred對(duì)象的各種方法,指定回調(diào)函數(shù)撮胧。
我們來(lái)看一個(gè)具體的例子桨踪。假定有一個(gè)很耗時(shí)的操作wait:
var wait = function(){
var tasks = function(){
alert("執(zhí)行完畢!");
};
setTimeout(tasks,5000);
};
我們?yōu)樗付ɑ卣{(diào)函數(shù)芹啥,應(yīng)該怎么做呢锻离?
很自然的,你會(huì)想到墓怀,可以使用$.when():
$.when(wait())
.done(function(){ alert("哈哈汽纠,成功了!"); })
.fail(function(){ alert("出錯(cuò)啦傀履!"); });
(運(yùn)行代碼示例5)
但是虱朵,這樣寫(xiě)的話,done()方法會(huì)立即執(zhí)行,起不到回調(diào)函數(shù)的作用碴犬。原因在于$.when()的參數(shù)只能是deferred對(duì)象絮宁,所以必須對(duì)wait()進(jìn)行改寫(xiě):
var dtd = $.Deferred(); // 新建一個(gè)deferred對(duì)象
var wait = function(dtd){
var tasks = function(){
alert("執(zhí)行完畢!");
dtd.resolve(); // 改變deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
return dtd;
};
現(xiàn)在服协,wait()函數(shù)返回的是deferred對(duì)象绍昂,這就可以加上鏈?zhǔn)讲僮髁恕?/p>
$.when(wait(dtd))
.done(function(){ alert("哈哈,成功了偿荷!"); })
.fail(function(){ alert("出錯(cuò)啦窘游!"); });
(運(yùn)行代碼示例6)
wait()函數(shù)運(yùn)行完,就會(huì)自動(dòng)運(yùn)行done()方法指定的回調(diào)函數(shù)跳纳。
六忍饰、deferred.resolve()方法和deferred.reject()方法
如果仔細(xì)看,你會(huì)發(fā)現(xiàn)在上面的wait()函數(shù)中棒旗,還有一個(gè)地方我沒(méi)講解喘批。那就是dtd.resolve()的作用是什么?
要說(shuō)清楚這個(gè)問(wèn)題铣揉,就要引入一個(gè)新概念"執(zhí)行狀態(tài)"。jQuery規(guī)定餐曹,deferred對(duì)象有三種執(zhí)行狀態(tài)----未完成逛拱,已完成和已失敗。如果執(zhí)行狀態(tài)是"已完成"(resolved),deferred對(duì)象立刻調(diào)用done()方法指定的回調(diào)函數(shù)台猴;如果執(zhí)行狀態(tài)是"已失敗"朽合,調(diào)用fail()方法指定的回調(diào)函數(shù);如果執(zhí)行狀態(tài)是"未完成"饱狂,則繼續(xù)等待曹步,或者調(diào)用progress()方法指定的回調(diào)函數(shù)(jQuery1.7版本添加)。
前面部分的ajax操作時(shí)休讳,deferred對(duì)象會(huì)根據(jù)返回結(jié)果讲婚,自動(dòng)改變自身的執(zhí)行狀態(tài);但是俊柔,在wait()函數(shù)中筹麸,這個(gè)執(zhí)行狀態(tài)必須由程序員手動(dòng)指定。dtd.resolve()的意思是雏婶,將dtd對(duì)象的執(zhí)行狀態(tài)從"未完成"改為"已完成"物赶,從而觸發(fā)done()方法。
類似的留晚,還存在一個(gè)deferred.reject()方法酵紫,作用是將dtd對(duì)象的執(zhí)行狀態(tài)從"未完成"改為"已失敗",從而觸發(fā)fail()方法。
var dtd = $.Deferred(); // 新建一個(gè)Deferred對(duì)象
var wait = function(dtd){
var tasks = function(){
alert("執(zhí)行完畢奖地!");
dtd.reject(); // 改變Deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
return dtd;
};
$.when(wait(dtd))
.done(function(){ alert("哈哈橄唬,成功了!"); })
.fail(function(){ alert("出錯(cuò)啦鹉动!"); });
(運(yùn)行代碼示例7)
七轧坎、deferred.promise()方法
上面這種寫(xiě)法,還是有問(wèn)題泽示。那就是dtd是一個(gè)全局對(duì)象缸血,所以它的執(zhí)行狀態(tài)可以從外部改變。
請(qǐng)看下面的代碼:
var dtd = $.Deferred(); // 新建一個(gè)Deferred對(duì)象
var wait = function(dtd){
var tasks = function(){
alert("執(zhí)行完畢械筛!");
dtd.resolve(); // 改變Deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
return dtd;
};
$.when(wait(dtd))
.done(function(){ alert("哈哈捎泻,成功了!"); })
.fail(function(){ alert("出錯(cuò)啦埋哟!"); });
dtd.resolve();
(運(yùn)行代碼示例8)
我在代碼的尾部加了一行dtd.resolve()笆豁,這就改變了dtd對(duì)象的執(zhí)行狀態(tài),因此導(dǎo)致done()方法立刻執(zhí)行赤赊,跳出"哈哈闯狱,成功了!"的提示框抛计,等5秒之后再跳出"執(zhí)行完畢哄孤!"的提示框。
為了避免這種情況吹截,jQuery提供了deferred.promise()方法瘦陈。它的作用是,在原來(lái)的deferred對(duì)象上返回另一個(gè)deferred對(duì)象波俄,后者只開(kāi)放與改變執(zhí)行狀態(tài)無(wú)關(guān)的方法(比如done()方法和fail()方法)晨逝,屏蔽與改變執(zhí)行狀態(tài)有關(guān)的方法(比如resolve()方法和reject()方法),從而使得執(zhí)行狀態(tài)不能被改變懦铺。
請(qǐng)看下面的代碼:
var dtd = $.Deferred(); // 新建一個(gè)Deferred對(duì)象
var wait = function(dtd){
var tasks = function(){
alert("執(zhí)行完畢捉貌!");
dtd.resolve(); // 改變Deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
return dtd.promise(); // 返回promise對(duì)象
};
var d = wait(dtd); // 新建一個(gè)d對(duì)象,改為對(duì)這個(gè)對(duì)象進(jìn)行操作
$.when(d)
.done(function(){ alert("哈哈阀趴,成功了昏翰!"); })
.fail(function(){ alert("出錯(cuò)啦!"); });
d.resolve(); // 此時(shí)刘急,這個(gè)語(yǔ)句是無(wú)效的
(運(yùn)行代碼示例9)
在上面的這段代碼中棚菊,wait()函數(shù)返回的是promise對(duì)象。然后叔汁,我們把回調(diào)函數(shù)綁定在這個(gè)對(duì)象上面统求,而不是原來(lái)的deferred對(duì)象上面检碗。這樣的好處是,無(wú)法改變這個(gè)對(duì)象的執(zhí)行狀態(tài)码邻,要想改變執(zhí)行狀態(tài)折剃,只能操作原來(lái)的deferred對(duì)象。
不過(guò)像屋,更好的寫(xiě)法是allenm所指出的怕犁,將dtd對(duì)象變成wait()函數(shù)的內(nèi)部對(duì)象。
var wait = function(dtd){
var dtd = $.Deferred(); //在函數(shù)內(nèi)部己莺,新建一個(gè)Deferred對(duì)象
var tasks = function(){
alert("執(zhí)行完畢奏甫!");
dtd.resolve(); // 改變Deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
return dtd.promise(); // 返回promise對(duì)象
};
$.when(wait())
.done(function(){ alert("哈哈,成功了凌受!"); })
.fail(function(){ alert("出錯(cuò)啦阵子!"); });
(運(yùn)行代碼示例10)
八、普通操作的回調(diào)函數(shù)接口(中)
另一種防止執(zhí)行狀態(tài)被外部改變的方法胜蛉,是使用deferred對(duì)象的建構(gòu)函數(shù)$.Deferred()挠进。
這時(shí),wait函數(shù)還是保持不變誊册,我們直接把它傳入$.Deferred():
$.Deferred(wait)
.done(function(){ alert("哈哈领突,成功了!"); })
.fail(function(){ alert("出錯(cuò)啦案怯!"); });
(運(yùn)行代碼示例11)
jQuery規(guī)定攘须,.Deferred()所生成的deferred對(duì)象將作為這個(gè)函數(shù)的默認(rèn)參數(shù)。
九浮驳、普通操作的回調(diào)函數(shù)接口(下)
除了上面兩種方法以外悍汛,我們還可以直接在wait對(duì)象上部署deferred接口。
var dtd = $.Deferred(); // 生成Deferred對(duì)象
var wait = function(dtd){
var tasks = function(){
alert("執(zhí)行完畢至会!");
dtd.resolve(); // 改變Deferred對(duì)象的執(zhí)行狀態(tài)
};
setTimeout(tasks,5000);
};
dtd.promise(wait);
wait.done(function(){ alert("哈哈离咐,成功了!"); })
.fail(function(){ alert("出錯(cuò)啦奉件!"); });
wait(dtd);
(運(yùn)行代碼示例12)
這里的關(guān)鍵是dtd.promise(wait)這一行宵蛀,它的作用就是在wait對(duì)象上部署Deferred接口。正是因?yàn)橛辛诉@一行县貌,后面才能直接在wait上面調(diào)用done()和fail()术陶。
十、小結(jié):deferred對(duì)象的方法
前面已經(jīng)講到了deferred對(duì)象的多種方法煤痕,下面做一個(gè)總結(jié):
(1) $.Deferred() 生成一個(gè)deferred對(duì)象梧宫。
(2) deferred.done() 指定操作成功時(shí)的回調(diào)函數(shù)
(3) deferred.fail() 指定操作失敗時(shí)的回調(diào)函數(shù)
(4) deferred.promise() 沒(méi)有參數(shù)時(shí)接谨,返回一個(gè)新的deferred對(duì)象,該對(duì)象的運(yùn)行狀態(tài)無(wú)法被改變塘匣;接受參數(shù)時(shí)脓豪,作用為在參數(shù)對(duì)象上部署deferred接口。
(5) deferred.resolve() 手動(dòng)改變deferred對(duì)象的運(yùn)行狀態(tài)為"已完成"忌卤,從而立即觸發(fā)done()方法扫夜。
(6)deferred.reject() 這個(gè)方法與deferred.resolve()正好相反,調(diào)用后將deferred對(duì)象的運(yùn)行狀態(tài)變?yōu)?已失敗"驰徊,從而立即觸發(fā)fail()方法笤闯。
(7) $.when() 為多個(gè)操作指定回調(diào)函數(shù)。
除了這些方法以外辣垒,deferred對(duì)象還有二個(gè)重要方法望侈,上面的教程中沒(méi)有涉及到。
有時(shí)為了省事勋桶,可以把done()和fail()合在一起寫(xiě)脱衙,這就是then()方法。
.ajax( "/main.php" ))
.then(successFunc, failureFunc );
如果then()有兩個(gè)參數(shù)例驹,那么第一個(gè)參數(shù)是done()方法的回調(diào)函數(shù)捐韩,第二個(gè)參數(shù)是fail()方法的回調(diào)方法。如果then()只有一個(gè)參數(shù)鹃锈,那么等同于done()荤胁。
這個(gè)方法也是用來(lái)指定回調(diào)函數(shù)的,它的作用是屎债,不管調(diào)用的是deferred.resolve()還是deferred.reject()仅政,最后總是執(zhí)行。
$.ajax( "test.html" )
.always( function() { alert("已執(zhí)行盆驹!");} );
(致謝:本文第一稿發(fā)表后圆丹,allenm來(lái)信指出原文對(duì)promise()的理解是錯(cuò)的。現(xiàn)在的第二稿是根據(jù)他的文章修改的躯喇,在此我表示衷心感謝辫封。)
(完)