axios详解

时间 2019-11-11

标签 axios 详解繁體版

原文原文链接

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

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

特性：css

从浏览器中建立 XMLHttpRequestshtml

从 node.js 建立 http 请求vue

支持 Promise APIjava

拦截请求和响应node

转换请求数据和响应数据jquery

取消请求webpack

自动转换 JSON 数据ios

客户端支持防护 XSRF

1、安装：

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

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

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

2、使用：

假如你安装了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 以后，经过修改原型链，来更方便的使用。

3、发起POST请求：

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

4、发起一个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);
});

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

处理并发请求的助手函数

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

6、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 这些属性都没必要在配置中指定。

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

跨域的解决办法有不少，好比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'。

8、建立实例：

可使用自定义配置新建一个 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 });

9、拦截器：

一、发送以前能够对请求进行拦截，还能够拦截响应，相似中间件。你能够在请求、响应在到达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
})

二、取消拦截器：

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

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

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

10、错误处理：

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

11、取消

使用 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 取消多个请求

11、将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>