@extremelyjs/store
v1.3.6
Published
a store for react
Downloads
80
Readme
一种全新的store库
之前叫@apiknight/store,现已更名
采用了发布订阅的设计模式,同时提供了大量React hooks,以一种新思路来管理状态,不再需要维护type和reducer,可以实现类似useState,setState式的使用方式。
同时具备了异步更新能力和持久化存储能力,同时采用ts开发,具备了完善的类型提示。
优势
相比其他状态管理库,采用了类useState,setState的思想。同时天然支持了良好的异步更新,持久化存储等能力。
写法上更加自由,心智负担更小,同时可以结合异步请求,异步事件,loading订阅和值订阅。来进一步优化代码结构,建立起统一的代码规范。
对比其他竞品状态管理库
- Redux Redux 是一个流行的 JavaScript 状态管理库,它采用单向数据流和可预测的状态更新机制。然而,与 @extremelyjs/store 相比,Redux 在某些方面可能显得更为复杂:
概念复杂度:Redux 引入了 action、reducer 和 store 等概念,需要开发者理解和遵循一定的规范。相比之下,@extremelyjs/store 提供了更简洁的 API,减少了概念上的负担。
异步处理:Redux 本身并不直接支持异步操作,通常需要结合额外的中间件(如 redux-thunk 或 redux-saga)来处理。而 @extremelyjs/store 内置了异步更新能力,通过 loadStoreValue 等 API 可以方便地处理异步操作。
类型安全:虽然 Redux 可以与 TypeScript 结合使用以提供类型安全,但 @extremelyjs/store 本身采用 TypeScript 开发,提供了更完善的类型提示和类型安全。
持久化存储:Redux 需要额外的配置和库支持才能实现状态的持久化存储。@extremelyjs/store 则内置了持久化能力,只需简单配置即可使用。
- Zustand Zustand 是一个轻量级且灵活的状态管理库,它允许你在单个 store 中存储多个独立的状态片段。与 @extremelyjs/store 相比Zustand:
轻量级与灵活性:Zustand 非常轻量级,并且提供了灵活的 API 来管理状态。然而,@extremelyjs/store 也致力于提供简洁和灵活的 API,同时在异步处理和持久化方面提供了更多内置功能。
异步与持久化:与 Redux 类似,Zustand 本身不直接支持异步操作和持久化存储。虽然可以通过扩展来实现这些功能,但 @extremelyjs/store 已经内置了这些能力。
类型安全:Zustand 可以与 TypeScript 结合使用,但 @extremelyjs/store 在类型安全方面可能更为出色,因为它本身采用 TypeScript 开发。
- MobX MobX 是另一个流行的状态管理库,它使用可观察对象和自动跟踪机制来简化状态管理。与 @extremelyjs/store 相比:
概念与复杂性:MobX 引入了可观察对象、观察者和动作等概念。虽然这些概念使得状态管理变得直观和强大,但也增加了一定的学习成本。@extremelyjs/store 则通过更简洁的 API 和发布订阅模式来降低复杂性。
异步与持久化:MobX 本身不直接处理异步操作和持久化存储,需要开发者自行实现或结合其他库。而 @extremelyjs/store 提供了内置的异步更新和持久化能力。
类型安全:虽然 MobX 可以与 TypeScript 结合使用以提供类型安全,但如前所述,@extremelyjs/store 在这方面可能更为出色。
综上所述,@extremelyjs/store 在提供简洁灵活的 API、内置异步更新与持久化能力以及出色的类型安全方面表现出色。这使得它在与其他竞品状态管理库的比较中具有一定的优势。
文档
下面是React Hooks的使用文档。class组件的使用暂没有良好的支持。
安装
npm install @extremelyjs/store --save
使用方式
要求:
- React Hooks版本
- 如果需要本地持久化存储,需要在有localStorage或者ReactNative的环境下使用
入门
使用上类似React Hooks中的useState。可以使用use订阅信息,使用set修改信息。其中,set可以传递数值或者回调
// 创建num.ts这个store
import { createMapperHooksStore } from '@extremelyjs/store'
const numStore = createMapperHooksStore<number>(0)
export const useNum = numStore.useStoreValue // 监听state变化
export const setNum = numStore.setStoreValue // 修改state,支持value或者callback
export const resetNum = numStore.reset // 重置state
使用这个store
function App() {
const num = useNum(); //订阅num状态
const handleClick = useCallback(() => {
setNum(value => value + 1);
},[])
const handleChangeValue = useCallback(
() => {
setNum(10);
},[]
)
return (
<div>
{num}
<button onClick={
handleClick
}>
+
</button>
<button onClick={handleChangeValue}>
change num 10
</button>
</div>
)
}
局部更新能力
用户在订阅一个大对象的时候,一些场景下只关注对象的一个属性,全量更新下会带来性能问题。
所以支持了局部更新能力。
import { createMapperHooksStore } from "@extremelyjs/store/src/index";
interface MyInfo {
id: string;
name: string;
age: number;
address: string;
}
const testObjectStore = createMapperHooksStore<MyInfo>({
id: '1',
name: "zhangsan",
age: 18,
address: "beijing"
});
export const useTestObject = testObjectStore.useStoreValue;
export const setTestObject = testObjectStore.setStoreValue;
创建上还是正常的创建方式。
使用上我们可以传递类型和selctor函数来实现只订阅局部更新的变化。
const userInfo = useTestObject<string>((value) => value?.id); // 只订阅id的变化
持久化
对于支持localStorage的环境,可以使用持久化能力。
const num = createMapperHooksStore<number>(0, {withLocalStorage: 'keyName'}) // keyName为自定义id
rn环境下,需要加上是rn的标志
import { AsyncStorage } from '@react-native-async-storage/async-storage';
const num = createMapperHooksStore<number>(0, {withLocalStorage: 'keyName',local: AsyncStorage}) // keyName为自定义id
异步更新能力
对于异步更新,可以使用异步更新能力。
import { createMapperHooksStore } from "@extremelyjs/store";
import fetchCurrentPageContent from "../api/fetchCurrentPageContent";
import { PageDataParams } from "../type/params";
const pageDataStore = createMapperHooksStore<string,PageDataParams>('', { withLocalStorage: 'page-data-new' });
export const usePageData = pageDataStore.useStoreValue; // 订阅state变化
export const usePageDataLoading = pageDataStore.useStoreLoading; // 订阅Loding状态
// 异步更新,支持传入参数
export const loadPageData = pageDataStore.loadStoreValue(
params => params,
fetchCurrentPageContent
);
loading订阅
对于异步请求更新,可以使用loading订阅。
我们可以写一个纯粹的请求函数,然后使用loadStoreValue来自动更新状态,后续的更新会在内部完成。
同时我们也可以订阅他的loading态,无需额外的代码。
import { createMapperHooksStore } from "@extremelyjs/store";
import fetchCurrentPageContent from "../api/fetchCurrentPageContent";
import { PageDataParams } from "../type/params";
export interface PageData {
id: number;
title: string;
content: string;
}
const pageDataStore = createMapperHooksStore<string,PageDataParams>('', { withLocalStorage: 'page-data-new' });
export const usePageData = pageDataStore.useStoreValue;
// 订阅Loding状态
export const usePageDataLoading = pageDataStore.useStoreLoading;
export const loadPageData = pageDataStore.loadStoreValue(
params => params,
fetchCurrentPageContent
);
// 使用
const loading = usePageDataLoading();
异步任务订阅
我们还提供了load
的api来订阅异步任务。
function mockPromiseArray() {
// 模拟十个异步任务,返回数字
const arr: Promise<string>[] = []
for (let i = 0; i < 10; i++) {
arr.push(new Promise((resolve) => {
setTimeout(() => resolve(String(i)), 1000 * i);
}))
}
return arr;
}
// store文件
import { createMapperHooksStore } from "@extremelyjs/store/src/index";
const testAsyncStore = createMapperHooksStore<string>("",{strategy: "acceptSequenced"});
export const useTestAsync = testAsyncStore.useStoreValue;
export const loadTestAsync = testAsyncStore.load;
// react组件
const testAsync = useTestAsync();
同时我们还支持四种异步更新策略
你可以使用 strategy
配置异步策略,目前提供了四种异步策略:
| 策略 | 描述 |
| --- | --- |
| acceptFirst
| 在多个异步任务同时发出的情况下,只接受第一个成功的结果。如果已经有成功的返回,则后续请求不再发出。 |
| acceptLatest
| 在多个异步任务同时发出的情况下,只接受最后一个发出的任务的结果,成功或失败。 |
| acceptEvery
| 在多个异步任务同时发出的情况下,接受所有的返回,按照到达的顺序处理。由于到达的顺序可能是乱序,你需要处理乱序导致的问题。 |
| acceptSequenced
| 在多个异步任务同时发出的情况下,按照任务发出的顺序,接受结果,当中间的任务到达时,则不再接受此任务之前发起的任务的结果,但依旧等待后续发出的结果。 |
默认使用 acceptSequenced
的策略,这个策略满足绝大多数情况,在你需要特别的优化的时候,你可以选择其他的策略。
直接取值
我们还提供了getStoreValue
和getStoreLoading
来直接取值。
Todo
完善文档
更好的错误提示
测试用例的完善