基于axios的HttpClient请求封装

项目使用代码 个人封装 可直接复制粘贴使用。
项目是基于react的 需结合自己项目使用框架进行适当修改。

import { message as Message } from 'antd'
import axios, { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios'

export const PRD_URL_PREFIX_ACTIVITY = '/api/activity/'
export const PRD_URL_PREFIX_BASE = '/api'

export type IErrorHandler = (statusCode: number, message: string) => void
const defaultErrorHandler: IErrorHandler = (statusCode, message) => {
  Message.error(typeof message === 'string' ? message : JSON.stringify(message))
}

export interface IRequestConfig extends AxiosRequestConfig {
  // 是否阻止提示错误消息
  suppressErrorMessage?: boolean
}
export interface IResponse<T = any> {
  status: string
  data: T
  message?: string
}
export interface IResponse2<T = any> {
  code: string | number
  data: T
  message: string
}

export class HttpClient {
  // 是否为生产环境
  private isProduction: boolean = false

  constructor(isProduction: boolean, errorHandler?: IErrorHandler) {
    this.isProduction = Boolean(isProduction)
    if (errorHandler) {
      this.errorHandler = errorHandler
    }
  }

  // 错误处理函数
  public errorHandler: IErrorHandler = (statusCode: number, message: string) => {
    console.error(message)
  }

  /**
   * 为发布环境处理URL
   */
  public dealUrlForPrd(url: string) {
    return this.isProduction ? url.replace(/^\/?api/g, '/marketApi') : url
  }

  /**
   * 转义查询参数
   */
  public encode(queryString?: string | null): string {
    if (!queryString) {
      return ''
    }

    return encodeURIComponent(queryString.replace(/[-[\]{}()*+?.,\\/^$|#]/g, '\\$&'))
  }

  /**
   * get查询
   */
  public async get<T = any>(url: string, requestConfig: IRequestConfig = {}) {
    const { suppressErrorMessage, ...config } = requestConfig

    try {
      const response: AxiosResponse<T> = await axios({
        url: this.getUrlWithTimestamp(this.dealUrlForPrd(url)),
        method: 'GET',
        headers: {
          'content-type': 'application/json; charse=UTF-8',
        },
        ...config,
      })
      return this.handleSuccess<T>(response, suppressErrorMessage)
    } catch (e) {
      this.handleError(e, suppressErrorMessage)
      throw e
    }
  }

  /**
   * post查询
   */
  public async post<T = any>(
    url: string,
    obj?: object | string,
    requestConfig: IRequestConfig = {}
  ): Promise<T> {
    const { suppressErrorMessage, ...config } = requestConfig

    let data = {}
    if (typeof obj === 'string') {
      try {
        data = JSON.parse(obj)
      } catch (e) {
        throw new Error(`请求参数解析失败\n${obj}\n${url}\n${e}`)
      }
    } else if (typeof obj === 'object') {
      data = obj
    }

    try {
      const response: AxiosResponse<T> = await axios({
        url: this.dealUrlForPrd(url),
        method: 'POST',
        headers: {
          'content-type': 'application/json; charse=UTF-8',
        },
        data,
        ...config,
      })
      return this.handleSuccess<T>(response, suppressErrorMessage)
    } catch (e) {
      this.handleError(e, suppressErrorMessage)
      throw e
    }
  }

  /**
   * del请求
   */
  public async del<T = any>(url: string, requestConfig: IRequestConfig = {}): Promise<T> {
    const { suppressErrorMessage, ...config } = requestConfig

    try {
      const response: AxiosResponse<T> = await axios({
        url: this.getUrlWithTimestamp(this.dealUrlForPrd(url)),
        method: 'DELETE',
        headers: {
          'content-type': 'application/json; charse=UTF-8',
        },
        ...config,
      })
      return this.handleSuccess<T>(response, suppressErrorMessage)
    } catch (e) {
      this.handleError(e, suppressErrorMessage)
      throw e
    }
  }

  /**
   * 上传文件
   */
  public async uploadFile<T = any>(
    url: string,
    file: File,
    requestConfig: IRequestConfig = {}
  ): Promise<T> {
    const { suppressErrorMessage, ...config } = requestConfig
    const formData = new FormData()

    try {
      formData.append('file', file)
      const response: AxiosResponse<T> = await axios.post(url, formData, {
        headers: {
          'content-type': 'multipart/form-data',
        },
        ...config,
      })
      return this.handleSuccess<T>(response, suppressErrorMessage)
    } catch (e) {
      this.handleError(e, suppressErrorMessage)
      throw e
    }
  }

  /**
   * 处理请求成功
   */
  private handleSuccess<T>(response: AxiosResponse, suppressErrorMessage: boolean = false): T {
    let message: string | undefined
    switch (response.status) {
      case 200:
        break

      case 400:
        message = '请求参数错误!'
        break

      case 401:
        message = '认证失败!'
        break

      case 403:
        message = '没有访问权限!'
        break

      case 415:
        message = '请求方式错误!'
        break

      default:
        message = '未知状态错误!'
        break
    }

    if (message && !suppressErrorMessage) {
      this.errorHandler(response.status, message)
    }

    // tslint:disable-next-line: no-object-literal-type-assertion
    return response.data || ({} as T)
  }

  /**
   * 处理请求失败
   */
  private handleError(error: AxiosError, suppressErrorMessage: boolean = false): void {
    let status: number = 0
    let message: string = '请求出错'

    /* 构造错误消息 */
    if (error.response) {
      status = error.response.status
      if (error.response.data.message) {
        message = error.response.data.message
      } else if (error.response.data.error) {
        message = error.response.data.error
      } else if (error.response.data.detail) {
        message = error.response.data.detail
      } else {
        if (status === 404) {
          message = error.message
        } else {
          message = error.response.data
        }
      }
    } else if (error.request) {
      status = error.request.status
      message = error.request.responseText
    } else {
      message = error.message
    }

    if (!suppressErrorMessage) {
      this.errorHandler(status, message)
    }
  }

  /**
   * 构造请求地址,添加时间戳参数,在开发环境禁用缓存
   * @param url 请求地址
   */
  private getUrlWithTimestamp(url: string): string {
    return this.isProduction
      ? url
      : `${url}${url.indexOf('?') > -1 ? '&' : '?'}_=${new Date().getTime()}`
  }
}

export default new HttpClient(process.env.REACT_APP_ENV!.trim() === 'prd', defaultErrorHandler)

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335

推荐阅读更多精彩内容

  • 当下数九寒天,寒风凛冽,一向怕冷的我今天丝毫感觉不到有一丝丝的凉意,因为我的心被一名六年级名叫程笑千的女生给...
    江左镇刘楼小学程盼婷阅读 592评论 0 2
  • 以前走过的路 有遗憾 但不后悔 现在要走的路 希望不留遗憾 不后悔 喵喵君
    喵喵诗茵阅读 104评论 0 2
  • 记录反思 2:30到酒店,3:00才睡,中间醒来无数次,高原反应慢慢显现,晚上睡觉头疼,以为空气不好,打开空调、打...
    冬梅姐自我管理阅读 95评论 0 0
  • 不知不觉,在忙碌的闲暇忽然想到闹闹快两岁半了。 那个身长一尺多点的婴孩儿,现在居然快一米了。他躺在...
    韦心草阅读 489评论 1 1