React Hooks 之 useRequest

2024-05-21 01:58

本文主要是介绍React Hooks 之 useRequest,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

基础用法 - ahooks 3.0https://ahooks.js.org/zh-CN/hooks/use-request/basic

https://hooks.umijs.org/zh-CN/hooks/asynchttps://hooks.umijs.org/zh-CN/hooks/async

一个强大的管理异步数据请求的 Hook.

核心特性

  • 自动请求/手动请求
  • SWR(stale-while-revalidate)
  • 缓存/预加载
  • 屏幕聚焦重新请求
  • 轮询
  • 防抖
  • 节流
  • 并行请求
  • loading delay
  • 分页
  • 加载更多,数据恢复 + 滚动位置恢复
  •  错误重试
  •  请求超时管理
  •  suspense
  • ...

 API

const {loading: boolean,data?: TData,error?: Error,params: 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,onBefore?: (params: TParams) => void,onSuccess?: (data: TData, params: TParams) => void,onError?: (e: Error, params: TParams) => void,onFinally?: (params: TParams, data?: TData, e?: Error) => void,}
);

基础版(自动请求)

import { useRequest } from '@umijs/hooks';
import Mock from 'mockjs';
import React from 'react';function getUsername(): Promise<string> {return new Promise(resolve => {setTimeout(() => {resolve(Mock.mock('@name'));}, 1000);});
}export default () => {const { data, error, loading } = useRequest(getUsername) // 请求回调Promiseif (error) {return <div>failed to load</div>}if (loading) {return <div>loading...</div>}return <div>Username: {data}</div>
}

字段变量转换(自动请求),如data转为listData,后加:号即可。

import { useRequest } from '@umijs/hooks';
import Mock from 'mockjs';
import React from 'react';function getUsername(): Promise<string> {return new Promise(resolve => {setTimeout(() => {resolve(Mock.mock('@name'));}, 1000);});
}export default () => {const { data:listData, error, loading:isLoading } = useRequest(getUsername)if (error) {return <div>failed to load</div>}if (isLoading) {return <div>loading...</div>}return <div>Username: {listData}</div>
}

回调

const { loading, data } = useRequest(() => {return getInfo({id: xxx,});});
const { data } = useRequest(() => {return getInfo({id: xxx,})}, {onSuccess: (result, params) => {console.log('data:', data)}});

基础用法 - ahooks 3.0https://ahooks.js.org/zh-CN/hooks/use-request/basic

手动(通过设置 options.manual = true , 则需要手动调用 run 时才会触发执行异步函数。)

import { useRequest } from '@umijs/hooks';
import { Button, Input, message } from 'antd';
import React, { useState } from 'react';
// 请求函数
function changeUsername(username: string): Promise<{ success: boolean }> {console.log(username);return new Promise(resolve => {setTimeout(() => {resolve({ success: true });}, 1000);});
}
// 默认情况下,useRequest 第一个参数是一个异步函数,在组件初始化时,会自动执行该异步函数。同时自动管理该异步函数的 loading , data , error 等状态。
export default () => {const [state, setState] = useState('');const { loading, run } = useRequest(changeUsername, {manual: true,onSuccess: (result, params) => {if (result.success) {setState('');message.success(`The username was changed to "${params[0]}" !`);}}});return (<div><InputonChange={e => setState(e.target.value)}value={state}placeholder="Please enter username"style={{ width: 240, marginRight: 16 }}/><Button onClick={() => run(state)} loading={loading}>Edit</Button></div>);
};

 手动+传参+刷新

