naive-ui-admin/src/utils/http/axios/index.ts

// axios配置  可自行根据项目进行更改，只需更改该文件即可，其他文件可以不动

import { VAxios } from './Axios'
import { AxiosTransform } from './axiosTransform'
import axios, { AxiosResponse } from 'axios'
import { checkStatus } from './checkStatus'
import { joinTimestamp, formatRequestDate } from './helper'
import { RequestEnum, ResultEnum, ContentTypeEnum } from '@/enums/httpEnum'

import { useGlobSetting } from '@/hooks/setting'

import { isString } from '@/utils/is/'
import { setObjToUrlParams } from '@/utils/urlUtils'

import { RequestOptions, Result } from './types'

import { useUserStoreWidthOut } from '@/store/modules/user'

const globSetting = useGlobSetting()
const urlPrefix = globSetting.urlPrefix || '';
// @ts-ignore
const { $message: Message, $dialog: Modal } = window

import router from '@/router'
import { storage } from '@/utils/Storage'

/**
 * @description: 数据处理，方便区分多种处理方式
 */
const transform: AxiosTransform = {
    /**
     * @description: 处理请求数据
     */
    transformRequestData: (res: AxiosResponse<Result>, options: RequestOptions) => {
        const {
            isTransformRequestResult,
            isShowMessage = true,
            isShowErrorMessage,
            isShowSuccessMessage,
            successMessageText,
            errorMessageText
        } = options

        const reject = Promise.reject

        const { data } = res
        //  这里 code，result，message为 后台统一的字段，需要在 types.ts内修改为项目自己的接口返回格式
        const { code, result, message } = data
        // 请求成功
        const hasSuccess = data && Reflect.has(data, 'code') && code === ResultEnum.SUCCESS
        // 是否显示提示信息
        if (isShowMessage) {
            if (hasSuccess && (successMessageText || isShowSuccessMessage)) {
                // 是否显示自定义信息提示
                Message.success(successMessageText || message || '操作成功！')
            } else if (!hasSuccess && (errorMessageText || isShowErrorMessage)) {
                // 是否显示自定义信息提示
                Message.error(message || errorMessageText || '操作失败！')
            } else if (!hasSuccess && options.errorMessageMode === 'modal') {
                // errorMessageMode=‘custom-modal’的时候会显示modal错误弹窗，而不是消息提示，用于一些比较重要的错误
                Modal.confirm({ title: '错误提示', content: message })
            }
        }
        // 不进行任何处理，直接返回
        // 用于页面代码可能需要直接获取code，data，message这些信息时开启
        if (!isTransformRequestResult) {
            return res.data
        }

        if (!data) {
            // return '[HTTP] Request has no return value';
            return reject(data)
        }

        // 接口请求成功，直接返回结果
        if (code === ResultEnum.SUCCESS) {
            return result
        }
        // 接口请求错误，统一提示错误信息
        if (code === ResultEnum.ERROR) {
            if (message) {
                Message.error(data.message)
                Promise.reject(new Error(message))
            } else {
                const msg = '操作失败,系统异常!'
                Message.error(msg)
                Promise.reject(new Error(msg))
            }
            return reject()
        }

        // 登录超时
        if (code === ResultEnum.TIMEOUT) {
            if (router.currentRoute.value.name == 'login') return
            // 到登录页
            const timeoutMsg = '登录超时,请重新登录!'
            Modal.destroyAll()
            Modal.warning({
                title: '提示',
                content: '登录身份已失效,请重新登录!',
                onOk: () => {
                    router.replace({
                        name: 'login',
                        query: {
                            redirect: router.currentRoute.value.fullPath
                        }
                    })
                    storage.clear()
                }
            })
            return reject(new Error(timeoutMsg))
        }

        // 这里逻辑可以根据项目进行修改
        if (!hasSuccess) {
            return reject(new Error(message))
        }

        return data
    },

    // 请求之前处理config
    beforeRequestHook: (config, options) => {
        const { apiUrl, joinPrefix, joinParamsToUrl, formatDate, joinTime = true } = options;

        if (joinPrefix) {
            config.url = `${ urlPrefix }${ config.url }`;
        }

        if (apiUrl && isString(apiUrl)) {
            config.url = `${ apiUrl }${ config.url }`;
        }
        const params = config.params || {};
        if (config.method?.toUpperCase() === RequestEnum.GET) {
            if (!isString(params)) {
                // 给 get 请求加上时间戳参数，避免从缓存中拿数据。
                config.params = Object.assign(params || {}, joinTimestamp(joinTime, false));
            } else {
                // 兼容restful风格
                config.url = config.url + params + `${ joinTimestamp(joinTime, true) }`;
                config.params = undefined;
            }
        } else {
            if (!isString(params)) {
                formatDate && formatRequestDate(params);
                config.data = params;
                config.params = undefined;
                if (joinParamsToUrl) {
                    config.url = setObjToUrlParams(config.url as string, config.data);
                }
            } else {
                // 兼容restful风格
                config.url = config.url + params;
                config.params = undefined;
            }
        }
        return config;
    },

    /**
     * @description: 请求拦截器处理
     */
    requestInterceptors: (config) => {
        // 请求之前处理config
        const userStore = useUserStoreWidthOut();
        const token = userStore.getToken
        if (token) {
            // jwt token
            config.headers.token = token
        }
        return config
    },

    /**
     * @description: 响应错误处理
     */
    responseInterceptorsCatch: (error: any) => {
        const { response, code, message } = error || {}
        const msg: string =
            response && response.data && response.data.error ? response.data.error.message : ''
        const err: string = error.toString()
        try {
            if (code === 'ECONNABORTED' && message.indexOf('timeout') !== -1) {
                Message.error('接口请求超时,请刷新页面重试!')
                return
            }
            if (err && err.includes('Network Error')) {
                Modal.confirm({
                    title: '网络异常',
                    content: '请检查您的网络连接是否正常!'
                })
                return
            }
        } catch (error) {
            throw new Error(error)
        }
        // 请求是否被取消
        const isCancel = axios.isCancel(error)
        if (!isCancel) {
            checkStatus(error.response && error.response.status, msg)
        } else {
            console.warn(error, '请求被取消！')
        }
        return error
    }
}

const Axios = new VAxios({
    timeout: 15 * 1000,
    // 基础接口地址
    // baseURL: globSetting.apiUrl,
    // 接口可能会有通用的地址部分，可以统一抽取出来
    // prefixUrl: prefix,
    headers: { 'Content-Type': ContentTypeEnum.FORM_URLENCODED },
    // 数据处理方式
    transform,
    // 配置项，下面的选项都可以在独立的接口请求中覆盖
    requestOptions: {
        // 默认将prefix 添加到url
        joinPrefix: true,
        // 需要对返回数据进行处理
        isTransformRequestResult: true,
        // post请求的时候添加参数到url
        joinParamsToUrl: false,
        // 格式化提交参数时间
        formatDate: true,
        // 消息提示类型
        errorMessageMode: 'none',
        // 接口地址
        apiUrl: globSetting.apiUrl as string
    },
    withCredentials: false
})

export default Axios