JavaScript中fetch()用法實例
fetch 基本使用
- Fetch API 提供了一個獲取資源的接口(包括跨域請求),用于取代傳統(tǒng)的XMLHttpRequest的,在 JavaScript 腳本里面發(fā)出 HTTP 請求。
- 目前還沒有被所有瀏覽器支持,如果考慮低版本瀏覽器的問題的話,引入https://github.com/github/fetch/blob/master/fetch.js 即可兼容。
- fetch api是基于promise的設(shè)計,返回的是Promise對象,它是為了取代傳統(tǒng)xhr的不合理的寫法而生的。
沒有fetch的時候,我們是這樣獲取異步資源的:
//發(fā)送一個get請求是這樣的: //首先實例化一個XMLHttpRequest對象 var httpRequest = new XMLHttpRequest(); //注冊httpRequest.readyState改變時會回調(diào)的函數(shù),httpRequest. //readyState共有5個可能的值, //0 UNSENT (未打開) open()方法還未被調(diào)用; //1 OPENED (未發(fā)送) send()方法還未被調(diào)用; //2 HEADERS_RECEIVED (已獲取響應(yīng)頭) send()方法已經(jīng)被調(diào)用, 響應(yīng)頭和響應(yīng)狀態(tài)已經(jīng)返回; //3 LOADING (正在下載響應(yīng)體) 響應(yīng)體下載中; responseText中已經(jīng)獲取了部分?jǐn)?shù)據(jù); //4 DONE (請求完成) 整個請求過程已經(jīng)完畢. httpRequest.onreadystatechange = function(){ //該回調(diào)函數(shù)會被依次調(diào)用4次 console.log(httpRequest.readyState); if(httpRequest.readyState===4){ //請求已完成 if(httpRequest.status===200){ //http狀態(tài)為200 console.log(httpRequest.response); var data = JSON.parse(httpRequest.response); console.log(data); } } } //請求的網(wǎng)址 var url = 'https://api.github.com/users/ruanyf';; //該方法為初始化請求,第一個參數(shù)是請求的方法,比如GET,POST,PUT,第二個參數(shù)是請求的url httpRequest.open('GET',url,true); //設(shè)置http請求頭 httpRequest.setRequestHeader("Content-Type","application/json"); //發(fā)出請求,參數(shù)為要發(fā)送的body體,如果是GET方法的話,一般無需發(fā)送body,設(shè)為空就可以 httpRequest.send(null);
如果用了fetch之后,發(fā)送一個get請求是這樣的:
//請求的網(wǎng)址 var url = 'https://api.github.com/users/ruanyf';; //發(fā)起get請求 var promise = fetch(url).then(function(response) { //response.status表示響應(yīng)的http狀態(tài)碼 if(response.status === 200){ //json是返回的response提供的一個方法,會把返回的json字符串反序列化成對象,也被包裝成一個Promise了 return response.json(); }else{ return {} } }); promise = promise.then(function(data){ //響應(yīng)的內(nèi)容 console.log(data); }).catch(function(err){ console.log(err); })
注意事項:
- fetch()使用 Promise,不使用回調(diào)函數(shù),因此大大簡化了寫法,寫起來更簡潔。
- fetch()采用模塊化設(shè)計,API 分散在多個對象上(Response 對象、Request 對象、Headers 對象),更合理一些;相比之下,XMLHttpRequest 的 API 設(shè)計并不是很好,輸入、輸出、狀態(tài)都在同一個接口管理,容易寫出非?;靵y的代碼。
- fetch()通過數(shù)據(jù)流(Stream 對象)處理數(shù)據(jù),可以分塊讀取,有利于提高網(wǎng)站性能表現(xiàn),減少內(nèi)存占用,對于請求大文件或者網(wǎng)速慢的場景相當(dāng)有用。XMLHTTPRequest 對象不支持?jǐn)?shù)據(jù)流,所有的數(shù)據(jù)必須放在緩存里,不支持分塊讀取,必須等待全部拿到后,再一次性吐出來。
語法:
fetch(url) .then(...) .catch(...)
例如:從服務(wù)器獲取 JSON 數(shù)據(jù)
fetch('https://api.github.com/users/ruanyf') // fetch()接收到的response是一個 Stream 對象 // response.json()是一個異步操作,取出所有內(nèi)容,并將其轉(zhuǎn)為 JSON 對象 .then(response => response.json()) .then(json => console.log(json)) .catch(err => console.log('Request Failed', err)); // 等價于以下寫法 async function getJSON() { let url = 'https://api.github.com/users/ruanyf'; try { let response = await fetch(url); return await response.json(); } catch (error) { console.log('Request Failed', error); } } console.log(getJSON()); // 獲取到的json數(shù)據(jù)
Response 對象
使用案例
export const winFetch = async ({ url, description, method, body, }: { url: string; description: string; method: string; body: { [key: string]: any }; }) => { console.info(description, url, body); const res = await new Promise((resolve, reject) => { window .fetch(baseURL + url, { method, headers: { 'content-type': 'application/json' }, mode: 'cors', credentials: 'include', body: JSON.stringify(body), }) .then((response) => response?.json().then( (json) => resolve(json), (err) => reject(err), ), ); }); return { data: res } as { data: { data: { [key: string]: any } } }; }; export async function delete(body: { id: number }) { const res = await winFetch({ url: '/aaa/bbb/delete/', description: '刪除信息', method: 'DELETE', body, }); return res.data.data; }
1、同步屬性
fetch()請求成功以后,得到的是一個 Response 對象。它對應(yīng)服務(wù)器的 HTTP 回應(yīng)。
Response 包含的數(shù)據(jù)通過 Stream 接口異步讀取,但是它還包含一些同步屬性,對應(yīng) HTTP 回應(yīng)的標(biāo)頭信息(Headers),可以立即讀取。
async function fetchText() { let response = await fetch('https://api.github.com/users/ruanyf'); console.log(response.status); // 200 console.log(response.statusText); // } fetchText()
標(biāo)頭信息屬性有下面這些:
const response = await fetch(url);
1. response.ok:返回一個布爾值,表示請求是否成功
例如:true對應(yīng) HTTP 請求的狀態(tài)碼 200 到 299,false對應(yīng)其他的狀態(tài)碼。2. response.status:返回一個數(shù)字,表示 HTTP 回應(yīng)的狀態(tài)碼
例如:200,表示成功請求3. response.statusText屬性返回一個字符串,表示 HTTP 回應(yīng)的狀態(tài)信息
例如:請求成功以后,服務(wù)器返回"OK"4. response.url:返回請求的 URL。
如果: URL 存在跳轉(zhuǎn),該屬性返回的是最終 URL。5. response.redirected:返回一個布爾值,表示請求是否發(fā)生過跳轉(zhuǎn)。
6. response.type:返回請求的類型??赡艿闹等缦拢?br />basic:普通請求,即同源請求。
cors:跨域請求。
error:網(wǎng)絡(luò)錯誤,主要用于 Service Worker。
2、判斷請求
fetch()發(fā)出請求以后,只有網(wǎng)絡(luò)錯誤或者無法連接時,fetch()才會報錯,其他情況都不會報錯,而是認(rèn)為請求成功。
只有通過Response.status屬性,得到 HTTP 回應(yīng)的真實狀態(tài)碼,才能判斷請求是否成功
async function fetchText() { let response = await fetch('/readme.txt'); if (response.status >= 200 && response.status < 300) { return await response.text(); } else { throw new Error(response.statusText); } }
另一種方法是判斷response.ok是否為true
if (response.ok) { // 請求成功 } else { // 請求失敗 }
3、操作標(biāo)頭
Response 對象還有一個Response.headers屬性,指向一個 Headers 對象,對應(yīng) HTTP 回應(yīng)的所有標(biāo)頭。
Headers 對象可以使用for...of循環(huán)進行遍歷
const response = await fetch(url); for (let [key, value] of response.headers) { console.log(`${key} : ${value}`); } // 或者 for (let [key, value] of response.headers.entries()) { console.log(`${key} : ${value}`); }
提供了以下方法,用來操作標(biāo)頭
下面的有些方法可以修改標(biāo)頭,那是因為繼承自 Headers 接口。對于 HTTP 回應(yīng)來說,修改標(biāo)頭意義不大,況且很多標(biāo)頭是只讀的,瀏覽器不允許修改。
比較常用的也就是response.headers.get()
const response = await fetch(url); response.headers.get():根據(jù)指定的鍵名,返回鍵值。 response.headers.has(): 返回一個布爾值,表示是否包含某個標(biāo)頭。 response.headers.set():將指定的鍵名設(shè)置為新的鍵值,如果該鍵名不存在則會添加。 response.headers.append():添加標(biāo)頭。 response.headers.delete():刪除標(biāo)頭。 response.headers.keys():返回一個遍歷器,可以依次遍歷所有鍵名。 response.headers.values():返回一個遍歷器,可以依次遍歷所有鍵值。 response.headers.entries():返回一個遍歷器,可以依次遍歷所有鍵值對([key, value])。 response.headers.forEach():依次遍歷標(biāo)頭,每個標(biāo)頭都會執(zhí)行一次參數(shù)函數(shù)。
4、讀取內(nèi)容
Response對象根據(jù)服務(wù)器返回的不同類型的數(shù)據(jù),提供了不同的讀取方法。
下面5個讀取方法都是異步的,返回的都是 Promise 對象。必須等到異步操作結(jié)束,才能得到服務(wù)器返回的完整數(shù)據(jù)。
const response = await fetch(url); response.text():得到文本字符串,用于獲取文本數(shù)據(jù),比如 HTML 文件。 response.json():得到 JSON 對象。 response.blob():得到二進制 Blob 對象,例如讀取圖片文件,顯示在網(wǎng)頁上。 response.formData():得到 FormData 表單對象,主要用在 Service Worker 里面,攔截用戶提交的表單,修改某些數(shù)據(jù)以后,再提交給服務(wù)器。 response.arrayBuffer():得到二進制 ArrayBuffer 對象,主要用于獲取流媒體文件。
5、創(chuàng)建副本
Stream 對象只能讀取一次,讀取完就沒了。這意味著五個讀取方法,只能使用一個,否則會報錯。
// 先使用了response.text(),就把 Stream 讀完了。 // 后面再調(diào)用response.json(),就沒有內(nèi)容可讀了,所以報錯。 let text = await response.text(); let json = await response.json(); // 報錯
Response 對象提供Response.clone()方法,創(chuàng)建Response對象的副本,實現(xiàn)多次讀取。
const response1 = await fetch('flowers.jpg'); // response.clone()復(fù)制了一份 Response 對象,然后將同一張圖片讀取了兩次 const response2 = response1.clone(); const myBlob1 = await response1.blob(); const myBlob2 = await response2.blob(); image1.src = URL.createObjectURL(myBlob1); image2.src = URL.createObjectURL(myBlob2);
6、底層接口
Response.body屬性是 Response 對象暴露出的底層接口,返回一個 ReadableStream 對象,供用戶操作
例如:用來分塊讀取內(nèi)容,顯示下載的進度
const response = await fetch('flower.jpg'); // response.body.getReader()方法返回一個遍歷器 const reader = response.body.getReader(); while(true) { // 這個遍歷器的read()方法每次返回一個對象,表示本次讀取的內(nèi)容塊 const {done, value} = await reader.read(); // done屬性是一個布爾值,用來判斷有沒有讀完 if (done) { break; } // value屬性是一個 arrayBuffer 數(shù)組,表示內(nèi)容塊的內(nèi)容,而value.length屬性是當(dāng)前塊的大小 console.log(`Received ${value.length} bytes`) }
定制 HTTP 請求
fetch()的第一個參數(shù)是 URL,還可以接受第二個參數(shù),作為配置對象,定制發(fā)出的 HTTP 請求
HTTP 請求的方法、標(biāo)頭、數(shù)據(jù)體都在這個optionObj對象里面設(shè)置
fetch(url, optionObj)
fetch()第二個參數(shù)的完整 API 如下
fetch()請求的底層用的是 Request() 對象的接口,參數(shù)完全一樣,因此上面的 API 也是Request()的 API
const response = fetch(url, { method: "GET", headers: { "Content-Type": "text/plain;charset=UTF-8" }, body: undefined, referrer: "about:client", referrerPolicy: "no-referrer-when-downgrade", mode: "cors", credentials: "same-origin", cache: "default", redirect: "follow", integrity: "", keepalive: false, signal: undefined });
參數(shù)詳解
method:HTTP 請求的方法,POST、DELETE、PUT都在這個屬性設(shè)置。 headers:一個對象,用來定制 HTTP 請求的標(biāo)頭。 body:POST 請求的數(shù)據(jù)體。 cache:指定如何處理緩存??赡艿娜≈等缦拢? /* default:默認(rèn)值,先在緩存里面尋找匹配的請求。 no-store:直接請求遠程服務(wù)器,并且不更新緩存。 reload:直接請求遠程服務(wù)器,并且更新緩存。 no-cache:將服務(wù)器資源跟本地緩存進行比較,有新的版本才使用服務(wù)器資源,否則使用緩存。 force-cache:緩存優(yōu)先,只有不存在緩存的情況下,才請求遠程服務(wù)器。 only-if-cached:只檢查緩存,如果緩存里面不存在,將返回504錯誤。 */ mode: 指定請求的模式??赡艿娜≈等缦拢? /* cors:默認(rèn)值,允許跨域請求。 same-origin:只允許同源請求。 no-cors:請求方法只限于 GET、POST 和 HEAD,并且只能使用有限的幾個簡單標(biāo)頭,不能添加跨域的復(fù)雜標(biāo)頭,相當(dāng)于提交表單所能發(fā)出的請求。 */ credentials:指定是否發(fā)送 Cookie??赡艿娜≈等缦拢? /* same-origin:默認(rèn)值,同源請求時發(fā)送 Cookie,跨域請求時不發(fā)送。 include:不管同源請求,還是跨域請求,一律發(fā)送 Cookie。 omit:一律不發(fā)送。 */ signal:指定一個 AbortSignal 實例,用于取消fetch()請求 keepalive:用于頁面卸載時,告訴瀏覽器在后臺保持連接,繼續(xù)發(fā)送數(shù)據(jù)。 /* 一個典型的場景就是,用戶離開網(wǎng)頁時,腳本向服務(wù)器提交一些用戶行為的統(tǒng)計信息。 這時,如果不用keepalive屬性,數(shù)據(jù)可能無法發(fā)送,因為瀏覽器已經(jīng)把頁面卸載了。 */ redirect: 指定 HTTP 跳轉(zhuǎn)的處理方法??赡艿娜≈等缦拢? /* follow:默認(rèn)值,fetch()跟隨 HTTP 跳轉(zhuǎn)。 error:如果發(fā)生跳轉(zhuǎn),fetch()就報錯。 manual:fetch()不跟隨 HTTP 跳轉(zhuǎn),但是response.url屬性會指向新的 URL,response.redirected屬性會變?yōu)閠rue,由開發(fā)者自己決定后續(xù)如何處理跳轉(zhuǎn)。 */ integrity:指定一個哈希值,用于檢查 HTTP 回應(yīng)傳回的數(shù)據(jù)是否等于這個預(yù)先設(shè)定的哈希值。 /* 比如,下載文件時,檢查文件的 SHA-256 哈希值是否相符,確保沒有被篡改 fetch('http://site.com/file', { integrity: 'sha256-abcdef' }); */ referrer: 用于設(shè)定fetch請求的referer標(biāo)頭。 /* 這個屬性可以為任意字符串,也可以設(shè)為空字符串(即不發(fā)送referer標(biāo)頭)。 */ referrerPolicy: 用于設(shè)定Referer標(biāo)頭的規(guī)則??赡艿娜≈等缦拢? /* no-referrer-when-downgrade:默認(rèn)值,總是發(fā)送Referer標(biāo)頭,除非從 HTTPS 頁面請求 HTTP 資源時不發(fā)送。 no-referrer:不發(fā)送Referer標(biāo)頭。 origin:Referer標(biāo)頭只包含域名,不包含完整的路徑。 origin-when-cross-origin:同源請求Referer標(biāo)頭包含完整的路徑,跨域請求只包含域名。 same-origin:跨域請求不發(fā)送Referer,同源請求發(fā)送。 strict-origin:Referer標(biāo)頭只包含域名,HTTPS 頁面請求 HTTP 資源時不發(fā)送Referer標(biāo)頭。 strict-origin-when-cross-origin:同源請求時Referer標(biāo)頭包含完整路徑,跨域請求時只包含域名,HTTPS 頁面請求 HTTP 資源時不發(fā)送該標(biāo)頭。 unsafe-url:不管什么情況,總是發(fā)送Referer標(biāo)頭。 */
取消 fetch 請求
fetch()請求發(fā)送以后,如果中途想要取消,需要使用AbortController對象
let controller = new AbortController(); fetch(url, { signal: controller.signal }); controller.signal.addEventListener('abort', () => console.log('abort!') ); // controller.abort()方法用于發(fā)出取消信號。這時會觸發(fā)abort事件,這個事件可以監(jiān)聽 controller.abort(); // 取消 // 可以通過controller.signal.aborted屬性判斷取消信號是否已經(jīng)發(fā)出 console.log(controller.signal.aborted); // true
示例:1秒后自動取消請求
let controller = new AbortController(); setTimeout(() => controller.abort(), 1000); try { let response = await fetch('/long-operation', { signal: controller.signal }); } catch(err) { if (err.name == 'AbortError') { console.log('Aborted!'); } else { throw err; } }
總結(jié)
到此這篇關(guān)于JavaScript中fetch()用法的文章就介紹到這了,更多相關(guān)JS fetch()用法內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
JavaScript語法高亮插件highlight.js用法詳解【附highlight.js本站下載】
這篇文章主要介紹了JavaScript語法高亮庫highlight.js用法,詳細(xì)分析了highlight.js的下載、調(diào)用及具體使用技巧,需要的朋友可以參考下2016-11-11JS/HTML5游戲常用算法之碰撞檢測 地圖格子算法實例詳解
這篇文章主要介紹了JS/HTML5游戲常用算法之碰撞檢測 地圖格子算法,結(jié)合實例形式詳細(xì)分析了javascript碰撞檢測算法的相關(guān)原理、實現(xiàn)技巧與操作注意事項,需要的朋友可以參考下2018-12-12Bootstrap進度條與AJAX后端數(shù)據(jù)傳遞結(jié)合使用實例詳解
這篇文章主要介紹了Bootstrap進度條與AJAX后端數(shù)據(jù)傳遞結(jié)合使用,需要的朋友可以參考下2017-04-04簡略的前端架構(gòu)心得&&基于editor為例子的編碼小技巧
這一陣事情有點多,沒來的及更新神馬東西。今天分享兩個ppt吧。主要內(nèi)容是關(guān)于一些編碼的小技巧,另一個關(guān)于前端架構(gòu)的一些些東西。2010-11-11JS 控制小數(shù)位數(shù)的實現(xiàn)代碼
上網(wǎng)查一查的確存在這種Bug,除了位數(shù)上控制之外也沒什么也好的方法(希望高手能提出其它思路)。2011-08-08微信小程序教程系列之設(shè)置標(biāo)題欄和導(dǎo)航欄(7)
這篇文章主要為大家詳細(xì)介紹了微信小程序教程系列之標(biāo)題欄和導(dǎo)航欄的設(shè)置,文中示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-04-04