记录自己对axios较为全面的使用 - 《Article - 前端文章》

写在前面
基础用法
实例用法
- 用法
配置默认值
- 全局默认配置
- 实例默认配置
关于配置冲突
拦截器
总结

写在前面

记录自己对axios的一次较为全面的使用，以前在开发项目时，当需要涉及到请求时，往往只需要自己去配置一下URL，传一下参数就可以OK了，这次自己独立从零开始开发，一切都需要自己做，此处记录一下自己对axios的全新的认识

基础用法

用法

最基础的使用方式，根据请求方式传入请求地址和参数即可

import axios from 'axios'
axios.get('https://juejin.cn/user', {
  // params该字段是固定的，表示添加到浏览器地址里的参数，没有参数可省略
    params: {
      ID: 10086
    }
  })
  .then(response => {
      // 请求成功时执行，response为返回的响应结构
    console.log(response);
  })
  .catch(error => {
      // 请求失败时执行
    console.log(error);
  })
    .then(() => {
    // 无论成功或者失败都会执行，有点像finally方法，当然这里也可以用finally代替
    })
// post方式携带参数
axios.post('https://juejin.cn/user', {
    firstName: 'Fred',
    lastName: 'Flintstone'
  },{
    // 其他一些参数的配置，例如
    headers: {
      'Content-Type': 'multipart/form-data',
      Token: this.token
    },
    responseType: "blob"
    })
  .then(() => {})
  .catch(() => {});

不同的请求方式略微有一些差异，如下
axios.request(config)
axios.get(url[, config])
axios.delete(url[, config])
axios.head(url[, config])
axios.options(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])
[]内参数可省略的

在使用别名方法时， url、method、data 这些属性都不必在配置中指定。

这里额外说一下axios.request(config)，之前一直以为request是一种请求，后来才知道request方式就是我们平时下面使用的这种方式，真的是蠢哭了！！！

axios({
  method: 'post',
  url: 'https://juejin.cn/user',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  },
  responseType:'blob'
})
  .then(() => {})
  .catch(() => {});

config配置参数

config配置参数是通用的，下文涉及到config，若未明确指出则是相同的

{
  // `url` 用于请求的服务器 URL
  url: '/user',
  // `method` 创建请求时使用的方法
  method: 'get', // 默认是 get
  // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
  // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  baseURL: 'https://juejin.cn',
  // `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
  cancelToken: new CancelToken(function (cancel) {
  })
}

响应结构

{
  // `data` 由服务器提供的响应
  data: {},
  // `status` 来自服务器响应的 HTTP 状态码
  status: 200,
  // `statusText` 来自服务器响应的 HTTP 状态信息
  statusText: 'OK',
  // `headers` 服务器响应的头
  headers: {},
  // `config` 是为请求提供的配置信息
  config: {}
}

实例用法

用法

用axios创建一个实例
axios.create([config])

const service = axios.create({
  baseURL: "https://juejin.cn",
  timeout: 5000
})

创建实例后，我们能像使用axios一样使用service这个实例，换句话说，就是只要能使用axios的地方，绝大多数都可以使用实例代替。
在使用别名请求方式时**实例没有options这个别名**

配置默认值

指定将被用在各个请求的配置默认值

全局默认配置

// 配置默认baseUrl
axios.defaults.baseURL = 'https://juejin.cn';
// 给每个请求加上 Authorization 字段
axios.defaults.headers.common['Authorization'] = "xxx";
// 给每个post请求设置 Content-Type 
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

实例默认配置

用法同上，只需将axios换成实例即可

// 配置默认baseUrl
service.defaults.baseURL = 'https://juejin.cn';
// 给每个请求加上 Authorization 字段
service.defaults.headers.common['Authorization'] = "xxx";
// 给每个post请求设置 Content-Type 
service.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

关于配置冲突

这里用timeout的例子来说明

// 1. 全局默认配置timeout为1000
axios.defaults.timeout = 1000;
// 2. 实例配置timeout
let instance = axios.create({
    baseURL: 'xxxxx',
      //     如果此处未设置timeout，则使用全局默认配置的timeout
    timeout: 2000,
})
// 创建完实例后修改配置timeout，会覆盖掉创建实例时的timeout
instance.defaults.timeout = 3000
// 3. 发起请求时修改配置，如果某个请求需要话费的时间很长，我们可以单独为这个请求设置一个timeout
instance.get('/xxx',{
    timeout: 5000
})

现在对上述情形进行说明

我们如果使用基础方式里面的方法来请求接口，那它的超时时间则为1000,例如 axios.get("/xx")
如果我们用实例的方法来请求接口且实例配置了timout，那它的超时时间则为3000
如果我们在请求接口时单独进行了配置，则以此处的配置为准

简单来说就是
**请求配置 > 实例配置 > 全局配置**

拦截器

拦截器的作用就是在请求和响应时，对他们统一做一些处理
以前没做过拦截器这块，听起来总感觉很高大上，直到自己实践了一次才发现也就那样。

import { Message } from 'element-ui';
// 请求拦截 也可用axios代替service实例来进行全局配置
service.interceptors.request.use((config) => {
  // 发送请求之前做些什么
  // 比如给每个请求都添加token
  config.headers.Token = "xx"
  return config
}, (err) => {
  // 对请求错误做些什么
  console.log("request拦截错误处理",err)
  return Promise.reject(err)
})
// 响应拦截
service.interceptors.response.use((res) => {
  // 对响应的数据做些什么
  if(res.data.code !== 0) {
    // 当请求错误时，提示错误信息
    Message.error(res.data.msg)
    if(res.data.code === -1) {
      // 在这里我们和后端约定 code === -1 则表示token已经过期需要从新登录
      router.push("/login")
    }
  }
  return res
}, (err) => {
  // 对响应错误做些什么
  console.log("reponse拦截错误处理",err)
  return Promise.reject(err)
})

总结

相比全局配置与实例配置，实例配置要相对灵活一点，我们可以通过创建多个实例来进行不同的配置，所以实例配置更适合相对系统的开发，如果只是单纯的开发一个网页，比如说一个分享页面，则可以考虑直接使用axios发起请求