03 在Vue项目中管理Axios请求和API接口

目的

尝试封装Axios,并集中管理接口。目的是进一步提高项目的可维护性。

思路

  1. 确保项目中已经安装了Axios
  2. 在request.js文件中导入Axios,封装后导出给api.js;
  3. 在api.js文件中导入request.js中封装好的请求,定制接口,随后导出;
  4. 在页面中使用api.js暴露出的接口。

有思路了可以首先改造项目目录,在/src文件夹新建request文件夹,同时在此创建两个文件,分别是:

  • request.js (用来管理Axios请求)
  • api.js (用来管理API接口)


    项目目录.png

封装Axios请求

在request.js文件中导入axios
导入qs,暂时只知道这个是用来序列化字符串的库
有需要的话,导入轻提示UI组件 toast
导入vuex store因为拦截请求前,要验证里面的状态对象
导入路由,用于解决跳转

import axios from 'axios'
import QS from 'qs'
import { Toast } from 'vant'
import store from '@/store'
import router from '@/router'

环境配置

// 分别配置开发、调试、发布时请求的根地址
if (process.env.NODE_ENV === 'development') {
  axios.defaults.baseURL = ''
} else if (process.env.NODE_ENV === 'debug') {
  axios.defaults.baseURL = ''
} else if (process.env.NODE_ENV === 'production') {
  axios.defaults.baseURL = ''
}

请求的基本配置

// 设置链接超时时长
axios.defaults.timeout = 1000 * 5
// 设置post请求头
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8'

请求的拦截

axios.interceptors.request.use(
  config => {
    // 请求前判断token是否存在,如果存在,再请求的header都加上token
    const token = store.state.token
    token && (config.headers.Authorization = token)
    return config
  },
  error => {
    return Promise.error(error)
  }
)

返回的拦截

axios.interceptors.response.use(
  response => {
    // 如果状态200,请求成功,否则抛出错误
    if (response.status === 200) {
      return Promise.resolve(response)
    } else {
      return Promise.reject(response)
    }
  },
  // 根据后台错误状态码进行操作
  // 以下是常规操作,其他需求自行拓展
  error => {
    if (error.response.status) {
      switch (error.response.status) {
        // 401 未登录
        case 401:
          // 跳转到登陆页面,并携带当前页面路径
          router.replace({
            path: '/login',
            query: {
              redirect: router.currentRoute.fullPath
            }
          })
          break
        // 403 token过期
        case 403:
          // 做出提示
          Toast({
            message: '403登陆信息异常,请重新登陆'
          })
          // 清除本地token
          localStorage.removeItem('token')
          // 清除vuex中的token对象
          store.commit('loginSucsess', null)
          // 1秒后,跳转到登陆页面,并携带当前页面路径
          setTimeout(() => {
            router.replace({
              path: '/login',
              query: {
                redirect: router.currentRoute.fullPath
              }
            })
          }, 1000)
          break
        // 404请求不存在
        case 404:
          Toast({
            message: '404请求不存在'
          })
          break
        default:
          // 提示信息
          Toast({
            message: error.response.data.message
          })
      }
      return Promise.reject(error.response)
    }
  }
)

封装并导出get方法

export function get (url, params) {
  return new Promise((resolve, reject) => {
    axios.get(url, {
      params: params
    })
      .then(res => {
        resolve(res.data)
      })
      .catch(err => {
        reject(err.data)
      })
  })
}

封装并导出post方法
这里有个问题要注意,axios.get()方法和axios.post()在提交数据时参数的书写方式还是有区别的。get的第二个参数是一个对象,这个对象的params属性值是参数对象。而post的第二个参数直接就是一个参数对象。

export function post (url, params) {
  return new Promise((resolve, reject) => {
    axios.post(url, params)
      .then(res => {
        resolve(res.data)
      })
      .catch(err => {
        reject(err.data)
      })
  })
}

API统一管理

在api.js文件中,导入request.js中封装好的get方法

import { get } from './request.js'

把接口暴露出去

// 如果有必要,把跟地址单独处理
const baseUrl = 'https://your_api_base_url.com'
// 定义接口,然后暴露出去
export const apiName = (params) => get(baseUrl + '/your_api_adress', params)

在需要使用接口的地方

// 导入接口
import { apiName } from '@/request/api.js'
// 使用接口
apiName(params)
    .then(res => {
       // 成功后的操作
    })
    .catch(res => {
       // 失败后的操作
    })
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容

  • axios非常方便,但是如果在每个组件中走一遍axios流程,最终又会写出“意大利面条”式的代码。况且很多时候在前...
    Angeladaddy阅读 31,389评论 3 66
  • axios是一个promise实现的http库,符合最新的ES规范。我们为啥要用这个东西呢,主要有以下几个原因: ...
    我是你班主任阅读 24,413评论 28 44
  • 人生来就有自己的看法。幼儿有对母乳的看法,儿童有对游戏的看法,青年有对女性的看法,中年也有对事业的看法。看法有...
    透明墙纸阅读 128评论 0 1
  • 子曰:“富与贵,是人之所欲也;不以其道得之,不处也。贫与贱,是人之所恶也;不以其道得之,不去也。君子去仁,恶乎成名...
    玄奇阅读 185评论 0 0