JavaScript

关注公众号 jb51net

关闭
首页 > 网络编程 > JavaScript > JavaScript fetch方法使

JavaScript中fetch方法的使用示例全面详解

作者:Tom_Li

这篇文章主要为大家介绍了JavaScript中fetch方法的使用示例全面详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

一、不使用 fetch时 获取异步资源

使用实例:

// 发送一个get请求
// 实例化一个XMLHttpResquest对象
let xhr = new XMLHttpResquest();
// 注册httpRequest.readyState改变时会回调的函数,xhr.onreadystatechange
// readyState共有5个可能的值,
//0    UNSENT (未打开)    open()方法还未被调用;
//1    OPENED  (未发送)    send()方法还未被调用;
//2    HEADERS_RECEIVED (已获取响应头)    send()方法已经被调用, 响应头和响应状态已经返回;
//3    LOADING (正在下载响应体)    响应体下载中; responseText中已经获取了部分数据;
//4    DONE (请求完成)    整个请求过程已经完毕.
xhr.onreadystatechange = function () {
    //该回调函数会被依次调用4次
    console.log(xhr.resdyState);
    //请求已完成
    if (xhr.readyState === 4) {
        //http状态为200
        if (xhr.status === 200) {
            //打印响应来的数据
            console.log(xhr.response);
            //JSON.parse()将JSON格式的字符串转化为JSON对象
            let data = JSON.parse(xhr.response);
            //打印得到的JSON对象
            console.log(data);
        }
    }
};

请求的网址

let url = '网址';
// 该方法为初始化请求,第一个参数是请求的方法,比如GET,POST,PUT,
// 第二个参数是请求的url,第三个参数为true表示发送异步请求
xhr.open('GET', url, true);
//设置http请求头
httpRequest.setRequestHeader('Content-Type', 'application/json');
//发出请求,参数为要发送的body体,如果是GET方法的话,一般无需发送body,设为空就可以
httpRequest.send(null);

二、使用fetch

// 请求的网址
let url = '网址';
//发起get请求
let _fetch = fetch(url).then(function (response) {
    //response.status表示响应的http状态码
    if (response.status === 200) {
        // json是返回的response提供的一个方法,
        // 会把返回的json字符串反序列化成对象,也被包装成一个Promise了
        return response.json();
    } else {
        return {};
    }
});
_fetch = _fetch
    .then(function (data) {
        //响应的内容
        console.log(data);
        // 响应数据格式化
        console.log(data.json());
    })
    .catch(function (err) {
        console.log(err);
    });

比较

fetch的语法

fetch(url)
  .then(...)
  .catch(...)

使用实例

// 接口的来源 https://api.uomg.com/doc-rand.qinghua.html
const data = {
    format: '搭讪',
};
const url = 'https://api.uomg.com/api/rand.qinghua';
fetch(url, {
    method: 'POST',
    body: JSON.stringify(data),
    headers: {
        'Content-Type': 'application/json',
    },
    credentials: 'same-origin',
})
    .then(res => {
        //转换后返回的数据
        console.log(res.json());
    })
    .catch(err => {
        //请求的错误处理
        console.log(err);
    });

 必须使用 json 方法才能得到需要的响应数据(即后端的数据)

使用实例:

fetch 中自带then 和 catch 方法

fetch('网址')
    // fetch()接收到的response是一个 Stream 对象
    // response.json()是一个异步操作,取出所有内容,并将其转为 JSON 对象
    .then(response => response.json())
    .then(json => console.log(json)) //获取到的json数据
    .catch(err => console.log('Request Failed', err));

等价于以下写法

async function getJSON() {
    let url = '请求的网址';
    try {
        let response = await fetch(url);
        return await response.json();
    } catch (error) {
        console.log('失败', error);
    }
}
console.log(getJSON()); // 获取到的数据

fetch的Response对象

同步属性

fetch()请求成功以后,得到的是一个 Response 对象。它对应服务器的 HTTP 回应。
Response 包含的数据通过 Stream 接口异步读取,但是它还包含一些同步属性,对应 HTTP 回应的标头信息(Headers),可以立即读取。

用法示例

async function getFetchText() {
    let response = await fetch('网址');
    console.log(response.status); // 获取http状态码 200
    console.log(response.statusText); // 获取http响应的状态信息
}
getFetchText();

