一、基本用法

fetch(url, [option]);

fetch的功能与XMLHttpRequest基本相同，但有三个主要的差异。

（1）fetch使用Promise，不使用回调函数，因此大大简化了写法，写起来更简洁。

（2）fetch采用模块化设计，API分散在多个对象上（Response 对象、Request 对象、Headers 对象），更合理一些。

（3）fetch通过数据流（Stream 对象）处理数据，可以分块读取，有利于提高网站性能表现，减少内存占用，对于请求大文件或者网速慢的场景相当有用。

在用法上，fetch默认发出GET请求，返回一个Promise对象。比如：

fetch("https://api.github.com/users/ruanyf")
  .then((response) => response.json())
  .then((json) => console.log(json))
  .catch((err) => console.log("Request Failed", err));

上面示例中，fetch()接收到的response是一个Stream对象，response.json()是一个异步操作，取出所有内容，并将其转为 JSON 对象。

Promise可以使用await语法改写，使得语义更清晰。

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);
  }
}

注意：上面示例中，await语句必须放在try...catch里面，这样才能捕捉异步操作中可能发生的错误。

后文都采用await的写法，不使用.then()的写法。

二、Response对象

2.1 Response对象的同步属性

fetch请求成功以后，得到的是一个Response对象，它对应服务器的HTTP回应。

前面说过，Response包含的数据通过Stream接口异步读取，但是它还包含一些同步属性，对应HTTP回应的标头信息Headers，可以立即读取。

async function fetchText() {
  let response = await fetch("/readme.txt");
  console.log(response.status);
  console.log(response.statusText);
}

上面示例中，response.status和response.statusText就是同步属性，可以立即读取。具体列表如下：

标头信息属性	类型	说明
ok	bool	表示请求是否成功，true对应状态码200到299，false对应其他
status	number	HTTP的状态码
statusText	string	HTTP的状态信息
url	string	请求的URL。如果URL存在跳转，该属性返回的是最终URL
redirected	bool	表示请求是否发生过跳转
type	string	请求的类型

type可能的值如下：

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

2.2 判断请求是否成功

::: danger 注意 fetch发出请求以后，有一个很重要的注意点：只有网络错误，或者无法连接时才会报错，其他情况都不会报错，而是认为请求成功。也就是说，即使服务器返回的状态码是4xx或5xx，fetch也不会报错（即Promise不会变为rejected状态）。 :::

只有通过Response.status属性，得到HTTP回应的真实状态码，才能判断请求是否成功。请看下面的例子。

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才能认定请求成功。这里不用考虑网址跳转（状态码为 3xx），因为fetch会将跳转的状态码自动转为200。

另一种方法是判断response.ok是否为true。

