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

下面是一个例子，从服务器获取 JSON 数据。

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 对象：处理 HTTP 回应

2.1 Response 对象的同步属性

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

const response = await fetch(url);

前面说过，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就是 Response 的同步属性，可以立即读取。

标头信息属性有下面这些。

Response.ok

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

Response.status  //Response.status属性返回一个数字，表示 HTTP 回应的状态码(例如200，表示成功请求)。

Response.statusText  //Response.statusText属性返回一个字符串，表示 HTTP 回应的状态信息(例如请求成功以后，服务器返回"OK")。

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

Response.type //Response.type属性返回请求的类型。可能的值如下：

//basic：普通请求，即同源请求。

//cors：跨域请求。

//error：网络错误，主要用于 Service Worker。

//opaque：如果fetch()请求的type属性设为no-cors，就会返回这个值，详见请求部分。表示发出的是简单的跨域请求，类似表单的那种跨域请求。
//opaqueredirect：如果fetch()请求的redirect属性设为manual，就会返回这个值，详见请求部分。

Response.redirected //Response.redirected属性返回一个布尔值，表示请求是否发生过跳转。

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

}

}

上面示例中，response.status属性只有等于 2xx (200~299)，才能认定请求成功。这里不用考虑网址跳转(状态码为 3xx)，因为fetch()会将跳转的状态码自动转为 200。

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

if (response.ok) {

// 请求成功

} else {

// 请求失败

}

2.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 对象提供了以下方法，用来操作标头。

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 response = await fetch(url);

response.headers.get('Content-Type');

2.4 读取内容的方法

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

response.text()：得到文本字符串,可以在后台返回html文件的时候使用。

response.json()：得到 JSON 对象。

response.blob()：得到二进制 Blob 对象。可以用于下载文件或展示图片

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

response.arrayBuffer()：得到二进制 ArrayBuffer 对象。

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

response.blob()

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

const response = await fetch('flower.jpg');

const myBlob = await response.blob();

const objectURL = URL.createObjectURL(myBlob);

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

myImage.src = objectURL;

上面示例读取图片文件flower.jpg，显示在网页上。

response.arrayBuffer()

response.arrayBuffer()主要用于获取流媒体文件。

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.arrayBuffer()获取音频文件song.ogg，然后在线播放的例子。

2.5 Response.clone()

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

let text = await response.text();

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

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

Response 对象提供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.clone()复制了一份 Response 对象，然后将同一张图片读取了两次。

Response 对象还有一个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属性是一个布尔值，用来判断有没有读完；value属性是一个 arrayBuffer 数组，表示内容块的内容，而value.length属性是当前块的大小。

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

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

fetch(url, optionObj)

上面命令的optionObj就是第二个参数。

HTTP 请求的方法、标头、数据体都在这个对象里面设置。下面是一些示例。

(1)POST 请求

const response = await fetch(url, {

method: 'POST',

headers: {

"Content-type": "application/x-www-form-urlencoded; charset=UTF-8",//代表body是a=1&b=2的形式

},

body: 'foo=bar&lorem=ipsum',

});

const json = await response.json();

上面示例中，配置对象用到了三个属性。

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

headers：一个对象，用来定制 HTTP 请求的标头。

body：POST 请求的数据体。

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

(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数据

},

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)//不需要设置content-type

})

(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

});

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

(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: {undefined

"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前面已经给过示例了，下面是其他属性的介绍。

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

//default：默认值，先在缓存里面寻找匹配的请求。

//no-store：直接请求远程服务器，并且不更新缓存。

//reload：直接请求远程服务器，并且更新缓存。

//no-cache：将服务器资源跟本地缓存进行比较，有新的版本才使用服务器资源，否则使用缓存。

//force-cache：缓存优先，只有不存在缓存的情况下，才请求远程服务器。

//only-if-cached：只检查缓存，如果缓存里面不存在，将返回504错误。

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

//cors：默认值，允许跨域请求。

//same-origin：只允许同源请求。

//no-cors：请求方法只限于 GET、POST 和 HEAD，并且只能使用有限的几个简单标头，不能添加跨域的复杂标头，相当于提交表单所能发出的请求。

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

//same-origin：默认值，同源请求时发送 Cookie，跨域请求时不发送。

//include：不管同源请求，还是跨域请求，一律发送 Cookie。

//omit：一律不发送。

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

//fetch('http://another.com', {

//credentials: "include"

//});

signal //signal属性指定一个 AbortSignal 实例，用于取消fetch()请求，详见下一节。

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

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

//window.onunload = function() {

//fetch('/analytics', {

//method: 'POST',

//body: "statistics",

//keepalive: true

//});

//};

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

//follow：默认值，fetch()跟随 HTTP 跳转。

//error：如果发生跳转，fetch()就报错。

//manual：fetch()不跟随 HTTP 跳转，但是response.url属性会指向新的 URL，response.redirected属性会变为true，由开发者自己决定后续如何处理跳转。

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

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

//fetch('http://site.com/file', {

//integrity: 'sha256-abcdef'

//});

referrer //referrer属性用于设定fetch()请求的referer标头。

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

//fetch('/page', {undefined

//referrer: ''

//});

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

五、取消fetch()请求

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属性判断取消信号是否已经发出。

下面是一个1秒后自动取消请求的例子。

let controller = new AbortController();

setTimeout(() => controller.abort(), 1000);

try {

let response = await fetch('/long-operation', {undefined

signal: controller.signal

});

} catch(err) {

if (err.name == 'AbortError') {undefined

console.log('Aborted!');

} else {undefined

throw err;

}

}

原文链接：(13条消息) fetch请求html页面,Fetch API 教程_weixin_39573598的博客-CSDN博客

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 199,636评论 5赞 468
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 83,890评论 2赞 376
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 146,680评论 0赞 330
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 53,766评论 1赞 271
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 62,665评论 5赞 359
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,045评论 1赞 276
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,515评论 3赞 390
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,182评论 0赞 254
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,334评论 1赞 294
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,274评论 2赞 317
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,319评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,002评论 3赞 315
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,599评论 3赞 303
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,675评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,917评论 1赞 255
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,309评论 2赞 345
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 41,885评论 2赞 341

推荐阅读更多精彩内容