✨ Vue3开发,或许你需要这样使用请求API

21,737 阅读7分钟

大家好,我是vue-hooks-plus的作者,这里和大家分享一下属于Vue3的方便快捷的请求方式是怎么样的。

Vue3 现在已经越来越多小伙伴用上了,在很多技术群中对于Vue3的评价是很高的,在技术博客、群里也会见到很多小伙伴展示自己的 Vue3 代码块以及对 Vue3 项目搭建的一些心得。

相信大部分项目采用了 Vite+Vue3开发,结合网上的资源我发现对于项目整体大架构,比如 状态管理 pinia、开发构建 Vite 、UI 框架 Element-plusVantAntd-vue 等主流框架,网络请求 axios 已经有很成熟的搭建使用方案了,咱们搞业务开发,基本上围绕着网络请求打交道,这里和大家聊聊不为人知的、好维护、质量可靠的业务API请求 🫣。

📄 列出我所知的请求使用的方案

  • 二次封装 axios、文件夹统一管理API请求,返回一个 Promise,在组件中使用链式调用
  • 二次封装 axios、文件夹统一管理API请求,返回一个 Promise,在组件中使用 async/await 使用
  • 二次封装axios、全局注入axios,组件内直接调用中这个实例去传参数调用
  • 直接使用 axios 请求(重复繁杂的代码,不利于维护,这里只做举例,不推荐 ❌)

我相信很多小伙伴都属于以上的使用方案,我会逐个和大家分析,谈一下关于 Vue3 网络请求这块的见解。

🔍 分析

二次封装 Axios

const axiosInstance = axios.create({
  baseURL: import.meta.env.VITE_SCREEN_BASE_URL,
  timeout: 1_000 * 10
});
// ... 省略拦截器

管理API的文件夹