标头信息的属性有:

const response = await fetch(url);
response.ok:返回一个布尔值,表示请求是否成功
例如:true对应 HTTP 请求的状态码 200 到 299,false对应其他的状态码。

response.status:返回一个数字,表示 HTTP 回应的状态码
例如:200,表示成功请求

response.statusText属性返回一个字符串,表示 HTTP 回应的状态信息
例如:请求成功以后,服务器返回"OK"

response.url:返回请求的 URL。
如果: URL 存在跳转,该属性返回的是最终 URL。

response.redirected:返回一个布尔值,表示请求是否发生过跳转。

response.type:返回请求的类型。可能的值如下:
    basic:普通请求,即同源请求。
    cors:跨域请求。
    error:网络错误,主要用于 Service Worker。

判断请求是否成功发出

第一种方法:

fetch()发出请求以后,只有网络错误或者无法连接时,fetch()才会报错,其他情况都不会报错,而是认为请求成功。

只有通过Response.status属性,得到HTTP 回应的真实状态码,才能判断请求是否成功

使用实例

async function getfetchText() {
  let response = await fetch('网址');
  if (response.status >= 200 && response.status < 300) {
    return await response.text();
  } else {
    throw new Error(response.statusText);
  }
}

判断response.ok是否为true

if (response.ok) {
  // 请求成功
  console.log('请求成功')
} else {
  // 请求失败
  console.log(‘请求失败')
}

操作标头

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

Headers 对象可以使用fo ... 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()) { 
// response.heasers.entries()方法返回一个遍历器,可以依次遍历所有键值对([key,value])
  console.log(`${key} : ${value}`);  
}

用来操作标头的方法有:

继承自 Headers 接口 的 可以修改标头。但是对于 HTTP响应来说,修改标头意义不大,并且很多标头是只读的,浏览器不允许修改。

比较常用的也就是response.headers.get()

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

读取Response对象内容的方法

const response = await fetch(url);
response.text():得到文本字符串,用于获取文本数据,比如 HTML 文件。
response.json():得到 返回格式化的 JSON 数据。
response.blob():得到二进制 Blob 对象,例如读取图片文件,显示在网页上。
response.formData():得到 FormData 表单对象,主要用在 Service Worker 里面,拦截用户提交的表单,修改某些数据以后,再提交给服务器。
response.arrayBuffer():得到二进制 ArrayBuffer 对象,主要用于获取流媒体文件。返回数组缓冲区数据
response.formData() :返回 formData 数据。

 由于 res.text( ) 具有可以获取URL 的文本内容的功能,所以可以使用它来获取网站的整个 HTML 。一旦运行 res.text( ),我们可以用另一个 then 捕获响应并在控制台记录它:

使用实例

使用 JavaScript Fetch 获取网站的 HTML 内容
由于res.text()具有可以获取URL 的文本内容的功能,所以可以使用它来获取网站的整个 HTML 。一旦运行 res.text(),我们可以用另一个 then 捕获响应并在控制台记录它:

fetch('https://api.uomg.com/api/rand.qinghua', {
    body: JSON.stringify({ format: '搭讪' }),
    method: 'POST',
    mode: 'cors',
    cache: 'no-cache',
    credentials: 'same-origin',
    headers: { 'Content-Type': 'application/json' },
    redirect: 'follow',
    referrerPolicy: 'no-referrer',
}).then(res => console.log(res.json())); // 随机的搭讪内容

如果链接不存在或发生错误,响应对象将返回错误。

例如,找不到页面将返回 404,或者网关错误将返回 502。

使用 JavaScript Fetch 从链接中获取 JSON 内容

Fetch 的另一个常见用途是获取数组的响应。如果想从 JSON 格式的 API 中获取响应,我们可以使用 res.json()。

例如,以下代码将从 URL 返回一个 JSON 对象,假设 URL 正在发送有效的 JSON:

fetch('https://api.uomg.com/api/rand.qinghua', {
    body: JSON.stringify({ format: '搭讪' }),
    method: 'POST',
    mode: 'cors',
    cache: 'no-cache',
    credentials: 'same-origin',
    headers: { 'Content-Type': 'application/json' },
    redirect: 'follow',
    referrerPolicy: 'no-referrer',
}).then(res => console.log(res.json())); // 随机的搭讪内容

