vue3.0+vite+ts項目搭建-axios封裝(六)

封裝方式一

import axios from 'axios'
import qs from 'qs'
import { Toast } from 'vant'
import Lockr from 'lockr'
 
axios.defaults.timeout = 30000
axios.defaults.baseURL = import.meta.env.VITE_HOST
axios.defaults.headers['Content-Type'] = 'application/x-www-form-urlencoded'
 
// http request
axios.interceptors.request.use((config) => {
  config.headers.refererUrl = window.location.href
  config.headers.authKey = Lockr.get('authKey')
  config.headers.sessionId = Lockr.get('sessionId')
  // 請求頭參數處理
  config.data = qs.stringify(config.data)
  return config
}, (error) => {
  return Promise.reject(error)
})

// http response                                                                            
axios.interceptors.response.use((res) => {
  if (res.status && res.status === 200 && res.data.code !== 200) {
    if (res.data.code === 101) {
      window.location.href = `${window.location.origin}${import.meta.env.VITE_HREF}/login${res.data.url?`?return_url=${res.data.url}&type=${res.data.type}`:''}`
    } else if (res.data.msg && res.data.msg !== '') {
      Toast(res.data.msg)
    } else if (res.data.code === 203) {
      return false
    } else {
      Toast('系統錯誤')
    }
  }
  return res
}, (error) => {
  if (!error.response && error.message) {
    Toast('請求超時，請檢查網絡，刷新后重試')
  } else {
    Toast('系統錯誤')
  }
  return Promise.reject(error)
})
export default axios

/**
* 封裝get方法
* @param url
* @param params
* @returns {Promise}
*/

export function get (url: any, params: Object = {}) {
  params.t = new Date().getTime()
  return new Promise((resolve, reject) => {
    axios.get(url, {
      params: params
    })
      .then(response => {
        resolve(response.data)
      })
      .catch(err => {
        reject(err)
      })
  })
}

/**
* 封裝post請求
* @param url
* @param data
* @returns {Promise}
*/

export function post (url: any, data: Object = {}) {
  return new Promise((resolve, reject) => {
    axios.post(url, data)
      .then(response => {
        resolve(response.data)
      }, err => {
        reject(err)
      })
      .catch(err => {
        reject(err)
      })
  })
}

/**
* 封裝delete方法
* @param url
* @param params
* @returns {Promise}
*/

export function doDelete (url: any, params: Object = {}) {
  return new Promise((resolve, reject) => {
    axios.delete(url, {
      params: params
    })
      .then(response => {
        resolve(response.data)
      })
      .catch(err => {
        reject(err)
      })
  })
}

/**
* 封裝patch請求
* @param url
* @param data
* @returns {Promise}
*/

export function patch (url: any, data: Object = {}) {
  return new Promise((resolve, reject) => {
    axios.patch(url, data)
      .then(response => {
        resolve(response.data)
      }, err => {
        reject(err)
      })
      .catch(err => {
        reject(err)
      })
  })
}

/**
* 封裝put請求
* @param url
* @param data
* @returns {Promise}
*/

export function put (url: any, data: Object = {}) {
  return new Promise((resolve, reject) => {
    axios.put(url, data)
      .then(response => {
        resolve(response.data)
      }, err => {
        reject(err)
      })
      .catch(err => {
        reject(err)
      })
  })
}

使用方式

import { get, post } from '@/utils/request.ts'
get(url).then(...)
post(url).then(...)
...

封裝方式二

 

// http.ts
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios'
import qs from 'qs'

