✍️ JavaScript - fetch API 发送网络请求 - 《📝 前端笔记分享》

一、fetch 基本用法
二、Response 对象
三、Response.header 属性
四、读取 response 对象的数据
五、Response.body 属性
六、fetch 定制 HTTP 请求
七、fetch() 配置对象的完整 API
八、取消 fetch 请求

推荐参看链接：

MDN：https://developer.mozilla.org/zh-CN/docs/Web/API/Fetch_API
阮一峰的博客：http://www.ruanyifeng.com/blog/2020/12/fetch-tutorial.html
一、fetch 基本用法

接受一个 URL 字符串作为参数，默认向网址发送 GET 请求，返回一个 Promise 对象

fetch() 接收到的 response 是一个 Stream 对象

response.json() 是一个异步操作，将受到的数据转化为 JSON 对象

fetch('https://api.github.com/users/mcx2020')
.then(response => response.json())
.then(json => console.log(json))
.catch(error => console.log('Request Failed', error));

await 写法

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 包含的数据通过 Stream 接口异步读取，它还包含一些同步属性

ok：返回一个布尔值，表示请求是否成功（true对应 HTTP 请求的状态码 200 到 299，false 对应其他）
status：返回一个数字，表示 HTTP 回应的状态码（例如200，表示成功请求）
statusText：返回一个字符串，表示 HTTP 回应的状态信息（例如请求成功以后，服务器返回”OK”）
url：返回请求的 URL（如果 URL 存在跳转，该属性返回的是最终 URL）
type：返回请求的类型
- basic：普通请求，即同源请求
- cors：跨域请求
- error：网络错误，主要用于 Service Worker
- opaque：如果fetch()请求的type属性设为no-cors，就会返回这个值
- 表示发出的是简单的跨域请求，类似
  表单的那种跨域请求。
- opaqueredirect：如果fetch()请求的redirect属性设为manual，就会返回这个值
redirected：返回一个布尔值，表示请求是否发生过跳转

判断请求是否成功

只有网络错误或无法连接时，fetch() 才会报错，其他情况都不会报错
只有通过 response.status 和 response.ok 判断是否请求成功

三、Response.header 属性

Response.header 属性，指向一个 Header 对象，对应 HTTP 回应的所有标头，可通过如下方式遍历它的所有属性

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

// response.headers.get()，用于读取某个标头的值用于读取某个标头的值
let response =  await  fetch(url);  
response.headers.get('Content-Type')
// application/json; charset=utf-8

// Headers.keys()和Headers.values()方法用来分别遍历标头的键名和键值
// 键名
for(let key of myHeaders.keys()) {
  console.log(key);
}
// 键值
for(let value of myHeaders.values()) {
  console.log(value);
}

四、读取 response 对象的数据

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

response.text()：得到文本字符串
response.json()：得到 JSON 对象
response.blob()：得到二进制 Blob 对象
response.formData()：得到 FormData 表单对象
response.arrayBuffer()：得到二进制 ArrayBuffer 对象

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

const response = await fetch('/users.html');
const body = await response.text();
document.body.innerHTML = body

response.blob()用于获取二进制文件（下面示例读取图片文件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()主要用于获取流媒体文件（下面示例是response.arrayBuffer()获取音频文件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.body 属性

Response.body属性是 Response 对象暴露出的底层接口，返回一个 ReadableStream 对象，它可以用来分块读取内容，应用之一就是显示下载的进度（下面示例中，response.body.getReader()方法返回一个遍历器。这个遍历器的read()方法每次返回一个对象，表示本次读取的内容块。这个对象的done属性是一个布尔值，用来判断有没有读完；value属性是一个 arrayBuffer 数组，表示内容块的内容，而value.length属性是当前块的大小。）

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

六、fetch 定制 HTTP 请求

fetch()的第一个参数是 URL，还可以接受第二个参数，作为配置对象，定制发出的 HTTP 请求
（HTTP 请求的方法、标头、数据体都在这个对象里面设置）

fetch(url, optionObj)

POST 请求（有些标头不能通过headers属性设置，比如Content-Length、Cookie、Host等等。它们是由浏览器自动生成，无法修改）

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

请求 JSON 数据（下面示例中，标头Content-Type要设成’application/json;charset=utf-8’。因为默认发送的是纯文本，Content-Type的默认值是’text/plain;charset=UTF-8’）

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

直接上传二进制数据（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() 配置对象的完整 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
});

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：一律不发送

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标头。这个属性可以为任意字符串，也可以设为空字符串（即不发送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 请求

fetch()请求发送以后，如果中途想要取消，需要使用AbortController对象
下面的示例的流程如下

新建一个 AbortController 实例
发送 fetch() 请求，其中配置对象的 signal 属性需要指定为 AbortController 实例的 controller.signal
监听 controller 的 abort 事件，在此可以书写取消后的逻辑
controller.abort() 用于发出取消信号，会触发 abort 事件
controller.signal.aborted 属性判断取消信号是否已经发出 ```javascript 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

下面是一个1秒后自动取消请求的例子
```javascript
let controller = new AbortController();
setTimeout(() => controller.abort(), 1000);
try {
  let response = await fetch('/long-operation', {
    signal: controller.signal
  });
} catch(error) {
  if (error.name == 'AbortError') {
    console.log('Aborted!');
  } else {
    throw error;
  }
}

「@浪里淘沙的小法师」

fetch API 发送网络请求