-

Javascript Fetch教程

WEB前端

fetch()是 浏览器原生提供这个对象。fetch()是 XMLHttpRequest 的升级版,用于在 JavaScript 脚本里面发出 HTTP 请求。下面雷雪松详细介绍fetch的用法。

一、基本用法
fetch()与 XMLHttpRequest 的功能基本相同,但有三个主要的差异。
(1)fetch()使用 Promise,不使用回调函数,因此大大简化了写法,写起来更简洁。
(2)fetch()采用模块化设计,API 分散在多个对象上(Response 对象、Request 对象、Headers 对象),更合理一些;相比之下,XMLHttpRequest 的 API 设计并不是很好,输入、输出、状态都在同一个接口管理,容易写出非常混乱的代码。
(3)fetch()通过数据流(Stream 对象)处理数据,可以分块读取,有利于提高网站性能表现,减少内存占用,对于请求大文件或者网速慢的场景相当有用。XMLHTTPRequest 对象不支持数据流,所有的数据必须放在缓存里,不支持分块读取,必须等待全部拿到后,再一次性吐出来。

fetch()接受一个 URL 字符串作为参数,默认向该网址发出 GET 请求,返回一个 Promise 对象。基本用法:fetch(url).then(…).catch(…)。

1
2
3
4
fetch('https://www.leixuesong.com')
.then(response => response.json())
.then(json => console.log(json))
.catch(err => console.log('Request Failed', err));

fetch()接收到的response是一个 Stream 对象,response.json()是一个异步操作,取出所有内容,并将其转为 JSON 对象。
Promise 可以使用 await 语法。如果捕捉异步操作中可能发生的错误,await语句必须放在try…catch里面。

1
2
3
4
5
6
7
8
9
async function getJSON() {
let url = 'https://www.leixuesong.com';
try {
let response = await fetch(url);
return await response.json();
} catch (error) {
console.log('Request Failed', error);
}
}

二、Request 对象:配置 HTTP 请求

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
const response = fetch(url, {
method: "GET",
headers: {
"Content-Type": "text/plain;charset=UTF-8"
},
body: undefined,
referrer: "about:client",//referer头
referrerPolicy: "no-referrer-when-downgrade",//设定Referer头的规则
mode: "cors", //指定请求的模式
credentials: "same-origin",//是否发送 Cookie
cache: "default", //如何处理缓存
redirect: "follow",//HTTP 跳转的处理方法
integrity: "",//指定一个哈希值,用于检查 HTTP 回应传回的数据是否等于这个预先设定的哈希值。
keepalive: false,//用于页面卸载时,告诉浏览器在后台保持连接,继续发送数据。
signal: undefined//指定一个 AbortSignal 实例
});

fetch()请求的底层用的是 Request() 对象的接口,参数完全一样。

三、Response 对象:处理 HTTP 响应
2.1 Response 对象的同步属性
fetch()请求成功以后,得到的是一个 Response 对象。Response 包含的数据需要通过 Stream 接口异步读取,但是它还包含一些同步属性,对应 HTTP 响应的头信息(Headers),可以立即读取。

1
2
3
4
5
async function fetchText() {
let response = await fetch('/article');
console.log(response.status);
console.log(response.statusText);
}

Response.ok:返回一个布尔值,表示请求是否成功,true对应 HTTP 请求的状态码 200 到 299,false对应其他的状态码。

Response.status:返回一个数字,表示 HTTP 响应的状态码(例如200,表示成功请求)。

Response.statusText:返回一个字符串,表示 HTTP 响应的状态信息(例如请求成功以后,服务器返回”OK”)。

Response.url:返回请求的 URL。如果 URL 存在跳转,该属性返回的是最终 URL。

Response.type:返回请求的类型。可能的值:basic:普通请求,即同源请求。cors:跨域请求。error:网络错误,主要用于 Service Worker。opaque:如果fetch()请求的type属性设为no-cors,就会返回这个值,详见请求部分。表示发出的是简单的跨域请求,类似<form>表单的那种跨域请求。opaqueredirect:如果fetch()请求的redirect属性设为manual,就会返回这个值,详见请求部分。

Response.redirected:返回一个布尔值,表示请求是否发生过跳转。

2.2 读取内容的方法
Response对象根据服务器返回的不同类型的数据,提供了不同的读取方法。返回的都是 Promise 对象,必须等到异步操作结束,才能得到服务器返回的完整数据。

response.text()可以用于获取文本数据,比如 HTML 文件。

1
2
3
4
const response = await fetch('/article');
const body = await response.text();
document.body.innerHTML = body
response.json()

response.formData()得到 FormData 表单对象。主要用在 Service Worker 里面,拦截用户提交的表单,修改某些数据以后,再提交给服务器。

response.blob()用于获取二进制文件。

1
2
3
4
5
6
// 读取图片文件logo.jpg,显示在网页上。
const response = await fetch('logo.jpg');
const myBlob = await response.blob();
const objectURL = URL.createObjectURL(myBlob);
const myImage = document.querySelector('img');
myImage.src = objectURL;

response.arrayBuffer()得到二进制 ArrayBuffer 对象。主要用于获取流媒体文件。

