51工具盒子

依楼听风雨
笑看云卷云舒,淡观潮起潮落

如何在React中使用自定义钩子在卸载时保存到上下文中?

英文:

How to save to context in custom hook on unmount in React?

问题 {#heading}

我有以下简化的自定义钩子:

function useSpecialState(defaultValue, key) {
  const { stateStore, setStateStore } = useContext(StateStoreContext);

  const [state, setState] = useState(
    stateStore[key] !== undefined ? stateStore[key] : defaultValue
  );

  const stateRef = useRef(state);

  useEffect(() => {
    stateRef.current = state;
  }, [state]);

  useEffect(() => {
    return () => {
      setStateStore((prevStateStore) => ({
        ...prevStateStore,
        [key]: stateRef.current,
      }));
    };
  }, []);

  return [state, setState];
}

目标是在卸载时保存到上下文,但是这段代码不起作用。将 state 放在负责保存到上下文的 useEffect 的依赖数组中不是一个好的解决方案,因为那样会在每次状态更改时保存,这是不必要的。

上下文:

const StateStoreContext = createContext({
  stateStore: {},
  setStateStore: () => {},
});

父组件:

function StateStoreComponent(props) {
  const [stateStore, setStateStore] = useState({});

  return (
    <StateStoreContext.Provider value={{ stateStore, setStateStore }}>
      {props.children}
    </StateStoreContext.Provider>
  );
}

英文:

I have the following simplified custom hook:

function useSpecialState(defaultValue, key) {
  const { stateStore, setStateStore } = useContext(StateStoreContext);

  const [state, setState] = useState(
    stateStore[key] !== undefined ? stateStore[key] : defaultValue
  );

  const stateRef = useRef(state);

  useEffect(() =&gt; {
    stateRef.current = state;
  }, [state]);

  useEffect(() =&gt; {
    return () =&gt; {
      setStateStore((prevStateStore) =&gt; ({
        ...prevStateStore,
        [key]: stateRef.current,
      }));
    };
  }, []);

  return [state, setState];
}

The goal would be to save to a context on unmount, however, this code does not work. Putting state in the dependency array of the useEffect which is responsible for saving to context would not be a good solution, because then it would be saved on every state change, which is grossly unnecessary.

The context:

const StateStoreContext = createContext({
  stateStore: {},
  setStateStore: () =&gt; {},
});

The parent component:

function StateStoreComponent(props) {
  const [stateStore, setStateStore] = useState({});

  return (
    &lt;StateStoreContext.Provider value={{ stateStore, setStateStore }}&gt;
      {props. Children}
    &lt;/StateStoreContext.Provider&gt;
  );
}

答案1 {#1}

得分: 4

TL;DR {#tldr}

你的代码是正确的,技术上是正确的,观察到的行为是由于在非生产环境中React.StrictMode组件双重挂载组件导致的。换句话说,你部署的正常生产环境中,代码和逻辑应该按照你的期望工作。这是所有预期的行为。

解释 {#heading-1}

你的代码是正确的,技术上是正确的。之所以看起来不起作用是因为你在React的StrictMode组件中渲染应用程序,它在非生产环境中执行额外的行为。具体来说,在这种情况下,它是为了检查Ensuring Reusable StateFixing bugs found by re-running Effects而双重挂载组件。

严格模式也可以帮助发现Effects中的错误。

每个Effect都有一些设置代码和可能有一些清理代码。
通常情况下,React在组件挂载(添加到屏幕上)时调用设置,并在组件卸载(从屏幕上移除)时调用清理。然后,如果它的依赖关系在上一次渲染之后发生了变化,React会再次调用清理和设置。

当启用Strict Mode时,在开发中,React还会为每个Effect运行一个额外的设置+清理周期。这可能会感到意外,但它有助于发现手动难以捕捉的细微错误。

React.StrictMode组件内渲染的任何组件并使用自定义的useSpecialState钩子将被挂载、卸载并运行第二个useEffect钩子的清理函数,这将更新上下文中的状态,然后再次挂载组件。

以下是一个小示例,切换使用useSpecialState钩子的相同组件的挂载,其中只有一个组件在React.StrictMode组件中挂载。请注意,"Component A"在每次挂载***和***卸载时都会更新上下文状态,而"Component B"仅在卸载时更新上下文状态。

如何在React中使用自定义钩子在卸载时保存到上下文中?

如何在React中使用自定义钩子在卸载时保存到上下文中?

步骤:

  1. 应用程序挂载,上下文渲染为0
  2. 切换A挂载:观察挂载/卸载/挂载,状态更新为A,上下文渲染为1
  3. 切换B挂载:观察挂载,无状态更新
  4. 切换A卸载:观察卸载,状态更新为A,上下文渲染为2
  5. 切换B卸载:观察卸载,状态更新为B,上下文渲染为3

沙盒代码:

const MyComponent = ({ label }) => {
  const [count, setCount] = useSpecialState(0, "count" + label);

  return (
    <>
      <h1>Component{label}</h1>
      <div>Count: {count}</div>
      <button type="button" onClick={() => setCount((c) => c + 1)}>
        +
      </button>
    </>
  );
};

export default function App() {
  const [mountA, setMountA] = useState(false);
  const [mountB, setMountB] = useState(false);
  return (
    <StateStoreComponent>
      <div className="App">
        <h1>Hello CodeSandbox</h1>
        <h2>Start editing to see some magic happen!</h2>

        <div>
          <button type="button" onClick={() => setMountA((mount) => !mount)}>
            {mountA ? "Unmount" : "Mount"} A
          </button>
          <button type="button" onClick={() => setMountB((mount) => !mount)}>
            {mountB ? "Unmount" : "Mount"} B
          </button>
        </div>
        <StrictMode>{mountA && <MyComponent label="A" />}</StrictMode>
        {mountB && <MyComponent label="B" />}
      </div>
    </StateStoreComponent>
  );
}

英文:

TL;DR {#tldr-1}

The code you have is fine and technically correct, the observed behavior is caused by the React.StrictMode component double-mounting components in non-production builds. In other words, the code & logic should behave as you expect in normal production builds you deploy. This is, or should be, all expected behavior.

Explanation {#explanation}

The code you have is fine and technically correct. The reason it appears that it is not working is because you are rendering the app within the React StrictMode component which executes additional behavior in non-production builds. Specifically in this case it's the double-mounting of components as part of React's check for Ensuring Reusable State or Fixing bugs found by re-running Effects if you prefer the current docs.

> Strict Mode can also help find bugs in Effects.
>
> Every Effect has some setup code and may have some cleanup code.
> Normally, React calls setup when the component mounts (is added to the
> screen) and calls cleanup when the component unmounts (is removed from
> the screen). React then calls cleanup and setup again if its
> dependencies changed since the last render.
>
> When Strict Mode is on, React will also run one extra setup+cleanup > cycle in development for every Effect . This may feel surprising, but
> it helps reveal subtle bugs that are hard to catch manually.

Any component rendered within a React.StrictMode component and using the custom useSpecialState hook will be mounted, unmounted and run the second useEffect hook's cleanup function which will update the state in the context, and then mount again the component.

Here's a small demo toggling the mounting of identical components that use the useSpecialState hook, where only one of them is mounted within a React.StrictMode component. Notice that "Component A" updates the context state each time when it is mounted and unmounted, while "Component B" updates the context state only when it unmounts.

如何在React中使用自定义钩子在卸载时保存到上下文中?

如何在React中使用自定义钩子在卸载时保存到上下文中?

Steps:

  1. App mounts, context render 0
  2. Toggle A mounted: observe mount/unmount/mount, state update A, context render 1
  3. Toggle B mounted: observe mount, no state update
  4. Toggle A unmounted: observe unmount, state update A, context render 2
  5. Toggle B unmounted: observe unmount, state update B, context render 3

Sandbox Code:

const MyComponent = ({ label }) =&gt; {
  const [count, setCount] = useSpecialState(0, &quot;count&quot; + label);

  return (
    &lt;&gt;
      &lt;h1&gt;Component{label}&lt;/h1&gt;
      &lt;div&gt;Count: {count}&lt;/div&gt;
      &lt;button type=&quot;button&quot; onClick={() =&gt; setCount((c) =&gt; c + 1)}&gt;
        +
      &lt;/button&gt;
    &lt;/&gt;
  );
};

export default function App() {
  const [mountA, setMountA] = useState(false);
  const [mountB, setMountB] = useState(false);
  return (
    &lt;StateStoreComponent&gt;
      &lt;div className=&quot;App&quot;&gt;
        &lt;h1&gt;Hello CodeSandbox&lt;/h1&gt;
        &lt;h2&gt;Start editing to see some magic happen!&lt;/h2&gt;

        &lt;div&gt;
          &lt;button type=&quot;button&quot; onClick={() =&gt; setMountA((mount) =&gt; !mount)}&gt;
            {mountA ? &quot;Unmount&quot; : &quot;Mount&quot;} A
          &lt;/button&gt;
          &lt;button type=&quot;button&quot; onClick={() =&gt; setMountB((mount) =&gt; !mount)}&gt;
            {mountB ? &quot;Unmount&quot; : &quot;Mount&quot;} B
          &lt;/button&gt;
        &lt;/div&gt;
        &lt;StrictMode&gt;{mountA &amp;&amp; &lt;MyComponent label=&quot;A&quot; /&gt;}&lt;/StrictMode&gt;
        {mountB &amp;&amp; &lt;MyComponent label=&quot;B&quot; /&gt;}
      &lt;/div&gt;
    &lt;/StateStoreComponent&gt;
  );
}

答案2 {#2}

得分: 1

我尝试了您的useSpecialState钩子,它似乎按预期正常工作。
从我的理解,您需要在组件卸载时保存上一个状态值到上下文中。
我创建了一个子组件来increment计数器,另一个toggle按钮用于挂载和卸载CounterComponent,同时保持上一次卸载时的计数器值。

以下是我尝试的方式。可工作的CodeSandbox链接

import React, {
  useState,
  useRef,
  useEffect,
  useContext,
  createContext
} from "react";
import "./styles.css";

const StateStoreContext = createContext({
  stateStore: {},
  setStateStore: () => {}
});

function StateStoreComponent(props) {
  const [stateStore, setStateStore] = useState({});

  return (
    <StateStoreContext.Provider value={{ stateStore, setStateStore }}>
      {props.children}
    </StateStoreContext.Provider>
  );
}

function useSpecialState(defaultValue, key) {
  const { stateStore, setStateStore } = useContext(StateStoreContext);

  const [state, setState] = useState(
    stateStore[key] !== undefined ? stateStore[key] : defaultValue
  );

  const stateRef = useRef(state);

  useEffect(() => {
    console.log("child state change ---> ");
    stateRef.current = state;
  }, [state]);

  useEffect(() => {
    console.log("mount ---> ");
    return () => {
      console.log("un-mount <--- ");
      console.log("prevStateStore ", stateStore);
      console.log("persistState :: ", key, stateRef.current);
      setStateStore((prevStateStore) => ({
        ...prevStateStore,
        [key]: stateRef.current
      }));
    };
  }, []);

  return [state, setState];
}

const CounterComponent = () => {
  const [counter, setCounter] = useSpecialState(0, "counter");

  return (
    <>
      <h1>Hello CodeSandbox Counter: {counter}</h1>
      <button onClick={() => setCounter((prev) => prev + 1)}>increment</button>
      <br />
      <br />
      <br />
    </>
  );
};

export default function App() {
  const [visible, setVisible] = useSpecialState(true, "visible");

  return (
    <div className="App">
      <StateStoreComponent>
        {visible && <CounterComponent />}
        <button onClick={() => setVisible(!visible)}>toggle</button>
      </StateStoreComponent>
    </div>
  );
}

英文:

I tried your useSpecialState hook and It seems to work fine as expected.
From what I understand that you needed to save the last state value in the context when the component un-mounts.
I created a child component that increment the counter and another toggle button which mounts and un-mounts that CounterComponent while persisting the counter value from the last un-mount.

Here is how I tried it. Working codesandbox

import React, {
useState,
useRef,
useEffect,
useContext,
createContext
} from &quot;react&quot;;
import &quot;./styles.css&quot;;
const StateStoreContext = createContext({
stateStore: {},
setStateStore: () =&gt; {}
});
function StateStoreComponent(props) {
const [stateStore, setStateStore] = useState({});
return (
&lt;StateStoreContext.Provider value={{ stateStore, setStateStore }}&gt;
{props.children}
&lt;/StateStoreContext.Provider&gt;
);
}
function useSpecialState(defaultValue, key) {
const { stateStore, setStateStore } = useContext(StateStoreContext);
const [state, setState] = useState(
stateStore[key] !== undefined ? stateStore[key] : defaultValue
);
const stateRef = useRef(state);
useEffect(() =&gt; {
console.log(&quot;child state change ---&gt; &quot;);
stateRef.current = state;
}, [state]);
useEffect(() =&gt; {
console.log(&quot;mount ---&gt; &quot;);
return () =&gt; {
console.log(&quot;un-mount &lt;--- &quot;);
console.log(&quot;prevStateStore &quot;, stateStore);
console.log(&quot;persistState :: &quot;, key , stateRef.current);
setStateStore((prevStateStore) =&gt; ({
...prevStateStore,
[key]: stateRef.current
}));
};
}, []);
return [state, setState];
}
const CounterComponent = () =&gt; {
const [counter, setCounter] = useSpecialState(0, &quot;counter&quot;);
return (
&lt;&gt;
&lt;h1&gt;Hello CodeSandbox Counter: {counter}&lt;/h1&gt;
&lt;button onClick={() =&gt; setCounter((prev) =&gt; prev + 1)}&gt;increment&lt;/button&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;/&gt;
);
};
export default function App() {
const [visible, setVisible] = useSpecialState(true, &quot;visible&quot;);
return (
&lt;div className=&quot;App&quot;&gt;
&lt;StateStoreComponent&gt;
{visible &amp;&amp; &lt;CounterComponent /&gt;}
&lt;button onClick={() =&gt; setVisible(!visible)}&gt;toggle&lt;/button&gt;
&lt;/StateStoreComponent&gt;
&lt;/div&gt;
);
}

赞(1)
未经允许不得转载:工具盒子 » 如何在React中使用自定义钩子在卸载时保存到上下文中?