Vue.js官方推荐的Ajax库Axios入门

作者: microkof | 来源:发表于2017-12-19 17:33 被阅读1120次

简介

Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。本文先从浏览器端学起。

它的特性是：

从浏览器中创建 XMLHttpRequests
从 node.js 创建 http 请求
支持 Promise API
拦截请求和响应
转换请求数据和响应数据
取消请求
自动转换 JSON 数据
客户端支持防御 XSRF

浏览器支持

IE9及以上。

引入

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

或

<script src="https://cdn.bootcss.com/axios/0.17.1/axios.min.js"></script>

基本用法

先做一个1.php：

<?php

$a['bc'] = 'd';
echo json_encode($a);

然后做一个1.html：

<script src="https://cdn.bootcss.com/axios/0.17.1/axios.min.js"></script>
<script type="text/javascript">
axios.get('1.php')
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });
</script>

控制台输出：

image.png

响应包含以下信息：

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

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

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

  // `request` 指向XHR对象
  request: {},

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

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

可以看出，Axios跟jQuery的response有极大区别，jQuery的response忠实的表达php的响应内容，而Axios会给response附加相当多的属性。

抛出错误

如果是404错误，会抛出：

Error: Request failed with status code 404
    at e.exports (https://cdn.bootcss.com/axios/0.17.1/axios.min.js:8:4479)
    at e.exports (https://cdn.bootcss.com/axios/0.17.1/axios.min.js:8:4321)
    at XMLHttpRequest.l.(anonymous function) (https://cdn.bootcss.com/axios/0.17.1/axios.min.js:8:3278)

加参数的GET请求

php：

<?php
echo $_GET['ID'];

html：

<script src="https://cdn.bootcss.com/axios/0.17.1/axios.min.js"></script>
<script type="text/javascript">
axios.get('1.php', {
    params: {
      ID: 12345
    }
  })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });
</script>

POST请求

官方给出的POST范例如下：

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

但是，这个例子并不能运行成功。官方给出的解决方案是，需要使用一个非常新的API：URLSearchParams。这里是它的介绍：https://developer.mozilla.org/zh-CN/docs/Web/API/URLSearchParams 。使用它之后，就可以正常发送POST请求了。

var params = new URLSearchParams();
params.append('key', 'value');

axios.post('1.php', params)
.then(function(res){
  console.log(res);
})
.catch(function(err){
  console.log(err);
});

由于IE11以上才支持URLSearchParams（可以参看https://www.caniuse.com/#feat=urlsearchparams），所以官方给出了一个垫片方案：https://github.com/WebReflection/url-search-params，使用方法很简单，引入<script src="https://cdn.bootcss.com/url-search-params/0.10.0/url-search-params.js"></script>，然后照常使用即可。

POST上传文件或Blob

URLSearchParams只能处理url字符串，并不能上传文件，如果想上传文件，可以使用另一个API：FormData。它的使用方法跟URLSearchParams一模一样：

<script src="https://cdn.bootcss.com/axios/0.17.1/axios.min.js"></script>
<input type="file" id="file">
<button>按钮</button>
<script type="text/javascript">
document.getElementsByTagName('button')[0].onclick = function () {
    var formdata = new FormData();
    formdata.append('key', 'value');
    formdata.append('file', file.files[0]);

    axios.post('1.php', formdata)
    .then(function(res){
      console.log(res.data);
    })
    .catch(function(err){
      console.log(err);
    });
};
</script>

并发请求

处理并发请求的助手函数：

axios.all(iterable) 接收数组参数，每一个数组元素都是一个Axios请求
axios.spread(callback) 执行并发并执行回调

function getA() {
  return axios.get('1.php?ID=12345');
}

function getB() {
  return axios.get('1.php?ID=910JQK');
}

function getC() {
  return axios.get('1.php?ID=abcde');
}

axios.all([getA(), getB(), getC()])
  .then(axios.spread(function (a, b, c) {
    // 当所有请求都执行完成，才执行此处代码
    // a 就是第一个请求的响应，其他类推
    console.log(a);
    console.log(b);
    console.log(c);
  }));

方法别名

跟jQuery类似，Axios也搞了很多方法别名，不过通常我们用GET和POST最多：

axios.request(config)
axios.get(url[, config])
axios.post(url[, data[, config]])
axios.delete(url[, config])
axios.head(url[, config])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])

axios API

有两种形式。

第一种：axios(config)

// 比如发送 POST 请求
axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});

从上文可知，这种写法是不会正确执行的，只能修改一下：

    var data = new URLSearchParams();
    data.append('key', '1111');
    axios({
      method: 'post',
      url: '1.php',
      data: data
    })

第二种：axios(url[, config])

axios('/user/12345', {
  method: 'get',
  params: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});

第一种、第二种形式的唯一区别在于是否把url择出来。

axios的所有config如下。通常我们不用关心全部的配置项，只需要设置常用的几个项即可。