JavaScript Fetch 的选项

由于 Fetch 可以发送和接收 HTTP 请求,当我们想要使用它获取 URL数据的时候,还可以带一些选项,即 fetch(URL, { options })。

如果你以前使用过 HTTP 请求就会对这很熟悉了。所有可用选项的示例,如下所示:

fetch('https://api.uomg.com/api/rand.qinghua', {
    body: JSON.stringify({ format: '搭讪' }),
    method: 'POST',
    mode: 'cors',
    cache: 'no-cache',
    credentials: 'same-origin',
    headers: { 'Content-Type': 'application/json' },
    redirect: 'follow',
    referrerPolicy: 'no-referrer',
}).then(res => console.log(res.json())); // 随机的搭讪内容

创建副本

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

使用实例:

// 先使用了response.text(),就把 Stream 读完了。
// 后面再调用response.json(),就没有内容可读了,所以报错。
let text = await response.text();
let json = await response.json(); // 报错

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

使用实例

const response1 = await fetch('图片地址');
// response.clone()复制了一份 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.body是 Response 对象暴露出的底层接口,返回一个 ReadableStream 对象,供用户操作
例如:用来分块读取内容,显示下载的进度

const response = await fetch('图片地址');
// response.body.getReader()方法返回一个遍历器
const reader = response.body.getReader();
while(true) {
  // 这个遍历器的read()方法每次返回一个对象,表示本次读取的内容块
  const {done, value} = await reader.read();
  // done属性是一个布尔值,用来判断有没有读完
  if (done) {
    break;
  }
  // value属性是一个 arrayBuffer 数组,表示内容块的内容,而value.length属性是当前块的大小
  console.log(`Received ${value.length} bytes`)
}

定制HTTP请求

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

HTTP 请求的方法、标头、数据体都在这个optionObj对象里面设置

fetch(url,optionObj)

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

fetch()的第二个参数的完整API如下:

const response = fetch(url, {
  method: "GET",//请求方式
  headers: {//定制http请求的标头
    "Content-Type": "text/plain;charset=UTF-8"
  },
  body: undefined,//post请求的数据体,因为此时为get请求,故为undefined
  referrer: "about:client",
  referrerPolicy: "no-referrer-when-downgrade",//用于设定fetch请求的referer标头
  mode: "cors", //指定请求模式,此时为cors表示支持跨域请求
  credentials: "same-origin",//发送cookie
  cache: "default",//指定如何处理缓存
  redirect: "follow",
  integrity: "",
  keepalive: false,
  signal: undefined 
});

参数详解:

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

headers:一个对象,用来定制 HTTP 请求的标头, 形式为 Headers 的对象或包含 ByteString 值的对象字面量

body:POST 请求的数据体(请求的参数),可能是一个 Blob、BufferSource、FormData、URLSearchParams 或者 USVString 对象,注意 GET 或 HEAD 方法的请求不能包含 body 信息

mode:请求是否允许跨域

    cors:默认值,允许跨域请求,遵守 CORS 协议

    same-origin:不允许跨域请求(只允许同源请求)

    no-cors:允许来自 CDN 的脚本、其他域的图片和其他一些跨域资源,前提条件是请求的 method 只能是 HEAD、GET 或 POST,而且 js 不能访问 Response 对象中的任何属性, 并且只能使用有限的几个简单标头,不能添加跨域的复杂标头,相当于提交表单所能发出的请求

credentials:请求是否携带cookie

    omit:默认值,不携带cookie

    same-origin:同源请求下携带cookie

    include:同源和跨域请求下都携带cookie

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

    default:默认值,先在缓存里面寻找匹配的请求。

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

    reload:直接请求远程服务器,并且更新缓存。

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

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

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

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

    same-origin:默认值,同源请求时发送 Cookie,跨域请求时不发送。

    include:不管同源请求,还是跨域请求,一律发送 Cookie。

    omit:一律不发送。

signal:指定一个 AbortSignal 实例,用于取消fetch()请求

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

    一个典型的场景就是,用户离开网页时,脚本向服务器提交一些用户行为的统计信息。