export  function getData(params,options){
  return new Promise((resolve, reject) => {
    axiosInstance({
      url,
      params,
      ...options,
    })
      .then((res) => {
        resolve(res?.data?.data);
      })
      .catch((err) => {
        reject(err);
      });
  }
}

链式调用,比较传统

const data = ref()
​
getData({...xxx},{...xxx}).then((res)=>{
  // ...这里处理数据
  data.value = res.data
}).catch(err=>{
  // ...xxx
})
​

Async/Await 调用,比较优雅

 const data = ref()
 onMounted(async () => {
 const res = await getData({...x},{...x})
 data.value = res
 }

Provide/Inject 调用,和链式用法基本一致,只是代码量稍少。

main.ts
import axios from 'axios'
import VueAxios from 'vue-axios'
​
app.use(VueAxios, axios)
app.provide('axios', app.config.globalProperties.axios) 
​
App.vue
const axios: any = inject('axios')  // inject axios
axios({url,data,...其他配置}).then() // 同上

🧑‍💻 看法

我相信很多小伙伴会比较喜欢第二种的 async/await 的语法糖,比较优雅,简洁。

在当今前端业务越来越复杂的环境下,网络请求场景也会变得复杂起来,比如

  • 多次请求拿上一次的数据作为参数体

  • 某个值变化了又需要重新请求

  • 或者某个值 满足条件 才开始请求。

    对于链式调用来说,是非常不利于代码阅读的,整个业务组件充斥着重复代码,非常不利于维护。

    对于 async/await 似乎很好的解决了以上的问题,

    • 第一个 ,await拿上一次 请求参数 的很方便啊! ✅。
    • 第二个,某个值变化了需要重新请求,这里很多小伙伴会想到我把这个请求封装起来,放进watch里面监听执行 ✅
    • 第三个,在封装的请求函数中加入判断条件是否执行 ✅

    上述场景多个组件,多次重复操作,这样文件一多,也存在很多代码重复 ❌

✅ 正确思路

我们需要将这些重复的操作进行封装成 hook,把依赖请求,判断条件是否发起请求这些封装成起来,有执行 async/await 的方法,又有这些依赖请求的功能模块一起联合使用,而用户只需要传递需要开启的功能配置即可;

什么是 hook ?

React 中的意思是将一个以 use 开头,含react 状态和 effect 纯函数的外部代码挂入到它的节点当中。

Vue 中,我认为将 Vue 的 effect ,如 ref、watch、watchEffect 的外部代码放入vue中执行,也是挂入 hook

这里我们命名 useRequest

 const useRequest = (service,option)=>{
   const data = ref()
   
   const run = async ()=>{
      const res = await service()
      data.value = res
   }
   
   // 是否满足条件
   if(option.ready){
     run()
   }
     // 依赖重新请求
   watch(option.deps,()=>{
     run()
   })
   
   return {
     data,
     run
   }
 }
​

以上的写法是hook写法,里面使用到了 refwatch,很多小伙伴从Vue2过渡来Vue3的,对这块这样使用的接触的很少。使用高质量可靠的请求hook我相信后面会成为Vue3开发的一个趋势,下面我展示一下业务中的使用流程,展现它的魅力 😉

<template>
  <div>读取值:{{ data }}</div>
</template><script lang="ts" setup>
import { ref } from 'vue'
import { useRequest } from '..'
 //、、、、、业务代码 
 //、、、、、业务代码 
const { data } = useRequest(() => getData(), {
  ready:true
  deps:[依赖其他响应式对象]
})
</script>

比如这块业务代码,用户直接拿到处理好的请求的 data,它是一个响应式,所以业务层省去了一个声明响应式对象来保存数据的代码,ready 判断条件,业务层又被砍去一个条件判断函数,依赖刷新,砍去书写watch的代码,用户只需要关注配置即可,我们会发现它是通过 run方法调用触发请求的,那么,我们的防抖、节流函数只需要作用于 run 函数即可,所以这样的做法,是不是很简洁。

这一块的拓展性极强,你可以拓展 loading状态、params等出去。因为使用 async/await ,所以我们管理的请求API返回一个promise对象即可,意味着axiosrequest 这些都兼容,完全将请求这块的功能性的模块从业务层脱离,用户只需要关注配置和API接口!

const { data } = useRequest(() => getData(), { 
// 防抖
// 节流
// ready
// 依赖刷新
// 格式化请求
 ...
})

几行配置下来,给人的感觉就清爽,而且维护起来那叫一个舒服。

🏃 Use

  • 二次封装 axios 或者 其他请求工具
  • 封装请求hook钩子
  • 使用文件管理 API 接口,👆写的使用一个函数返回一个 promise 即可
  • 业务层使用 hook 传配置即可

📌 来点实战例子

封装带有ts提示的axios axiosInstance 和大家常用的一样,AxiosRequestConfig 类型从 axios 导出。

注意: 实际上不管是 axios 还是 request 本身返回的都是 Promsie 对象 的,所以这里符合前提条件返回一个 Promsie 对象

这里和大家分享一下axios的封装,拦截器和其他额外的设置大家可以根据自己的需求添加,以下配置的好处就是可以根据你的 method里面的请求方式返回不同的实例。

const requestObj = {
  get: <ResponseType = unknown>(
    url: string,
    options?: AxiosRequestConfig<unknown>
  ): Promise<ResponseType> => {
    return axiosInstance.get(url, options)
  },
  delete: <ResponseType = unknown>(
    url: string,
    options?: AxiosRequestConfig<unknown>
  ): Promise<ResponseType> => {
    return axiosInstance.delete(url, options)
  },
  post: <ResponseType = unknown>(
    url: string,
    data: any,
    options?: AxiosRequestConfig<unknown>
  ): Promise<ResponseType> => {
    return axiosInstance.post(url, data, options)
  },
  put: <ResponseType = unknown>(
    url: string,
    data: any,
    options?: AxiosRequestConfig<unknown>
  ): Promise<ResponseType> => {
    return axiosInstance.put(url, data, options)
  },
  patch: <ResponseType = unknown>(
    url: string,
    data: any,
    options?: AxiosRequestConfig<unknown>
  ): Promise<ResponseType> => {
    return axiosInstance.patch(url, data, options)
  }
}

const request = <ResponseType = unknown>(
  url: string,
  options?: AxiosRequestConfig<unknown> & {
    method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'
  }
): Promise<ResponseType> => {
  const method = options?.method ?? 'GET'

  if (method === 'GET') {
    return requestObj.get<ResponseType>(url, options)
  }
  if (method === 'DELETE') {
    return requestObj.delete<ResponseType>(url, options)
  }
  if (method === 'POST') {
    return requestObj.post<ResponseType>(url, options?.data, options)
  }
  if (method === 'PUT') {
    return requestObj.post<ResponseType>(url, options?.data, options)
  }
  if (method === 'PATCH') {
    return requestObj.patch<ResponseType>(url, options?.data, options)
  }

  return requestObj.get<ResponseType>(url, options)
}

需要配合拦截器截取 举例:【res.data.data】,注意,使用拦截器的时候或者是我们封装的请求实例的时候返回的必须是数据data,具体说 res.data或者 res.data.data根据自己的业务而定,这样才能保证我们业务开发的时候,useRequest取得的ts类型与data一致。

请求函数示例 AnalysisReportType 为 数据返回预定的 data 类型,支持 ts

export async function getListReports(
  params?: {
    reportGroup?: string | null;
    sortCol?: 'visitUv' | 'uploadFileTime';
    sortType?: string;
    reportName?: string;
  },
) {
  return request<AnalysisReportType>('/platform/report/listReports', {
    params: { ...params, sortType: 2 },
  });
}

业务组件中

const { data } = useRequest(()=>getListReports(),{
  ready:true,
  ...其他配置
})

👋 拿来吧你

由于vueuse没有这块的功能,我针对业务层写了一个 vue-hooks-plus库,完整的测试用例覆盖,高质量可靠,里面涵盖封装了一个 useRequest 钩子,自己公司已经用上,安全可靠,满足业务 99% 需求,并且支持按需引入,以下展示基本功能,更多详细见API文档 👇

const {
  loading: Ref<boolean>,
  data?: Ref<TData>,
  error?: Ref<Error>,
  params: Ref<TParams || []>,
  run: (...params: TParams) => void,
  runAsync: (...params: TParams) => Promise<TData>,
  refresh: () => void,
  refreshAsync: () => Promise<TData>,
  mutate: (data?: TData | ((oldData?: TData) => (TData | undefined))) => void,
  cancel: () => void,
} = useRequest<TData, TParams>(
  service: (...args: TParams) => Promise<TData>,
  {
    manual?: boolean,
    defaultParams?: TParams,
    formatResult?:(response:TData)=>any,
    onBefore?: (params: TParams) => void,
    onSuccess?: (data: TData, params: TParams) => void,
    onError?: (e: Error, params: TParams) => void,
    onFinally?: (params: TParams, data?: TData, e?: Error) => void,
  }
);

2023.5.11 更新:

99% + 1% 的业务覆盖,余下的 1 %,useRequest支持用户自定义功能插件,意味着只要你想,你能开发出任何对自己业务有效的插件。以下是作者自己实现的两个外置插件供大家参考。

  • 基于 pinia 的全局请求状态管理。例子,全局的loading判断,即所有请求完成loading才算完成。
  • 基于浏览器的 broadcast-channel 实现的跨浏览器窗口的同源广播。例子,同域名下两个项目间的数据广播。

详情请参考 文档 useRequest 外置插件

✒️ 划重点

作者整理出来一整套业务开发规范,快人一步的学会吧!

useRequest 保姆级业务开发教程

useRequest 国内文档地址

Github 地址

喜欢的小伙伴顺手点个 star 🌟 ,多多支持!

✨ 文档闪亮登场

iShot_2023-05-04_09.49.30.png iShot_2023-05-04_09.49.54.png