{
  //`url`是请求的服务器地址
  url:'/user',
  //`method`是请求资源的方式
  method:'get'//default
  //如果`url`不是绝对地址，那么`baseURL`将会加到`url`的前面
  //当`url`是相对地址的时候，设置`baseURL`会非常的方便
  baseURL:'https://some-domain.com/api/',
  //`transformRequest`选项允许我们在请求发送到服务器之前对请求的数据做出一些改动
  //该选项只适用于以下请求方式：`put/post/patch`
  //数组里面的最后一个函数必须返回一个字符串、-一个`ArrayBuffer`或者`Stream`
  transformRequest:[function(data){
    //在这里根据自己的需求改变数据
    return data;
  }],
  //`transformResponse`选项允许我们在数据传送到`then/catch`方法之前对数据进行改动
  transformResponse:[function(data){
    //在这里根据自己的需求改变数据
    return data;
  }],
  //`headers`选项是需要被发送的自定义请求头信息
  headers: {'X-Requested-With':'XMLHttpRequest'},
  //`params`选项是要随请求一起发送的请求参数----一般链接在URL后面
  //他的类型必须是一个纯对象或者是URLSearchParams对象
  params: {
    ID:12345
  },
  //`paramsSerializer`是一个可选的函数，起作用是让参数（params）序列化
  //例如(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`选项时dada必须是以下几种类型之一
  //string/plain/object/ArrayBuffer/ArrayBufferView/URLSearchParams
  //仅仅浏览器：FormData/File/Blob
  //仅node:Stream
  data {
    firstName:"Fred"
  },
  //`timeout`选项定义了请求发出的延迟毫秒数
  //如果请求花费的时间超过延迟的时间，那么请求会被终止

  timeout:1000,
  //`withCredentails`选项表明了是否是跨域请求
  
  withCredentials:false,//default
  //`adapter`适配器选项允许自定义处理请求，这会使得测试变得方便
  //返回一个promise,并提供验证返回
  adapter: function(config){
    /*..........*/
  },
  //`auth`表明HTTP基础的认证应该被使用，并提供证书
  //这会设置一个authorization头（header）,并覆盖你在header设置的Authorization头信息
  auth: {
    username:"zhangsan",
    password: "s00sdkf"
  },
  //返回数据的格式
  //其可选项是arraybuffer,blob,document,json,text,stream
  responseType:'json',//default
  //
  xsrfCookieName: 'XSRF-TOKEN',//default
  xsrfHeaderName:'X-XSRF-TOKEN',//default
  //`onUploadProgress`上传进度事件
  onUploadProgress:function(progressEvent){
    //下载进度的事件
onDownloadProgress:function(progressEvent){
}
  },
  //相应内容的最大值
  maxContentLength:2000,
  //`validateStatus`定义了是否根据http相应状态码，来resolve或者reject promise
  //如果`validateStatus`返回true(或者设置为`null`或者`undefined`),那么promise的状态将会是resolved,否则其状态就是rejected
  validateStatus:function(status){
    return status >= 200 && status <300;//default
  },
  //`maxRedirects`定义了在nodejs中重定向的最大数量
  maxRedirects: 5,//default
  //`httpAgent/httpsAgent`定义了当发送http/https请求要用到的自定义代理
  //keeyAlive在选项中没有被默认激活
  httpAgent: new http.Agent({keeyAlive:true}),
  httpsAgent: new https.Agent({keeyAlive:true}),
  //proxy定义了主机名字和端口号，
  //`auth`表明http基本认证应该与proxy代理链接，并提供证书
  //这将会设置一个`Proxy-Authorization` header,并且会覆盖掉已经存在的`Proxy-Authorization`  header
  proxy: {
    host:'127.0.0.1',
    port: 9000,
    auth: {
      username:'skda',
      password:'radsd'
    }
  },
  //`cancelToken`定义了一个用于取消请求的cancel token
  //详见cancelation部分
  cancelToken: new cancelToken(function(cancel){

  })
}

创建axios实例

利用axios.create(config)创建实例，我们可以创建一个定制版axios。

下面栗子中，baseURL:"https://www.baidu.com/"指定了baseURL，当然了，这个例子的执行结果是抛出错误，大家明白道理即可。

var axiosInstance = axios.create({
  baseURL:"https://www.baidu.com/",
});
axiosInstance('1.php', {
  method: 'get',
  params: {
    ID: '23456'
  }
}).then(function (a) {
  console.log(a);
});

默认配置

在不创建定制版实例的前提下，我们也可以先修改默认配置。比如：

1、设置全局默认配置

axios.defaults.baseURL = 'http://api.exmple.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['content-Type'] = 'appliction/x-www-form-urlencoded';

2、设置自定义实例的默认设置

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

//当实例创建时候修改配置
axiosInstance.defaults.headers.common["Authorization"] = AUTH_TOKEN;

配置的覆盖规则

现在我们可以看到，有三种方式对我们的请求进行配置：

请求之前给axios传参
定制一个实例
给axios设置默认配置，或给实例修改默认配置

那么，配置覆盖规则是什么呢？

