【问题标题】:Potential bug in "official" useInterval example“官方” useInterval 示例中的潜在错误
【发布时间】:2021-09-25 03:37:42
【问题描述】:

使用间隔

useInterval 来自this blog post by Dan Abramov (2019):

function useInterval(callback, delay) {
  const savedCallback = useRef();

  // Remember the latest callback.
  useEffect(() => {
    savedCallback.current = callback;
  }, [callback]);

  // Set up the interval.
  useEffect(() => {
    function tick() {
      savedCallback.current();
    }
    if (delay !== null) {
      let id = setInterval(tick, delay);
      return () => clearInterval(id);
    }
  }, [delay]);
}

一个潜在的错误

间隔回调可能会在提交阶段和useEffect 调用之间被调用,从而导致旧的(因此不是最新的)回调被调用。换句话说,这可能是执行顺序:

  1. 渲染阶段 - callback 的新值。
  2. 提交阶段 - 提交到 DOM 的状态。
  3. useLayoutEffect
  4. 间隔回调 - 使用savedCallback.current(),与callback不同。
  5. useEffect - savedCallback.current = callback;

React 的生命周期

为了进一步说明这一点,这里是a diagram showing React's Life Cycle with hooks:

虚线表示异步流(事件循环已释放),您可以在这些点进行间隔回调调用。

但是请注意,Render 和 React updates DOM(提交阶段)之间的虚线很可能是 a mistake。正如this codesandbox 演示的那样,您只能在useLayoutEffect 或useEffect 之后调用间隔回调(但不能在渲染阶段之后)。

所以你可以在 3 个地方设置回调:

  • 渲染 - 不正确,因为状态更改尚未提交到 DOM。
  • useLayoutEffect - 正确,因为状态更改已提交到 DOM。
  • useEffect - 不正确,因为旧的间隔回调可能在此之前触发(在布局效果之后)。

演示

此错误已在此 codesandebox 中演示。重现:

  • 将鼠标移到灰色 div 上 - 这将导致带有新 callback 引用的新渲染。
  • 通常,您会在鼠标移动不到 2000 次时看到该错误。
  • 间隔设置为 50 毫秒,因此您需要一点运气才能让它在渲染和效果阶段之间触发。

用例

演示显示当前回调值可能与useEffect中的有所不同好吧,但真正的问题是其中一个是“正确”的?

考虑这段代码:

const [size, setSize] = React.useState();

const onInterval = () => {
  console.log(size)
}

useInterval(onInterval, 100);

如果在提交阶段之后但在useEffect 之前调用onInterval,它将打印错误的值。

【问题讨论】:

  • 在我们讨论这个确切的事情here时你发现了这个只是巧合吗?
  • @daphtdazz 完全巧合。我们的一位开发人员在我们的代码库中添加了useInterval 代码,我标记了这个可能的问题。不过,感谢您的分享-其他帖子内容丰富。 Only mildly related but could also be of interest.
  • @Izhaki 我查看了您的 first 沙盒,确实render 的计数器没有增加,为什么?你展示的图片,在Render和React Update DOM之间有一条虚线,这不是应该增加render计数器的地方吗?
  • @GiorgiMoniava 那是因为渲染和布局效果是同步发生的(事件循环没有“释放”)。图中的虚线似乎是a mistake。

标签: javascript reactjs react-hooks event-loop


【解决方案1】:

尝试严格回答您的最后一个问题:

我看不出更新render() 中的回调而不是useEffect() 有任何逻辑危害。 useEffect() 在render() 之后从未被调用过,无论它被调用什么都将是最后一个渲染被调用的对象,所以逻辑上唯一的区别是回调可能会更加过时useEffect() 被调用。

即将到来的concurrent mode 可能会加剧这种情况,如果在调用useEffect() 之前可能有多次调用render(),但我什至不确定它是否会这样工作。

然而:我会说这样做是有维护成本的:这意味着在render()中引起副作用是可以的。总的来说,这不是一个好主意,所有必要的副作用都应该在useEffect() 中完成,因为就像the docs say:

render 方法本身不应该引起副作用......我们通常希望在 React 更新 DOM 之后执行我们的效果

