jQuery Ajax請求狀態(tài)管理器打包
更新時間:2012年05月03日 22:02:18 作者:
現(xiàn)在的網(wǎng)站,在一個網(wǎng)頁中有異步請求甚至許多個異步請求已經(jīng)不足為奇。Ajax已經(jīng)成為了現(xiàn)在網(wǎng)站必須的基本功能,使網(wǎng)頁應(yīng)用更接近于桌面應(yīng)用
然而,無論有多么接近,通過客戶端與服務(wù)端的一來一回,必定會有等待加載數(shù)據(jù)的時間。所以,大多數(shù)網(wǎng)站都通過一個Gif動態(tài)圖標(biāo)或‘Loading...'等字樣來告知用戶數(shù)據(jù)還在加載中。但有時候這個問題會非常繁瑣和麻煩,要么將這個‘Loading'顯示在ajax請求之前,然后在ajax成功后隱藏它,或者將它寫在jquery的ajax的全局事件jQuery.ajaxStart()和jQuery.ajaxStop()中來控制整個頁面的ajax狀態(tài)。前者方法使用起來太瑣碎,每個請求都要寫一遍這個‘Loading',而且無論請求成功或失敗都需要隱藏它。后者是全局的,也就是整個頁面的請求狀態(tài),有時候無法滿足在局部顯示加載狀態(tài)的要求。
為了解決這些問題,我開發(fā)了jQuery的插件,名為:Ajax請求狀態(tài)管理器。使用這個插件可以讓loading不再那么麻煩了。你可以在觸發(fā)ajax請求前,用該插件事先添加寫好所有請求,你要做的只是在用戶交互的事件中執(zhí)行下.request()方法。你可以將一個頁面上所有請求設(shè)置為獨(dú)立顯示loading,也可以設(shè)置為全局顯示(只顯示一個loading)。下面是插件的具體使用方法:
自定義loading的css樣式:
.state-loading { background: #fff url(images/icon-ajax-loader.gif) ... }
引用jquery最新版本文件:
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.js"></script>
注意:該插件只在jquery1.4.4及之后的版本中測試通過。
引用Ajax請求狀態(tài)管理器插件文件:
<script src="js/jquery-ajaxloader.js"></script>
在jquery的ready事件中執(zhí)行.install()方法:
$.loader.install( className, isGlobal );
參數(shù)說明:
className:string,表示你自定義的loading的class名稱,比如上面css定義的state-loading。
isGlobal:boolean,定義是否是全局顯示還是獨(dú)立顯示loading,默認(rèn)值是true,該參數(shù)可以省略。
添加所需的ajax請求參數(shù)和成功后的回調(diào)方法:
$.loader( key ).add( modules, settings , callback );
參數(shù)說明:
key:string,通過這個key來創(chuàng)建或獲取指定模塊的加載器。當(dāng)然,同一個key可以執(zhí)行多次add()方法來添加不同的module,但是settings和callback是對于這個key是共享的,所以之后添加的settings和callback會覆蓋之前的。
modules:jquery object,一個頁面中同一個請求可以處理多個模塊的數(shù)據(jù),所以,如果之前install()方法是設(shè)置為false的,在執(zhí)行ajax請求時,添加到這個loader的所有module都會顯示loading狀態(tài)。
settings:map,jquery的ajax settings參數(shù),但不要設(shè)置ajax事件,這樣會覆蓋插件中的回調(diào)方法,默認(rèn)請求類型為GET。
callback:function,成功后的回調(diào)函數(shù),它有一個參數(shù)data,默認(rèn)是json類型返回的對象。
add()方法返回一個由'module'前綴的字符串?dāng)?shù)組,比如你添加了3個元素,那結(jié)果為['module1', 'module2', 'module3']。你可以通過返回的數(shù)組來刪除指定的其中一個模塊的loading,也可以不指定,也就是全部刪除,當(dāng)然如果你需要這樣做的話。
remove()方法刪除指定的模塊:
$.loader( key ).remove( moduleId );
參數(shù)說明:
moduleId:string或者array,指定為string的話會刪除其中一個module,指定為數(shù)組會批量刪除模塊,如果未指定參數(shù),會將模塊全部刪除。
示例
添加2個模塊到名為userinfo的加載器中:
var id1 = $.loader( 'userinfo' ).add(
$( '#userinfo, #top-userinfo' ),
{ url: 'server/userinfo.php' },
function( data ) {
updateContent( $( '#userinfo, #topsection, #footer-userinfo' ), data );
}
);
再添加一個模塊到userinfo的加載器中:
var id2 = $.loader( 'userinfo' ).add( $('#footer-userinfo') );
var idList = id1.concat( id2 );
// result: [ 'module1', 'module2', 'module3' ]
刪除第2個模塊的loading,也就是‘#top-userinfo':
var ret = $.loader( 'userinfo' ).remove( idList[1] );
// result: true, modules: [ 'module1', 'module3' ]
在交互事件中執(zhí)行.request()方法:
$.loader( key ).request();
]
當(dāng)然,你也可以拋棄之前add的ajax settings和callback,在交互事件中自己寫$.ajax或$.get等。然后在請求前調(diào)用$.loader( key ).show(),在回調(diào)函數(shù)內(nèi)調(diào)用$.loader( key ).hide()。這樣也可以靈活控制loading的狀態(tài)。
示例
$( '#getUserInfo' ).bind( 'click', function() {
$.loader( 'userinfo' ).request();
});
你也可以從新重新寫請求:
$( '#getUserInfo' ).bind( 'click', function() {
$.loader( 'userinfo' ).show();
$.get( 'server/userinfo.php', function( data ) {
$.loader( 'userinfo' ).hide();
updateContent( $( '#userinfo, #topsection, #footer-userinfo' ), data );
})
});
注意:一個請求反復(fù)觸發(fā)時,管理器會執(zhí)行abor()來阻止之前未完成的請求,重新發(fā)布新的請求,然而如果你在頁面中通過jquery的ajaxError事件輸出錯誤信息,會把該信息一并認(rèn)為是錯誤的,所以如果有必要的話,需要你自行過濾。
示例
// 輸出錯誤日志
$( 'body' ).bind( 'ajaxError', function( event, xhr, setting, thrownError ) {
// 過濾掉 abort 的錯誤信息
if ( xhr.status === 0 || xhr.readyState === 0 || xhr.statusText === 'abort' ) {
return;
}
$( '#log' ).append( '<p>' + thrownError + '</p>' );
});
該插件簡單易用,代碼邏輯也不是很復(fù)雜,但本人能力和技術(shù)水平有限,如遇到使用問題或任何bug請通過郵件方式告訴我:nicolas-zhao@hotmail.com。謝謝捧場!
打包下載:Ajax請求狀態(tài)管理器。
為了解決這些問題,我開發(fā)了jQuery的插件,名為:Ajax請求狀態(tài)管理器。使用這個插件可以讓loading不再那么麻煩了。你可以在觸發(fā)ajax請求前,用該插件事先添加寫好所有請求,你要做的只是在用戶交互的事件中執(zhí)行下.request()方法。你可以將一個頁面上所有請求設(shè)置為獨(dú)立顯示loading,也可以設(shè)置為全局顯示(只顯示一個loading)。下面是插件的具體使用方法:
自定義loading的css樣式:
.state-loading { background: #fff url(images/icon-ajax-loader.gif) ... }
引用jquery最新版本文件:
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.js"></script>
注意:該插件只在jquery1.4.4及之后的版本中測試通過。
引用Ajax請求狀態(tài)管理器插件文件:
<script src="js/jquery-ajaxloader.js"></script>
在jquery的ready事件中執(zhí)行.install()方法:
$.loader.install( className, isGlobal );
參數(shù)說明:
className:string,表示你自定義的loading的class名稱,比如上面css定義的state-loading。
isGlobal:boolean,定義是否是全局顯示還是獨(dú)立顯示loading,默認(rèn)值是true,該參數(shù)可以省略。
添加所需的ajax請求參數(shù)和成功后的回調(diào)方法:
$.loader( key ).add( modules, settings , callback );
參數(shù)說明:
key:string,通過這個key來創(chuàng)建或獲取指定模塊的加載器。當(dāng)然,同一個key可以執(zhí)行多次add()方法來添加不同的module,但是settings和callback是對于這個key是共享的,所以之后添加的settings和callback會覆蓋之前的。
modules:jquery object,一個頁面中同一個請求可以處理多個模塊的數(shù)據(jù),所以,如果之前install()方法是設(shè)置為false的,在執(zhí)行ajax請求時,添加到這個loader的所有module都會顯示loading狀態(tài)。
settings:map,jquery的ajax settings參數(shù),但不要設(shè)置ajax事件,這樣會覆蓋插件中的回調(diào)方法,默認(rèn)請求類型為GET。
callback:function,成功后的回調(diào)函數(shù),它有一個參數(shù)data,默認(rèn)是json類型返回的對象。
add()方法返回一個由'module'前綴的字符串?dāng)?shù)組,比如你添加了3個元素,那結(jié)果為['module1', 'module2', 'module3']。你可以通過返回的數(shù)組來刪除指定的其中一個模塊的loading,也可以不指定,也就是全部刪除,當(dāng)然如果你需要這樣做的話。
remove()方法刪除指定的模塊:
$.loader( key ).remove( moduleId );
參數(shù)說明:
moduleId:string或者array,指定為string的話會刪除其中一個module,指定為數(shù)組會批量刪除模塊,如果未指定參數(shù),會將模塊全部刪除。
示例
添加2個模塊到名為userinfo的加載器中:
復(fù)制代碼 代碼如下:
var id1 = $.loader( 'userinfo' ).add(
$( '#userinfo, #top-userinfo' ),
{ url: 'server/userinfo.php' },
function( data ) {
updateContent( $( '#userinfo, #topsection, #footer-userinfo' ), data );
}
);
再添加一個模塊到userinfo的加載器中:
var id2 = $.loader( 'userinfo' ).add( $('#footer-userinfo') );
var idList = id1.concat( id2 );
// result: [ 'module1', 'module2', 'module3' ]
刪除第2個模塊的loading,也就是‘#top-userinfo':
var ret = $.loader( 'userinfo' ).remove( idList[1] );
// result: true, modules: [ 'module1', 'module3' ]
在交互事件中執(zhí)行.request()方法:
$.loader( key ).request();
]
當(dāng)然,你也可以拋棄之前add的ajax settings和callback,在交互事件中自己寫$.ajax或$.get等。然后在請求前調(diào)用$.loader( key ).show(),在回調(diào)函數(shù)內(nèi)調(diào)用$.loader( key ).hide()。這樣也可以靈活控制loading的狀態(tài)。
示例
復(fù)制代碼 代碼如下:
$( '#getUserInfo' ).bind( 'click', function() {
$.loader( 'userinfo' ).request();
});
你也可以從新重新寫請求:
復(fù)制代碼 代碼如下:
$( '#getUserInfo' ).bind( 'click', function() {
$.loader( 'userinfo' ).show();
$.get( 'server/userinfo.php', function( data ) {
$.loader( 'userinfo' ).hide();
updateContent( $( '#userinfo, #topsection, #footer-userinfo' ), data );
})
});
注意:一個請求反復(fù)觸發(fā)時,管理器會執(zhí)行abor()來阻止之前未完成的請求,重新發(fā)布新的請求,然而如果你在頁面中通過jquery的ajaxError事件輸出錯誤信息,會把該信息一并認(rèn)為是錯誤的,所以如果有必要的話,需要你自行過濾。
示例
復(fù)制代碼 代碼如下:
// 輸出錯誤日志
$( 'body' ).bind( 'ajaxError', function( event, xhr, setting, thrownError ) {
// 過濾掉 abort 的錯誤信息
if ( xhr.status === 0 || xhr.readyState === 0 || xhr.statusText === 'abort' ) {
return;
}
$( '#log' ).append( '<p>' + thrownError + '</p>' );
});
該插件簡單易用,代碼邏輯也不是很復(fù)雜,但本人能力和技術(shù)水平有限,如遇到使用問題或任何bug請通過郵件方式告訴我:nicolas-zhao@hotmail.com。謝謝捧場!
打包下載:Ajax請求狀態(tài)管理器。
相關(guān)文章
jQuery實(shí)現(xiàn)級聯(lián)菜單效果(仿淘寶首頁菜單動畫)
今天我們就帶大家體會一下級聯(lián)菜單的顯示,只是實(shí)現(xiàn)了簡單的效果,不過大都原理是一樣的2014-04-04從零開始學(xué)習(xí)jQuery (九) jQuery工具函數(shù)
我們經(jīng)常要使用腳本處理各種業(yè)務(wù)邏輯, 最常見的就是數(shù)組和對象的操作. jQuery工具函數(shù)為我們操作對象和數(shù)組提供了便利條件.2011-02-02輕松實(shí)現(xiàn)jQuery添加刪除按鈕Click事件
這篇文章主要為大家詳細(xì)介紹了如何輕松實(shí)現(xiàn)jQuery添加刪除按鈕Click事件,具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-03-03jquery 給動態(tài)生成的標(biāo)簽綁定事件的幾種方法總結(jié)
下面小編就為大家分享一篇jquery 給動態(tài)生成的標(biāo)簽綁定事件的幾種方法總結(jié),具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-02-02jQuery $.each遍歷對象、數(shù)組用法實(shí)例
這篇文章主要介紹了jQuery $.each遍歷對象、數(shù)組用法實(shí)例,本文講解了在有參數(shù)和無參數(shù)的情況下遍歷對象及遍歷數(shù)組的例子及each方法的幾種常用用法,需要的朋友可以參考下2015-04-04多功能jQuery樹插件zTree實(shí)現(xiàn)權(quán)限列表簡單實(shí)例
這篇文章主要介紹了多功能jQuery樹插件zTree實(shí)現(xiàn)權(quán)限列表簡單實(shí)例,優(yōu)異的性能、靈活的配置、多種功能的組合,是樹插件zTree最大的優(yōu)勢,感興趣的小伙伴們可以參考一下2016-07-07jQuery實(shí)現(xiàn)顏色打字機(jī)的完整代碼
這篇文章主要介紹了jQuery實(shí)現(xiàn)顏色打字機(jī)的完整代碼,代碼簡單易懂,非常不錯,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-03-03