- Fetch 是在 ES6 出现的,使用了 ES6 提出的 Promise 对象,是
XMLHttpRequest
的替代品
建议阅读:MDN
以下内容摘选自:fetch教学
-
fetch()与 XMLHttpRequest 差异
-
fetch使用 Promise,不使用回调函数,写起来更简洁
-
fetch采用模块化设计,API 分散在多个对象上(Response 对象、Request 对象、Headers 对象)
XMLHttpRequest
的输入、输出、状态都在同一个接口管理,容易写出非常混乱的代码
-
fetch通过数据流(Stream 对象)处理数据,可以分块读取,有利于提高网站性能表现,减少内存占用,对于请求大文件或者网速慢的场景相当有用
XMLHTTPRequest
对象不支持数据流,所有的数据必须放在缓存里,不支持分块读取,必须等待全部拿到后,再一次性吐出来
-
-
await语句必须放在
try...catch
里面,这样才能捕捉异步操作中可能发生的错误
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)
}
}
Response
- Response 对象的同步属性
const response = await fetch(url)
async function fetchText() {
let response = await fetch('/readme.txt');
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,就会返回这个值。表示发出的是简单的跨域请求,类似
表单的那种跨域请求
-
opaqueredirect:如果fetch()请求的redirect属性设为manual,就会返回这个值
-
-
-
Response.redirected
- 返回布尔值:请求是否发生过跳转
判断请求是否成功
- 只有网络错误,或无法连接时,fetch()才会报错
-
Response.status
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.status
属性只有等于 2xx (200~299),才能认定请求成功- 不用考虑网址跳转(状态码为 3xx),fetch()会将跳转的状态码自动转为 200
-
服务器返回的状态码是 4xx 或 5xx,fetch()也不会报错(即 Promise 不会变为 rejected状态)
- response.ok是否为true
if (response.ok) {
// 请求成功
} else {
// 请求失败
}
Response.headers
-
指向一个 Headers 对象,对应 HTTP 回应的所有标头
-
使用for…of循环进行遍历
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}`); }
-
方法
-
Headers.get():根据键名返回键值
-
Headers.has(): 返回布尔值:是否包含某个标头
-
Headers.set():将指定的键名设置为新的键值,如果该键名不存在则会添加
-
Headers.append():添加标头
-
Headers.delete():删除标头
-
Headers.keys():返回键名遍历器
-
Headers.values():返回键值遍历器
-
Headers.entries():返回键值对([key, value])遍历器
-
Headers.forEach():依次遍历标头,每个标头都会执行一次参数函数
let response = await fetch(url); response.headers.get('Content-Type') // application/json; charset=utf-8 // 键名 for(let key of myHeaders.keys()) { console.log(key); } // 键值 for(let value of myHeaders.values()) { console.log(value); } let response = await fetch(url); response.headers.forEach( (value, key) => console.log(key, ':', value) )
-
读取内容的方法
-
5个读取方法都是异步的,返回 Promise 对象
-
五个读取方法,只能使用一个,否则会报错
- Stream 对象只能读取一次,读取完就没了
-
-
response.text()
- 获取文本数据,比如 HTML 文件
const response = await fetch('/users.html') const body = await response.text() document.body.innerHTML = body
-
response.json()
- 获取服务器返回的 JSON 数据
-
response.formData()
- 用在 Service Worker 里面,拦截用户提交的表单,修改某些数据以后提交给服务器
-
response.blob()
-
获取二进制文件
-
eg. 读取图片文件flower.jpg
const response = await fetch('flower.jpg') const myBlob = await response.blob(); const objectURL = URL.createObjectURL(myBlob) const myImage = document.querySelector('img') myImage.src = objectURL
-
-
response.arrayBuffer()
-
获取流媒体文件
-
eg. 获取音频文件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;
-
Response.clone
-
创建Response对象的副本,实现多次读取
const response1 = await fetch('flowers.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);
Response.body
-
返回一个
ReadableStream
对象 -
用来分块读取内容:显示下载的进度
const response = await fetch('flower.jpg'); const reader = response.body.getReader(); while(true) { const {done, value} = await reader.read(); if (done) { break; } console.log(`Received ${value.length} bytes`) }
-
read()方法每次返回对象:本次读取的内容块
-
这个对象的done属性是布尔值:判断有没有读完
-
value属性是一个 arrayBuffer 数组:内容块的内容
-
value.length属性是当前块的大小
-
定制 HTTP 请求
POST 请求
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();
-
method:HTTP 请求的方法,POST、DELETE、PUT都在这个属性设置
-
headers:一个对象,用来定制 HTTP 请求的标头
-
body:POST 请求的数据体
-
有些由浏览器自动生成标头不能通过headers属性设置
- Content-Length、Cookie、Host
提交 JSON 数据
const user = { name: 'John', surname: 'Smith' };
const response = await fetch('/article/fetch/post/user', {
method: 'POST',
headers: {
'Content-Type': 'application/json;charset=utf-8'
},
body: JSON.stringify(user)
});
-
标头Content-Type要设成’application/json;charset=utf-8′
-
因为默认发送的是纯文本,Content-Type的默认值是’text/plain;charset=UTF-8′
提交表单
const form = document.querySelector('form');
const response = await fetch('/users', {
method: 'POST',
body: new FormData(form)
})
文件上传
- 用脚本添加文件,构造出一个表单,进行上传
const input = document.querySelector('input[type="file"]');
const data = new FormData();
data.append('file', input.files[0]);
data.append('user', 'foo');
fetch('/avatars', {
method: 'POST',
body: data
});
直接上传二进制数据
let blob = await new Promise(resolve =>
canvasElem.toBlob(resolve, 'image/png')
);
let response = await fetch('/article/fetch/post/image', {
method: 'POST',
body: blob
});
option API
- fetch()第二个参数的完整 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
});
- fetch()请求的底层用的是 Request() 对象的接口,参数完全一样
cache属性指定如何处理缓存
-
default:默认值,先在缓存里面寻找匹配的请求
-
no-store:直接请求远程服务器,并且不更新缓存
-
reload:直接请求远程服务器,并且更新缓存
-
no-cache:将服务器资源跟本地缓存进行比较,有新的版本才使用服务器资源,否则使用缓存
-
force-cache:缓存优先,只有不存在缓存的情况下,才请求远程服务器
-
only-if-cached:只检查缓存,如果缓存里面不存在,将返回504错误
mode属性指定请求的模式
-
cors:默认值,允许跨域请求
-
same-origin:只允许同源请求
-
no-cors:请求方法只限于 GET、POST 和 HEAD,并且只能使用有限的几个简单标头,不能添加跨域的复杂标头,相当于提交表单所能发出的请求
credentials属性指定是否发送 Cookie
-
same-origin:默认值,同源请求时发送 Cookie,跨域请求时不发送
-
include:不管同源请求,还是跨域请求,一律发送 Cookie
-
omit:一律不发送
-
跨域请求发送 Cookie,需要将credentials属性设为include
fetch('http://another.com', {
credentials: "include"
});
signal属性指定一个 AbortSignal
实例,用于取消fetch()请求
keepalive属性用于页面卸载时,告诉浏览器在后台保持连接,继续发送数据
- 场景:用户离开网页时,脚本向服务器提交一些用户行为的统计信息
- 如果不用keepalive属性,数据可能无法发送,因为浏览器已经把页面卸载
window.onunload = function() {
fetch('/analytics', {
method: 'POST',
body: "statistics",
keepalive: true
});
};
redirect属性指定 HTTP 跳转的处理方法
-
follow:默认值,fetch()跟随 HTTP 跳转
-
error:如果发生跳转,fetch()就报错
-
manual:fetch()不跟随 HTTP 跳转,但是response.url属性会指向新的 URL,response.redirected属性会变为true,由开发者自己决定后续如何处理跳转
integrity属性指定一个哈希值,用于检查 HTTP 回应传回的数据是否等于这个预先设定的哈希值
- 下载文件时,检查文件的 SHA-256 哈希值是否相符,确保没有被篡改
fetch('http://site.com/file', {
integrity: 'sha256-abcdef'
});
referrer属性用于设定fetch()请求的referer标头
- referrer可以为任意字符串,也可以设为空字符串(即不发送referer标头)
fetch('/page', {
referrer: ''
});
referrerPolicy属性用于设定Referer标头的规则
-
no-referrer-when-downgrade
:默认值,总是发送Referer标头,除非从 HTTPS 页面请求 HTTP 资源时不发送 -
no-referrer
:不发送Referer标头 -
origin
:Referer标头只包含域名,不包含完整的路径 -
origin-when-cross-origin
:同源请求Referer标头包含完整的路径,跨域请求只包含域名 -
same-origin
:跨域请求不发送Referer,同源请求发送 -
strict-origin
:Referer标头只包含域名,HTTPS 页面请求 HTTP 资源时不发送Referer标头 -
strict-origin-when-cross-origin
:同源请求时Referer标头包含完整路径,跨域请求时只包含域名,HTTPS 页面请求 HTTP 资源时不发送该标头 -
unsafe-url
:不管什么情况,总是发送Referer标头
fetch cancel
- fetch()请求发送以后,如果中途想要取消,需要使用
AbortController
对象
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
属性判断取消信号是否已经发出
- 这时会触发abort事件,这个事件可以监听,也可以通过
-
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;
}
}
测试
- 针对
json-server
服务,只需要执行
fetch('http://localhost:3000/posts')
.then(res => res.json())
.then(data => {
console.log(data);
})
.catch(err => {
console.log(err);
});