axios详解

vuejs 2 后 作者尤雨溪发布消息，不再继续维护vue-resource，官方推荐大axios。

Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。

特性：

从浏览器中创建 XMLHttpRequests

从 node.js 创建 http 请求

支持 Promise API

拦截请求和响应

转换请求数据和响应数据

取消请求

自动转换 JSON 数据

客户端支持防御 XSRF

一、安装：

1、 利用npm安装npm install axios --save

2、 利用bower安装bower install axios --save

3、 直接利用cdn引入<script src="https://cdn.bootcss.com/axios/0.18.0/axios.js"></script>

二、使用：

假如你安装了vue脚手架，则在main.js文件中添加如下代码：

import axios from 'axios'
Vue.prototype.$axios = axios

然后在组件中可以这样使用了：

<script>
  export default {
    data() {
      return {
        visible: false
      };
    },
    methods: {
      getData() {
        this.$axios.get("https://api.github.com/events")
          .then(function (response) {
            console.log(response)
          })
          .catch(function (error) {
            console.log(error);
          })
      }
    }
  };
</script>

 说明：

安装其他插件的时候，可以直接在 main.js 中引入并使用 Vue.use()来注册，但是 axios并不是vue插件，所以不能使用Vue.use()，所以只能在每个需要发送请求的组件中即时引入。

为了解决这个问题，我们在引入 axios 之后，通过修改原型链，来更方便的使用。

三、发起POST请求：

axios.post('/user', {
    firstName: 'Fred',
    lastName: 'Flintstone'
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

四、发起一个GET请求：

    axios.get('https://api.github.com/events')
        .then(function(response){
            console.log(response.data);
        })
        .catch(function(err){
            console.log(err);
        });

携带参数：

// 向具有指定ID的用户发出请求
axios.get('/user?ID=12345')
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});

 或

// 也可以通过 params 对象传递参数
axios.get('/user', {
params: {
ID: 12345
}
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});

五、并发请求：一次发起多个请求

处理并发请求的助手函数

axios.all( iterable )
axios.spread( callback )

function getUserAccount() {
  return axios.get('/user/12345');
}
function getUserPermissions() {
  return axios.get('/user/12345/permissions');
}
axios.all([getUserAccount(), getUserPermissions()])
  .then(axios.spread(function (acct, perms) {
    // Both requests are now complete
  }));

//两个请求同时请求成功才返回数据
axios.all([http1(),http2()]).then( (response)=>{
        console.log(response);  //返回的是一个数组，数组项是每个请求返回的结果，用下标去取每个请求的结果
        } )

        axios.all([http1(),http2()]).then(axios.spread((res1,res2)=>{ //用spread分割开2个请求返回的结果
                console.log(res1)  //第一个请求返回的结果
                console.log(res2) //第二个请求返回的结果
        }))
        .catch((error) =>{
            if (axios.isCancel(error)) {
                console.log(error.message);
            }else{
                    console.log(error)
            }
})

六、axios可以通过配置（config）来发送请求：

// Send a POST request
axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});
// GET request for remote image
axios({
  method:'get',
  url:'http://bit.ly/2mTM3nY',
  responseType:'stream'
})
  .then(function(response) {
  response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
});

axios(url[, config])

// Send a GET request (default method)
axios('/user/12345');

请求方法的别名

为方便起见，为所有支持的请求方法提供了别名

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]])

NOTE

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

七、当有跨域限制的时候解决方案：

跨域的解决办法有很多，比如script标签 、jsonp、后端设置cros等等...,但是我这里讲的是webpack配置vue 的 proxyTable解决跨域。

这里我请求的地址是 http://www.thenewstep.cn/test/testToken.php

那么在ProxyTable中具体配置如下：

​

