axios

背景

  • 在项目开发中ajax请求是必不可缺少
  • 一部分ajax请求不需要 loading 或则请求时间少于多少是不显示 loading
  • 项目中对请求的同一化处理(错误处理,返回数据格式化处理,loading 处理,token 处理)
  • 配置基于个人 vue 项目进行配置,已加载 vux 相关组件,会进行一些依赖的 import(可以按需配置)
1
2
3
4
5
6
7
8
9
10
import Vue from 'vue'
import axios from 'axios'
//项目的一些环境配置参数,读取host
import config from '@/config'
//vuex状态管理,这里主要进行对全局loading的控制
import store from '@/store'
//vue-router对相应状态码的页面操作(router实例)
import router from '@/router'
//console对应封装
import { log } from '@/utils'

解决方案

对于 axios 的封装中我们定义几个参数进行申明

1
2
3
4
5
6
7
8
9
10
// 加载最小时间
const MINI_TIME = 300
// 超时时间(超时时间)
let TIME_OUT_MAX = 5000
// 环境value
let _env = process.env.NODE_ENV
// 请求接口host
let _apiHost = config.api
// 请求组(判断当前请求数)
let _requests = []

一般一个项目中的根 host 和 Content-Type 都是统一的,这里对 axios 进行统一的配置(如果这个后端需要 formData 格式的表单即 content-type='application/x-www-form-urlencoded;charset=utf-8' 数据,需要对请求数据进行表单序列化,比较快的方式就是引入 qsqs.stringify 进行处理后传输)

1
2
axios.defaults.headers.common['Content-Type'] = 'application/json'
axios.defaults.baseURL = _apiHost

一般情况下项目中同一时刻都会有不止一个请求在进行(还没有返回),要判断当前是否还存在进行中的 ajax,就需要对_requests 这个数组进行维护;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/**
* 添加请求,显示loading
* @param {请求配置} config
*/
function pushRequest(config) {
log(`${config.url}--begin`)
_requests.push(config)
Vue.$vux.loading.show({
text: 'Loading',
})
store.dispatch('loading')
}

/**
* 移除请求,无请求时关闭loading
* @param {请求配置} config
*/
function popRequest(config) {
log(`${config.url}--end`)
let _index = _requests.findIndex(r => {
return r === config
})
if (_index > -1) {
_requests.splice(_index, 1)
}
if (!_requests.length) {
Vue.$vux.loading.hide(0)
store.dispatch('loading', false)
}
}

接下来对 axios 基于上面的准备进行处理

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/**
* 请求地址,请求数据,是否静默,请求方法
*/
export default (url, data = {}, isSilence = false, method = 'POST') => {
let _opts = { method, url }
//通用数据的合并(token)
let _data = Object.assign({}, data, { token: store.getters.token })
const _query = {}
for (let _key in _data) {
if (_data.hasOwnProperty(_key) && _data[_key] !== '') {
_query[_key] = _data[_key]
}
}
//axios实例请求定时器ID
let _timer = null
//判断请求类型
if (method.toLocaleUpperCase() === 'POST') {
_opts.data = _query
} else {
_opts.params = _query
}
//返回一个promise
return new Promise((resolve, reject) => {
//实例化axios
const _instance = axios.create({
timeout: TIME_OUT_MAX
})
//定义请求的唯一标识
let _random = { stamp: Date.now(), url: `${_apiHost + url}` }
//判断是否静默(静默的话就不加入请求标识队列,不是则申明此请求实例的定时器)
if (!isSilence) {
_timer = setTimeout(() => {
pushRequest(_random)
}, MINI_TIME)
}
//axios实例发送当前请求
//请求完成:1、取消当前请求的定时器;2、在当前请求标识队列中移除当前标识;
3、成功的话返回统一处理后的数据,失败则对状态码进行判断
_instance(_opts)
.then(res => {
let responseData = res.data
clearTimeout(_timer)
popRequest(_random)
resolve(res.data)
})
.catch(res => {
let _response = res.response
let _message = null
clearTimeout(_timer)
popRequest(_random)
switch (_response.status) {
case 404:
_message = '404,错误请求'
break
case 401:
router.push({ path: '/login', query: { redirect: router.currentRoute.fullPath } })
_message = '未授权'
break
case 403:
_message = '禁止访问'
break
case 408:
_message = '请求超时'
break
case 500:
_message = '服务器内部错误'
break
case 501:
_message = '功能未实现'
break
case 503:
_message = '服务不可用'
break
case 504:
_message = '网关错误'
break
default:
_message = '未知错误'
}
if (!isSilence) {
Vue.$vux.toast.show({
text: _response.data && _response.data.error ? _response.data.error : _message,
type: 'warn',
width: '10em'
})
}
reject(res)
})
})
}

完整代码

坚持原创技术分享,您的支持将鼓励我继续创作!
  • 本文作者: Leo
  • 本文链接: https://xuebin.me/posts/a09486d2.html
  • 版权声明: 本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!