alovajs请求封装

510 阅读2分钟

基于vue的网络请求封装,请求适配器 axios

简单封装

import useUserStore from '@/store/modules/user'
import {createAlova} from "alova";
import VueHook from "alova/vue"
import {axiosRequestAdapter} from '@alova/adapter-axios';

let downloadLoadingInstance;

export let isRelogin = {show: false};
// 创建实例
const alovaInstance = createAlova({
    // axios中请求配置有baseURL选项,表示请求URL公共部分
    baseURL: import.meta.env.VITE_APP_BASE_API,
    // 请求超时时间,单位为毫秒,默认为0,表示永不超时
    timeout: 1000 * 60,
    cacheFor: {
        GET: 2000,
    },
    shareRequest: false,
    statesHooks: VueHook,
    requestAdapter: axiosRequestAdapter(),
    beforeRequest: method => {
        // 是否需要设置 token
        let config = method.config
        const notToken = (config.headers || {}).isToken === false
        // 是否需要防止数据重复提交
        const notRepeatSubmit = (config.headers || {}).repeatSubmit === false
        if (getToken() && !notToken) {
            config.headers['Authorization'] = 'Bearer ' + getToken() // 让每个请求携带自定义token 请根据实际情况自行修改
        }
        if (!notRepeatSubmit && (method.type === 'POST' || method.type === 'PUT')) {
            const requestObj = {
                url: method.url,
                data: typeof method.data === 'object' ? JSON.stringify(method.data) : method.data,
                time: new Date().getTime()
            }
            const requestSize = Object.keys(JSON.stringify(requestObj)).length; // 请求数据大小
            const limitSize = 5 * 1024 * 1024; // 限制存放数据5M
            if (requestSize >= limitSize) {
                console.warn(`[${method.url}]: ` + '请求数据大小超出允许的5M限制,无法进行防重复提交验证。')
                return config;
            }
            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)
                }
            }
        }
    },
    responded: async (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;
                ElMessageBox.confirm('登录状态已过期,继续留在该页面,或者重新登录', '系统提示', {
                    confirmButtonText: '重新登录',
                    cancelButtonText: '取消',
                    type: 'warning'
                }).then(() => {
                    isRelogin.show = false;
                    useUserStore().logOut()
                }).catch(() => {
                    isRelogin.show = false;
                });
            }
            return Promise.reject('无效的会话,或者会话已过期,请重新登录。')
        } else if (code === 500) {
            ElMessage({message: msg, type: 'error'})
            return Promise.reject(new Error(msg))
        } else if (code === 601) {
            ElMessage({message: msg, type: 'warning'})
            return Promise.reject(new Error(msg))
        } else if (code !== 200) {
            ElNotification.error({title: msg})
            return Promise.reject('error')
        } else {
            return Promise.resolve(res.data)
        }
    }
})

// 通用下载方法
export function download(url, params, filename, config) {
    downloadLoadingInstance = ElLoading.service({text: "正在下载数据,请稍候", background: "rgba(0, 0, 0, 0.7)",})
    return alovaInstance.Post(url, params, {
        headers: {'Content-Type': 'application/x-www-form-urlencoded'},
        responseType: 'blob',
        ...config
    }).then(async (data) => {
        const isBlob = blobValidate(data);
        if (isBlob) {
            const blob = new Blob([data])
            saveAs(blob, filename)
        } else {
            const resText = await data?.text();
            const rspObj = JSON.parse(resText);
            const errMsg = errorCode[rspObj.code] || rspObj.msg || errorCode['default']
            ElMessage.error(errMsg);
        }
        downloadLoadingInstance.close();
    }).catch((r) => {
        console.error(r)
        ElMessage.error('下载文件出现错误,请联系管理员!')
        downloadLoadingInstance.close();
    })
}

export default alovaInstance

其它功能自行查看文档添加

参考

官网