所以我建议将 any 副作用放在 useEffect() 中并将其作为编码标准,即使在某些情况下也可以。特别是在 React 核心开发人员的博客文章中,该文章将 被“指导”许多人复制和粘贴,重要的是要树立正确的榜样;-P

替代解决方案

至于如何解决您的问题,我将复制并粘贴我建议的从this answer 实现的setInterval(),这应该通过在单独的useEffect() 中调用回调来消除歧义,此时所有状态应该是一致的,你不必担心哪个是“正确的”。将其放入沙盒似乎可以解决问题。

function useTicker(delay) {
  const [ticker, setTicker] = useState(0);
  useEffect(() => {
    const timer = setInterval(() => setTicker(t => t + 1), delay);
    return () => clearInterval(timer);
  }, [delay]);

  return ticker;
}

function useInterval(cbk, delay) {
  const ticker = useTicker(delay);
  const cbkRef = useRef();
  // always want the up to date callback from the caller
  useEffect(() => {
    cbkRef.current = cbk;
  }, [cbk]);

  // call the callback whenever the timer pops / the ticker increases.
  // This deliberately does not pass `cbk` in the dependencies as
  // otherwise the handler would be called on each render as well as
  // on the timer pop
  useEffect(() => cbkRef.current(), [ticker]);
}

【讨论】:

  • "这意味着可以在 render() 中引起副作用" 很好的观察,但我认为这里不适用 - 我们不是 调用打回来;我们只是存储它。
  • 存储它是副作用:-)(严格来说!)
  • 是的。我想是的。这是边缘哲学。
【解决方案2】:

这在我看来不像是一个错误,尽管我理解讨论。

上面的答案表明在渲染期间更新 ref 将是一个副作用,should be avoided because it will cause problems。

demo显示当前的回调值可能和useEffect中的不一样好吧,但真正的问题是哪一个是“正确”的?

我相信“正确”的是已经承诺的。出于一个原因,提交的效果是唯一可以保证以后有清理阶段的效果。 (这个问题中的间隔不需要清理效果,但其他的东西可能。)

在这种情况下,另一个更令人信服的原因可能是,React 可能预渲染事物(以较低的优先级,或者因为它们是“屏幕外”并且还不可见,或者在动画 API 的未来 b'c)。像这样的预渲染工作不应该修改 ref,因为修改是任意的。 (考虑一个未来的动画 API,它预渲染多个可能的未来视觉状态,以更快地响应用户交互。你不希望最后渲染的那个只是改变你当前可见/提交的引用查看。)


编辑 1 这个讨论似乎主要是在指出,当 JavaScript 不同步(阻塞)时,当它在渲染之间yield 时,还有其他事情的机会发生在两者之间(如先前安排的计时器/间隔)。确实如此,但我不认为这是一个错误,如果这发生在 渲染期间(在更新“提交”之前)。

如果主要担心回调可能会在用户界面提交后执行并且与屏幕上的内容不匹配,那么您可能需要考虑使用useLayoutEffect。这种效果类型在提交阶段被调用,在 React 修改了 DOM 之后但在 React 返回给浏览器之前(也就是没有间隔或计时器可以在其间运行)。


编辑 2 我相信 Dan 最初建议为此使用 ref 和效果(而不仅仅是效果)的原因是因为对回调的更新不会重置间隔。 (如果每次回调改变时调用clearInterval和setInterval,整体时序会中断。)

【讨论】:

    【解决方案3】:

    这是对您的示例的修改,表明这两种方法都是正确的:https://codesandbox.io/s/useintervalbug-neither-are-correct-zu2zt?file=/src/App.js

    使用 refs 并不是您在现实中会做的事情,但有必要轻松检测和报告问题。它们不会对行为产生重大影响。

    在此示例中,父组件创建了新的“正确”回调,完成了渲染并希望子组件和计时器使用该新回调。

    最终在“正确”回调最终传递给useInterval 和浏览器决定调用回调之间存在竞争条件。我认为这是不可能避免的。

    如果你记住回调没有区别,除非它当然没有依赖关系并且永远不会改变。

    【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2017-03-20
    • 2019-07-16
    • 1970-01-01
    • 2021-05-29
    • 1970-01-01
    • 2018-10-15
    • 2017-09-28
    • 2018-10-26
    相关资源
    最近更新 更多