axios基本使用及封装

#axios基本使用及封装| 来源: 网络整理| 查看: 265

一起养成写作习惯！这是我参与「掘金日新计划 · 4 月更文挑战」的第1天，点击查看活动详情。

无论任何前端项目都是离不开网络请求。就前端请求而言，axios是目前流行的网络请求，也是vue官方推荐使用的ajax库。掌握它的基本使用是非常必要的，这篇文章将axios与vue项目结合做一个基本使用的总结，非常适合入门。

网络请求发展史

要学习axios首先应该了解前端ajax请求的大致发展。

1. 传统的Ajax 传统的Ajax请求是基于XMLHttpRequest（XHR）对象。可以直接使用。但是使用起来配置较为麻烦，实际开发中使用非常少，在MVC时代通常使用的是JQuery-Ajax。相对于传统的Ajax现在使用更多的是Fetch请求。

2. JQuery-Ajax JQuery-Ajax在前端JQuery时，因为JQuery的强大兼容性在项目开发中$Ajax使用非常广泛，需要引入JQuery库，其底层原理也是对传统的Ajax，XHR对象进行封装。但是在前端框架MVVC时代，例如使用vue搭建项目，如果再继续使用$Ajax就还需再单独引入JQuery重量级1w+代码量的库是得不偿失的。所以针对于框架的网络请求应运而生。

3.axios 在Vue1.0时代，官方推出了Vue-resource，其体积相对于JQuery小的多，但是在Vue2.0时代官方宣布不再更新，那么继续使用Vue-resource就会存在版本无法匹配问题。因此在Vue2.0时代开始，官方推荐使用axios作为新一代的Ajax库。axios其优点：在浏览器中发送XMLHttpRequest请求、在node中发送http请求、支持Promise API、拦截请求和相应、转换请求和响应数据等，这里不再一一描述，想进一步了解其优点，可以查询相关资料。

axios安装

先来看看axios的基本使用,本篇介绍axios的使用是与vue项目结合起来的，首先在命令行中输入npm create vue创建vue项目。其次，axios是一个第三方Ajax库，需要单独安装和引入，在命令行中输入npm install axios --save-D安装axios的依赖包。接着，在需要使用的地方引入axios对象import axios from axios，在实际开发中，通常会单独建立一个js文件引入axios引入再进行封装，下文会介绍。

axios基本使用 axios请求方式

先来看看axios具体有哪些请求方式：

axios(config) 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]]) axios(config)请求方式： axios接收一个对象，在对象中使用键值对方式写入配置信息，get请求下，默认method可以不写。 axios({ url:'http://123.207.32.32:8000/home/multidata', params:{ type:'pop', page:1 } }).then(res=>{ console.log(res); }).catch(err=>{ console.log(err); }) 复制代码

axios.request(config)请求方式：与axios(config)写法一致，都是接收一个对象，在对象中使用键值对方式配置信息。

axios.request({ url:'http://123.207.32.32:8000/home/multidata' }).then(res=>{ console.log(res); }).catch(err=>{ console.log(err); }) 复制代码

axios.get(url[, config])请求方式：限定method为get请求，网络请求中get请求是将参数拼接搭配url上发送的请求，在axios请求中则可以使用params属性配置将传递的参数拼接到url上。params属性是一个对象，其传递的参数使用键值对形式书写

axios.get('http://123.207.32.32:8000/home/multidata',{ params:{ type:'pop',page:1 } }).then(res=>{ console.log(res); }).catch(err=>{ console.log(err); }) 复制代码 axios配置

常见配置项

请求地址：url: '/user' 请求类型：method: 'get' 请根路径：baseURL: 'http://www.mt.com/api' 请求前的数据处理：transformRequest:[function(data){}] 请求后的数据处理： transformResponse: [function(data){}] 自定义的请求头：headers:{'x-Requested-With':'XMLHttpRequest'} URL查询对象：params:{ id: 12 }, 查询对象序列化函数：paramsSerializer: function(params){ } request body：data: { key: 'aa'} 超时设置：timeout: 1000, 跨域是否带Token：withCredentials: false 自定义请求处理：adapter: function(resolve, reject, config){} 身份验证信息：auth: { uname: '', pwd: '12'} 响应的数据格式json / blob /document /arraybuffer / text / stream：responseType: 'json'

全局配置

第三方框架通过import axios from axios引入axios属于全局的axios。使用default关键字可以对axios进行一个配置。那么所有的axios请求都会携带default预先定义好的默认设置。对于公共的请求配置可以抽离出来，例如：请求超时时间、服务器地址、设置请求头等

语法格式：axios实例.default.配置项

参考代码：

// axios.defaults.配置项===》axios全局配置 axios.defaults.baseURL = 'http://123.207.32.32:8000' axios.defaults.timeout = 5000 axios.defaults.headers['X-TOKEN'] = '123xxx' axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded'; axios.defaults.responseType = 'blob' axios('home/multidata', { params: { type: 'pop', page: 1 } } ).then(res => { console.log(res); }).catch(err => { console.log(err); }) 复制代码 axios并发请求

有时候存在这样一种情况：同时发送多个请求，并且等到多个请求完成响应并拿到响应内容时候才会返回。这个时候就需要使用到并发请求。axios.all()本质上就是promise.all()。 axios.all()接收一个Array数组作为参数，每个参数成员就是要发送的axios请求体，axios.all()函数返回一个promise实例，通过.then方法接收响应的数据，并且响应的数据也包裹在一个Array数组中，每个数组成员对应响应的请求结果。可以通过axios.spread()函数将返回的数组[res1,res2]展开为，res1，res2。注意，并发请求如果有一个单独的请求失败，那么axios.all()函数整个请求就会报错，通过.catch()方法拿到报错信息。