这时,如果不用keepalive属性,数据可能无法发送,因为浏览器已经把页面卸载了。

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

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实例
let controller = new AbortController();
fetch(url, {
  signal: controller.signal
});
//给controller.signal绑定监听事件,controller.signal的值改变则会触发abort事件
controller.signal.addEventListener('abort',
  () => console.log('abort!')
);
// controller.abort()方法用于发出取消信号。这时会触发abort事件,这个事件可以监听
controller.abort(); // 取消
// 可以通过controller.signal.aborted属性判断取消信号是否已经发出
console.log(controller.signal.aborted); // true

使用实例:

//创建实例
let controller = new AbortController();
//设置定时器
setTimeout(() => controller.abort(), 300);
try {
  let response = await fetch('请求路径', {
    signal: controller.signal
  });
} catch(err) {
  if (err.name == 'AbortError') {
    console.log('Aborted!');
  } else {
    throw err;
  }
}

response 实例的属性

fetch('https://api.uomg.com/api/rand.qinghua', {
    body: JSON.stringify({ format: '搭讪' }),
    method: 'POST',
    mode: 'cors',
    cache: 'no-cache',
    credentials: 'same-origin',
    headers: { 'Content-Type': 'application/json' },
    redirect: 'follow',
    referrerPolicy: 'no-referrer',
}).then(response => console.log(response.json())); // 随机的搭讪内容

参数如下

status    
HTTP响应状态码

statusText    
HTTP响应状态描述

headers    
HTTP响应头,headers无法直接通过.来获取响应头,而要通过get方法来获取,原因时headers是Header类型,该类实现了Symbol.iterator,是一个可迭代对象,他需要通过get方法获取指定响应头

body 
HTTP响应体。一个简单的 getter,用于暴露一个 ReadableStream 类型的 body 内容。

bodyUsed 
包含了一个布尔值 (en-US)来标示该 Response 是否读取过 Body。
ok    
本次响应是否成功,true成功,false失败。

判断标准是:HTTP响应状态码在200~299之间表示成功,其他表示失败

type    
响应类型,有如下值:

basic
标准值, 同源响应, 带有所有的头部信息除了“Set-Cookie” 和 “Set-Cookie2″.

cors
Response 接收到一个有效的跨域请求. 

error
网络错误. 没有有用的描述错误的信息。响应的状态为0,header为空且不可变。从 

Response.error()中获得的响应的类型.

opaque
响应 “no-cors” 的跨域请求.

url
HTTP请求URL

redirected  
表示该 Response 是否来自一个重定向,如果是的话,它的 URL 列表将会有多个条目。

需要注意的是body属性值是一个可读流,所以我们无法直接获取body内容,需要从可读流中读取内容,而读取可读流中内容也是一个异步操作,Response贴心的为我们提供了如下实例方法去异步地获取body可读流中的内容

json()    读取body内容为JSON对象

text()    读取body内容为普通文本字符串

formData()    读取body内容为FormData对象

blob()    读取body内容为Blob对象

arrayBuffer()    读取body内容为ArrayBuffer对象

以上方法都返回一个Promise对象,且Promise对象的结果值为它们读取到并转换为对应格式的数据。

async function fetchFun(){
    const response = await fetch('http://127.0.0.1:3000/api?name=tom&age=18')
    console.log('bodyUsed:', response.bodyUsed)
    const body = await response.json()
    console.log(body)
    console.log('bodyUsed:', response.bodyUsed)
    const bodyAgain = await response.json()
    console.log(bodyAgain)
}
fetchFun()

 需要注意的是,可读流的内容只能读取一次,再次读取则会报错

如果我们想进行多次读取,则可以对可读流进行克隆,然后操作克隆的可读流,具体操作如下:

async function fetchFun(){
    const response = await fetch('http://127.0.0.1:3000/api?name=tom&age=18')
    const clone1 = response.clone()
    const body = await clone1.json()
    console.log(body)
    const clone2 = response.clone()
    const bodyAgain = await clone2.json()
    console.log(bodyAgain)
}
fetchFun()

主流浏览器对 fetch 的支持

Chrome 42+
Edge 14+
Firefox 39+

IE 使用fetch

安装npm插件 whatwg-fetch

npm install whatwg-fetch --save

使用

import 'whatwg-fetch'

ie8 下需要安装 fetch-ie8

以上就是JavaScript中fetch方法的使用示例全面详解的详细内容,更多关于JavaScript fetch方法使的资料请关注脚本之家其它相关文章!

您可能感兴趣的文章:
阅读全文