vp-tools

vp-axios

README in English

基于 axios 进行二次封装，更简单、更统一地使用 axios。

功能列表

• 封装调用方式统一的 GET/POST/PUT/DELETE/FORMDATA 方法
• 自定义接口调用失败时如何处理错误提示（可开关）
• 常见 HTTP 状态码的中英文提示 400/401/403/404/405/413/414/500/502/504
• 自定义错误处理函数，可以根据状态码指定不同错误类型的自定义操作：如 403 跳转到指定页面
• hooks 方法
  • beforeHook(config) 接口请求前自定义操作：如可以在请求时给页面添加蒙层，加载中效果
  • afterHook(responce/error, isError) 接口返回后自定义操作：如取消 loading 效果、处理返回数据的数据结构等
• 兼容错误信息在 200 请求情况
  • 指定获取状态码函数 getResStatus(resData)，获取 response 中的错误码
  • 指定获取错误消息函数 getResErrMsg(resData)，获取 response 中的错误消息
  • 指定获取返回最终数据函数 getResData(resData)，获取 response 中的返回数据
• validateStatus自主校验接口状态
• 配置可取消重复请求
  • 在 new VpAxios 实例时，配置cancelDuplicated: true可开启取消重复的请求
  • 在 new VpAxios 实例时，duplicatedKeyFn函数可配置统一的重复请求的标识
  • 在请求时可自定义配置单个请求的重复标识duplicatedKey

基础用法

安装

npm install -S vp-tools

使用

可以通过以下方法 new 一个 VpAxios 的实例，第一个参数 vpAxiosConfig 为 vp-axios 的配置，第二个参数 axiosConfig 为 axios 所支持的配置。

// request.js
import { VpAxios } from 'vp-tools'
// 此处 vpAxiosConfig, axiosConfig 未定义，下面会详细介绍 vpAxiosConfig
const request = new VpAxios(vpAxiosConfig, axiosConfig)

export default {
  list: (params) => request.GET('/user', params),
  add: (params) => request.POST('/user', params),
  update: (id, params) => request.PUT(`/user/${id}`, params),
  delete: (id) => request.DELETE(`/user/${id}`),
  deletes: (params) => request.DELETE(`/user/`, params),
  upload: (params) => request.FORMDATA(`/user/`, params),
}

vpAxiosConfig 支持以下配置：

{
  // 发生错误时，是否显示提示
  tip: true, // default

  // 如何显示提示，可以传入显示message的方法
  tipFn: (message) => {},

  // 当请求成功时，
  returnCodeHandlers: {

  },

  errorHandlers: {
    // 支持 400/401/403/404/405/413/414/500/502/504/任意其他 errno
    // 401: () => {}
    // 403: () => {}
    // ...
  },

  // 内置错误提示语言: 'zh-cn'/'en'
  lang: 'zh-cn', // default

  // 请求前的自定义操作
  beforeHook: (config) => {},

  // 请求后的自定义操作
  afterHook: (responce|error, isError) => {},

  // 从请求响应中请求状态码，默认取status
  // 如果传入的不是一个函数也会使用默认值
  getResStatus: (resData) => resData.status, // default

  // 从请求响应中获取错误消息，默认取message
  // 如果传入的不是一个函数也会使用默认值
  getResErrMsg: (resData) => resData.message, // default

  // 从请求响应中获取返回数据，默认取data
  // 如果传入的不是一个函数也会使用默认值
  getResData: (resData) => resData.data, // default
  
  // 是否开启取消重复请求
  cancelDuplicated: false, // default
    
  // 如果开启了取消重复请求，如何生成重复标识
  duplicatedKeyFn: (config) => `${config.method}${config.url}` // default
}

VpAxios 实例支持 GET/POST/PUT/DELETE/FORMDATA实例方法，并且调用方式统一。

• request.GET(path, params, config)
• request.POST(path, params, config)
• request.PUT(path, params, config)
• request.DELETE(path, params, config)
• request.FORMDATA(path, params, config)

path 为请求路径；

params 为请求参数，GET/FORMDATA 的参数也不用特殊处理，vp-axios 会统一处理，其中FORMDATA的 Content-Type 为 multipart/form-data;charset=UTF-8

config 为axios的原始配置 和 新增的 vpConfig 字段用于 VpAxios 调用实例方法时传入配置，后续会介绍

自定义错误提示函数

当接口报错时，我们通常会对错误信息进行提示。VpAxios 提供了统一的方式来处理错误消息。在 VpAxiosConfig 中指定 tipFn(errmsg) 可以指定错误消息的处理方式，指定 tip（布尔值）可以开关是否执行错误提示。

如下，我们可以将 tipFn 指定为 alert，则错误信息会使用 alert 函数弹出提醒。

// request.js
import VpAxios from 'vp-axios'
const request = new VpAxios({
  tipFn: () => alert
})

VpAxios 内置了常见 HTTP 错误的中英文提示，如 401 对应 “未授权，请确认是否登录” / “Unauthorized”。可以通过配置中的 lang 指定提示的语言。

