浅谈axios

在我们的项目中有用到:

• fetch
  有直接用的，也有自己封装之后用的;
• vue-resource
  在vue1的时候使用，把方法抽象出来后，总需要往方法里传 this.$http ,感觉是个超级不爽的设计，在vue2的时候弃用；
• Axios
  这是一个非常棒的设计，它是借用angularJs的http + httpBackend的概念，对unit test，mocking data比较方便，替换一个假的backend就可以，而且代码扣除注释，500行左右；

那么现在我们来详细了解一下Axios (朋友圈有前端同学叫它 “阿迪奥克斯”??)

二、详解axios

1. Axios是什么

Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。(一看是基于promise是不是就对它的API有了大概的了解？哈哈哈)

2. Axios的特点

• 从浏览器中创建 XMLHttpRequests
• 从 node.js 创建 http 请求
• 支持 Promise API
• 拦截请求和响应 （就是有interceptor）
• 转换请求数据和响应数据
• 取消请求
• 自动转换 JSON 数据
• 客户端支持防御 XSRF

ps: 可能大家对interceptor（拦截器）并不是很熟悉，在这里作下介绍，拦截器可以在请求发送前和发送请求后做一些处理。有一张图可以清晰的了解它在一次HTTP请求中做了什么，如下图

image.png

3.兼容性

image.png

4.安装
使用 npm:
$ npm install axios
使用 bower:
$ bower install axios
使用 cdn:
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

5.基本用法

//执行get请求
// Make a request for a user with a given ID
axios.get(‘/user?ID=12345‘)
  .then(function (response) {
    console.log(response);
  }).catch(function (error) {
    console.log(error);
  });

// Optionally the request above could also be done as
axios.get(‘/user‘, {
    params: {
      ID: 12345
    }
  }).then(function (response) {
    console.log(response);
  }).catch(function (error) {
    console.log(error);
  });

是不是都在then,catch里处理response，感觉fetch差不多，写起来很方便
6.使用流程
本来想在这贴Axios API,这跟大家读api文档无异，所以在这里贴一下我们是如何使用的吧，或许对你更有帮助

//首先我们来创建一个Axios实例

var axiosIns = axios.create({
  baseURL: ‘https://some-domain.com/api/‘,
  timeout: 1000,
  headers: {‘X-product‘: ‘h5‘}
});

//设置request拦截器
axiosIns.interceptors.request.use((request) => {
//在这里处理request，可以对所有请求统一处理请求头等
})

//设置response拦截器
axiosIns.interceptors.response.use((response) => {
       //在这里处理response，这是全局的，对所有使用axios的请求起作用
 });

//可以将上边的创建实例和设置的拦截器封装成函数，之后直接调用就Ok

//实例方法
//以下是可用的实例方法。指定的配置将与实例的配置合并
axios#request(config)
axios#get(url[, config])
axios#delete(url[, config])
axios#head(url[, config])
axios#post(url[, data[, config]])
axios#put(url[, data[, config]])
axios#patch(url[, data[, config]])

//请求配置

{
  // `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) {
  })
}

补充说明：
XMLHttpRequest 或 Fetch都是浏览器实现的功能，而axios是我们封装的axios库

7.参考资料
https://github.com/mzabriskie/axios