if (response.ok) { // 请求成功 } else

2.3 headers属性

Response对象还有一个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对象的方法

方法名	说明
Headers.get()	根据指定的键名，返回键值
Headers.has()	返回一个布尔值，表示是否包含某个标头
Headers.set()	将指定的键名设置为新的键值，如果该键名不存在则会添加
Headers.append()	添加标头
Headers.delete()	删除标头
Headers.keys()	返回一个遍历器，可以依次遍历所有键名。
Headers.values()	返回一个遍历器，可以依次遍历所有键值。
Headers.entries()	返回一个遍历器，可以依次遍历所有键值对（[key, value]）
Headers.forEach()	依次遍历标头，每个标头都会执行一次参数函数

上面的有些方法可以修改标头，那是因为继承自Headers接口。对于HTTP回应来说，修改标头意义不大，况且很多标头是只读的，浏览器不允许修改。这些方法中，最常用的是response.headers.get()，用于读取某个标头的值。

let res1 = await fetch(url);
res1.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 res2 = await fetch(url);
res2.headers.forEach(
  (value, key) => console.log(key, ":", value),
);

2.4 读取内容的方法

Response对象根据服务器返回的不同类型的数据，提供了不同的读取方法。

方法名	说明
text()	得到文本字符串
json()	得到`JSON`对象
blob()	得到二进制`Blob`对象，用于获取二进制文件
formData()	得到`FormData`表单对象，主要用在`Service Worker`里面，拦截用户提交的表单，修改某些数据以后，再提交给服务器。
arrayBuffer()	得到二进制`ArrayBuffer`对象，主要用于获取流媒体文件。

上面5个读取方法都是异步的，返回的都是Promise对象。必须等到异步操作结束，才能得到服务器返回的完整数据。

const res1 = await fetch("/users.html");
const body = await res1.text();
document.body.innerHTML = body;

// 读取图片flower.jpg显示在网页上
const res2 = await fetch("flower.jpg");
const myBlob = await res2.blob();
const objectURL = URL.createObjectURL(myBlob);
const myImage = document.querySelector("img");
myImage.src = objectURL;

// 直接获取图片的Base64编码
let myBlob = await res.blob()
  function getBase64() {
    return new Promise(function(resolve, reject) {
      let reader = new FileReader();
      reader.readAsDataURL(myBlob);
      reader.onloadend = () => resolve(reader.result)
      reader.onerror = () => reject('reader error');
    });
  }
let base64data = await getBase64();
console.log(base64data)

// 获取音频文件song.ogg然后在线播放
const audioCtx = new window.AudioContext();
const source = audioCtx.createBufferSource();
const res3 = await fetch("song.ogg");
const buffer = await res3.arrayBuffer();
const decodeData = await audioCtx.decodeAudioData(buffer);
source.buffer = buffer;
source.connect(audioCtx.destination);
source.loop = true;

2.5 Response.clone()

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

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

上面示例先使用了response.text()，把Stream读完了。后面再调用response.json()就没有内容可读了，所以报错。

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

const response1 = await fetch("flowers.jpg");
// 复制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);

Response对象还有一个redirect()方法，用于将Response结果重定向到指定的URL。该方法一般只用在Service Worker里面，这里就不介绍了。

2.6 Response.body 属性

Response.body属性是Response对象暴露出的底层接口，返回一个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`);
}

上面示例中，response.body.getReader()方法返回一个遍历器。这个遍历器的read()方法每次返回一个对象，表示本次读取的内容块。

这个对象的done属性是一个bool，用来判断有没有读完。value属性是一个arrayBuffer数组，表示内容块的内容，而value.length属性是当前块的大小。

三、fetch的第二个参数

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()对象的接口，参数完全一样，因此上面的API也是Request()的API。

这些属性里面，headers、body前面已经给过示例了，下面是其他属性的介绍。

method

method属性指定HTTP请求的方法，POST、DELETE、PUT都在这个属性设置。

cache

cache属性指定如何处理缓存。可能的取值如下：

值	说明
default	默认值，先在缓存里面寻找匹配的请求
no-store	直接请求远程服务器，并且不更新缓存
reload	直接请求远程服务器，并且更新缓存
no-cache	将服务器资源跟本地缓存进行比较，有新的版本才使用服务器资源，否则使用缓存
force-cache	缓存优先，只有不存在缓存的情况下，才请求远程服务器
only-if-cached	只检查缓存，如果缓存里面不存在，将返回504错误

mode

mode属性指定请求的模式。可能的取值如下：

值	说明
cors	默认值，允许跨域请求
same-origin	只允许同源请求
no-cors	只限于`GET`、`POST`和`HEAD`，并且只能使用有限的几个简单标头，不能添加跨域的复杂标头，相当于提交表单所能发出的请求。

no-cors可以用于简单的跨域请求。

credentials

credentials属性指定是否发送Cookie。可能的取值如下：

值	说明
same-origin	默认值，同源请求时发送Cookie，跨域请求时不发送。
include	不管同源请求，还是`跨域`请求，一律发送Cookie。
omit	一律不发送。

跨域请求发送Cookie，需要将credentials属性设为include。

signal

signal属性指定一个AbortSignal实例，用于取消fetch请求。

keepalive

keepalive属性用于页面卸载时，告诉浏览器在后台保持连接，继续发送数据。

一个典型的场景就是，用户离开网页时，脚本向服务器提交一些用户行为的统计信息。这时，如果不用keepalive属性，数据可能无法发送，因为浏览器已经把页面卸载了。

window.onunload = function () {
  fetch("/analytics", {
    method: "POST",
    body: "statistics",
    keepalive: true,
  });
};

redirect

redirect属性指定HTTP跳转的处理方法。可能的取值如下：

值	说明
follow	默认值，跟随HTTP跳转
error	如果发生跳转，fetch()就报错
manual	不跟随HTTP跳转，但是`response.url`属性会指向新的URL，`response.redirected`属性会变为`true`，由开发者自己决定后续如何处理跳转。

integrity

integrity属性指定一个哈希值，用于检查HTTP回应传回的数据是否等于这个预先设定的哈希值。

比如，下载文件时，检查文件的 SHA-256 哈希值是否相符，确保没有被篡改。

fetch("http://site.com/file", {
  integrity: "sha256-abcdef",
});

referrer

referrer属性用于设定请求的referer标头。

这个属性可以为任意字符串，也可以设为空字符串（即不发送referer标头）。

referrerPolicy

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标头。

四、一些实例

发送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();

注意，有些标头不能通过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),
});

提交表单

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,
});

上传二进制文件时，不用修改标头的Content-Type，浏览器会自动设置。

直接上传二进制数据

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

let blob = await new Promise((resolve) =>
  canvasElem.toBlob(resolve, "image/png")
);

let response = await fetch("/article/fetch/post/image", {
  method: "POST",
  body: blob,
});

取消fetch请求

如果中途想要取消fetch请求，需要使用AbortController对象。

let controller = new AbortController();
let signal = controller.signal;

fetch(url, {
  signal,
});

signal.addEventListener("abort", () => console.log("abort!"));

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

controller.abort()方法用于发出取消信号。这时会触发abort事件，这个事件可以监听，也可以通过controller.signal.aborted属性判断取消信号是否已经发出。

下面是一个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;
  }
}