网络请求工具之axios,vue-resouce,fetch

网络请求工具之axios,vue-resouce,fetch

一.背景

目前前端三大框架中,要调用接口,发送网络请求,如果还是使用以前的jquery来操作的话,是很不明智的,jquery是个比较庞大的dom操作库,体积比较大,然后这个时候,就出现了很多的网络请求工具,体积小,专门用来发送网络请求,比较方便

1.angularjs

使用内置的http模块

2.vuejs

使用vue-resource.fetch.axios

3.react

使用fetch,axios

二.请求工具

1.vue-resource

vue 1.x的时候,vue内置的一个发送网络请求请求插件,vue-resource的用法和axios相似度很高.vue2.x的时候,尤大就推荐我们使用axios,官网就不在维护vue-resource了

1.1 安装

$ npm install vue-resource

1.2 使用

main.js文件中

//引入vue
import Vue from 'vue'
//引入vue-resource
import VueResource from 'vue-resource'

//使用
Vue.http或者this.$http

1.3 常用api

this.$http.get(url,[options]).then().catch();
this.$http.post(url,[body],options).then().catch();
this.$http(options).then().catch();

注意:请求传参的时候,注意get方式和post方式,与之前的jquery的ajax传参不一样,这边的传递url参数是params参数,post传参是body参数,其实就是对象

2.fetch

ES6提供的.一个底层的请求API,用来替代XMLHttpRequest这个API的

2.1.安装

不需要额外的安装,因为fetch是底层的API,也就是原生js提供的,所以可以当做全局变量来使用,它是挂在window对象身上的.

但是fetch有兼容性问题,如果要处理兼容性问题时,需要去安装一个Polyfill

2.2.使用

使用时需要对接收到的数据根据数据类型做转换

fetch(url).then(response=>response.json()).then().catch();
fetch(url).then(response=>response.text()).then().catch();

详情api,可以参考MDN

3.axios

参考链接 axios

一款基于XMLHttpRequest对象封装的网络请求工具,同时支持浏览器和nodejs,继承了Promise

根据环境不同

浏览器是基于XMLHttpRequest

Nodejs是基于http模块

3.1 安装

$ npm install axios

3.2使用

axios.get(url,[options]).then().catch()
axios.post(url,[body],[options]).then().catch()
...
axios(options).then().catch()

更多Api见官网

3.3 axios特点

• 从浏览器中创建XMLHttpRequest

• 从node.js创建http请求

• 支持Promise Api

• 拦截请求和响应

• 转换请求数据和响应数据

• 取消请求

• 自动转换JSON数据

• 客户端支持防御XSRF

3.4 axios响应对象

axios的响应数据不是接口直接的响应,而是axios的一个包装对象.

{
    //此属性,才是接口的响应,我们需要的数据
    data:{},
    //响应的状态码
    status:200,
    //服务器响应信息
    statusText:'ok',
    //服务器响应的头
    headers:{},
    //为请求提供的配置信息
    config:{}   
}

3.5 axios 请求对象

这些是创建请求时可以用的配置选项。只有 url 是必需的。如果没有指定 method，请求将默认使用 get 方法。