/* const showStatus = (status: number) => {
  let message = ''
  switch (status) {
    case 400:
      message = '請求錯誤(400)'
      break
    case 401:
      message = '未授權，請重新登錄(401)'
      break
    case 403:
      message = '拒絕訪問(403)'
      break
    case 404:
      message = '請求出錯(404)'
      break
    case 408:
      message = '請求超時(408)'
      break
    case 500:
      message = '服務器錯誤(500)'
      break
    case 501:
      message = '服務未實現(501)'
      break
    case 502:
      message = '網絡錯誤(502)'
      break
    case 503:
      message = '服務不可用(503)'
      break
    case 504:
      message = '網絡超時(504)'
      break
    case 505:
      message = 'HTTP版本不受支持(505)'
      break
    default:
      message = `連接出錯(${status})!`
  }
  return `${message}，請檢查網絡或聯系管理員！`
} */

const service = axios.create({
  baseURL: import.meta.env.VITE_HOST,
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  // 是否跨站點訪問控制請求
  withCredentials: false,
  timeout: 30000,
  transformRequest: [(data) => {
    data = JSON.stringify(data)
    return data
  }],
  validateStatus() {
    // 使用async-await，處理reject情況較為繁瑣，所以全部返回resolve，在業務代碼中處理異常
    return true
  },
  transformResponse: [(data) => {
    if (typeof data === 'string' && data.startsWith('{')) {
      data = JSON.parse(data)
    }
    return data
  }]
})

// 聲明一個 Map 用於存儲每個請求的標識 和 取消函數
const pending = new Map()
/**
 * 添加請求
 * @param {Object} config 
 */
const addPending = (config: AxiosRequestConfig) => {
  const url = [
    config.method,
    config.url,
    qs.stringify(config.params),
    qs.stringify(config.data)
  ].join('&')
  config.cancelToken = config.cancelToken || new axios.CancelToken(cancel => {
    if (!pending.has(url)) { // 如果 pending 中不存在當前請求，則添加進去
      pending.set(url, cancel)
    }
  })
}
/**
 * 移除請求
 * @param {Object} config 
 */
const removePending = (config: AxiosRequestConfig) => {
  const url = [
    config.method,
    config.url,
    qs.stringify(config.params),
    qs.stringify(config.data)
  ].join('&')
  if (pending.has(url)) { // 如果在 pending 中存在當前請求標識，需要取消當前請求，並且移除
    const cancel = pending.get(url)
    cancel(url)
    pending.delete(url)
  }
}

/**
 * 清空 pending 中的請求（在路由跳轉時調用）
 */
export const clearPending = () => {
  for (const [url, cancel] of pending) {
    cancel(url)
  }
  pending.clear()
}

// 請求攔截器
service.interceptors.request.use((config: AxiosRequestConfig) => {
  removePending(config) // 在請求開始前，對之前的請求做檢查取消操作
  addPending(config) // 將當前請求添加到 pending 中
  // let token = localStorage.getItem('token')
  // if(token){
  //   config.headers.Authorization = `${token}`;
  // }
  return config
}, (error) => {
  // 錯誤拋到業務代碼
  error.data = {}
  error.data.msg = '服務器異常，請聯系管理員！'
  return Promise.resolve(error)
})

// 響應攔截器
service.interceptors.response.use((response: AxiosResponse) => {

  removePending(response) // 在請求結束后，移除本次請求
  const status = response.status
  let msg = ''
  if (status < 200 || status >= 300) {
    // 處理http錯誤，拋到業務代碼
    // msg = showStatus(status)
    if (typeof response.data === 'string') {
      response.data = { msg }
    } else {
      response.data.msg = msg
    }
  }

  return response
}, (error) => {
  if (axios.isCancel(error)) {
    console.log('repeated request: ' + error.message)
  } else {
    // handle error code
    // 錯誤拋到業務代碼
    error.data = {}
    error.data.msg = '請求超時或服務器異常，請檢查網絡或聯系管理員！'
    // ElMessage.error(error.data.msg)
  }
  return Promise.reject(error)
})

export default service

 

使用方式

import axios from '@/utils/http.ts'
axios(url, {
    method: 'get',
    responseType: 'json',
    params: {},
  }).then(res => {
    console.warn('tag', res)
  })

方式二參考:Vue3+TypeScript封裝axios並進行請求調用

注意事項: 謹慎添加withCredentials為true