proxyTable: {
      '/apis': {
        // 测试环境
        target: 'http://www.thenewstep.cn/',  // 接口域名
        changeOrigin: true,  //是否跨域
        pathRewrite: {
            '^/apis': ''   //需要rewrite重写的,
        }              
}

target：就是需要请求地址的接口域名。 

这里列举了1种数据请求方式：axios

main.js代码：

import Vue from 'vue'
import App from './App'
import axios from 'axios'
Vue.config.productionTip = false

Vue.prototype.$axios = axios //将axios挂载在Vue实例原型上

// 设置axios请求的token
axios.defaults.headers.common['token'] = 'f4c902c9ae5a2a9d8f84868ad064e706'
//设置请求头
axios.defaults.headers.post["Content-type"] = "application/json"

axios请求页面代码：

this.$axios.post('/apis/test/testToken.php',data).then(res=>{
        console.log(res)
})

这里的'apis'就是在ProxyTable中配置的'/apis'。

八、创建实例：

可以使用自定义配置新建一个 axios 实例

axios.create([config])

var instance = axios.create({
    baseURL:'',
    timeout:1000,
    headers:{},
    responseType:'json',
    params:{},
    transformRequest:[],  只适合PUT、POST和、PATCH
    transformResponse:[],
    validateStatus:function(){},  //验证状态码在哪个范围是成功，哪个范围是失败
    cancelToken
});

实例：http组件

import axios from 'axios';
import queryString from 'queryString'

//创建取消请求令牌
var CancelToken = axios.CancelToken;
var source = CancelToken.source();

//可以把这个HTTP写在某一个单独的组件内，也可以提取出来放在一个js文件内，
//然后export default HTTP，在其他组件内，通过import这个js文件进行使用
var HTTP = axios.create({
    baseURL:'https://www.easy-mock.com/mock/5c1767c06ccaa7461ef01ee9/example/'   //基本url都一样
    timeout:1000        //单位是ms，请求超过这个时间就取消，即请求超时
    responseType:'json',  //后端返回的数据类型
    header:{  //自定义请求头
        'custom-header':'xiao',  //Request Headers里面就多了一个custom-header:xiao，后端可以拿到这个数据
        'content-type':'application/x-www-form-urlencoded'  //设置这个，那么经过transformRequest处理之后的数据格式就变为了  miaov=ketang&username=leo，只支持POST请求方式
    },
    params:{  //查询字符串，传给后端的数据，不管是get还是post请求，这条数据都会附在url后面，发送给后端
        bookId:'123'
    },
    transformRequest:[function(data){  //数组格式，用于转换发送数据格式，只适合PUT、POST、PATCH，data是传递给后端的数据，transformRequest类似一个中间件，发送数据，经过它来转换，需要reture出来，否则就是undefined，但是不能直接是return data，因为这样返回的是[object object]，
安装queryString来处理查询字符串，格式化成一个字符串
      data.age = 30;  //发送请求之前可以再次添加数据
      return queryString.stringify(data);  
    }],
    transformResponse:[function(data){   //数组格式，用于处理返回的数据格式，data是后端发送回来的数据
      data.abc = 'miaov'  //对返回数据做进一步处理，请求此类地址的返回值都拥有abc这个属性，值是miaov
      return data;  //需要return出来
    }],
    cancelToken: source.token  //主动取消请求
})

export default({
    created(){
      HTTP.get('test-axios')
      .then((response)=>{
            console.log(response.data)
        })
      .catch((error) =>{
        console.log(error)
    })

  }
})

export default{
    created(){
        HTTP.post('postData#!method=post',{   //只是请求方式不一样
                miaov:"ketang", 
        username:"leo"
        }) 
        .then( (response)=>{
            console.log(response.data)
        } )
        .catch( (error)=>{
            if (axios.isCancel(error)) {  //被用户取消
          console.log(error.message);
        }else{  //发送请求超时
            console.log(error)
        }
        } )

        //手动、立即取消请求，走catch分支，添加这个，会走catch里面的if分支，不添加这个，如果出错会走else分支
        source.cancel('操作被用户取消')
    }
}

实例方法

以下是可用的实例方法。指定的配置将与实例的配置合并

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 是必需的。如果没有指定 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) {
  })
}

响应结构

某个请求的响应包含以下信息

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

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

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

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

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

 使用 then 时，你将接收下面这样的响应：

axios.get('/user/12345')
  .then(function(response) {
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.config);
  });

在使用 catch 时，或传递 rejection callback 作为 then 的第二个参数时，响应可以通过 error 对象可被使用，正如在错误处理这一节所讲。

配置的默认值/defaults

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

全局的 axios 默认值

axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

自定义实例默认值

// 创建实例时设置配置的默认值
var instance = axios.create({
  baseURL: 'https://api.example.com'
});

// 在实例已创建后修改默认值
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

 配置的优先顺序

配置会以一个优先顺序进行合并。这个顺序是：在 lib/defaults.js 找到的库的默认值，然后是实例的 defaults 属性，最后是请求的 config 参数。后者将优先于前者。这里是一个例子：

// 使用由库提供的配置的默认值来创建实例
// 此时超时配置的默认值是 `0`
var instance = axios.create();

// 覆写库的超时默认值
// 现在，在超时前，所有请求都会等待 2.5 秒
instance.defaults.timeout = 2500;

// 为已知需要花费很长时间的请求覆写超时设置
instance.get('/longRequest', {
  timeout: 5000
});

九、拦截器：

1、发送之前可以对请求进行拦截，还可以拦截响应，类似中间件。你可以在请求、响应在到达then/catch之前拦截他们。

var HTTP = axios.create({  //自定义请求
    baseURL:'http://easy-mock.com/mock/596077559adc231f357bcdfb/axios/',
    timeout: 1000,
    responseType:'json',
    headers:{
        'custome-header': 'miaov',
        'content-type':'application/x-www-form-urlencoded'
    }
})

