在VUE3项目中对axios请求进行二次封装

1,187 阅读2分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 10 月更文挑战」的第10天,点击查看活动详情

在vue3的项目的根目录里面创建utils文件夹,在里面创建reques.js文件

对asios进行二次封装,思路如下:

  1. 创建一个新的axios实例
  2. 请求拦截器,如果有token进行头部携带
  3. 响应拦截器:1. 剥离无效数据 2. 处理token失效
  4. 导出一个函数,调用当前的axsio实例发请求,返回值promise

1.创建axios实例

import store from '@/store'
import router from '@/router'
import axios from 'axios'

export const baseURL = 'http://pcapi-xiaotuxian-front-devtest.itheima.net/'

const instance = axios.create({
  baseURL,
  timeout: 5000
})

注意这里单独导出了baseURL,是为了让一些不通过axios发送网络请求的地方使用基地址。

2.请求拦截器

instance.interceptors.request.use(config => {
  const { profile } = store.state.user
  if (profile.token) {
    config.headers.Authorization = `Bearer ${profile.token}`
  }
  return config
}, err => {
  return Promise.reject(err)
})

在设置请求拦截器时,一般在这里设置header携带token。 所以要判断用户信息对象里面是否有token属性,有就设置token。

3.响应拦截器

响应拦截器一般处理两件事:

  • 剥离无效数据。
  • 处理token失效。
instance.interceptors.response.use(res => {
  return res.data // 这样就将无效数据剥离了
}, err => {
  // 401状态码,进入该函数
  // 判断“err.response”是否存在这一步是为了防止没有响应
  if (err.response && err.response.status === 401) {
    // 1.清空无效用户信息
    // 2.跳转到登录页码
    // 3.传递当前路由给登录页码
    store.commit('user/SETUSER', {})

    const fullPath = router.currentRoute.value.fullPath // router.currentRoute是一个ref响应式对象
    router.push('/login?redirectURL=' + encodeURIComponent(fullPath)) // 转码“...%20...”,防止解析地址出问题
  }
  return Promise.reject(err)
})

4.导出一个请求工具函数

export default (url, method = 'get', submitData) => {
  
  return instance({
    url,
    method,
    [method.toLowerCase() === 'get' ? 'params' : 'data']: submitData
  })
}

负责发请求:请求地址,请求方式,提交的数据。

整体封装代码:

// 1. 创建一个新的axios实例
// 2. 请求拦截器,如果有token进行头部携带
// 3. 响应拦截器:1. 剥离无效数据  2. 处理token失效
// 4. 导出一个函数,调用当前的axsio实例发请求,返回值promise

import store from '@/store'
import router from '@/router'
import axios from 'axios'

// 将这个基准地址导出,让一些不是通过axios发送请求的地方使用
export const baseURL = '填写基地址'

const instance = axios.create({
  baseURL,
  timeout: 5000
})

// 请求拦截器。一般在这里面设置headers里携带token
instance.interceptors.request.use(config => {
  // 1.获取用户信息对象
  const { profile } = store.state.user
  // 2.判断profile里面是否有token
  if (profile.token) {
    // 3.有就设置token
    config.headers.Authorization = `Bearer ${profile.token}`
  }
  return config
}, err => {
  return Promise.reject(err)
})

// 响应拦截器。1.剥离无效数据 2.处理token失败
instance.interceptors.response.use(res => {
  return res.data // 这样就将无效数据剥离了
}, err => {
  // 401状态码,进入该函数
  // 判断“err.response”是否存在这一步是为了防止没有响应
  if (err.response && err.response.status === 401) {
    // 1.清空无效用户信息
    // 2.跳转到登录页码
    // 3.传递当前路由给登录页码
    store.commit('user/SETUSER', {})

    // 组件里头:`/user?a=10` $route.path === /user  $route.fullPath === /user?a=10
    // js模块中:router.currentRoute.value.fullPath 就是当前路由地址,router.currentRoute 是ref响应式数据
    const fullPath = router.currentRoute.value.fullPath // router.currentRoute是一个ref响应式对象
    router.push('/login?redirectURL=' + encodeURIComponent(fullPath)) // 转码“...%20...”,防止解析地址出问题
  }
  return Promise.reject(err)
})

// 请求工具函数
export default (url, method = 'get', submitData) => {
  // 负责发请求:请求地址,请求方式,提交的数据
  return instance({
    url,
    method,
    // 1. 如果是get请求  需要使用params来传递submitData   ?a=10&c=10
    // 2. 如果不是get请求  需要使用data来传递submitData   请求体传参
    // [] 设置一个动态的key, 写js表达式,js表达式的执行结果当作KEY
    // method参数:get,Get,GET  转换成小写再来判断
    // 在对象,['params']:submitData ===== params:submitData 这样理解
    [method.toLowerCase() === 'get' ? 'params' : 'data']: submitData
  })
}