简单说，实例的配置永远高于axios类的配置，请求之前给axios传参高于一切。

拦截器

拦截器英文为interceptor。拦截器的作用是，在你的请求发出之前，或者响应到达之前，多一次或多次身份验证。

因为前后台交互一定要遵循一个原则：互不信任原则。前端发送到后台的参数必须在前端验证合法的才能发送，后台必须验证是否合法，验证是否符合该参数的原定数据类型和值范围。后台返回给前端的数据，也必须验证是否为约定的数据结构和值类型。

例如：你写了几个请求数据的接口，开启服务后，用户没登录直接访问这些接口，也是可以拿到数据的，但这就违背了后台管理系统必须先登录的原则，有心人就会利用这个bug来窃取你的数据库数据。所以让拦截器拦截这种非法请求。

拦截分为请求发送前的拦截，和接到响应数据前的拦截。看个栗子：

//添加一个请求拦截器
axios.interceptors.request.use(function(config){
  console.log('尚未发出请求');
  return config;
},function(err){
  return Promise.reject(error);
});

//添加一个响应拦截器
axios.interceptors.response.use(function(res){
  console.log('尚未处理响应');
  return res;
},function(err){
  return Promise.reject(error);
});

axios('1.php', {
  method: 'get'
}).then(function (a) {
  console.log(a);
});

输出：

尚未发出请求
尚未处理响应
Object {data: 111, status: 200, statusText: "OK", headers: Object, config: Object…}

你可能会说，我在发送请求之前先做条件判断不行么？条件判断通过才发送请求，不可以么？可以虽然是可以，但是这不符合面向对象的原则，因为先写验证然后写发送，这是面向过程的，还有一个弊端是会造成重复代码，不方便管理，因为你每写一处请求，就要先写一片验证代码。

观察代码，你会发现拦截器的回调函数里面有一个config，这是干嘛的？我们打印一下它：

image.png

简单说，config是一组可修改的配置项，比如，我们修改url，改成2.php，看看会有什么现象：

//添加一个请求拦截器
axios.interceptors.request.use(function(config){
  config.url = '2.php';
  return config;
},function(err){
  return Promise.reject(error);
});

axios('1.php', {
  method: 'get'
}).then(function (a) {
  console.log(a);
});

结果呢，由于我根本没有2.php，所以直接报错了。

然后，响应拦截器里面的res又是什么呢？这个就简单了，它指向Axios的响应对象。

拦截器的注意事项：

拦截器必须在请求前设置才有效，所以注意代码先后顺序。
直接为axios全局对象创建拦截器，会导致全局的axios发出的请求或接收的响应都会被拦截到，实践中不要做事做这么绝，所以应该使用axios.create()来创建单独的axios实例，然后给实例设置拦截器。

错误处理

符合标准Promises的错误处理方法，就是用catch()来捕获。

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.header);
    }else {
      //一些错误是在设置请求的时候触发
      console.log('Error',error.message);
    }
    console.log(error.config);
  });

取消请求

先写例子：

1.php如下，php的作用是，5秒钟之后返回111。

<?php
sleep(5);
echo 111;

html：

<script src="https://cdn.bootcss.com/axios/0.17.1/axios.min.js"></script>
<button>1111</button>
<script type="text/javascript">
var CancelToken = axios.CancelToken;
var source = CancelToken.source();
axios.get('1.php', {
  cancelToken: source.token
}).then(function (response) {
  console.log(response);
}, function(thrown) {
  if (axios.isCancel(thrown)) {
    console.log('Request canceled - ', thrown.message);
  } else {
    // handle error
  }
});

document.getElementsByTagName('button')[0].onclick = function () {
    source.cancel();
}
</script>

在不点击按钮的前提下，5秒钟之后，顺利的打印了response对象。如果5秒钟之内点击了按钮，则属于异常，会被捕获。打印Request canceled - undefined。

我们分析一下：

var CancelToken = axios.CancelToken; 是创建一个取消令牌对象
var source = CancelToken.source(); 是取得这个对象的资源对象

说实话这2句的原理，很少有文献能查到，所以我们暂时不去了解原理，只需要知道，我们操作source就可以取消请求。

取消请求的代码就一句source.cancel();，可以加字符串参数，用于说明取消的原因。

然后，我们在Axios的配置项里加入cancelToken: source.token，这个的意义在于，程序怎么知道你要取消哪个请求呢？就靠这个令牌来识别到底是该取消哪个请求。

另一种写法是：

<script src="https://cdn.bootcss.com/axios/0.17.1/axios.min.js"></script>
<button>1111</button>
<script type="text/javascript">
var CancelToken = axios.CancelToken;
var cancel;
axios.get('1.php', {
  cancelToken: new CancelToken(function executor(c) {
    cancel = c;
  })
}).then(function (response) {
  console.log(response);
}, function(thrown) {
  if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.message);
  } else {
    // handle error
  }
});

document.getElementsByTagName('button')[0].onclick = function () {
    cancel();
}
</script>

这个理解起来更麻烦，推荐用第一种。