http.ts 6.54 KB
import type { AxiosResponse } from 'axios'
import type { RequestOptions, Result } from '/#/external/axios'
import type { AxiosTransform, CreateAxiosOptions } from '@/utils/external/http/axios/axiosTransform'
import { useGlobSetting } from '@/hooks/external/setting'
import { RequestEnum, ContentTypeEnum } from '@/enums/external/httpEnum'
import { isString } from '@/utils/external/is'
import { getJwtToken, getShareJwtToken } from '@/utils/external/auth'
import { setObjToUrlParams, deepMerge } from '@/utils/external'
import { formatRequestDate, joinTimestamp } from '@/utils/external/http/axios/helper'
import { VAxios } from '@/utils/external/http/axios/Axios'
import { checkStatus } from './checkStatus'

const globSetting = useGlobSetting()
const urlPrefix = globSetting.urlPrefix

/**
 * @description: 数据处理,方便区分多种处理方式
 */
const transform: AxiosTransform = {
  /**
   * @description: 处理请求数据。如果数据不是预期格式,可直接抛出错误
   */
  transformRequestHook: (res: AxiosResponse<Result>, options: RequestOptions) => {
    const { isReturnNativeResponse } = options
    // 是否返回原生响应头 比如:需要获取响应头时使用该属性
    if (isReturnNativeResponse) {
      return res
    }
    return res.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 || {}
    const data = config.data || false
    formatDate && data && !isString(data) && formatRequestDate(data)
    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)
        if (Reflect.has(config, 'data') && config.data && Object.keys(config.data).length > 0) {
          config.data = data
          config.params = params
        } else {
          // 非GET请求如果没有提供data,则将params视为data
          config.data = params
          config.params = undefined
        }
        if (joinParamsToUrl) {
          config.url = setObjToUrlParams(config.url as string, Object.assign({}, config.params, config.data))
        }
      } else {
        // 兼容restful风格
        config.url = config.url + params
        config.params = undefined
      }
    }
    return config
  },

  /**
   * @description: 请求拦截器处理
   */
  requestInterceptors: (config, options) => {
    // 请求之前处理config
    const { requestOptions } = config
    const { withShareToken } = requestOptions || {}
    const { requestOptions: { withToken } = {} } = options
    const { withThirdTokenPrefix, withThirdTokenKey, withThirdTokenString } = config.requestOptions as Recordable
    if (withToken !== false) {
      const shareToken = getShareJwtToken()
      if (withShareToken && shareToken) {
        config.headers!['X-Authorization'] = options.authenticationScheme
          ? `${options.authenticationScheme} ${shareToken}`
          : shareToken
      } else {
        const token = getJwtToken()
        if (!withThirdTokenString) {
          // 则是此平台
          if (token) {
            config.headers!['X-Authorization'] = options.authenticationScheme
              ? `${options.authenticationScheme} ${token}`
              : token
          }
        } else {
          // 第三方接口
          const authenticationScheme = !withThirdTokenPrefix ? 'Bearer': withThirdTokenPrefix
          const tokenKey = withThirdTokenKey ? withThirdTokenKey : 'X-Authorization'
          config.headers![tokenKey!] = withThirdTokenPrefix
            ? `${authenticationScheme} ${withThirdTokenString}`
            : `${withThirdTokenString}`
        }
      }
    }
    return config
  },

  /**
   * @description: 响应拦截器处理
   */
  responseInterceptors: (res: AxiosResponse<any>) => {
    return res
  },

  /**
   * @description: 响应错误处理
   */
  responseInterceptorsCatch: (error: any) => {
    const { response, config } = error || {}
    const errorMessageMode = config?.requestOptions?.errorMessageMode || 'none'
    const errorMsgIsObj = typeof response?.data === 'object'
    const msg: string = errorMsgIsObj ? response?.data?.message || response?.data?.msg : response?.data

    const flag = checkStatus(error?.response?.status, msg, errorMessageMode)
    return Promise.reject(response?.data)
  }
}

function createAxios(opt?: Partial<CreateAxiosOptions>) {
  return new VAxios(
    deepMerge(
      {
        // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#authentication_schemes
        // authentication schemes,e.g: Bearer
        // authenticationScheme: 'Bearer',
        authenticationScheme: 'Bearer',
        timeout: 10 * 1000,
        // 基础接口地址
        // baseURL: globSetting.apiUrl,
        // 接口可能会有通用的地址部分,可以统一抽取出来
        urlPrefix: urlPrefix,
        headers: { 'Content-Type': ContentTypeEnum.JSON },
        // 如果是form-data格式
        // headers: { 'Content-Type': ContentTypeEnum.FORM_URLENCODED },
        // 数据处理方式
        transform,
        // 配置项,下面的选项都可以在独立的接口请求中覆盖
        requestOptions: {
          // 默认将prefix 添加到url
          joinPrefix: true,
          // 是否返回原生响应头 比如:需要获取响应头时使用该属性
          isReturnNativeResponse: false,
          // 需要对返回数据进行处理
          isTransformResponse: true,
          // post请求的时候添加参数到url
          joinParamsToUrl: false,
          // 格式化提交参数时间
          formatDate: true,
          // 消息提示类型
          errorMessageMode: 'message',
          // 接口地址
          apiUrl: globSetting.apiUrl,
          //  是否加入时间戳
          joinTime: true,
          // 忽略重复请求
          ignoreCancelToken: true,
          // 是否携带token
          withToken: true
        }
      },
      opt || {}
    )
  )
}

export const customHttp = createAxios()