axios.all([ axios.get('http://123.207.32.32:8000/home/multidata', { params: { type: 'pop', page: 1 } }), axios({ url: 'http://123.207.32.32:8000/home/multidata', params: { type: 'pop', page: 1 } }) ]).then(res => { console.log(res) // 返回的是数组包裹的响应信息[res1,res2] }).catch(err=>{ console.log(err) }) 复制代码 axios.all([ axios.get('http://123.207.32.32:8000/home/multidata', { params: { type: 'pop', page: 1 } }), axios({ url: 'http://123.207.32.32:8000/home/multidata', params: { type: 'pop', page: 1 } }) ]).then(axios.spread((res1,res2) => { // 使用axios。spread展开数组 console.log(res1) console.log(res2) })).catch(err=>{ console.log(err) }) 复制代码创建axios实例

思考一下，我们通过import axios from 'axios'引入了全局的axios对象，为什么还要再单独创建axios实例呢？

在实际项目开发中，我们存在不同的请求默认配置可能不一样，例如，服务器地址、请求超时...默认配置不同，那么全局引进的axios再使用axios.default.配置项设置全局的默认统一的配置无法解决这个问题。因此，我们使用axios.create()函数创建新的axios实例，不同的axios实例可以设置不同的默认配置，各个axios实例之间的配置是互不影响的。 axios.create()接收一个对象参数，使用键值对传入默认的配置，返回axios实例。

import axios from 'axios' // axios实例1 const axiosInstance1 = axios.create({ baseURL:'http://123.207.32.32:8000', timeout:5000 }) axiosInstance1({ url:'/home/multidata', params:{ type:'pop', page:3 } }).then(res=>{ console.log(res) }).catch(err=>{ console.log(err) }) // axios实例2 const axiosInstance2 = axios.create({ baseURL:'http://192.168.5.110:9001', timeout:5000 }) axiosInstance1({ url:'/home/multidata'', params:{ type:'pop', page:3 } }) .then(res=>{ console.log(res) }).catch(err=>{ console.log(err) }) 复制代码

也可以对新创建的axios实例使用.default方法配置

import axios from 'axios' // axios实例1 const axiosInstance1 = axios.create() axiosInstance1.default.baseURL = 'http://123.207.32.32:8000' axiosInstance1.default.timeout = 5000 axiosInstance1({ url:'/home/multidata', params:{ type:'pop', page:3 } }).then(res=>{ console.log(res) }).catch(err=>{ console.log(err) }) 复制代码 axios拦截器

拦截器顾名思义即为拦截，对所有的请求和响应进行拦截。

方法： axios.interceptor.request.use()请求拦截器 axios.interceptor.response.use()响应拦截器

两个拦截器使用方法一致，都接收两个参数：

参数1：拦截成功回调函数参数2：拦截失败回调函数。注意，无论请求还是响应拦截，拦截完了要return 返回拦截的请求体和响应体，不然就不会执行后边的请求和响应结果操作了。

可参axios照源码如下：

export interface AxiosInterceptorManager { use(onFulfilled?: (value: V) => T | Promise, onRejected?: (error: any) => any): number; eject(id: number): void; } 复制代码

请求拦截器使用场景:

发送请求时添加‘正在加载中...’图标某些请求必须用户登陆，判断是否有用户token，没有跳转到登陆页对请求的参数进行序列化 axios.interceptor.request.use(res=>{ console.log('来到了request拦截的success中'); // 拦截完了要返回 return res },err=>{ console.log('来到了request拦截的failure中'); }) 复制代码

响应拦截器使用场景：

返回响应的res.data数据结果根据响应的status状态码，做出不同的操作。例如：如果status是401，响应拦截失败，那么通常是token失效，没有授权，要跳转至登陆页；status是200，响应拦截成功操作，返回res.data响应数据 axios.interceptor.response.use(res=>{ console.log('来到了response拦截的success中'); // 拦截完了要返回 return res.data },err=>{ console.log('来到了response拦截的failure中'); }) 复制代码 axios封装

在项目中，我们通常会对请求进行二次封装，在项目中src/utils文件下新建request.js文件存放封装的请求，导入第三方请求库。那么为什么会二次封装请求呢？因为例如axios请求属于第三方库，如果后期作者不再维护axios库的时候，我们只需要修改request.js文件依赖的第三方框架部分，这样不会影响项目中其他需要发送请求的代码。

import axios from 'axios' import { useMsgbox, Message } from 'element3' import store from '@/store' import { getToken } from '@/utils/auth' const service = axios.create({ baseURL: process.env.VUE_APP_BASE_API, // url = base url + request url timeout: 5000, // request timeout }) service.interceptors.request.use( config => { if (store.getters.token) { config.headers['X-Token'] = getToken() } return config }, error => { console.log(error) // for debug return Promise.reject(error) }, ) service.interceptors.response.use( response => { const res = response.data if (res.code !== 20000) { console.log('接口信息报错',res.message) return Promise.reject(new Error(res.message || 'Error')) } else { return res } }, error => { console.log('接口信息报错' + error) return Promise.reject(error) }, ) export default service 复制代码

【本文地址】

公司简介

联系我们