axios 全攻略

已于 2023-09-19 11:19:18 修改
阅读量154 收藏
点赞数
分类专栏： 前端学习札记 文章标签： javascript vue.js node.js es6
于 2020-05-11 14:09:56 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiubinxu/article/details/106049919
版权

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

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

axios 简介

axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端，它本身具有以下特征：
1.从浏览器中创建 XMLHttpRequest
2.从 node.js 发出 http 请求
3.支持 Promise API
4.拦截请求和响应
5.转换请求和响应数据
6.取消请求
7.自动转换JSON数据
8.客户端支持防止 CSRF/XSRF

浏览器兼容性

在这里插入图片描述

引入方式：

$ npm install axios$ cnpm install axios //taobao源$ bower install axios
或者使用cdn：
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

举个栗子：

执行 GET 请求

// 向具有指定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 请求

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

执行多个并发请求

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)

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

axios(url[, config])

// 发送一个 GET 请求 (GET请求是默认请求模式)
axios('/user/12345');

请求方法别名

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

  1. axios.request（config）
  2. axios.get（url [，config]）
  3. axios.delete（url [，config]）
  4. axios.head（url [，config]）
  5. axios.post（url [，data [，config]]）
  6. axios.put（url [，data [，config]]）
  7. axios.patch（url [，data [，config]]）
注意

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

并发

帮助函数处理并发请求。

  1. axios.all（iterable）
  2. axios.spread（callback）

创建实例

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

axios.create（[config]）

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

实例方法

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

  1. axios＃request（config）
  2. axios＃get（url [，config]）
  3. axios＃delete（url [，config]）
  4. axios＃head（url [，config]）
  5. axios＃post（url [，data [，config]]）
  6. axios＃put（url [，data [，config]]）
  7. axios＃patch（url [，data [，config]]）

请求配置

这些是用于发出请求的可用配置选项。 只有url是必需的。 如果未指定方法，请求将默认为GET。

{  
   // `url`是将用于请求的服务器URL  
   url: '/user',  
   // `method`是发出请求时使用的请求方法  
   method: 'get', // 默认  
   // `baseURL`将被添加到`url`前面，除非`url`是绝对的。  
   // 可以方便地为 axios 的实例设置`baseURL`，以便将相对 URL 传递给该实例的方法。  
   baseURL: 'https://some-domain.com/api/',  
   // `transformRequest`允许在请求数据发送到服务器之前对其进行更改  
   // 这只适用于请求方法'PUT'，'POST'和'PATCH'  
   // 数组中的最后一个函数必须返回一个字符串，一个 ArrayBuffer或一个 Stream  
   transformRequest: [function (data) {    
       // 做任何你想要的数据转换
       return data;  
   }],  
   // `transformResponse`允许在 then / catch之前对响应数据进行更改  
   transformResponse: [function (data) {    
       // Do whatever you want to transform the data    
       return data;  
   }],  
   // `headers`是要发送的自定义 headers  
   headers: {'X-Requested-With': 'XMLHttpRequest'},  
   // `params`是要与请求一起发送的URL参数  
   // 必须是纯对象或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  
   // - Browser only: FormData, File, Blob  
   // - Node only: Stream  
   data: {    firstName: 'Fred'  },  
   // `timeout`指定请求超时之前的毫秒数。  
   // 如果请求的时间超过'timeout'，请求将被中止。  
   timeout: 1000,  
   // `withCredentials`指示是否跨站点访问控制请求  
   // should be made using credentials  
   withCredentials: false, // default  
   // `adapter'允许自定义处理请求，这使得测试更容易。  
   // 返回一个promise并提供一个有效的响应（参见[response docs]（＃response-api））  
   adapter: function (config) {    
       /* ... */  
   },  
   // `auth'表示应该使用 HTTP 基本认证，并提供凭据。  
   // 这将设置一个`Authorization'头，覆盖任何现有的`Authorization'自定义头，使用`headers`设置。  
   auth: {
       username: 'janedoe', 
       password: 's00pers3cret'
   },  
   // “responseType”表示服务器将响应的数据类型  
   // 包括 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'  
   responseType: 'json', // default  
   //`xsrfCookieName`是要用作 xsrf 令牌的值的cookie的名称  
   xsrfCookieName: 'XSRF-TOKEN', // default  
   // `xsrfHeaderName`是携带xsrf令牌值的http头的名称  
   xsrfHeaderName: 'X-XSRF-TOKEN', // default  
   // `onUploadProgress`允许处理上传的进度事件  
   onUploadProgress: function (progressEvent) {    
       // 使用本地 progress 事件做任何你想要做的  
   },  
   // `onDownloadProgress`允许处理下载的进度事件  
   onDownloadProgress: function (progressEvent) {
       // Do whatever you want with the native progress event  
   },  
   // `maxContentLength`定义允许的http响应内容的最大大小  
   maxContentLength: 2000,  
   // `validateStatus`定义是否解析或拒绝给定的promise  
   // HTTP响应状态码。如果`validateStatus`返回`true`（或被设置为`null` promise将被解析;否则，promise将被拒绝。  
   validateStatus: function (status) {    
       return status >= 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”指定可用于取消请求的取消令牌  
   cancelToken: new CancelToken(function (cancel) {

   })
}

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

配置默认值

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

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

环境的切换

我们的项目环境可能有开发环境、测试环境和生产环境。我们通过node的环境变量来匹配我们的默认的接口url前缀。axios.defaults.baseURL可以设置axios的默认请求地址就不多说了。

// 环境的切换
if (process.env.NODE_ENV == 'development') {    
    axios.defaults.baseURL = 'https://www.baidu.com';} 
else if (process.env.NODE_ENV == 'debug') {    
    axios.defaults.baseURL = 'https://www.ceshi.com';
} 
else if (process.env.NODE_ENV == 'production') {    
    axios.defaults.baseURL = 'https://www.production.com';
}

拦截器

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

// 添加请求拦截器
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)
})

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

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

