如何使用 React useEffect 窗口 removeEventListener

Question

在 React Hooks 文档中，展示了如何在组件的清理阶段移除事件监听器。 https://reactjs.org/docs/hooks-reference.html#conditionally-firing-an-effect

在我的用例中，我正在尝试根据功能组件的状态属性删除EventListener。

这是一个永远不会卸载组件但应该删除事件侦听器的示例：

function App () {
  const [collapsed, setCollapsed] = React.useState(true);

  React.useEffect(
    () => {
      if (collapsed) {
        window.removeEventListener('keyup', handleKeyUp); // Not the same "handleKeyUp" :(
      } else {
        window.addEventListener('keyup', handleKeyUp);
      }
    },
    [collapsed]
  );

  function handleKeyUp(event) {
    console.log(event.key);
    switch (event.key) {
      case 'Escape':
        setCollapsed(true);
        break;
    }
  }

  return collapsed ? (
    <a href="javascript:;" onClick={()=>setCollapsed(false)}>Search</a>
  ) : (
    <span>
      <input placeholder="Search" autoFocus />&nbsp;
      <a href="javascript:;">This</a>&nbsp;
      <a href="javascript:;">That</a>&nbsp;
      <input placeholder="Refinement" />
    </span>
  );
}
ReactDOM.render(<App />, document.body.appendChild(document.createElement('div')));

（https://codepen.io/caqu/pen/xBeBMN 的实时示例）

我看到的问题是removeEventListener 中的handleKeyUp 引用在每次组件呈现时都会发生变化。函数handleKeyUp 需要引用setCollapsed，所以它必须被App 括起来。将handleKeyUp 移动到useEffect 内部似乎也会多次触发并丢失对原始handleKeyUp 的引用。

如何在不卸载组件的情况下使用 React Hooks 有条件地 window.removeEventListener？

Answer 1

您可以将handleKeyUp 函数放在赋予useEffect (which is the recommended way of doing it according to the official documentation) 的函数中，并且仅在collapsed 为false 时添加侦听器并返回清理函数。

useEffect(() => {
  if (collapsed) {
    return;
  }

  function handleKeyUp(event) {
    switch (event.key) {
      case "Escape":
        setCollapsed(true);
        break;
    }
  }

  window.addEventListener("keyup", handleKeyUp);
  return () => window.removeEventListener("keyup", handleKeyUp);
}, [collapsed]);

Answer 2

Tholle 的 答案可能有效，但在 if 中声明函数是不好的做法。

当函数声明和未声明时，这使得更难理解。由于函数被提升，它也可能导致错误。

有一个更巧妙的方法来解决它：

通过使用 useCallback 挂钩包装您的事件处理程序。

const [collapsed, setCollapsed] = useState(true)

const handleKeyUp = useCallback((event) => {
    if (event.key === "Escape") {
      setCollapsed(true)
    }
}, [setCollapsed])

useEffect(() => {
    if (!collapsed) {
        window.addEventListener("keyup", handleKeyUp)
    } else {
        window.removeEventListener("keyup", handleKeyUp)
    }

    return () => window.removeEventListener("keyup", handleKeyUp)
}, [collapsed, handleKeyUp])

• useCallback 依赖于 setCollapsed。这确保handleKeyUp 在组件重新渲染时不会被重新定义（这总是在状态更改时发生）
• useEffect 将有条件地添加/删除事件监听器，否则只要组件被挂载，事件就会一直触发。

如果您在 useEffect 中使用大量事件处理程序，则有一个自定义挂钩：https://usehooks.com/useEventListener/

这是使用我的解决方案更新的问题海报示例：https://codepen.io/publicJorn/pen/eYzwENN