有些时候，我们可能想要只针对某个接口禁用tip，这可以在调用接口时传入第三个参数，如下，可以禁用该接口发生错误时的错误提示。

// 禁用 tip
request.GET(path, params, { vpConfig: { disableTip: true } })

自定义错误处理函数

使用 axios 进行接口请求发生错误时，一般会有两种，一种是 validateStatus 不通过时（默认是 2xx 通过） ，另一种是所有接口错误信息都由 200 状态返回，返回结果中带有固定字段表示，如 errno/errmsg。

在接口请求的过程中，我们有时会需要对于对某些特殊的错误进行一些额外的操作，如 403 的时候跳转到无权限的错误提示页。

这时候，我们可以在配置中添加相应的错误处理函数errorHandlers，可以给不同的错误码指定不同的处理函数，并且支持自定义的 errno。

// request.js
import VpAxios from 'vp-axios'
const request = new VpAxios({
  errorHandlers: {
    // 支持 400/401/403/404/405/413/414/500/502/504/任意其他 errno
    401: () => {}
    403: () => {}
    // 任意自定义errno
    1002: () => {}
  },
})

Hooks

VpAxios 在请求前和请求后都留了钩子，以备需要在这两个时机进行特殊的处理。

• beforeHook(config) 接口请求前的钩子函数

  在接口请求前触发，可以在请求时给页面添加蒙层，加载中效果。config参数是最后发送请求时的配置。

  config 为引用传值，可以对该引用的值进行修改，修改后会影响提交的配置

• afterHook(responce/error, isError) 接口返回后钩子函数

  在接口请求返回后触发，可以进行取消 loading 效果、处理返回的数据结构等操作。其中第一个参数在请求成功时是接口返回的响应response，在接口失败时，是返回的错误对象。第二个参数标识是否是错误返回。

  response 为引用传值，可以对该引用的值进行修改，如对返回的数据结构进行调整

通常我们会在实例化时进行通用的钩子函数定义。但可能存在某些特殊的请求，不需要执行 hooks，这时候我们可以在单独的请求中，指定是否禁用 hooks 以及禁用哪一个 hooks。

// 禁用全部 hooks
request.GET(path, params, { vpConfig: { disableHooks: true } })

// 禁用 before hooks
request.GET(path, params, { vpConfig: { disableHooks: { before: true } } })

// 禁用 afater hooks
request.GET(path, params, { vpConfig: { disableHooks: { after: true } } })

自定义错误信息及数据的获取

前面提到，接口在返回错误时有两种常见方案，其中一种是全部 200 返回，通过特定字段标识是否是错误，如 errno 表示错误号，非 0 则为错误；errmsg 表示错误信息；data 为返回的数据。这也是 VpAxios 的默认值。

当然，有些时候，接口并非我们预想的这样统一，我们可以通过以下三个函数分别指定如何从 reponse data 中获取上述的三个值。

• getResStatus(resData)，获取 response 中的错误码，默认值 (resData) => resData.errno
• getResErrMsg(resData)，获取 response 中的错误消息，默认值 (resData) => resData.errmsg
• getResData(resData)，获取 response 中的返回数据，默认值 (resData) => resData.data

validateStatus自主校验接口状态

与 axios 中默认的 validateStatus 配置略有不同，vp-axios 中的默认值为 (status) => status === 0 || (status >= 200 && status < 300)，主要是兼容了错误码由正确响应返回的情况。这时，status 通常可能为0，有可能是正确的状态码 2xx，所以加了一个可以判断的逻辑。特殊情况修改该判断逻辑即可。该配置不影响 axios 中 validateStatus 的判断逻辑，如果两个地方都需要，需要分别指定。

配置可取消重复请求自动

如果开启了取消重复请求，但是没有配置duplicatedKeyFn 和 duplicatedKey，那么默认的重复请求标识为：${config.method}${config.url}。如果同时配置了duplicatedKeyFn 和 duplicatedKey，那么duplicatedKey的优先级高于duplicatedKeyFn

• 在 new VpAxios 实例时，配置cancelDuplicated: true可开启取消重复的请求

  const vpAxiosConfig = {
    cancelDuplicated: true,
  }
  const request = new VpAxios(vpAxiosConfig)
  

• 在 new VpAxios 实例时，duplicatedKeyFn函数可配置统一的重复请求的标识

  const vpAxiosConfig = {
    cancelDuplicated: true,
    duplicatedKeyFn: (config) => {
      const { method, url, responseType } = config
      return `${method}${url}${responseType}`
    }
  }
  const request = new VpAxios(vpAxiosConfig)
  

• 在请求时的可自定义配置单个请求的重复标识duplicatedKey

  request.GET(path, params, { vpConfig: { duplicatedKey: 'duplicatedKey' } })
  

获取原始 axios 对象

如果你现有项目已经使用了 axios，需要兼容旧的逻辑，可以通过以下方式获取原始 axios 的引用。

import { originalAxios as axios, VpAxios, vpCode } from 'vp-tools'