1
2
3
4
5
6
7
8
9
// 获取音频文件song.ogg,然后在线播放的例子。
const audioCtx = new window.AudioContext();
const source = audioCtx.createBufferSource();
const response = await fetch('song.ogg');
const buffer = await response.arrayBuffer();
const decodeData = await audioCtx.decodeAudioData(buffer);
source.buffer = buffer;
source.connect(audioCtx.destination);
source.loop = true;

2.3 Response.clone()
Stream 对象只能读取一次,读取完就没了。这意味着,前一节的五个读取方法,只能使用一个,否则会报错。

1
2
let text = await response.text();
let json = await response.json(); // 报错

Response 对象提供Response.clone()方法,创建Response对象的副本,实现多次读取。

1
2
3
4
5
6
const response1 = await fetch('logo.jpg');
const response2 = response1.clone();
const myBlob1 = await response1.blob();
const myBlob2 = await response2.blob();
image1.src = URL.createObjectURL(myBlob1);
image2.src = URL.createObjectURL(myBlob2);

2.4 Response.body 属性
Response.body属性是 Response 对象暴露出的底层接口,返回一个 ReadableStream 对象,供用户操作。它可以用来分块读取内容,应用之一就是显示下载的进度。

1
2
3
4
5
6
7
8
9
10
const response = await fetch('logo.jpg');
const reader = response.body.getReader();

while(true) {
const {done, value} = await reader.read();
if (done) {
break;
}
console.log(`Received ${value.length} bytes`)
}

response.body.getReader()方法返回一个遍历器。这个遍历器的read()方法每次返回一个对象,表示本次读取的内容块。对象的done属性是一个布尔值,用来判断有没有读完;value属性是一个 arrayBuffer 数组,表示内容块的内容,而value.length属性是当前块的大小。

四、fetch()常用方法
(1)判断请求是否成功
fetch()发出请求以后,有一个很重要的注意点:只有网络错误,或者无法连接时,fetch()才会报错,其他情况都认为请求成功。即使服务器返回的状态码是 4xx 或 5xx,fetch()也不会报错(即 Promise 不会变为 rejected状态)。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// 通过Response.status属性,等于 2xx (200~299),才能判断请求是否成功
async function fetchText() {
let response = await fetch('/article');
if (response.status >= 200 && response.status < 300) {
return await response.text();
} else {
throw new Error(response.statusText);
}
}
// response.ok是否为true
if (response.ok) {
// 请求成功
} else {
// 请求失败
}

(2)POST 请求

1
2
3
4
5
6
7
8
const response = await fetch(url, {
method: 'POST',
headers: {
"Content-type": "application/x-www-form-urlencoded; charset=UTF-8",
},
body: 'foo=bar&lorem=ipsum',
});
const json = await response.json();

(3)提交 JSON 数据

1
2
3
4
5
6
7
8
const user = { name: 'John', surname: 'Smith' };
const response = await fetch('/article', {
method: 'POST',
headers: {
'Content-Type': 'application/json;charset=utf-8'
},
body: JSON.stringify(user)
});

(4)提交表单

1
2
3
4
5
const form = document.querySelector('form');
const response = await fetch('/article', {
method: 'POST',
body: new FormData(form)
})

(5)用脚本添加文件,构造出一个表单,进行文件上传

1
2
3
4
5
6
7
8
const input = document.querySelector('input[type="file"]');
const data = new FormData();
data.append('file', input.files[0]);
data.append('user', 'foo');
fetch('/upload', {
method: 'POST',
body: data
});

(6)fetch()也可以直接上传二进制数据,将 Blob 或 arrayBuffer 数据放在body属性里面。

1
2
3
4
5
6
7
let blob = await new Promise(resolve =>
canvasElem.toBlob(resolve, 'image/png')
);
let response = await fetch('/upload', {
method: 'POST',
body: blob
});

(6)fetch()请求发送以后,如果中途想要取消,需要使用AbortController对象。

1
2
3
4
5
6
7
8
9
10
11
let controller = new AbortController();
let signal = controller.signal;
fetch(url, {
signal: controller.signal
});
signal.addEventListener('abort',
() => console.log('abort!')
);

controller.abort(); // 取消
console.log(signal.aborted); // true

首先新建 AbortController 实例,然后发送fetch()请求,配置对象的signal属性必须指定接收 AbortController 实例发送的信号controller.signal。controller.abort()方法用于发出取消信号。这时会触发abort事件,这个事件可以监听,也可以通过controller.signal.aborted属性判断取消信号是否已经发出。

 

来源:Javascript Fetch教程

5 评论 “Javascript Fetch教程

    今日 评论:
    2021年3月11日 下午9:42

    支持一下交个朋友

    站元素主机 评论:
    2021年3月29日 下午1:52

    感谢分享 赞一个

    今日新闻 评论:
    2021年4月25日 上午12:52

    文章不错非常喜欢

    热搜 评论:
    2021年5月3日 下午9:34

    文章不错交个朋友

    容添下 评论:
    2021年6月5日 下午5:51

    麻雀虽小五脏俱全

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注