fetch的概念以及基本用法

Posted 2022-03-08 咖啡壶子

(笔记来源：廖大神)
前言:fetch()是XMLHttpRequest的升级版,在js脚本中发请求

fetch

• • • 一.基本用法
    • • fetch与XMLHttpRequest的区别
    • 二.Response 对象
    • 三.fetch()的第二个参数：定制 HTTP 请求
    • 四.fetch()配置对象的完整 API

一.基本用法

fetch与XMLHttpRequest的区别

1. fetch()使用 Promise，不使用回调函数，因此大大简化了写法，写起来更简洁。
2. fetch()采用模块化设计，API 分散在多个对象上（Response 对象、Request 对象、Headers 对象），更合理一些；相比之下，XMLHttpRequest 的 API 设计并不是很好，输入、输出、状态都在同一个接口管理，容易写出非常混乱的代码。
3. fetch()通过数据流（Stream 对象）处理数据，可以分块读取，有利于提高网站性能表现，减少内存占用，对于请求大文件或者网速慢的场景相当有用。XMLHTTPRequest 对象不支持数据流，所有的数据必须放在缓存里，不支持分块读取，必须等待全部拿到后，再一次性吐出来。
4. 在用法上，fetch()接受一个 URL 字符串作为参数，默认向该网址发出 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 对象。

二.Response 对象

2.1 Response 对象的同步属性

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

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

上面示例中，response.status和response.statusText就是 Response 的同步属性，可以立即读取。

2. 判断请求是否成功

   fetch()发出请求以后，有一个很重要的注意点：只有网络错误，或者无法连接时，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);
  

3. Response.headers 属性

   Response 对象还有一个Response.headers属性，指向一个 Headers 对象，对应 HTTP 回应的所有标头。

   Headers 对象可以使用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()：依次遍历标头，每个标头都会执行一次参数函数。

4. 读取内容的方法

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

const response = await fetch('flower.jpg');
const myBlob = await response.blob();
const objectURL = URL.createObjectURL(myBlob);

const myImage = document.querySelector('img');
myImage.src = objectURL;

三.fetch()的第二个参数：定制 HTTP 请求

fetch()的第一个参数是 URL，还可以接受第二个参数，作为配置对象，定制发出的 HTTP 请求。

1. 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 请求的数据体。

2. 提交 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’。
3. 提交表单

const form = document.querySelector('form');

const response = await fetch('/users', 
  method: 'POST',
  body: new FormData(form)
)

4. 文件上传

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

5. 直接上传二进制数据
   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
);

fetch()请求的底层用的是 Request() 对象的接口，参数完全一样，因此上面的 API 也是Request()的 API。