美文网首页
Fetch用法说明(转)

Fetch用法说明(转)

作者: 小豆soybean | 来源:发表于2018-08-13 14:44 被阅读0次

    原文链接:https://segmentfault.com/a/1190000007019545
    由于 FetchAPI 是基于 Promise 设计,有必要先学习一下 Promise,推荐阅读 MDN Promise 教程
    本文章内容推荐阅读 MDN Fetch 教程

    语法说明

    fetch(url, options).then(function(response) {
      // handle HTTP response
    }, function(error) {
      // handle network error
    })
    

    具体参数案例:

    //兼容包
    require('babel-polyfill')
    require('es6-promise').polyfill()
    
    import 'whatwg-fetch'
    
    fetch(url, {
      method: "POST",
      body: JSON.stringify(data),
      headers: {
        "Content-Type": "application/json"
      },
      credentials: "same-origin"
    }).then(function(response) {
      response.status     //=> number 100–599
      response.statusText //=> String
      response.headers    //=> Headers
      response.url        //=> String
    
      response.text().then(function(responseText) { ... })
    }, function(error) {
      error.message //=> String
    })
    
    

    url

    定义要获取的资源。这可能是:

    • 一个 USVString 字符串,包含要获取资源的 URL

    • 一个 Request 对象。

    options(可选)

    一个配置项对象,包括所有对请求的设置。可选的参数有:

    • method: 请求使用的方法,如 GETPOST

    • headers: 请求的头信息,形式为 Headers 对象或 ByteString

    • body: 请求的 body 信息:可能是一个 BlobBufferSourceFormDataURLSearchParams 或者 USVString 对象。注意 GETHEAD 方法的请求不能包含 body 信息。

    • mode: 请求的模式,如 corsno-cors 或者 same-origin

    • credentials: 请求的 credentials,如 omitsame-origin 或者 include

    • cache: 请求的 cache 模式: default, no-store, reload, no-cache, force-cache, 或者 only-if-cached

    response

    一个 Promiseresolve 时回传 Response 对象:

    • 属性:

      • status (number) - HTTP请求结果参数,在100–599 范围

      • statusText (String) - 服务器返回的状态报告

      • ok (boolean) - 如果返回200表示请求成功则为true

      • headers (Headers) - 返回头部信息,下面详细介绍

      • url (String) - 请求的地址

    • 方法:

      • text() - 以string的形式生成请求text

      • json() - 生成JSON.parse(responseText)的结果

      • blob() - 生成一个Blob

      • arrayBuffer() - 生成一个ArrayBuffer

      • formData() - 生成格式化的数据,可用于其他的请求

    • 其他方法:

      • clone()

      • Response.error()

      • Response.redirect()

    response.headers

    • has(name) (boolean) - 判断是否存在该信息头

    • get(name) (String) - 获取信息头的数据

    • getAll(name) (Array) - 获取所有头部数据

    • set(name, value) - 设置信息头的参数

    • append(name, value) - 添加header的内容

    • delete(name) - 删除header的信息

    • forEach(function(value, name){ ... }, [thisContext]) - 循环读取header的信息

    使用案例

    GET请求

    • HTML

      fetch('/users.html')
        .then(function(response) {
          return response.text()
        }).then(function(body) {
          document.body.innerHTML = body
        })
      
    • IMAGE

      var myImage = document.querySelector('img');
      
      fetch('flowers.jpg')
        .then(function(response) {
          return response.blob();
        })
        .then(function(myBlob) {
          var objectURL = URL.createObjectURL(myBlob);
          myImage.src = objectURL;
        });
      
    • JSON

      fetch(url)
        .then(function(response) {
          return response.json();
        }).then(function(data) {
          console.log(data);
        }).catch(function(e) {
          console.log("Oops, error");
        });
      

    使用 ES6 的 箭头函数 后:

    fetch(url)
      .then(response => response.json())
      .then(data => console.log(data))
      .catch(e => console.log("Oops, error", e))
    

    response的数据

    fetch('/users.json').then(function(response) {
      console.log(response.headers.get('Content-Type'))
      console.log(response.headers.get('Date'))
      console.log(response.status)
      console.log(response.statusText)
    })
    

    POST请求

    fetch('/users', {
      method: 'POST',
      headers: {
        'Accept': 'application/json',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        name: 'Hubot',
        login: 'hubot',
      })
    })
    

    检查请求状态

    function checkStatus(response) {
      if (response.status >= 200 && response.status < 300) {
        return response
      } else {
        var error = new Error(response.statusText)
        error.response = response
        throw error
      }
    }
    
    function parseJSON(response) {
      return response.json()
    }
    
    fetch('/users')
      .then(checkStatus)
      .then(parseJSON)
      .then(function(data) {
        console.log('request succeeded with JSON response', data)
      }).catch(function(error) {
        console.log('request failed', error)
      })
    

    采用promise形式

    Promise 对象是一个返回值的代理,这个返回值在promise对象创建时未必已知。它允许你为异步操作的成功或失败指定处理方法。 这使得异步方法可以像同步方法那样返回值:异步方法会返回一个包含了原返回值的 promise 对象来替代原返回值。

    Promise构造函数接受一个函数作为参数,该函数的两个参数分别是resolve方法和reject方法。如果异步操作成功,则用resolve方法将Promise对象的状态变为“成功”(即从pending变为resolved);如果异步操作失败,则用reject方法将状态变为“失败”(即从pending变为rejected)。

    promise实例生成以后,可以用then方法分别指定resolve方法和reject方法的回调函数。

    //创建一个promise对象
    var promise = new Promise(function(resolve, reject) {
      if (/* 异步操作成功 */){
        resolve(value);
      } else {
        reject(error);
      }
    });
    //then方法可以接受两个回调函数作为参数。
    //第一个回调函数是Promise对象的状态变为Resolved时调用,第二个回调函数是Promise对象的状态变为Reject时调用。
    //其中,第二个函数是可选的,不一定要提供。这两个函数都接受Promise对象传出的值作为参数。
    promise.then(function(value) {
      // success
    }, function(value) {
      // failure
    });
    

    那么结合promise后fetch的用法:

    //Fetch.js
    export function Fetch(url, options) {
      options.body = JSON.stringify(options.body)
    
      const defer = new Promise((resolve, reject) => {
        fetch(url, options)
          .then(response => {
            return response.json()
          })
          .then(data => {
            if (data.code === 0) {
              resolve(data) //返回成功数据
            } else {
                if (data.code === 401) {
                //失败后的一种状态
                } else {
                //失败的另一种状态
                }
              reject(data) //返回失败数据
            }
          })
          .catch(error => {
            //捕获异常
            console.log(error.msg)
            reject() 
          })
      })
    
      return defer
    }
    

    调用Fech方法:

    import { Fetch } from './Fetch'
    
    Fetch(getAPI('search'), {
      method: 'POST',
      options
    })
    .then(data => {
      console.log(data)
    })
    

    支持状况及解决方案

    原生支持率并不高,幸运的是,引入下面这些 polyfill 后可以完美支持 IE8+ :

    • 由于 IE8 是 ES3,需要引入 ES5 的 polyfill: es5-shim, es5-sham

    • 引入 Promisepolyfill: es6-promise

    • 引入 fetch 探测库:fetch-detector

    • 引入 fetchpolyfill: fetch-ie8

    • 可选:如果你还使用了 jsonp,引入 fetch-jsonp

    • 可选:开启 Babelruntime 模式,现在就使用 async/await

    相关文章

      网友评论

          本文标题:Fetch用法说明(转)

          本文链接:https://www.haomeiwen.com/subject/socubftx.html