axios在vue.js中的应用

介绍

Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中。也是vue.js作者推荐的库

实现功能

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

浏览器支持

浏览器兼容性.png

项目中需要配置完成的功能

创建axios实例,统一配置实现如下功能

  • axios本身的配置
    • 配置URL前缀
    • 超时时间
    • 跨域cookie
    • ...
  • HTTPRequest拦截器
    • 调用加载信息
    • 请求头中加入身份验证Token
    • 针对 IE 浏览器 GET 请求缓存的处理
    • ... 其它业务代码
  • HTTPResponse拦截器
    • 隐藏加载信息
    • 针对返回值统一处理
    • ....其它业务代码

具体封装代码如下:

其中部分业务代码已经被摘除,实现思路仅供参考

import axios from 'axios'
import store from '@/store'
import { Loading, Message, MessageBox } from 'element-ui'

// 加载顶部进度条
import NProgress from 'nprogress'
NProgress.configure({ showSpinner: false })

// 关闭nprogress和loading
function closeLoading () {
  NProgress.done()
  loadingService.close()
}

// 跨域请求,允许保存cookie
axios.defaults.withCredentials = true

// 创建axios实例、配置baseURL、超时时间
const service = axios.create({
  baseURL: process.env.VUE_APP_API_BASEURL, // 从环境进程中根据运行环境获取的api的base_url
  timeout: 50000 // 请求超时时间
})

let loadingService
/**
  * request拦截器
  * 发送请求前请求头中设置cookie
  */
service.interceptors.request.use(config => {
  NProgress.start()
  loadingService = Loading.service({
    lock: true,
    text: 'Loading',
    spinner: 'el-icon-loading',
    background: 'rgba(0, 0, 0, 0.1)'
  })

  let token = store.getters.token
  if (token && token.access_token && Date.now() < token.expires_in) {
    // 让每个请求携带身份验证信息
    if (!config.headers['Authorization']) {
      config.headers['Authorization'] = `Bearer ${token.access_token}`
    }
  }

  // 判断如果是get请求增加随机数,防止IE浏览器缓存api请求
  if (config.method === 'get') {
    if (config.params && Object.keys(config.params).length > 0) {
      config.params['cache'] = new Date().getTime()
    } else {
      config = Object.assign({}, config, { params: { cache: new Date().getTime() } })
    }
  }
  return config
}, error => {
  console.error(error) 
  Promise.reject(error)
})

/**
  * respone拦截器
  * 通过response自定义code来标示请求状态,处理相应问题
  */
service.interceptors.response.use(
  response => {
    closeLoading()
    const { status }= response.data

    // 状态码:-1:未登录 /1:请求成功 /-2:请求失败 /-3:无权限 /-4:系统错误
    if (status === 1) {
      return response.data.data
    } else {
      let errorMessage = response.data.message
      switch (
        case -1:
          // 清除本地保存的Token
          // 跳转到登录页面
          break
        case -2:
          // 提示错误信息
          break
        default:
           // 提示错误信息
      }
      return Promise.reject(new Error(errorMessage))
    }
  },
  // 服务端错误
  error => {
    console.
    console.error('err' + error) // for debug
    return Promise.reject(error)
  }
)

export default service

调用过程

注意:在实例调用中传入的配置会覆盖上一步在构造函数 axios 上的配置

import request from '@/XXX/request.js'

/* 用户登录 */
export function loginByUsername (reqParams) {
  return request({
    // baseURL: '/api', 
    // headers: { },
    url: '/auth/oauth/token',
    method: 'post',
    params: reqParams
  })
}

有其他问题或更好思路,欢迎私信一起讨论。

参考文档

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

推荐阅读更多精彩内容