axios中文文档|axios中文网 | axios
一、封装全局http请求
1,封装
/**
* @Author:
* @Date: 2019/10/14
* @Description: 封装http请求
* @remarks:
*/
import axios from 'axios'
import { MessageBox, Message } from 'element-ui'
import store from '@/store'
import { getToken } from '@/utils/auth'
let lock = false // 用于防止多个异步请求弹出多次登录失效
// create an axios instance
const service = axios.create({
baseURL: process.env.VUE_APP_BASE_API, // url = base url + request url
// withCredentials: true, // send cookies when cross-domain requests
timeout: 20 * 1000 // request timeout
})
/**
* 请求拦截器
* 拦截器函数接收一个参数 config
* config 就是你当前请求的配置对象
* 当你使用 axios 发起请求的时候,那么就会先经过这个拦截器然后再发出请求
* 也就是说在请求拦截器内部的请求还没有发出去
* 我们可以在这里定制请求之前的行为
*/
service.interceptors.request.use(
config => {
// do something before request is sent
if (store.getters.token) {
// let each request carry token
// ['X-Token'] is a custom headers key
// please modify it according to the actual situation
config.headers['Authorization'] = getToken()
}
return config
},
error => {
// do something with request error
console.log(error) // for debug
return Promise.reject(error)
}
)
/**
* 响应拦截器
* 我们可以在这里对一些公共的业务进行处理
* 例如需要对每个接口进行 403 权限认证判断
* 如果本地响应的数据是 403 ,则我们提示用户:你没有权限执行该操作
*/
service.interceptors.response.use(
/**
* If you want to get http information such as headers or status
* Please return response => response
*/
/**
* Determine the request status by custom code
* Here is just an example
* You can also judge the status by HTTP Status Code
*/
response => {
const res = response.data
// if the custom code is not 20000, it is judged as an error.
if (res.code !== 0 && res.code !== 5001) {
Message({
message: res.message || 'Error',
type: 'error',
duration: 5 * 1000
})
if (!lock) {
// 29999: 非法token; 30000: Token 过期;
if (res.code === 29999) {
lock = true
// to re-login
MessageBox.confirm('您尚未登陆,请登录。', '退出登录', {
confirmButtonText: '确认',
cancelButtonText: '取消',
type: 'warning'
}).then(() => {
store.dispatch('user/resetToken').then(() => {
location.reload()
})
})
}
if (res.code === 30000) {
lock = true
// to re-login
MessageBox.confirm('登录信息已过期,请尝试重新登录。', '退出登录', {
confirmButtonText: '确认',
cancelButtonText: '取消',
type: 'warning'
}).then(() => {
store.dispatch('user/resetToken').then(() => {
location.reload()
})
})
}
}
return Promise.reject(new Error(res.message || 'Error'))
} else {
return res
}
},
error => {
if (!lock) {
// 29999: 非法token; 30000: Token 过期;
if (error.response.data.code === 29999) {
lock = true
// to re-login
MessageBox.confirm('您尚未登陆,请登录。', '退出登录', {
confirmButtonText: '确认',
cancelButtonText: '取消',
type: 'warning'
}).then(() => {
store.dispatch('user/resetToken').then(() => {
location.reload()
})
})
}
if (error.response.data.code === 30000) {
lock = true
// to re-login
MessageBox.confirm('登录信息已过期,请尝试重新登录。', '退出登录', {
confirmButtonText: '确认',
cancelButtonText: '取消',
type: 'warning'
}).then(() => {
store.dispatch('user/resetToken').then(() => {
location.reload()
})
})
}
}
return Promise.reject(error)
}
)
export default service
2,使用
import request from '@/utils/request'
export function queryStatus(data) {
return request({
url: 'api/cr/chapter/queryStatus',
method: 'post',
data,
timeout: 3000 // 局部覆盖全局 http://www.axios-js.com/zh-cn/docs/#%E9%85%8D%E7%BD%AE%E7%9A%84%E4%BC%98%E5%85%88%E9%A1%BA%E5%BA%8F
})
}
二、局部实例化和使用
使用场景:
之所以使用局部的axios实例化,是因为全局实例化 http 请求有全局的响应拦截码,当我们某些接口无法返回状态码code时,我们将无法得到response,此时我们需要在当前 api 中重新实例化一个 axios,设置新的响应拦截码或者不设置来进行你的相关业务
/**
* @Author:
* @Date: 2019/11/09
* @Description: 考试管理接口
* @remarks:
*/
import request from '@/utils/request'
import axios from 'axios'
import { MessageBox } from 'element-ui'
import store from '@/store'
import { getToken } from '@/utils/auth'
// create an axios instance
const service = axios.create({
timeout: 20 * 1000 // request timeout
})
service.interceptors.request.use(
config => {
config.headers['Authorization'] = getToken()
return config
},
error => {
console.log(error) // for debug
return Promise.reject(error)
}
)
/**
* 响应拦截器
* 我们可以在这里对一些公共的业务进行处理
* 例如需要对每个接口进行 403 权限认证判断
* 如果本地响应的数据是 403 ,则我们提示用户:你没有权限执行该操作
*/
service.interceptors.response.use(
/**
* If you want to get http information such as headers or status
* Please return response => response
*/
/**
* Determine the request status by custom code
* Here is just an example
* You can also judge the status by HTTP Status Code
*/
response => {
// const res = response.data
return response
},
error => {
// 29999: 非法token; 30000: Token 过期;
if (error.response.data.code === 29999) {
// to re-login
MessageBox.confirm('您尚未登陆,请登录。', '退出登录', {
confirmButtonText: '确认',
cancelButtonText: '取消',
type: 'warning'
}).then(() => {
store.dispatch('user/resetToken').then(() => {
location.reload()
})
})
}
if (error.response.data.code === 30000) {
// to re-login
MessageBox.confirm('登录信息已过期,请尝试重新登录。', '退出登录', {
confirmButtonText: '确认',
cancelButtonText: '取消',
type: 'warning'
}).then(() => {
store.dispatch('user/resetToken').then(() => {
location.reload()
})
})
}
return Promise.reject(error)
}
)
// 下载Excel导入模板
export function exportExcelModel(data) {
var url = process.env.VUE_APP_BASE_API + '/system/model/downloadModel?code=' + data.code
return service({
url,
method: 'get',
responseType: 'blob',
data
})
}