context-state

unstated

简单、优雅的 React hooks 状态管理方案

• React Hooks 适用于 React Hooks 组件
• 专注性能 减少额外 rerender，运行畅快
• 1KB min+gz
• 无依赖 仅仅使用了 React，无第三方库的依赖
• 简单 只需会 React Hooks，即可上手
• TypeScript 编写 完备的类型提示，轻松编写代码
• 容易集成 可渐进式引入，与其他状态管理共存
• 通用 组件、模块、应用以及服务端渲染
• 灵活 基于 Context，轻松组合 Provider
• 轻松迁移 它基于自定义 Hooks 创建

安装

npm install --save context-state

Example

import React from 'react';
import { createContainer, useFunction } from 'context-state';

function useCounter() {
  const [count, setCount] = React.useState(0);
  const increment = useFunction(() => setCount((c) => c + 1));

  return {
    count,
    increment,
  };
}

const CounterContainer = createContainer(useCounter);

function CounterDisplay() {
  const { count, increment } = CounterContainer.usePicker(['count', 'increment']);

  return (
    <div>
      {count}
      <button type="button" onClick={increment}>
        ADD
      </button>
    </div>
  );
}

function App() {
  return (
    <CounterContainer.Provider>
      <CounterDisplay />
    </CounterContainer.Provider>
  );
}

render(<App />, document.getElementById('root'));

API

createContainer(useHook)

import { createContainer, useFunction } from 'context-state';

function useCustomHook() {
  const [value, setInput] = useState();
  const onChange = useFunction((e) => setValue(e.currentTarget.value));
  return {
    value,
    onChange,
  };
}

const Container = createContainer(useCustomHook);
// Container === { Provider, usePicker }

<Container.Provider>

function ParentComponent() {
  return (
    <Container.Provider>
      <ChildComponent />
    </Container.Provider>
  );
}

<Container.Provider initialState>

function useCustomHook(initialState = '') {
  const [value, setValue] = useState(initialState);
  // ...
}

function ParentComponent() {
  return (
    <Container.Provider initialState="value">
      <ChildComponent />
    </Container.Provider>
  );
}

Container.useSelector()

监听当前容器中选择后的值，若值发生改变，则触发 rerender

function ChildComponent() {
  const value = Container.useSelector((state) => state.value);
  return <span>{value}</span>;
}

Container.usePicker()

useSelector 的语法糖，更常用的写法

function ChildComponent() {
  const { value } = Container.usePicker(['value']);
  return <span>{value}</span>;
}

Container.withPicker()

usePicker 的高阶组件形式

function ChildComponent({ value }) {
  return <span>{value}</span>;
}

Container.withPicker(ChildComponent, ['value']);

useFunction

持久化 function 的 Hook。（来自 ahooks 中 usePersistFn）

你可能会需要用 useCallback 记住一个回调，但由于内部函数必须经常重新创建，记忆效果不佳，导致子组件重复 render。对于复杂的子组件，重新渲染会对性能造成影响。通过 useFunction，可以保证函数地址永远不会变化。

性能提示

context-state 的灵感来自于 unstated-next，并解决了 unstated-next 中导致的 context 穿透的性能问题，而无需过量抽象组合优化组件。 在大型模块/项目中性能极其重要，它能为我们节省大量的调优时间。

导出成员记忆化

在 React Hooks 中，每一次 setState 会重新执行一遍当前的 function，也就是 rerender。在这个特性下，组件的内部 function 也会随着 rerender 而重新创建，表达式也会重新执行，useMemo 、useCallBack 也因此而存在。

context-state 的记忆特性也与 React 保持一致。在下方 useCounter 返回值中，函数需要 useFunction 包裹才能达到记忆效果。因此需要注意：不要导出会随着每次 render 而重新创建的可变对象。context-state 无需优化，所有你要做的优化，都是标准的 React 优化。

function useCounter() {
  const [count, setCount] = React.useState(0);
  const increment = useFunction(() => setCount((c) => c + 1));

  return {
    count,
    increment,
  };
}

const Counter = createContainer(useCounter);

使用 memo & useMemo 减少性能损耗

常规组件中，默认情况下父组件的 rerender 也会穿透到所有的子组件中，层级多计算量大的情况下则会出现性能问题。虽然 usePicker 已经阻止了来自不相关状态变化而导致的 rerender，但是穿透渲染的情况依然会导致优化没有效果（木桶原理）。这时需要搭配 React.memo 来阻止不必要的渲染，由于 React.memo 是浅对比， 传递给子组件的参数中也不能带有可变对象，这时需要 React.useMemo 来保持参数不可变。

const CustomComponent = React.memo(() => {
  const { value } = Container.usePicker(['value']);
  const style = React.useMemo(() => ({ width: value } as React.CSSProperties), [value]);
  return <ChildComponent style={style} />;
});

TODO

• 测试用例
• 完善example
• 继承项目的process.env