axios学习教程全攻略

前言

随着 vuejs 作者尤雨溪发布消息，不再继续维护vue-resource，并推荐大家使用 axios 开始，axios 被越来越多的人所了解。本来想在网上找找详细攻略，突然发现，axios 的官方文档本身就非常详细！！有这个还要什么自行车！！所以推荐大家学习这种库，最好详细阅读其官方文档。大概翻译了一下 axios 的官方文档，相信大家只要吃透本文再加以实践，axios 就是小意思啦！！

如果您觉得本文对您有帮助，不妨点个赞或关注收藏一下，您的鼓励对我非常重要。

axios 简介

axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端，它本身具有以下特征：

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

浏览器兼容性

引入方式：

rush:js;"> $ npm install axios $ cnpm install axios //taobao源 $ bower install axios

或者使用cdn：

rush:xhtml;">

举个栗子：

执行 GET 请求

rush:js;"> // 向具有指定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); });

执行 POST 请求

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

执行多个并发请求

rush:js;"> 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) { //两个请求现已完成 }));

axios API

可以通过将相关配置传递给 axios 来进行请求。

axios(config)

rush:js;"> // 发送一个 POST 请求 axios({ method: 'post',url: '/user/12345',data: { firstName: 'Fred',lastName: 'Flintstone' } }); axios(url[,config])

rush:js;"> // 发送一个 GET 请求 (GET请求是默认请求模式) 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]]）

注意

当使用别名方法时，不需要在config中指定url，method和data属性。

并发

帮助函数处理并发请求。

• axios.all（iterable）
• axios.spread（callback）

创建实例

您可以使用自定义配置创建axios的新实例。

rush:js;"> axios.create（[config]）

var instance = axios.create({
baseURL: 'https://some-domain.com/api/',timeout: 1000,headers: {'X-Custom-Header': 'foobar'}
});

实例方法

可用的实例方法如下所示。 指定的配置将与实例配置合并。

• 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是必需的。 如果未指定方法，请求将默认为GET。

= 200 && status < 300; // default },// `maxRedirects`定义在node.js中要遵循的重定向的最大数量。 // 如果设置为0，则不会遵循重定向。 maxRedirects: 5,// 默认 // `httpAgent`和`httpsAgent`用于定义在node.js中分别执行http和https请求时使用的自定义代理。 // 允许配置类似`keepAlive`的选项， // 默认情况下不启用。 httpAgent: new http.Agent({ keepAlive: true }),httpsAgent: new https.Agent({ keepAlive: true }),// 'proxy'定义代理服务器的主机名和端口 // `auth`表示HTTP Basic auth应该用于连接到代理，并提供credentials。 // 这将设置一个`Proxy-Authorization` header，覆盖任何使用`headers`设置的现有的`Proxy-Authorization` 自定义 headers。 proxy: { host: '127.0.0.1',port: 9000,auth: : { username: 'mikeymike',password: 'rapunz3l' } },// “cancelToken”指定可用于取消请求的取消令牌 // (see Cancellation section below for details) cancelToken: new CancelToken(function (cancel) { }) }

使用 then 时，您将收到如下响应：

rush:js;"> 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); });

配置默认值

您可以指定将应用于每个请求的配置默认值。

全局axios默认值

rush:js;"> 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';

自定义实例默认值

rush:js;"> //在创建实例时设置配置默认值 var instance = axios.create（{ baseURL：'https://api.example.com' }）;

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

配置优先级顺序

配置将与优先顺序合并。 顺序是lib / defaults.js中的库默认值，然后是实例的defaults属性，最后是请求的config参数。 后者将优先于前者。 这里有一个例子。

rush:js;"> //使用库提供的配置默认值创建实例 //此时，超时配置值为`0`，这是库的默认值 var instance = axios.create（）;

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

//覆盖此请求的超时，因为它知道需要很长时间
instance.get（'/ longRequest'，{
timeout：5000
}）;

拦截器

你可以截取请求或响应在被 then 或者 catch 处理之前

rush:js;"> //添加请求拦截器 axios.interceptors.request.use（function（config）{ //在发送请求之前做某事 return config; }，function（error）{ //请求错误时做些事 return Promise.reject（error）; }）;

//添加响应拦截器
axios.interceptors.response.use（function（response）{
//对响应数据做些事
return response;
}，function（error）{
//请求错误时做些事
return Promise.reject（error）;
}）;

如果你以后可能需要删除拦截器。

rush:js;"> var myInterceptor = axios.interceptors.request.use(function () {/*...*/}); axios.interceptors.request.eject(myInterceptor); 你可以将拦截器添加到axios的自定义实例。

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

处理错误

rush:js;"> 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 { //在设置触发错误的请求时发生了错误 console.log（'Error'，error.message）; }} console.log（error.config）; }）;

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

rush:js;"> axios.get（'/ user / 12345'，{ validateStatus：function（status）{ return status < 500; //仅当状态代码大于或等于500时拒绝 }} }）

消除

您可以使用取消令牌取消请求。

axios cancel token API基于可取消的promise提议，目前处于阶段1。

您可以使用CancelToken.source工厂创建一个取消令牌，如下所示：

rush:js;"> 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 { // 处理错误 } }); //取消请求（消息参数是可选的） source.cancel（'操作被用户取消。'）;

您还可以通过将执行器函数传递给CancelToken构造函数来创建取消令牌：

rush:js;"> var CancelToken = axios.CancelToken; var cancel;

axios.get（'/ user / 12345'，{
cancelToken：new CancelToken（function executor（c）{
//一个执行器函数接收一个取消函数作为参数
cancel = c;
}）
}）;

// 取消请求
clear();

注意：您可以使用相同的取消令牌取消几个请求。

使用application / x-www-form-urlencoded格式

默认情况下，axios将JavaScript对象序列化为JSON。 要以应用程序/ x-www-form-urlencoded格式发送数据，您可以使用以下选项之一。

浏览器

在浏览器中，您可以使用URLSearchParams API，如下所示：

rush:js;"> var params = new URLSearchParams(); params.append('param1','value1'); params.append('param2','value2'); axios.post('/foo',params);

请注意，所有浏览器都不支持URLSearchParams，但是有一个polyfill可用（确保polyfill全局环境）。

或者，您可以使用qs库对数据进行编码：

rush:js;"> var qs = require('qs'); axios.post('/foo',qs.stringify({ 'bar': 123 });

Node.js

在node.js中，可以使用querystring模块，如下所示：

rush:js;"> var querystring = require('querystring'); axios.post('http://something.com/',querystring.stringify({ foo: 'bar' });

你也可以使用qs库。

Promise

axios 依赖本机要支持ES6 Promise实现。 如果您的环境不支持ES6 Promises，您可以使用polyfill。

TypeScript

axios包括TypeScript定义。

rush:js;"> import axios from 'axios'; axios.get('/user?ID=12345');

axios在很大程度上受到Angular提供的$http服务的启发。 最终，axios努力提供一个在Angular外使用的独立的$http-like服务。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作能带来一定的帮助，如果有疑问大家可以留言交流，谢谢大家对编程之家的支持。

原文地址：https://www.jb51.cc/js/40434.html