https://github.com/kne-union/react-fetch
用于获取数据的react组件
https://github.com/kne-union/react-fetch
ajax fetch react
Last synced: 8 months ago
JSON representation
用于获取数据的react组件
- Host: GitHub
- URL: https://github.com/kne-union/react-fetch
- Owner: kne-union
- License: mit
- Created: 2020-04-20T03:08:09.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-12T06:25:35.000Z (over 1 year ago)
- Last Synced: 2025-07-06T23:02:09.219Z (9 months ago)
- Topics: ajax, fetch, react
- Language: JavaScript
- Homepage:
- Size: 10.6 MB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-fetch
### 描述
用于获取数据的react组件
### 安装
```shell
npm i --save @kne/react-fetch
```
### 概述
* 该组件处理了数据请求的逻辑，在数据请求返回之前会渲染一个loading组件，在请求数据返回之后渲染业务组件
* 在url，data，options其中之一发生改变的时候，组件会自动发出一个新的请求去请求数据
* 底层采用 [axios](https://github.com/axios/axios) 易于扩展
* 插件式设计，方便追踪每一步的调用堆栈信息，易于扩展
* 用preset预制设置，全局生效，不用在每次调用都设置一些通用属性
### 示例
#### 示例样式
```scss
.ant-space-vertical {
width: 100%;
}
.load-container {
height: 300px;
overflow: auto;
}
.scroller-no-more {
text-align: center;
}
```
#### 示例代码
- preset设置
- 注意：react-fetch 内部处理请求的时候只通过 code,msg,results来作为内部逻辑，code为200判定为请求成功，不为200时判定为错误，msg会传入到error组件，拿到results后，会将results作为业务组件的data属性
如果后端的返回不满足上诉格式，需要在preset的transformResponse方法做转换适配
ajax为一个axios实例，每个实例的拦截器可能不同，默认会在内部自动创建一个axios实例，但是没有任何拦截器，如果想给其添加拦截器，可以自行创建axios实例通过preset设置
preset 可以单独放一个文件里，在入口文件顶部引入。
preset全局设置一次即可。
- ReactFetch(@kne/current-lib_react-fetch),antd(antd),_(lodash)
```jsx
const {preset} = ReactFetch;
const {Input,Spin,Empty,Result,Space} = antd;
let timeout = 1000;
preset({
ajax: (config) => {
return new Promise((resolve) => {
setTimeout(() => {
if (config.url === '/data1') {
console.log('data1 request');
resolve({
data: {
code: 0,
data: [
{title: '数据一'},
{title: '数据二'}
]
}
});
return;
}
if (config.url === '/data3') {
console.log('data1 request');
resolve({
data: [
{title: '数据一'},
{title: '数据二'}
]
});
return;
}
if (config.url === '/data2') {
resolve({
data: {
code: 0,
data: {
list: _.range(0, config.params.size || 10).map((index) => {
return {
title: config.params.page + '页，数据' + (index + 1)
}
}),
total: 100
}
}
});
return;
}
return resolve({
data: {
code: 404,
msg: '没找到资源'
}
});
}, timeout);
});
},
loading: 数据加载中...,
empty: ,
error: (msg) => ,
transformResponse: (response) => {
const {data} = response;
response.data = {
code: data.code === 0 ? 200 : data.code, msg: data.msg, results: data.data
};
return response;
}
});
const Preset = () => {
return
该组件只设置其他示例的mock data，不展示任何功能
这里可以设置模拟请求延迟时间
{
timeout = parseInt(e.target.value);
}} addonAfter="ms"/>
};
render();
```
- 请求成功
- 发送一个成功请求，内部组件拿到数据并展示数据
- ReactFetch(@kne/current-lib_react-fetch),antd(antd)
```jsx
const {createWithFetch} = ReactFetch;
const {List} = antd;
const Remote = createWithFetch({
url: '/data1'
})(({data}) => {
return
{data.map((item, index) => {
return {item.title}
})}
;
});
render();
```
- 使用Fetch组件发送请求
- 使用Fetch组件发送一个成功请求，内部组件拿到数据并展示数据
- ReactFetch(@kne/current-lib_react-fetch),antd(antd)
```jsx
const {default: Fetch} = ReactFetch;
const {List} = AntdList;
const Remote = () => {
return {
return new Promise((resolve) => {
resolve([{title:'loader数据'}]);
})
}} render={({data}) => {
return
{data.map((item, index) => {
return {item.title}
})}
}}/>
};
render();
```
- 请求失败
- 发送一个失败请求，内部组件不渲染，直接展示错误信息
- ReactFetch(@kne/current-lib_react-fetch)
```jsx
const {createWithFetch} = ReactFetch;
const Error = createWithFetch({
url: '/error'
})(() => {
return '这是一个错误请求';
});
render();
```
- 分页数据请求
- 分页加载数据
- ReactFetch(@kne/current-lib_react-fetch),antd(antd),_(lodash)
```jsx
const {useState} = React;
const {createWithFetch} = ReactFetch;
const {Button,Pagination,Space,List} = antd;
const Page = createWithFetch({
url: '/data2',
params: {page: 1, size: 10}
})(({data, requestParams, isRefresh, reload, refresh}) => {
return
{data.list.map((item, index) => {
return {item.title}
})}
{
(isRefresh ? refresh : reload)({params: {page, size}});
}}/>
;
});
const Remote = () => {
const [isRefresh, setIsRefresh] = useState(false);
return
{
setIsRefresh((value) => !value);
}}>以{isRefresh ? 'refresh' : 'reload'}方式加载
};
render();
```
- 下拉加载更多
- 下拉加载更多数据
- ReactFetch(@kne/current-lib_react-fetch),antd(antd),_(lodash)
```jsx
const {useEffect, forwardRef, useRef, useImperativeHandle} = React;
const {createWithFetch} = ReactFetch;
const {Space,List,Spin} = antd;
const {throttle} = _;
const ScrollLoader = forwardRef(({
className,
noMore,
getScrollContainer,
onLoader,
isLoading,
completeTips,
children
}, ref) => {
const scrollerRef = useRef();
const onLoaderHandlerRef = useRef(onLoader);
onLoaderHandlerRef.current = onLoader;
const canLoadRef = useRef(!noMore && !isLoading);
canLoadRef.current = !noMore && !isLoading;
useImperativeHandle(ref, () => {
return scrollerRef.current;
}, []);
useEffect(() => {
if (canLoadRef.current && scrollerRef.current.clientHeight === scrollerRef.current.scrollHeight) {
onLoaderHandlerRef.current();
}
}, [isLoading]);
useEffect(() => {
const el = scrollerRef.current;
const scrollHandler = throttle((e) => {
const el = e.target;
if (canLoadRef.current && el.clientHeight + el.scrollTop + 20 > el.scrollHeight) {
onLoaderHandlerRef.current();
}
}, 100);
el.addEventListener('scroll', scrollHandler, true);
return () => {
el.removeEventListener('scroll', scrollHandler, true);
};
}, []);
return
{children}
{isLoading ? : null}
{noMore ? {completeTips} : null}
;
});
const Remote = createWithFetch({
url: '/data2',
params: {page: 1, size: 10}
})(({data, isComplete, requestParams, loadMore}) => {
return = Math.ceil(data.total / requestParams.params.size)}
onLoader={() => {
return loadMore({
params: {page: requestParams.params.page + 1}
}, (data, newData) => {
return Object.assign({}, newData, {
list: data.list.concat(newData.list)
});
});
}} completeTips="加载完成">
{data.list.map((item, index) => {
return {item.title}
})}
;
});
render();
```
- 空数据
- 用isEmpty判断数据是不是空状态
- ReactFetch(@kne/current-lib_react-fetch),antd(antd)
```jsx
const {createWithFetch} = ReactFetch;
const {List} = antd;
const Remote = createWithFetch({
url: '/data1',
isEmpty: () => true
})(({data}) => {
return
{data.map((item, index) => {
return {item.title}
})}
;
});
render();
```
- 用loader加载数据
- 展示了用loader来加载数据的例子
- ReactFetch(@kne/current-lib_react-fetch)
```jsx
const {createWithFetch} = ReactFetch;
const Example = createWithFetch({
loader: async (data) => {
return await new Promise((resolve, reject) => {
setTimeout(() => {
resolve(Object.assign({}, data, {message: '请求成功'}));
}, 1000);
});
}
})(({data,requestParams}) => {
console.log(requestParams);
return JSON.stringify(data, null, 2);
});
render();
```
- transform
- 展示transformResponse的调用
- ReactFetch(@kne/current-lib_react-fetch),antd(antd)
```jsx
const {createWithFetch} = ReactFetch;
const {List} = antd;
const Remote = createWithFetch({
url: '/data1',
transformResponse: (response) => {
console.log(response);
return {
data:{
code: 200, results: [
{title: '我是response被拦截以后的内容'}
]
}
};
}
})(({data}) => {
return
{data.map((item, index) => {
return {item.title}
})}
;
});
render();
```
- 缓存操作
- 展示缓存操作
- ReactFetch(@kne/current-lib_react-fetch),antd(antd)
```jsx
const {createWithFetch, getCache} = ReactFetch;
const {List,Space,Button} = antd;
const {useRef} = React;
const Remote = createWithFetch({
url: '/data1',
cache: 'cache'
})(({data}) => {
return
{data.map((item, index) => {
return {item.title}
})}
;
});
const cache = getCache();
const Example = () => {
const ref = useRef();
return
{
ref.current.reload({}, false);
}}>获取数据
{
cache.delByCacheName('cache');
}}>清除缓存
;
};
render();
```
- 忽略请求成功状态
- 发送一个成功请求，内部组件拿到数据并展示数据
- ReactFetch(@kne/current-lib_react-fetch),antd(antd)
```jsx
const {createWithFetch} = ReactFetch;
const {List} = antd;
const Remote = createWithFetch({
url: '/data3', ignoreSuccessState: true
})(({data}) => {
return
{data.map((item, index) => {
return {item.title}
})}
;
});
render();
```
- url params
- 发送一个成功请求，内部组件拿到数据并展示数据
- ReactFetch(@kne/current-lib_react-fetch),antd(antd)
```jsx
const {createWithFetch} = ReactFetch;
const {List} = antd;
const Remote = createWithFetch({
url: '/data{id}', urlParams: {
id: 1
}
})(({data}) => {
return
{data.map((item, index) => {
return {item.title}
})}
;
});
render();
```
### API
#### Fetch
| 属性名 | 说明 | 类型 | 默认值 |
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------|
| url | 需要请求接口的url | string | - |
| data | POST请求的data | object | - |
| params | GET请求的query | object | - |
| options | 请求的其他参数，如method,headers等，详细请参考[axios](https://github.com/axios/axios) | - |
| loading | 在请求发出后没有返回结果时渲染的组件 | jsx | null |
| error | 请求返回后code不为200时渲染的组件，如果传入函数，参数中会接收到请求返回的错误msg | jsx|function | null |
| empty | 请求未发出时渲染的组件 | jsx | null |
| isEmpty | 判断响应数据是否是空状态 | boolean | - |
| auto | 是否自动发送请求，如果为false需要手动调用refresh方法才会发送请求，并且url,data,options发生变化后不会自动发送新的请求 | bool | true |
| component | 请求返回成功时需要渲染的组件 | jsx | - |
| render | 请求返回成功时执行的方法，改方法需要返回jsx，参数可以拿到{data,refresh,setData}，当存在component时改方法不会被执行 | function | - |
| loader | 当该参数存在时，组件会优先执行loader去获取数据，而不会用ajax去发送请求，注意其请求的返回结果页不会transformResponse转换，也不会通过结果的code去判断请求是否成功，如果loader返回的Promise为resolve就判定为请求成功。其返回数据也会原样传给组件的data不会再data.results取值 | function | - |
| ajax | 通常情况下你不需要传入这个参数,该参数默认取preset中的ajax。当你需要一个完全不同于全局的ajax发送请求的时候可以通过该参数为此组件设置一个新的ajax对象 | axios object | - |
| transformResponse | 通常情况下你不需要传入这个参数,该参数默认取preset中的transformResponse。当你需要一个完全不同于全局的响应数据转换器的时候可以通过该参数为此组件设置 | function | - |
| transformData | 转换data返回值函数，它在拿到transformResponse返回结果之后执行 | function | - |
#### withFetch
高阶组件 Fetch组件的封装 withFetch(WrappedComponent) WrappedComponent为一个React Component,等价于给Fetch传入component参数
#### createWithFetch
withFetch的高阶函数，可以将部分参数提前传入，不必在调用withFetch(WrappedComponent) 时再传入参数
#### useFetch
React Hooks
参数 useFetch(options)
options:
| 属性名 | 说明 | 类型 | 默认值 |
|--------------------|----------------------------------------------------------------------------|----------|-------|
| url | 需要请求接口的url | string | - |
| data | POST请求的data | object | - |
| params | GET请求的query | object | - |
| options | 请求的其他参数，如method,headers等，详细请参考[axios](https://github.com/axios/axios) | object | - |
| urlParams | url模板参数,当url为 /example/{id}且传入urlParams为{id:123},真正发出请求的url为: /example/123 | object | - |
| ignoreSuccessState | 当且仅当该参数为true时在output阶段不再判断返回数据的code===200为请求成功，且返回data不再取results而是返回data本身 | boolean | - |
| auto | 是否自动发送请求，如果为false需要手动调用refresh方法才会发送请求，并且url,data,options发生变化后不会自动发送新的请求 | boolean | true |
| debug | 是否开启调试，开启以后可以在控制台打印整个组件的plugin执行堆栈，可以帮助排查问题 | boolean | false |
| onRequestStart | 请求开始时回调方法 | function | - |
| onRequestError | 请求发生错误时回调方法 | function | - |
| onRequestSuccess | 请求成功时回调方法 | function | - |
| onRequestComplete | 请求完成时（包括成功和失败）的回调方法 | function | - |
返回值
| 属性名 | 说明 | 类型 |
|---------------|---------------------------------------------------------------------------------------------------------------------------------------------|----------|
| isLoading | 当前fetch组件是否正在加载 | boolean |
| isComplete | 当前fetch组件是否已完成 | boolean |
| error | 当前组件的请求错误信息 | boolean |
| data | 当前组件的请求返回数据 | - |
| refresh | 可以调用它手动重新发送请求的方法 | function |
| reload | 可以调用它手动重新发送请求的方法和refresh的差异在于，reload在请求响应返回之前不会写在掉当前页面，当请求响应返回后对内层组件做数据更新操作，refresh则会在请求发送后切换到loading状态，请求响应返回后内层组件走重新install操作 | func |
| setData | 可以调用它给fetch中保存值的state赋值 | function |
| requestParams | 当前请求的实际参数 | object |-|
| fetchProps | Fetch组件接受到的请求参数,它和requestParams的区别在于，只有当Fetch的参数发生修改fetchProps的值会修改，通过send，reload,refresh修改请求参数，fetchProps的值不会修改，requestParams却始终时实际发送请求的参数 | object |-|
#### preset 预制设置的方法 preset(options)
options
| 属性名 | 说明 | 类型 | 默认值 |
|-------------------|----------------------------------------------------|-------------------|------|
| ajax | axios实例 | object | - |
| loading | 在请求发出后没有返回结果时渲染的组件 | jsx | null |
| error | 请求返回后code不为200时渲染的组件，如果传入函数，参数中会接收到请求返回的错误msg | jsx|function | null |
| empty | 请求未发出时渲染的组件 | jsx | null |
| transformResponse | 请求转换器，参数为response返回值为response需要在此方法将请求返回结果转换成规定的格式 | function | - |
#### 缓存接口的应用
Fetch options
| 属性名 | 说明 | 类型 | 默认值 |
|---------|---------------------------------------------------------------------|---------------------|-------|
| cache | 为true或者为字符串的时候为开启缓存，如果请求参数完全一致则命中缓存。如果cache为字符串，只有cahce一致的组件之间会命中缓存 | boolean|string | - |
| ttl | 缓存失效时间，为0的时候不失效，单位为毫秒 | number | 0 |
| isLocal | 缓存是否存储到localStorge | bool | false |
### request
导出一个行为，参数和Fetch一致的方法，调用后发送一个ajax请求
使用方法
```js
request(props)
```