// index.tsx
const { data, run,refresh} = useRequest((id: number) => {return dataGet({id: id}) // 请求方法}, {manual: true, // 手动onSuccess: (res) => {}});useEffect(() => {run(1);}, []);// api.ts
export async function dataGet(params: any) {return request<any>(`${host}/api/info/${params.id}`, {method: 'GET',headers: { 'Content-Type': 'application/x-www-form-urlencoded'},});
}

useRequest 提供了 refresh 和 refreshAsync 方法,使我们可以使用上一次的参数,重新发起请求。

假如在读取用户信息的场景中

  1. 我们读取了 ID 为 1 的用户信息 run(1)
  2. 我们通过某种手段更新了用户信息
  3. 我们想重新发起上一次的请求,那我们就可以使用 refresh 来代替 run(1),这在复杂参数的场景中是非常有用的
import { useRequest } from 'ahooks';
import Mock from 'mockjs';
import React, { useEffect } from 'react';function getUsername(id: number): Promise<string> {console.log('use-request-refresh-id', id);return new Promise((resolve) => {setTimeout(() => {resolve(Mock.mock('@name'));}, 1000);});
}export default () => {const { data, loading, run, refresh } = useRequest((id: number) => getUsername(id), {manual: true,});useEffect(() => {run(1);}, []);if (loading) {return <div>loading...</div>;}return (<div><p>Username: {data}</p><button onClick={refresh} type="button">Refresh</button></div>);
};

// 转换及整合
const { run: postRun } = useRequest((method, params) => {if (method === 'remove') {return removeFakeList(params);}if (method === 'update') {return updateFakeList(params);}return addFakeList(params);},{manual: true,onSuccess: (result) => {mutate(result);},},
);const deleteItem = (id: string) => {postRun('remove', { id });
};

其他的看官网,很丰富!

这篇关于React Hooks 之 useRequest的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/995954

相关文章

Vue中组件之间传值的六种方式(完整版)

《Vue中组件之间传值的六种方式(完整版)》组件是vue.js最强大的功能之一,而组件实例的作用域是相互独立的,这就意味着不同组件之间的数据无法相互引用,针对不同的使用场景,如何选择行之有效的通信方式... 目录前言方法一、props/$emit1.父组件向子组件传值2.子组件向父组件传值(通过事件形式)方

css中的 vertical-align与line-height作用详解

《css中的vertical-align与line-height作用详解》:本文主要介绍了CSS中的`vertical-align`和`line-height`属性,包括它们的作用、适用元素、属性值、常见使用场景、常见问题及解决方案,详细内容请阅读本文,希望能对你有所帮助... 目录vertical-ali

浅析CSS 中z - index属性的作用及在什么情况下会失效

《浅析CSS中z-index属性的作用及在什么情况下会失效》z-index属性用于控制元素的堆叠顺序,值越大,元素越显示在上层,它需要元素具有定位属性(如relative、absolute、fi... 目录1. z-index 属性的作用2. z-index 失效的情况2.1 元素没有定位属性2.2 元素处

Python实现html转png的完美方案介绍

《Python实现html转png的完美方案介绍》这篇文章主要为大家详细介绍了如何使用Python实现html转png功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 1.增强稳定性与错误处理建议使用三层异常捕获结构:try: with sync_playwright(

Vue 调用摄像头扫描条码功能实现代码

《Vue调用摄像头扫描条码功能实现代码》本文介绍了如何使用Vue.js和jsQR库来实现调用摄像头并扫描条码的功能,通过安装依赖、获取摄像头视频流、解析条码等步骤,实现了从开始扫描到停止扫描的完整流... 目录实现步骤:代码实现1. 安装依赖2. vue 页面代码功能说明注意事项以下是一个基于 Vue.js

CSS @media print 使用详解

《CSS@mediaprint使用详解》:本文主要介绍了CSS中的打印媒体查询@mediaprint包括基本语法、常见使用场景和代码示例,如隐藏非必要元素、调整字体和颜色、处理链接的URL显示、分页控制、调整边距和背景等,还提供了测试方法和关键注意事项,并分享了进阶技巧,详细内容请阅读本文,希望能对你有所帮助...

Nginx实现前端灰度发布

《Nginx实现前端灰度发布》灰度发布是一种重要的策略,它允许我们在不影响所有用户的情况下,逐步推出新功能或更新,通过灰度发布,我们可以测试新版本的稳定性和性能,下面就来介绍一下前端灰度发布的使用,感... 目录前言一、基于权重的流量分配二、基于 Cookie 的分流三、基于请求头的分流四、基于请求参数的分

基于Canvas的Html5多时区动态时钟实战代码

《基于Canvas的Html5多时区动态时钟实战代码》:本文主要介绍了如何使用Canvas在HTML5上实现一个多时区动态时钟的web展示,通过Canvas的API,可以绘制出6个不同城市的时钟,并且这些时钟可以动态转动,每个时钟上都会标注出对应的24小时制时间,详细内容请阅读本文,希望能对你有所帮助...

HTML5 data-*自定义数据属性的示例代码

《HTML5data-*自定义数据属性的示例代码》HTML5的自定义数据属性(data-*)提供了一种标准化的方法在HTML元素上存储额外信息,可以通过JavaScript访问、修改和在CSS中使用... 目录引言基本概念使用自定义数据属性1. 在 html 中定义2. 通过 JavaScript 访问3.

CSS模拟 html 的 title 属性(鼠标悬浮显示提示文字效果)

《CSS模拟html的title属性(鼠标悬浮显示提示文字效果)》:本文主要介绍了如何使用CSS模拟HTML的title属性,通过鼠标悬浮显示提示文字效果,通过设置`.tipBox`和`.tipBox.tipContent`的样式,实现了提示内容的隐藏和显示,详细内容请阅读本文,希望能对你有所帮助... 效