前端培训-中级阶段（42）- axios 使用及如何和 vue 结合使用

前端最基础的就是 HTML+CSS+Javascript。掌握了这三门技术就算入门，但也仅仅是入门，如今前端开发的定义已经远远不止这些。前端小课堂（HTML/CSS/JS），本着提高技术水平，打牢基础知识的中心思想，咱们开课啦（每周四）。

今天来了解一下 axios 这个库，基本上大多数的 vue 应用都在使用过 axios 。
早期 Vue 通常使用 vue-resource ，再往没有 Vue 的时候说就是就是无敌的 jQuery 的 $.ajax。

axios 特色

• 支持浏览器环境、Node 环境
• 支持 Promise ，链式调用。
• 有拦截器功能，能够拦截请求和响应
• 有转换器功能，能够转换请求数据和响应数据
• 取消请求（fetch 不支持取消），经过 CancelToken 实现的逻辑
  Axios 的 cancel token API 基于cancelable promises proposal

API

请求方法

• axios(config) 我最喜欢用的方式，方便修改，也方便批量改其余方式（好比我以前封装了一个 axios 自动重试的库，改起来贼快）。
• axios(url[, config])
• 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]])

请求配置 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) {
  })
}

响应

{
  // `data` 由服务器提供的响应
  data: {},

  // `status` 来自服务器响应的 HTTP 状态码
  status: 200,

  // `statusText` 来自服务器响应的 HTTP 状态信息
  statusText: 'OK',

  // `headers` 服务器响应的头
  headers: {},

  // `config` 是为请求提供的配置信息
  config: {}
}

其余方法

处理并发请求的助手函数

1. axios.all(iterable) 能够理解为 Promise.all
2. axios.spread(callback) 把响应拆开，变成一个个的入参
   

3. axios.create([config]) 使用自定义配置新建一个 axios 实例，好比说针对不一样的业务，封装起来作针对性的配置。还能够经过default 来配置，好比 axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';
   
   由于涉及多个配置，因此会有一个优先级。这个顺序是：在 lib/defaults.js 找到的库的默认值，而后是实例的 defaults 属性，最后是请求的 config 参数。后者将优先于前者。这里是一个例子：

   // 使用由库提供的配置的默认值来建立实例
   // 此时超时配置的默认值是 `0`
   var instance = axios.create();
   
   // 覆写库的超时默认值
   // 如今，在超时前，全部请求都会等待 2.5 秒
   instance.defaults.timeout = 2500;
   
   // 为已知须要花费很长时间的请求覆写超时设置
   instance.get('/longRequest', {
     timeout: 5000
   });

序列化 paramsSerializer

需求仍是挺常见的，好比说数组如何显示？

paramsSerializer 是一个负责 params 序列化的函数(e.g. https://www.npmjs.com/package... http://api.jquery.com/jquery.param/)

paramsSerializer: function(params) {
    return Qs.stringify(params, {arrayFormat: 'brackets'})
},

拦截器

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求以前作些什么
    return config;
  }, function (error) {
    // 对请求错误作些什么
    return Promise.reject(error);
  });

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 对响应数据作点什么
    return response;
  }, function (error) {
    // 对响应错误作点什么
    return Promise.reject(error);
  });
  
// 移除拦截器  
var myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);

停止请求

var CancelToken = axios.CancelToken;
var source = CancelToken.source();

axios.get('/user/12345', {
  cancelToken: source.token
}).catch(function(thrown) {
  if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.message);
  } else {
    // 处理错误
  }
});

// 取消请求（message 参数是可选的）
source.cancel('Operation canceled by the user.');

注意事项

1. axios 依赖原生的 ES6 Promise 实现支持。若是你的环境不支持 ES6 Promise，你可使用 polyfill。安卓 4.x ，别问我为何兼容这么低的版本，问就是哭
2. responseType 表示服务器响应的数据类型，能够是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'。
   stream 是 Node 中才能使用的。
   arraybuffer, blob, document 是在浏览器中才能使用的。
3. node 中使用 proxy 部分服务会出现不能访问问题。能够考虑使用 axios-https-proxy-fix

微信公众号：前端linong

参考文献

1. 前端培训目录、前端培训规划、前端培训计划