{
  // `url` 是用于请求的服务器 URL
  url: '/user',

  // `method` 是创建请求时使用的方法
  method: 'get', // 默认是 get

  // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
  // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  baseURL: 'https://some-domain.com/api/',

  // `transformRequest` 允许在向服务器发送前，修改请求数据
  // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
  transformRequest: [function (data) {
    // 对 data 进行任意转换处理

    return data;
  }],

  // `transformResponse` 在传递给 then/catch 前，允许修改响应数据
  transformResponse: [function (data) {
    // 对 data 进行任意转换处理

    return data;
  }],

  // `headers` 是即将被发送的自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'},

  // `params` 是即将与请求一起发送的 URL 参数
  // 必须是一个无格式对象(plain object)或 URLSearchParams 对象
  params: {
    ID: 12345
  },

  // `paramsSerializer` 是一个负责 `params` 序列化的函数
  // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  paramsSerializer: function(params) {
    return Qs.stringify(params, {arrayFormat: 'brackets'})
  },

  // `data` 是作为请求主体被发送的数据
  // 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH'
  // 在没有设置 `transformRequest` 时，必须是以下类型之一：
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属：FormData, File, Blob
  // - Node 专属： Stream
  data: {
    firstName: 'Fred'
  },

  // `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
  // 如果请求话费了超过 `timeout` 的时间，请求将被中断
  timeout: 1000,

  // `withCredentials` 表示跨域请求时是否需要使用凭证
  withCredentials: false, // 默认的

  // `adapter` 允许自定义处理请求，以使测试更轻松
  // 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
  adapter: function (config) {
    /* ... */
  },

  // `auth` 表示应该使用 HTTP 基础验证，并提供凭据
  // 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },

  // `responseType` 表示服务器响应的数据类型，可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
  responseType: 'json', // 默认的

  // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
  xsrfCookieName: 'XSRF-TOKEN', // default

  // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的

  // `onUploadProgress` 允许为上传处理进度事件
  onUploadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },

  // `onDownloadProgress` 允许为下载处理进度事件
  onDownloadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },

  // `maxContentLength` 定义允许的响应内容的最大尺寸
  maxContentLength: 2000,

  // `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，promise 将被 resolve; 否则，promise 将被 rejecte
  validateStatus: function (status) {
    return status >= 200 && status < 300; // 默认的
  },

  // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
  // 如果设置为0，将不会 follow 任何重定向
  maxRedirects: 5, // 默认的

  // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项：
  // `keepAlive` 默认没有启用
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // 'proxy' 定义代理服务器的主机名称和端口
  // `auth` 表示 HTTP 基础验证应当用于连接代理，并提供凭据
  // 这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
  proxy: {
    host: '127.0.0.1',
    port: 9000,
    auth: : {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

  // `cancelToken` 指定用于取消请求的 cancel token
  // （查看后面的 Cancellation 这节了解更多）
  cancelToken: new CancelToken(function (cancel) {
  })
}

特别注意的是:

一般情况下请求时

• get请求的参数是params选项
• post请求的参数是data选项

但是特殊情况下,post请求也是可以传递params选项的,具体看接口的定义

3.6 axios 请求拦截

先引入一个问题:

我们调接口时,有时候会需要传入一个token,而我们的token是放在cookie或者localStorage里,如果说我们token改变了,用户退出再登录的情况下,后续会携带的token将是上一次的token,为了保证我们每次请求是最新的token,所以需要请求拦截了.

// 封装请求拦截器
instance.interceptors.request.use((config) => {
    // 在这里做一些检测或者包装等处理
    // console.log('请求拦截', config)
    // 鉴权 token添加
    config.headers.Authorization = localStorage.getItem('token') || ''
    return config
})

3.7 axios 响应拦截

同样引入一个问题,每次我们通过axios去请求接口时,返回的response体并不是我们想要的数据,response中的data才是我们想要的,这时就可以使用使用响应拦截了

// 封装响应拦截器
instance.interceptors.response.use((response) => {
    
    // 请求成功
    // console.log('响应拦截', response)
    // 数据过滤，根据后端标识字符来进行数据
    if (response.data && response.data.err == 0) {
        return response.data.data
    } 
}, (error) => {
    // 请求失败
    return Promise.reject(error)
})

3.8 axios在vue中全局使用

将axios挂载到Vue的原型上即可

//main.js
import Vue from 'vue';
import axios from 'axios'
Vue.prototype.$axios=axios;

//我在项目中一般喜欢把接口都封装在apis文件中之后,然后全局调用接口
//方法都是可以,看个人情况
//引入api,将api挂载到vue原型,方便调用
import http from '@/utils/apis'
Vue.prototype.$http = http

3.9 封装一个axios

//fetch.js

//引入axios 
import axios from 'axios';

//创建一个axios的实例对象
var instance = axios.create({
    //baseUrl 自己按实际情况配置
    baseUrl: "http://localhost:8080",
    //设置超时时间 ms
    timeout: 7000,
    headers: {
        'Content-Type': 'application/json;charset=UTF-8'
    }
});

// 封装请求拦截器
instance.interceptors.request.use((config) => {
    // 在这里做一些检测或者包装等处理
    // console.log('请求拦截', config)
    // 鉴权 token添加
    config.headers.Authorization = localStorage.getItem('token') || ''
    return config
})

// 封装响应拦截器
instance.interceptors.response.use((response) => {
    //按自己实际情况配置
    // 请求成功
    // console.log('响应拦截', response)
    // 数据过滤，根据后端标识字符来进行数据
    if (response.data && response.data.err == 0) {
        return response.data.data
    } 
}, (error) => {
    // 请求失败
    return Promise.reject(error)
})

// 暴露axios实例
export default instance;