在實現前後臺分離之後,後臺只需要給前臺提供相應的接口(數據請求地址),而衆多的接口如果沒有很好的管理,對於開發和維護都是很不友好的,如果我們在每個頁面需要獲取數據的時候直接,通過Ajax調用傳參如:
$.ajax({
url:"http://www.microsoft.com", //請求的url地址
dataType:"json", //返回格式爲json
async:true,//請求是否異步,默認爲異步,這也是ajax重要特性
data:{"id":"value"}, //參數值
type:"GET", //請求方式
beforeSend:function(){
//請求前的處理
},
success:function(req){
//請求成功時處理
},
complete:function(){
//請求完成的處理
},
error:function(){
//請求出錯處理
}
});
下面是參數:
1.url:
要求爲String類型的參數,(默認爲當前頁地址)發送請求的地址。2.type:
要求爲String類型的參數,請求方式(post或get)默認爲get。注意其他http請求方法,例如put和delete也可以使用,但僅部分瀏覽器支持。3.timeout:
要求爲Number類型的參數,設置請求超時時間(毫秒)。此設置將覆蓋$.ajaxSetup()方法的全局設置。4.async:
要求爲Boolean類型的參數,默認設置爲true,所有請求均爲異步請求。如果需要發送同步請求,請將此選項設置爲false。注意,同步請求將鎖住瀏覽器,用戶其他操作必須等待請求完成纔可以執行。5.cache:
要求爲Boolean類型的參數,默認爲true(當dataType爲script時,默認爲false),設置爲false將不會從瀏覽器緩存中加載請求信息。6.data:
要求爲Object或String類型的參數,發送到服務器的數據。如果已經不是字符串,將自動轉換爲字符串格式。get請求中將附加在url後。防止這種自動轉換,可以查看 processData選項。對象必須爲key/value格式,例如{foo1:"bar1",foo2:"bar2"}轉換爲&foo1=bar1&foo2=bar2。如果是數組,JQuery將自動爲不同值對應同一個名稱。例如{foo:["bar1","bar2"]}轉換爲&foo=bar1&foo=bar2。7.dataType:
要求爲String類型的參數,預期服務器返回的數據類型。如果不指定,JQuery將自動根據http包mime信息返回responseXML或responseText,並作爲回調函數參數傳遞。可用的類型如下:
xml:返回XML文檔,可用JQuery處理。
html:返回純文本HTML信息;包含的script標籤會在插入DOM時執行。
script:返回純文本JavaScript代碼。不會自動緩存結果。除非設置了cache參數。注意在遠程請求時(不在同一個域下),所有post請求都將轉爲get請求。
json:返回JSON數據。
jsonp:JSONP格式。使用SONP形式調用函數時,例如myurl?callback=?,JQuery將自動替換後一個“?”爲正確的函數名,以執行回調函數。
text:返回純文本字符串。8.beforeSend:
要求爲Function類型的參數,發送請求前可以修改XMLHttpRequest對象的函數,例如添加自定義HTTP頭。在beforeSend中如果返回false可以取消本次ajax請求。XMLHttpRequest對象是惟一的參數。
function(XMLHttpRequest){
this; //調用本次ajax請求時傳遞的options參數
}
9.complete:
要求爲Function類型的參數,請求完成後調用的回調函數(請求成功或失敗時均調用)。參數:XMLHttpRequest對象和一個描述成功請求類型的字符串。
function(XMLHttpRequest, textStatus){
this; //調用本次ajax請求時傳遞的options參數
}10.success:要求爲Function類型的參數,請求成功後調用的回調函數,有兩個參數。
(1)由服務器返回,並根據dataType參數進行處理後的數據。
(2)描述狀態的字符串。
function(data, textStatus){
//data可能是xmlDoc、jsonObj、html、text等等
this; //調用本次ajax請求時傳遞的options參數
}11.error:
要求爲Function類型的參數,請求失敗時被調用的函數。該函數有3個參數,即XMLHttpRequest對象、錯誤信息、捕獲的錯誤對象(可選)。ajax事件函數如下:
function(XMLHttpRequest, textStatus, errorThrown){
//通常情況下textStatus和errorThrown只有其中一個包含信息
this; //調用本次ajax請求時傳遞的options參數
}12.contentType:
要求爲String類型的參數,當發送信息至服務器時,內容編碼類型默認爲"application/x-www-form-urlencoded"。該默認值適合大多數應用場合。13.dataFilter:
要求爲Function類型的參數,給Ajax返回的原始數據進行預處理的函數。提供data和type兩個參數。data是Ajax返回的原始數據,type是調用jQuery.ajax時提供的dataType參數。函數返回的值將由jQuery進一步處理。
function(data, type){
//返回處理後的數據
return data;
}14.dataFilter:
要求爲Function類型的參數,給Ajax返回的原始數據進行預處理的函數。提供data和type兩個參數。data是Ajax返回的原始數據,type是調用jQuery.ajax時提供的dataType參數。函數返回的值將由jQuery進一步處理。
function(data, type){
//返回處理後的數據
return data;
}15.global:
要求爲Boolean類型的參數,默認爲true。表示是否觸發全局ajax事件。設置爲false將不會觸發全局ajax事件,ajaxStart或ajaxStop可用於控制各種ajax事件。16.ifModified:
要求爲Boolean類型的參數,默認爲false。僅在服務器數據改變時獲取新數據。服務器數據改變判斷的依據是Last-Modified頭信息。默認值是false,即忽略頭信息。17.jsonp:
要求爲String類型的參數,在一個jsonp請求中重寫回調函數的名字。該值用來替代在"callback=?"這種GET或POST請求中URL參數裏的"callback"部分,例如{jsonp:'onJsonPLoad'}會導致將"onJsonPLoad=?"傳給服務器。18.username:
要求爲String類型的參數,用於響應HTTP訪問認證請求的用戶名。19.password:
要求爲String類型的參數,用於響應HTTP訪問認證請求的密碼。20.processData:
要求爲Boolean類型的參數,默認爲true。默認情況下,發送的數據將被轉換爲對象(從技術角度來講並非字符串)以配合默認內容類型"application/x-www-form-urlencoded"。如果要發送DOM樹信息或者其他不希望轉換的信息,請設置爲false。21.scriptCharset:
要求爲String類型的參數,只有當請求時dataType爲"jsonp"或者"script",並且type是GET時纔會用於強制修改字符集(charset)。通常在本地和遠程的內容編碼不同時使用。
如果每次通過這樣的方式有一個請求就要寫一次,這樣代碼很長也不易閱讀和維護。於是有人可能是把Ajax再分裝一個方法,把公共的部分寫進方法裏,把一些如url、data當做參數傳遞,但這種方式依然不是很好。
第一步
那麼今天我們重點來說一說如何通過async方法實現api接口調用。在jquery 2.x.x的版本之後$.ajax()
都可以返回Promise對象,所以我們可以在async方法中await之後直接寫 $.ajax()
,然後再把它return
出去如下所示
const myRequest = async (params = {},url) => {
let data = params.query || {};
data.id = 'value',
let res = await $.ajax({
url:url,
method: params.method || 'GET',
data:data,
})
return res;
}
第二步
我們可以把我們所有需要請求的,請求方法都寫在一個單獨的文件,命名爲api.js。因爲相同的請求地址請求的參數也有可能是不同的,所以我們需要把請求參數,作爲新的方法的參數傳遞進去。
// api.js
const baseUrl= 'https://sujiefs.com/';
const getAdList = (params) => myRequest(params, apiMall + '/api/adverts/list');
const getAdList2 = (params) => myRequest(params, apiMall + '/api/adverts/list2');
const getAdList3 = (params) => wxRequest(params, apiMall + '/api/adverts/list3');
const getAdList4 = (params) => myRequest(params, apiMall + '/api/adverts/list4');
第三步
此時我們就可以根據需求在需要的地方調用對應的請求數據,
getAdList({query: {}}).then(res => console.log(JSON.parse(res)));
async/await多個函數關聯調用
async/await使得異步代碼看起來像同步代碼
async函數會隱式地返回一個promise,而promise的reosolve值就是函數return的值
Async/Await不需要寫.then,不需要寫匿名函數處理Promise的resolve值,也不需要定義多餘的data變量,還避免了嵌套代碼
async聲明一個異步函數
await只能在async函數中使用,後面跟一個promise對象
所以在模擬異步調用函數時,函數體內返回promise
async/await缺點
async函數裏,無論是Promise reject的數據還是邏輯報錯,都會被默默吞掉。所以最好把await放入try{}catch{}中,或者在async返回的promise對象中使用.cache捕獲錯誤。
實現
項目中實現三個不同的接口調用,三個接口是相互關聯的,前一個接口的返回值是後一個接口的參數,如果使用Promise實現的話,只能實現異步調用,但是無法相互關聯,也就是數據不互通,所以使用async/await實現
- 接口調用的方法獨立封裝,參數可動態設置
- async聲明異步方法,內部使用await關鍵字調用封裝的接口,參數可直接傳入
- async/await相當於將Promise異步調用同步化,數據可實現關聯
- async/await會默認返回一個Promise對象,在實際調用中使用cache捕獲錯誤
代碼實現
<script>
//再此使用定時器模擬異步接口的調用
// 異步函數a
function a() {
return new Promise(resolve => {
setTimeout(()=>{
resolve('a')
}, 1000)
})
}
// 異步函數b,關聯a參數
function b(a) {
return new Promise(resolve => {
setTimeout(()=>{
resolve(a+'b')
}, 1000)
})
}
// 異步函數c,關聯b參數
function c(b) {
return new Promise(resolve => {
setTimeout(()=>{
resolve(b+'c')
}, 1000)
})
}
// 同步執行三個關聯的異步函數
async function d(){
const da = await a();
const db = await b(da);
const dc = await c(db);
return dc;
}
// 實際調用
d().then(res=>{
console.log(res)
}).catch(err=>{
console.log(err)
});
</script>
到此,分享就結束了,此文只是本人在學習過程中的一些總結,也怕自己忘了就把它大致的記了一下,如果我說的不對或有問題的地方煩請大家指出或提問,彼此也可以互相學習一下,如果能幫到你,請點個贊再走吧~~~~~