你可以将拦截器添加到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 {
        // 在设置触发错误的请求时发生了错误
        console.log('Error', error.message)
        console.log(error.config)
    }
})

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

axios.get('/ user / 12345', {
    validateStatus: function(status) {
        return status < 500
        // 仅当状态代码大于或等于500时拒绝
    }
})

消除

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

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

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

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构造函数来创建取消令牌：

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，如下所示：

var params = new URLSearchParams()
params.append('param1', 'value1')
params.append('param2', 'value2')
axios.post('/foo', params)

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

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

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

Node.js

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

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

你也可以使用qs库。

Promise

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

TypeScript

axios包括TypeScript定义。

import axios from 'axios';axios.get('/user?ID=12345');

axios在很大程度上受到Angular提供的 h t t p 服务的启发。最终， a x i o s 努力提供一个在 A n g u l a r 外使用的独立的 http服务的启发。 最终，axios努力提供一个在Angular外使用的独立的 http服务的启发。最终，axios努力提供一个在Angular外使用的独立的http-like服务。

xuxb000
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
vue axios全攻略
代码青春
11-01 266
http://www.cnblogs.com/libin-1/p/6607945.html
vue axios整合使用全攻略
08-27
vue axios 整合使用全攻略 以下是 vue axios 整合使用全攻略的知识点总结： 一、axios 配置 在使用 axios 之前，我们需要先安装 axios，然后配置 axios。在本篇文章中，我们将axios 配置写在了 src/axios/index....
详解axios 全攻略之基本介绍与使用（GET 与 POST）
08-29
Axios 基本介绍与使用（GET 与 POST） Axios 是一个基于 Promise 的 HTTP 客户端，专门为浏览器和 node.js 服务，Vue 2.0 官方推荐使用 axios 来代替原来的 Vue request。下面是 Axios 的基本介绍和使用方法： ...
axios学习教程全攻略
12-12
本来想在网上找找详细攻略，突然发现，axios 的官方文档本身就非常详细！！有这个还要什么自行车！！所以推荐大家学习这种库，最好详细阅读其官方文档。大概翻译了一下 axios 的官方文档，相信大家只要吃透本文再...
axios的使用
热门推荐
吴小迪的博客
06-10 4万+
首先要在项目目录下使用如下命令下载axios $npm i axios -S 而后在src目录下创建requests文件夹，里面用来存放你整个项目的ajax请求。 此文件夹中首先创建一个index.js文件 编写里面的内容： //引入axios import axios from 'axios'; //创建一个变量看当前环境是否是开发环境 const isDev = process.env.N...
axios 中文文档
09-16
Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。 Features 从浏览器中创建 XMLHttpRequests 从 node.js 创建 http 请求 支持 Promise API 拦截请求和响应 转换请求数据和响应数据 取消请求 自动转换 JSON 数据 客户端支持防御 XSRF
axios 全攻略之基本介绍与使用（GET 与 POST）
{{ Coding enjoy }}
08-28 2万+
axios axios 是一个基于 Promise 的 HTTP 客户端，专门为浏览器和 node.js 服务 Vue 2.0 官方推荐使用 axios 来代替原来的 Vue request，所以这里介绍一下 axios 的功能和基本的使用方法，希望能够对各位所有帮助。^_^功能
服务器网络请求返回状态码集合
qq_41241504的博客
11-25 536
在开发过程中报错是最令人头疼的，接下来我们就来谈谈那些状态码都是什么 200: '服务器成功返回请求的数据。', 201: '新建或修改数据成功。', 202: '一个请求已经进入后台排队（异步任务）。', 204: '删除数据成功。', 400: '发出的请求有错误，服务器没有进行新建或修改数据的操作。', 401: '用户没有权限（令牌、用户名、密码错误）。', ...
axios全攻略
小小马的博客
08-11 2895
axios全攻略 2017-05-02 12:03 1192人阅读 评论(0) 收藏 举报
axios请求封装与开发环境proxyTable代理
qq_44706779的博客
12-13 1483
axios请求封装与开发环境proxyTable代理详解一、axios请求封装1. axios安装与使用1.1 安装1.2 引入1.3 环境切换1.4 设置请求超时1.5 请求头设置1.6 请求拦截二、开发环境proxyTable代理详解二级目录三级目录 一、axios请求封装 1. axios安装与使用 1.1 安装 npm install axios; // 安装axios 1.2 引入 在项目中axios的封装一般都放在src目录下的utils文件夹中，因此我们在此处新建一个r
axios的使用详解
酒客的博客
03-11 1万+
axios的基本使用 axios是什么 ​ 前端最流行的ajax请求库，react/vue官方都推荐使用axios发送ajax请求，是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。文档:https://hithub.com/axios/axios ​ 细节：axios包括TypeScript定义。 特性 从浏览器中创建 XMLHttpRequests 从 node.js 创建 http 请求 支持 Promise API 拦截请求和响应拦截 转换请求数据和响应数据 取消
vue2.0之axios使用详解
x3002525的博客
08-18 7669
[javascript] view plain copy 方法一:直接在.vue文件中引入使用      在.vue文件中使用        import axios from 'axios';     export default {       name: 'news',       data () {         return {     
【vueUse库Component模块各函数简介及使用方法--上篇】
xiejunlan的博客
07-02 1326
vueUseComponent函数理解 `computedInject` 的概念模拟 `computedInject`使用场景总结构想`createReusableTemplate`的用途可能的实现方式方法一：使用高阶组件（HOC）方法二：使用插槽（Slots）和默认插槽内容结论构想`createTemplatePromise`的用途可能的实现方式使用Vue 3的异步组件构想中的`createTemplatePromise`结论使用Vue的`ref`属性在模板中引用元素或组件示例：引用模板中的DOM元素。
Vue前端打包
最新发布
weixin_63680330的博客
07-04 226
介绍:Nginx是一款轻量级的Web服务器/反向代理服务器及电子邮件(IMAP/POP3)代理服务器。其特点是占有内存少，并发能力强，在各大型互联网公司都有非常广泛的使用。启动：双击nginx.exe 文件启动，服务器默认占用80端口。官网:https://nginx.org/打包好的dist目录赋值到html下。html静态资源文件目录。conf 配置文件目录。logs日志文件目录。temp临时文件目录。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值