axios

axios

axios是基于JavaScript的ajax请求的一个框架，Vue推荐使用axios作为Vue项目的网络请求框架

axios使用非常简单，同时它类似于Promise，将异步请求与处理进行分离

npm安装

npm install axios --save

使用

一个简单的网络请求

axios({
  url: 'http://wthrcdn.etouch.cn/weather_mini',
  params: {
    city: '贵阳'
  }
}).then(message => {
  console.log(message.data)
})

axios返回的是一个包含返回数据，状态等的一个对象

请求多个数据

axios.all提供多个数据的请求

axios.all([
  axios({
    url: 'http://wthrcdn.etouch.cn/WeatherApi?city=贵阳'
  }),
  axios({
    url: 'http://wthrcdn.etouch.cn/weather_mini?city=贵阳'
  })
]).then(message => {
  console.log(message)
})

其返回值为一个数组，分别为两个返回对象

上述代码的then方法也可以传入axios.spread方法，该方法接收的参数为all里面发送的axios请求

axios.all([
  axios({
    url: 'http://wthrcdn.etouch.cn/WeatherApi?city=贵阳'
  }),
  axios({
    url: 'http://wthrcdn.etouch.cn/weather_mini?city=贵阳'
  })
]).then(axios.spread((message1, message2) => {
    console.log(message1);
    console.log(message2);
  }))

axios对象

当遇到需要不同的URL地址时，可以使用axios.create方法来创建axios对象

const instance = axios.create({
  baseURL: 'http://wthrcdn.etouch.cn',
  timeout: 5000
})

instance({
  url: '/weather_mini',
  params: {
    city: '贵阳'
  }
}).then(message => {
  console.log(message)
})

可以在一个专门的JS文件中存储不同的axios对象，这样就可以实现不同的axios需求

js文件

export function request(config) {
  const instance = axios.create({
    baseURL: 'http://wthrcdn.etouch.cn',
    timeout: 5000
  })

  return instance(config)
}

调用模块

import {request} from "./network/request";
request({
  url: '/weather_mini',
  params: {
    city: '贵阳'
  }
}).then(message => {
  console.log(message)
})

axios拦截器

请求拦截器

请求拦截器的返回值是一些请求信息，例如请求头，请求地址，请求方式等等

export function request(config) {
  const instance = axios.create({
    baseURL: 'http://wthrcdn.etouch.cn',
    timeout: 5000
  })

  instance.interceptors.request.use(config => {
    console.log(config)
    return config
  }, error => {
    console.log(error)
    return error
  })

  return instance(config)
}

响应拦截器

响应拦截器的返回值是服务器返回的相应信息，包括响应状态，响应数据，响应头等等，通常我们需要的就是响应数据，所以此时可以返回data

export function request(config) {
  const instance = axios.create({
    baseURL: 'http://wthrcdn.etouch.cn',
    timeout: 5000
  })

  instance.interceptors.response.use(config => {
      console.log(config)
      return config.data
    }, error => {
      console.log(error)
      return error
    })

  return instance(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) {
  })
}