JS中fetch()用法實例詳解
了解fetch
- Fetch API 提供了一個獲取資源的接口(包括跨域請求),用于取代傳統(tǒng)的XMLHttpRequest的,在 JavaScript 腳本里面發(fā)出 HTTP 請求。
- 目前還沒有被所有瀏覽器支持,如果考慮低版本瀏覽器的問題的話,引入https://github.com/github/fetch/blob/master/fetch.js即可兼容。
- Fetch API是基于promise的設計,返回的是Promise對象,它是為了取代傳統(tǒng)xhr的不合理的寫法而生的。
沒有fetch時我們獲取異步資源的方式:
//舉例:發(fā)送一個get請求
//實例化一個XMLHttpResquest對象
var xhr = new XMLHttpResquest();
//注冊httpRequest.readyState改變時會回調的函數(shù),xhr.onreadystatechange
//readyState共有5個可能的值,
//0 UNSENT (未打開) open()方法還未被調用;
//1 OPENED (未發(fā)送) send()方法還未被調用;
//2 HEADERS_RECEIVED (已獲取響應頭) send()方法已經被調用, 響應頭和響應狀態(tài)已經返回;
//3 LOADING (正在下載響應體) 響應體下載中; responseText中已經獲取了部分數(shù)據;
//4 DONE (請求完成) 整個請求過程已經完畢.
xhr.onreadystatechange = function(){
//該回調函數(shù)會被依次調用4次
console.log(xhr.resdyState);
//請求已完成
if(xhr.readyState===4){
//http狀態(tài)為200
if(xhr.status===200){
//打印響應來的數(shù)據
console.log(xhr.response);
//JSON.parse()將JSON格式的字符串轉化為JSON對象
var data = JSON.parse(xhr.response);
//打印得到的JSON對象
console.log(data);
}
}
}
//請求的網址
var url = '網址';;
//該方法為初始化請求,第一個參數(shù)是請求的方法,比如GET,POST,PUT,第二個參數(shù)是請求的url,第三個參數(shù)為true表示發(fā)送異步請求
xhr.open('GET',url,true);
//設置http請求頭
httpRequest.setRequestHeader("Content-Type","application/json");
//發(fā)出請求,參數(shù)為要發(fā)送的body體,如果是GET方法的話,一般無需發(fā)送body,設為空就可以
httpRequest.send(null);
使用fetch后我們獲取異步資源的方式
//請求的網址
var url = '網址';;
//發(fā)起get請求
var promise = fetch(url).then(function(response) {
//response.status表示響應的http狀態(tài)碼
if(response.status === 200){
//json是返回的response提供的一個方法,會把返回的json字符串反序列化成對象,也被包裝成一個Promise了
return response.json();
}else{
return {}
}
});
promise = promise.then(function(data){
//響應的內容
console.log(data);
}).catch(function(err){
console.log(err);
})
比較:
- fetch()使用 Promise,不使用回調函數(shù),因此大大簡化了寫法,寫起來更簡潔。
- fetch()采用模塊化設計,API 分散在多個對象上(Response 對象、Request 對象、Headers 對象),更合理一些;相比之下,XMLHttpRequest 的 API 設計并不是很好,輸入、輸出、狀態(tài)都在同一個接口管理,容易寫出非?;靵y的代碼。
- fetch()通過數(shù)據流(Stream對象)處理數(shù)據,可以分塊讀取,有利于提高網站性能表現(xiàn),減少內存占用,對于請求大文件或者網速慢的場景相當有用。XMLHTTPRequest對象不支持數(shù)據流,所有的數(shù)據必須放在緩存里,不支持分塊讀取,必須等待全部拿到后,再一次性吐出來。
fetch的語法
fetch(url) .then(...) .catch(...)
示例:
fetch('網址')
// fetch()接收到的response是一個 Stream 對象
// response.json()是一個異步操作,取出所有內容,并將其轉為 JSON 對象
.then(response => response.json())
.then(json => console.log(json))//獲取到的json數(shù)據
.catch(err => console.log('Request Failed', err));
// 等價于以下寫法
async function getJSON() {
let url = '網址';
try {
let response = await fetch(url);
return await response.json();
} catch (error) {
console.log('Request Failed', error);
}
}
console.log(getJSON()); // 獲取到的json數(shù)據
fetch的Response對象
1.同步屬性
fetch()請求成功以后,得到的是一個Response對象。它對應服務器的HTTP回應。Response包含的數(shù)據通過Stream接口異步讀取,但是它還包含一些同步屬性,對應 HTTP 回應的標頭信息(Headers),可以立即讀取。
示例:
async function getfetchText() {
let response = await fetch('網址');
console.log(response.status); // 獲取http狀態(tài)碼 //200
console.log(response.statusText); // 獲取http回應的狀態(tài)信息
}
getfetchText()
標頭信息的屬性有:
const response = await fetch(url); - response.ok:返回一個布爾值,表示請求是否成功 例如:true對應 HTTP 請求的狀態(tài)碼 200 到 299,false對應其他的狀態(tài)碼。 - response.status:返回一個數(shù)字,表示 HTTP 回應的狀態(tài)碼 例如:200,表示成功請求 - response.statusText屬性返回一個字符串,表示 HTTP 回應的狀態(tài)信息 例如:請求成功以后,服務器返回"OK" - response.url:返回請求的 URL。 如果: URL 存在跳轉,該屬性返回的是最終 URL。 - response.redirected:返回一個布爾值,表示請求是否發(fā)生過跳轉。 - response.type:返回請求的類型??赡艿闹等缦拢? basic:普通請求,即同源請求。 cors:跨域請求。 error:網絡錯誤,主要用于 Service Worker。
2.判斷請求是否成功發(fā)出
第一種方法:
- fetch()發(fā)出請求以后,只有網絡錯誤或者無法連接時,fetch()才會報錯,其他情況都不會報錯,而是認為請求成功。
- 只有通過Response.status屬性,得到HTTP 回應的真實狀態(tài)碼,才能判斷請求是否成功
示例:
async function getfetchText() {
let response = await fetch('網址');
if (response.status >= 200 && response.status < 300) {
return await response.text();
} else {
throw new Error(response.statusText);
}
}
第二種方法:
判斷response.ok是否為true
示例:
if (response.ok) {
// 請求成功
console.log('請求成功')
} else {
// 請求失敗
console.log(‘請求失敗')
}
3.操作標頭
- Response 對象還有一Response.headers屬性,指向一個 Headers 對象,對應 HTTP 回應的所有標頭。
- 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()) {
//response.heasers.entries()方法返回一個遍歷器,可以依次遍歷所有鍵值對([key,value])
console.log(`${key} : ${value}`);
}
用來操作標頭的方法有:
下面的有些方法可以修改標頭,那是因為繼承自 Headers 接口。對于 HTTP回應來說,修改標頭意義不大,況且很多標頭是只讀的,瀏覽器不允許修改。
比較常用的也就是response.headers.get()
const response = await fetch(url);
response.headers.get():根據指定的鍵名,返回鍵值。
response.headers.has(): 返回一個布爾值,表示是否包含某個標頭。
response.headers.set():將指定的鍵名設置為新的鍵值,如果該鍵名不存在則會添加。
response.headers.append():添加標頭。
response.headers.delete():刪除標頭。
response.headers.keys():返回一個遍歷器,可以依次遍歷所有鍵名。
response.headers.values():返回一個遍歷器,可以依次遍歷所有鍵值。
response.headers.entries():返回一個遍歷器,可以依次遍歷所有鍵值對([key, value])。
response.headers.forEach():依次遍歷標頭,每個標頭都會執(zhí)行一次參數(shù)函數(shù)。
4.讀取Response對象內容的方法
const response = await fetch(url);
response.text():得到文本字符串,用于獲取文本數(shù)據,比如 HTML 文件。
response.json():得到 JSON 對象。
response.blob():得到二進制 Blob 對象,例如讀取圖片文件,顯示在網頁上。
response.formData():得到 FormData 表單對象,主要用在 Service Worker 里面,攔截用戶提交的表單,修改某些數(shù)據以后,再提交給服務器。
response.arrayBuffer():得到二進制 ArrayBuffer 對象,主要用于獲取流媒體文件。
5.創(chuàng)建副本(clone)
Stream 對象只能讀取一次,讀取完就沒了,這意味著五個讀取方法,只能使用一個,否則會報錯。
示例:
// 先使用了response.text(),就把 Stream 讀完了。 // 后面再調用response.json(),就沒有內容可讀了,所以報錯。 let text = await response.text(); let json = await response.json(); // 報錯
Response 對象提供Response.clone()方法,創(chuàng)建Response對象的副本,實現(xiàn)多次讀取。
示例:
const response1 = await fetch('圖片地址');
// response.clone()復制了一份 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 對象,供用戶操作
例如:用來分塊讀取內容,顯示下載的進度
const response = await fetch('圖片地址');
// response.body.getReader()方法返回一個遍歷器
const reader = response.body.getReader();
while(true) {
// 這個遍歷器的read()方法每次返回一個對象,表示本次讀取的內容塊
const {done, value} = await reader.read();
// done屬性是一個布爾值,用來判斷有沒有讀完
if (done) {
break;
}
// value屬性是一個 arrayBuffer 數(shù)組,表示內容塊的內容,而value.length屬性是當前塊的大小
console.log(`Received ${value.length} bytes`)
}
定制HTTP請求
fetch()的第一個參數(shù)是 URL,還可以接受第二個參數(shù)optionObj,作為配置對象,定制發(fā)出的 HTTP 請求。
HTTP 請求的方法、標頭、數(shù)據體都在這個optionObj對象里面設置
fetch(url,optionObj)
fetch()請求的底層用的是 Request() 對象的接口,參數(shù)完全一樣,因此上面的 API 也是 Request()的 API
fetch()的第二個參數(shù)的完整API如下:
const response = fetch(url, {
method: "GET",//請求方式
headers: {//定制http請求的標頭
"Content-Type": "text/plain;charset=UTF-8"
},
body: undefined,//post請求的數(shù)據體,因為此時為get請求,故為undefined
referrer: "about:client",
referrerPolicy: "no-referrer-when-downgrade",//用于設定fetch請求的referer標頭
mode: "cors", //指定請求模式,此時為cors表示支持跨域請求
credentials: "same-origin",//發(fā)送cookie
cache: "default",//指定如何處理緩存
redirect: "follow",
integrity: "",
keepalive: false,
signal: undefined
});
參數(shù)詳解:
method:HTTP 請求的方法,POST、DELETE、PUT都在這個屬性設置。
headers:一個對象,用來定制 HTTP 請求的標頭。
body:POST 請求的數(shù)據體。
cache:指定如何處理緩存??赡艿娜≈等缦拢?
/*
default:默認值,先在緩存里面尋找匹配的請求。
no-store:直接請求遠程服務器,并且不更新緩存。
reload:直接請求遠程服務器,并且更新緩存。
no-cache:將服務器資源跟本地緩存進行比較,有新的版本才使用服務器資源,否則使用緩存。
force-cache:緩存優(yōu)先,只有不存在緩存的情況下,才請求遠程服務器。
only-if-cached:只檢查緩存,如果緩存里面不存在,將返回504錯誤。
*/
mode: 指定請求的模式??赡艿娜≈等缦拢?
/*
cors:默認值,允許跨域請求。
same-origin:只允許同源請求。
no-cors:請求方法只限于 GET、POST 和 HEAD,并且只能使用有限的幾個簡單標頭,不能添加跨域的復雜標頭,相當于提交表單所能發(fā)出的請求。
*/
credentials:指定是否發(fā)送 Cookie??赡艿娜≈等缦拢?
/*
same-origin:默認值,同源請求時發(fā)送 Cookie,跨域請求時不發(fā)送。
include:不管同源請求,還是跨域請求,一律發(fā)送 Cookie。
omit:一律不發(fā)送。
*/
signal:指定一個 AbortSignal 實例,用于取消fetch()請求
keepalive:用于頁面卸載時,告訴瀏覽器在后臺保持連接,繼續(xù)發(fā)送數(shù)據。
/*
一個典型的場景就是,用戶離開網頁時,腳本向服務器提交一些用戶行為的統(tǒng)計信息。
這時,如果不用keepalive屬性,數(shù)據可能無法發(fā)送,因為瀏覽器已經把頁面卸載了。
*/
redirect: 指定 HTTP 跳轉的處理方法??赡艿娜≈等缦拢?
/*
follow:默認值,fetch()跟隨 HTTP 跳轉。
error:如果發(fā)生跳轉,fetch()就報錯。
manual:fetch()不跟隨 HTTP 跳轉,但是response.url屬性會指向新的 URL,response.redirected屬性會變?yōu)閠rue,由開發(fā)者自己決定后續(xù)如何處理跳轉。
*/
integrity:指定一個哈希值,用于檢查 HTTP 回應傳回的數(shù)據是否等于這個預先設定的哈希值。
/*
比如,下載文件時,檢查文件的 SHA-256 哈希值是否相符,確保沒有被篡改
fetch('http://site.com/file', {
integrity: 'sha256-abcdef'
});
*/
referrer: 用于設定fetch請求的referer標頭。
/*
這個屬性可以為任意字符串,也可以設為空字符串(即不發(fā)送referer標頭)。
*/
referrerPolicy: 用于設定Referer標頭的規(guī)則。可能的取值如下:
/*
no-referrer-when-downgrade:默認值,總是發(fā)送Referer標頭,除非從 HTTPS 頁面請求 HTTP 資源時不發(fā)送。
no-referrer:不發(fā)送Referer標頭。
origin:Referer標頭只包含域名,不包含完整的路徑。
origin-when-cross-origin:同源請求Referer標頭包含完整的路徑,跨域請求只包含域名。
same-origin:跨域請求不發(fā)送Referer,同源請求發(fā)送。
strict-origin:Referer標頭只包含域名,HTTPS 頁面請求 HTTP 資源時不發(fā)送Referer標頭。
strict-origin-when-cross-origin:同源請求時Referer標頭包含完整路徑,跨域請求時只包含域名,HTTPS 頁面請求 HTTP 資源時不發(fā)送該標頭。
unsafe-url:不管什么情況,總是發(fā)送Referer標頭。
*/
取消fetch請求
fetch()請求發(fā)送后,如果中途想要取消,需要使用AbortController對象
//創(chuàng)建一個AbortController實例
let controller = new AbortController();
fetch(url, {
signal: controller.signal
});
//給controller.signal綁定監(jiān)聽事件,controller.signal的值改變則會觸發(fā)abort事件
controller.signal.addEventListener('abort',
() => console.log('abort!')
);
// controller.abort()方法用于發(fā)出取消信號。這時會觸發(fā)abort事件,這個事件可以監(jiān)聽
controller.abort(); // 取消
// 可以通過controller.signal.aborted屬性判斷取消信號是否已經發(fā)出
console.log(controller.signal.aborted); // true
實例:
//創(chuàng)建實例
let controller = new AbortController();
//設置定時器
setTimeout(() => controller.abort(), 1000);
try {
let response = await fetch('路徑', {
signal: controller.signal
});
} catch(err) {
if (err.name == 'AbortError') {
console.log('Aborted!');
} else {
throw err;
}
}
總結
到此這篇關于JS中fetch()用法詳解的文章就介紹到這了,更多相關JS fetch()用法內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
JavaScript中無法通過div.style.left獲取值的解決方法
這篇文章主要介紹了JavaScript中無法通過div.style.left獲取值的問題分析及解決方法,需要的朋友可以參考下2017-02-02
uni-app實現(xiàn)數(shù)據上拉加載更多功能實例
數(shù)據列表在很多時候,經常會用到,下面這篇文章主要給大家介紹了關于uni-app實現(xiàn)數(shù)據上拉加載更多功能的相關資料,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2022-08-08
使用JSX 建立 Markup 組件風格開發(fā)的示例(前端組件化)
這篇文章主要介紹了使用JSX 建立 Markup 組件風格開發(fā)的示例(前端組件化)本文重點講解如何從0搭建一個組件系統(tǒng),在這里我們會學習使用JSX來建立markup 的風格,我們基于與React 一樣的 JSX 去建立我們組件的風格2021-04-04
淺談Vue3.0之前你必須知道的TypeScript實戰(zhàn)技巧
這篇文章主要介紹了淺談Vue3.0之前你必須知道的TypeScript實戰(zhàn)技巧,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2019-09-09
深入理解JavaScript系列(10) JavaScript核心(晉級高手必讀篇)
本篇是ECMA-262-3 in detail系列的一個概述(本人后續(xù)會翻譯整理這些文章到本系列(第11-19章)。每個章節(jié)都有一個更詳細的內容鏈接,你可以繼續(xù)讀一下每個章節(jié)對應的詳細內容鏈接進行更深入的了解2012-01-01

