当 ref 指向 DOM 元素时，使用 ref.current 作为 useEffect 的依赖是否安全？

Question

我知道 ref 是一个可变容器，因此它不应该列在 useEffect 的依赖项中，但是 ref.current 可能是一个变化的值。

当一个 ref 用于存储像 <div ref={ref}> 这样的 DOM 元素时，并且当我开发一个依赖于该元素的自定义钩子时，假设 ref.current 可以随着时间的推移而改变，如果组件有条件地返回：

const Foo = ({inline}) => {
  const ref = useRef(null);
  return inline ? <span ref={ref} /> : <div ref={ref} />;
};

我的自定义效果接收ref 对象并使用ref.current 作为依赖项是否安全？

const useFoo = ref => {
  useEffect(
    () => {
      const element = ref.current;
      // Maybe observe the resize of element
    },
    [ref.current]
  );
};

我读过 this comment 说 ref 应该在 useEffect 中使用，但我无法弄清楚 ref.current 更改但不会触发效果的任何情况。

正如那个问题所建议的，我应该使用回调 ref，但是作为参数的 ref 对集成多个钩子非常友好：

const ref = useRef(null);
useFoo(ref);
useBar(ref);

虽然回调 ref 更难使用，因为强制用户编写它们：

const fooRef = useFoo();
const barRef = useBar();
const ref = element => {
  fooRef(element);
  barRef(element);
};

<div ref={ref} />

这就是为什么我要问在useEffect 中使用ref.current 是否安全。

Answer 1

这是不安全的，因为改变引用不会触发渲染，因此，不会触发useEffect。

React Hook useEffect 有一个不必要的依赖：'ref.current'。 排除它或删除依赖数组。可变值，例如 'ref.current' 不是有效的依赖项，因为改变它们不会 重新渲染组件。 (react-hooks/exhaustive-deps)

反模式示例：

const Foo = () => {
  const [, render] = useReducer(p => !p, false);
  const ref = useRef(0);

  const onClickRender = () => {
    ref.current += 1;
    render();
  };

  const onClickNoRender = () => {
    ref.current += 1;
  };

  useEffect(() => {
    console.log('ref changed');
  }, [ref.current]);

  return (
    <>
      <button onClick={onClickRender}>Render</button>
      <button onClick={onClickNoRender}>No Render</button>
    </>
  );
};

---

与此模式相关的现实生活用例是当我们希望有一个持久引用时，即使在元素卸载时。

查看下一个示例，在该示例中，我们无法在卸载时保留元素大小。我们将尝试将useRef 与useEffect 组合使用，但它不起作用。

// BAD EXAMPLE, SEE SOLUTION BELOW
const Component = () => {
  const ref = useRef();

  const [isMounted, toggle] = useReducer((p) => !p, true);
  const [elementRect, setElementRect] = useState();

  useEffect(() => {
    console.log(ref.current);
    setElementRect(ref.current?.getBoundingClientRect());
  }, [ref.current]);

  return (
    <>
      {isMounted && <div ref={ref}>Example</div>}
      <button onClick={toggle}>Toggle</button>
      <pre>{JSON.stringify(elementRect, null, 2)}</pre>
    </>
  );
};

---

令人惊讶的是，要修复它，我们需要直接处理 node，同时使用 useCallback 记忆函数：

// GOOD EXAMPLE
const Component = () => {
  const [isMounted, toggle] = useReducer((p) => !p, true);
  const [elementRect, setElementRect] = useState();

  const handleRect = useCallback((node) => {
    setElementRect(node?.getBoundingClientRect());
  }, []);

  return (
    <>
      {isMounted && <div ref={handleRect}>Example</div>}
      <button onClick={toggle}>Toggle</button>
      <pre>{JSON.stringify(elementRect, null, 2)}</pre>
    </>
  );
};

• 查看 React Docs 中的另一个示例：How can I measure a DOM node?
• 进一步阅读和更多示例参见uses of useEffect

Answer 2

2021 年答案：

这篇文章解释了使用 refs 和 useEffect:Ref objects inside useEffect Hooks:

如果将 useRef 钩子与跳过渲染的 useEffect 结合使用，则该钩子可能会成为自定义钩子的陷阱。您的第一反应是将 ref.current 添加到 useEffect 的第二个参数，因此一旦 ref 更改它就会更新。 但是 ref 直到组件渲染后才会更新——这意味着，任何跳过渲染的 useEffect 在下一次渲染之前都不会看到 ref 的任何更改。

同样如本文所述，官方的 react 文档现已更新为推荐的方法（即使用回调而不是 ref + 效果）。见How can I measure a DOM node?:

function MeasureExample() {
  const [height, setHeight] = useState(0);

  const measuredRef = useCallback(node => {
    if (node !== null) {
      setHeight(node.getBoundingClientRect().height);
    }
  }, []);

  return (
    <>
      <h1 ref={measuredRef}>Hello, world</h1>
      <h2>The above header is {Math.round(height)}px tall</h2>
    </>
  );
}

Answer 3

我遇到了同样的问题，我使用 Typescript 创建了一个自定义钩子，并使用 ref 回调创建了一个官方方法。希望对您有所帮助。

export const useRefHeightMeasure = <T extends HTMLElement>() => {
  const [height, setHeight] = useState(0)

  const refCallback = useCallback((node: T) => {
    if (node !== null) {
      setHeight(node.getBoundingClientRect().height)
    }
  }, [])

  return { height, refCallback }
}

Answer 4

我遇到了类似的问题，其中我的 ESLint 抱怨 ref.current 在 useCallback 中的使用。我在我的项目中添加了一个自定义钩子来规避这个 eslint 警告。每当 ref 对象发生变化时，它都会切换一个变量以强制重新计算 useCallback。

import { RefObject, useCallback, useRef, useState } from "react";

/**
 * This hook can be used when using ref inside useCallbacks
 * 
 * Usage
 * ```ts
 * const [toggle, refCallback, myRef] = useRefWithCallback<HTMLSpanElement>();
 * const onClick = useCallback(() => {
    if (myRef.current) {
      myRef.current.scrollIntoView({ behavior: "smooth" });
    }
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [toggle]);
  return (<span ref={refCallback} />);
  ```
 * @returns 
 */
function useRefWithCallback<T extends HTMLSpanElement | HTMLDivElement | HTMLParagraphElement>(): [
  boolean,
  (node: any) => void,
  RefObject<T>
] {
  const ref = useRef<T | null>(null);
  const [toggle, setToggle] = useState(false);
  const refCallback = useCallback(node => {
    ref.current = node;
    setToggle(val => !val);
  }, []);

  return [toggle, refCallback, ref];
}

export default useRefWithCallback;

Answer 5

我已经停止使用useRef，现在只使用一次或两次useState：

const [myChart, setMyChart] = useState(null)

const [el, setEl] = useState(null)
useEffect(() => {
    if (!el) {
        return
    }
    // attach to element
    const myChart = echarts.init(el)
    setMyChart(myChart)
    return () => {
        myChart.dispose()
        setMyChart(null)
    }
}, [el])

useEffect(() => {
    if (!myChart) {
        return
    }
    // do things with attached object
    myChart.setOption(... data ...)
}, [myChart, data])

return <div key='chart' ref={setEl} style={{ width: '100%', height: 1024 }} />

对图表、身份验证和其他非反应库很有用，因为它保留了一个元素 ref 和初始化的对象，并且可以根据需要直接处理它。

我现在不确定为什么 useRef 首先存在...？