//添加一个请求拦截器：请求之前的拦截
HTTP.interceptors.request.use(function(config){  //config就是自定义请求的配置信息，即HTTP的配置参数
    //在发送请求之前做某事
    console.log("拦截")
    //这里可以对配置项config做处理，取消某些配置或增加
    return config;  //return config请求会继续进行，否则请求就被拦截了
},function(error){
    //请求错误时做些事
    return Promise.reject(error);
});

//添加一个请求拦截器：请求之后的拦截
HTTP.interceptors.response.use(function(data){
        console.log("response")
        console.log(data)
        return data;  //需要return data才能拿到数据，否则就是undefined
})

2、取消拦截器：

var myInterceptor = axios.interceptor.request.use(function(){/*....*/});
axios.interceptors.request.eject(myInterceptor);

3、 给自定义的axios实例添加拦截器：

var instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});

十、错误处理：

axios.get('/user/12345')
  .catch(function (error) {
    if (error.response) {
      // 请求已发出，但服务器响应的状态码不在 2xx 范围内
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.headers);
    } else {
      // Something happened in setting up the request that triggered an Error
      console.log('Error', error.message);
    }
    console.log(error.config);
  });

可以使用 validateStatus 配置选项定义一个自定义 HTTP 状态码的错误范围。

axios.get('/user/12345', {
  validateStatus: function (status) {
    return status < 500; // 状态码在大于或等于500时才会 reject
  }
})

十一、取消

使用 cancel token 取消请求

Axios 的 cancel token API 基于cancelable promises proposal，它还处于第一阶段。

可以使用 CancelToken.source 工厂方法创建 cancel token，像这样：

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.');

还可以通过传递一个 executor 函数到 CancelToken 的构造函数来创建 cancel token：

var CancelToken = axios.CancelToken;
var cancel;

axios.get('/user/12345', {
  cancelToken: new CancelToken(function executor(c) {
    // executor 函数接收一个 cancel 函数作为参数
    cancel = c;
  })
});

// 取消请求
cancel();

Note : 可以使用同一个 cancel token 取消多个请求

十一、将axios定义在一个单独的文件中：

​

http.js

import axios from 'axios';

let HTTP = axios.create({
  baseURL:'http://127.0.0.1:8000/',
  timeout:1000,        //单位是ms，请求超过这个时间就取消，即请求超时
  responseType:'json',  //后端返回的数据类型
  header:{  //自定义请求头
    'custom-header':'xiao',  //Request Headers里面就多了一个custom-header:xiao，后端可以拿到这个数据
    'content-type':'application/x-www-form-urlencoded'  //设置这个，那么经过transformRequest处理之后的数据格式就变为了  miaov=ketang&username=leo，只支持POST请求方式
  },
  params:{  //查询字符串，传给后端的数据，不管是get还是post请求，这条数据都会附在url后面，发送给后端
    bookId:'123'
  },
  transformResponse:[function(data){   //数组格式，用于处理返回的数据格式，data是后端发送回来的数据
    data.abc = 'miaov'  //对返回数据做进一步处理，请求此类地址的返回值都拥有abc这个属性，值是miaov
    return data;  //需要return出来
  }]
});

//添加一个请求拦截器：请求之前的拦截
HTTP.interceptors.request.use(function(config){  //config就是自定义请求的配置信息，即HTTP的配置参数
  //在发送请求之前做某事
  console.log("拦截")
  //这里可以对配置项config做处理，取消某些配置或增加
  return config;  //return config请求会继续进行，否则请求就被拦截了
},function(error){
  //请求错误时做些事
  return Promise.reject(error);
});

//添加一个请求拦截器：请求之后的拦截
HTTP.interceptors.response.use(function(data){
  console.log("response")
  console.log(data)
  return data;  //需要return data才能拿到数据，否则就是undefined
})

export default HTTP;

在main.js中引入http，并修改原型链方便使用（同上面的第二大点）

// The Vue build version to load with the `import` command
// (runtime-only or standalone) has been set in webpack.base.conf with an alias.
import Vue from 'vue'
import App from './App'
import router from './router'

Vue.config.productionTip = false

import http from './axios/http'
Vue.prototype.$HTTP = http;

/* eslint-disable no-new */
new Vue({
  el: '#app',
  router,
  components: { App },
  template: '<App/>'
})

这样，就可以在任何地方使用了：

Table.vue

<template>
  <div>
    table
  </div>
</template>

<script>
  export default {
    mounted(){
      this.$HTTP.get('get_data',
        {
          params: {
            id: 12345
          }
        }
      ).then((response)=>{
          console.log(response.data)
        })
        .catch((error) =>{
          console.log(error)
        });
    }
  }
</script>

<style scoped lang="">

</style>