《若依ruoyi》第四章:Ruoyi前端和后端数据通讯-Axios详解

随着 vuejs 作者尤雨溪发布消息，不再继续维护vue-resource，并推荐大家使用 axios 开始，axios 被越来越多的人所了解。axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端，它本身具有以下特征：

1、从浏览器中创建 XMLHttpRequest

2、从 node.js 发出 http 请求

3、支持 Promise API

4、拦截请求和响应

5、转换请求和响应数据

6、取消请求

7、自动转换JSON数据

一、若依vue-前端和后端交互的库使用Axios
Axios 是一个基于 Promise 的 HTTP 库

若依vue的封装等代码路径是

/src/utils/request.js

二、request.js代码解析

1.包引入说明

axios：引入axios组件，实现HTTP库，前端和后端使用http+json的方式做数据传输

import axios from 'axios'
import { Notification, MessageBox, Message, Loading } from 'element-ui' //引入element-ui框架的组件，例如Loading组件，在网络请求中，界面显示加载的图标
import store from '@/store' //引入本地存储封装，可以将返回的数据存储到本地
import { getToken } from '@/utils/auth' //权限认证，登陆成功后，将token存储到本地，
import errorCode from '@/utils/errorCode' //错误编码封装
import { tansParams, blobValidate } from "@/utils/ruoyi"; //工具类，参数验证封装
import cache from '@/plugins/cache' //缓存组件
import { saveAs } from 'file-saver' //文件保存

2.创建实例

后端服务url地址配置在测试环境：.env.development，生产环境.env.production

axios创建实列需要传入后端服务接口的url和超时时间，初始化成功后，可以使用service变量进行数据发送

const service = axios.create({
// axios中请求配置有baseURL选项，表示请求URL公共部分
baseURL: process.env.VUE_APP_BASE_API,
// 超时
timeout: 10000
})

3.请求和响应拦截

请求拦截是指在发送前，需要将公共的参数进行设置，例如token的设置，防止多次重发，请求头的编码等

如下是请求拦截的代码片段

// request拦截器
service.interceptors.request.use(config => {
// 是否需要设置 token
const isToken = (config.headers || {}).isToken === false
// 是否需要防止数据重复提交
const isRepeatSubmit = (config.headers || {}).repeatSubmit === false
if (getToken() && !isToken) {
config.headers['Authorization'] = 'Bearer ' + getToken() // 让每个请求携带自定义token 请根据实际情况自行修改
}
// get请求映射params参数
if (config.method === 'get' && config.params) {
let url = config.url + '?' + tansParams(config.params);
url = url.slice(0, -1);
config.params = {};
config.url = url;
}
if (!isRepeatSubmit && (config.method === 'post' || config.method === 'put')) {
const requestObj = {
url: config.url,
data: typeof config.data === 'object' ? JSON.stringify(config.data) : config.data,
time: new Date().getTime()
}
const sessionObj = cache.session.getJSON('sessionObj')
if (sessionObj === undefined || sessionObj === null || sessionObj === '') {
cache.session.setJSON('sessionObj', requestObj)
} else {
const s_url = sessionObj.url; // 请求地址
const s_data = sessionObj.data; // 请求数据
const s_time = sessionObj.time; // 请求时间
const interval = 1000; // 间隔时间(ms)，小于此时间视为重复提交
if (s_data === requestObj.data && requestObj.time - s_time < interval && s_url === requestObj.url) {
const message = '数据正在处理，请勿重复提交';
console.warn(`[${s_url}]: ` + message)
return Promise.reject(new Error(message))
} else {
cache.session.setJSON('sessionObj', requestObj)
}
}
}
return config
}, error => {
console.log(error)
Promise.reject(error)
})

响应拦截是指服务端返回数据后，根据http的响应码进行判断处理，http响应码包含200（成功），401，500，601等，根据每个编码进行特殊处理

Notification是element-ui的组件，在管理界面上面弹出提示信息

// 响应拦截器
service.interceptors.response.use(res => {
// 未设置状态码则默认成功状态
const code = res.data.code || 200;
// 获取错误信息
const msg = errorCode[code] || res.data.msg || errorCode['default']
// 二进制数据则直接返回
if (res.request.responseType === 'blob' || res.request.responseType === 'arraybuffer') {
return res.data
}
if (code === 401) {
if (!isRelogin.show) {
isRelogin.show = true;
MessageBox.confirm('登录状态已过期，您可以继续留在该页面，或者重新登录', '系统提示', { confirmButtonText: '重新登录', cancelButtonText: '取消', type: 'warning' }).then(() => {
isRelogin.show = false;
store.dispatch('LogOut').then(() => {
location.href = '/index';
})
}).catch(() => {
isRelogin.show = false;
});
}
return Promise.reject('无效的会话，或者会话已过期，请重新登录。')
} else if (code === 500) {
Message({ message: msg, type: 'error' })
return Promise.reject(new Error(msg))
} else if (code === 601) {
Message({ message: msg, type: 'warning' })
return Promise.reject('error')
} else if (code !== 200) {
Notification.error({ title: msg })
return Promise.reject('error')
} else {
return res.data
}
},
error => {
console.log('err' + error)
let { message } = error;
if (message == "Network Error") {
message = "后端接口连接异常";
} else if (message.includes("timeout")) {
message = "系统接口请求超时";
} else if (message.includes("Request failed with status code")) {
message = "系统接口" + message.substr(message.length - 3) + "异常";
}
Message({ message: message, type: 'error', duration: 5 * 1000 })
return Promise.reject(error)
}
)

二、request.js对外提供服务

在vue开发的过程中，常用到暴露和引入，常见的暴露与引入方式是通过export暴露通过import引入。

将service暴露给其他js文件调用，需要在文件底部增加如下操作

export default service

已在知识星球更新源码解析如下：