响应式 Effect 的生命周期

Effect 与组件有不同的生命周期。
组件可以挂载、更新或卸载。
Effect 只能做两件事：开始同步某些东西，然后停止同步它。
如果 Effect 依赖于随时间变化的 props 和 state，这个循环可能会发生多次。
React 提供了代码检查规则来检查是否正确地指定了 Effect 的依赖项，这能够使 Effect 与最新的 props 和 state 保持同步。

Effect 的生命周期

每个 React 组件都经历相同的生命周期：

当组件被添加到屏幕上时，它会进行组件的挂载。
当组件接收到新的 props 或 state 时，通常是作为对交互的响应，它会进行组件的更新。
当组件从屏幕上移除时，它会进行组件的卸载。

这是一种很好的思考组件的方式，但并不适用于 Effect。

相反，尝试从组件生命周期中跳脱出来，独立思考 Effect。
Effect 描述了如何将外部系统与当前的 props 和 state 同步。
随着代码的变化，同步的频率可能会增加或减少。

为了说明这一点，考虑下面这个示例。Effect 将组件连接到聊天服务器：

const serverUrl = 'https://localhost:1234'

function ChatRoom({ roomId }) {
  useEffect(() => {
    const connection = createConnection(serverUrl, roomId)
    connection.connect()
    return () => {
      connection.disconnect()
    }
  }, [roomId])
  // ...
}

Effect 的主体部分指定了如何 开始同步：

// ...
const connection = createConnection(serverUrl, roomId)
connection.connect()
return () => {
  connection.disconnect()
}
// ...

Effect 返回的清理函数指定了如何 停止同步：

// ...
const connection = createConnection(serverUrl, roomId)
connection.connect()
return () => {
  connection.disconnect()
}
// ...

你可能会直观地认为当组件挂载时 React 会开始同步，而当组件卸载时会停止同步。
然而，事情并没有这么简单！有时，在组件保持挂载状态的同时，可能还需要多次开始和停止同步。

让我们来看看为什么这是必要的、何时会发生以及如何控制这种行为。

**注意：**有些 Effect 根本不返回清理函数。在大多数情况下，可能希望返回一个清理函数，但如果没有返回，React 将表现得好像返回了一个空的清理函数。

为什么同步可能需要多次进行

比如文章页，UI 相同，当文章内容不同。我们肯定要根据文章 id，从新获得数据。所以当文章 ID 改变时，Effect 就需要进行再次同步。

比如聊天室。当房间号 roomid 改变时，UI 不变，但数据展示变了。就要重新同步 Effect 获得新的数据

function ChatRoom({ roomId /* "general" */ }) {
  useEffect(() => {
    const connection = createConnection(serverUrl, roomId); // 连接到 "general" 聊天室
    connection.connect();
    return () => {
      connection.disconnect(); // 断开与 "general" 聊天室的连接
    };
    // ...

从 Effect 的角度思考

让我们总结一下从 ChatRoom 组件的角度所发生的一切：

ChatRoom 组件挂载，roomId 设置为 "general"
ChatRoom 组件更新，roomId 设置为 "travel"
ChatRoom 组件更新，roomId 设置为 "music"
ChatRoom 组件卸载

在组件生命周期的每个阶段，Effect 执行了不同的操作：

Effect 连接到了 "general" 聊天室
Effect 断开了与 "general" 聊天室的连接，并连接到了 "travel" 聊天室
Effect 断开了与 "travel" 聊天室的连接，并连接到了 "music" 聊天室
Effect 断开了与 "music" 聊天室的连接

现在让我们从 Effect 本身的角度来思考所发生的事情：

useEffect(() => {
  // Effect 连接到了通过 roomId 指定的聊天室...
  const connection = createConnection(serverUrl, roomId)
  connection.connect()
  return () => {
    // ...直到它断开连接
    connection.disconnect()
  }
}, [roomId])

这段代码的结构可能会将所发生的事情看作是一系列不重叠的时间段：

Effect 连接到了 "general" 聊天室（直到断开连接）
Effect 连接到了 "travel" 聊天室（直到断开连接）
Effect 连接到了 "music" 聊天室（直到断开连接）

之前，你是从组件的角度思考的。
当你从组件的角度思考时，很容易将 Effect 视为在特定时间点触发的“回调函数”或“生命周期事件”，
例如“渲染后”或“卸载前”。这种思维方式很快变得复杂，所以最好避免使用。
相反，始终专注于单个启动/停止周期。
无论组件是挂载、更新还是卸载，都不应该有影响。
只需要描述如何开始同步和如何停止。
如果做得好， Effect 将能够在需要时始终具备启动和停止的弹性。
这可能会让你想起当编写创建 JSX 的渲染逻辑时，并不考虑组件是挂载还是更新。
描述的是应该显示在屏幕上的内容，而 React 会解决其余的问题。

React 如何验证 Effect 可以重新进行同步

import { useState, useEffect } from 'react'
import { createConnection } from './chat.js'

const serverUrl = 'https://localhost:1234'

function ChatRoom({ roomId }) {
  useEffect(() => {
    const connection = createConnection(serverUrl, roomId)
    connection.connect()
    return () => connection.disconnect()
  }, [roomId])
  return <h1>欢迎来到 {roomId} 房间！</h1>
}

export default function App() {
  const [roomId, setRoomId] = useState('general')
  const [show, setShow] = useState(false)
  return (
    <>
      <label>
        选择聊天室：{' '}
        <select value={roomId} onChange={(e) => setRoomId(e.target.value)}>
          <option value="general">所有</option>
          <option value="travel">旅游</option>
          <option value="music">音乐</option>
        </select>
      </label>
      <button onClick={() => setShow(!show)}>
        {show ? '关闭聊天' : '打开聊天'}
      </button>
      {show && <hr />}
      {show && <ChatRoom roomId={roomId} />}
    </>
  )
}

export function createConnection(serverUrl, roomId) {
  // 实际的实现将会连接到服务器
  return {
    connect() {
      console.log('✅ 连接到 "' + roomId + '" 房间，位于' + serverUrl + '...')
    },
    disconnect() {
      console.log('❌ 断开 "' + roomId + '" 房间，位于' + serverUrl)
    },
  }
}

请注意，当组件首次挂载时，会看到三个日志：

✅ 连接到 "general" 聊天室，位于 https://localhost:1234... (仅限开发环境)
❌ 从 "general" 聊天室断开连接，位于 https://localhost:1234. (仅限开发环境)
✅ 连接到 "general" 聊天室，位于 https://localhost:1234...

前两个日志仅适用于开发环境。在开发环境中，React 总是会重新挂载每个组件一次。

React 通过在开发环境中立即强制 Effect 重新进行同步来验证其是否能够重新同步。这可能让你想起打开门并额外关闭它以检查门锁是否有效的情景。React 在开发环境中额外启动和停止 Effect 一次，以检查是否正确实现了它的清理功能。

实际上，Effect 重新进行同步的主要原因是它所使用的某些数据发生了变化。在上面的示例中，更改所选的聊天室。注意当 roomId 发生变化时，Effect 会重新进行同步。

然而，还存在其他一些不寻常的情况需要重新进行同步。例如，在上面的示例中，尝试在聊天打开时编辑 serverUrl。注意当修改代码时，Effect 会重新进行同步。将来，React 可能会添加更多依赖于重新同步的功能。

React 如何知道需要重新进行 Effect 的同步

你可能想知道 React 是如何知道在 roomId 更改后需要重新同步 Effect。
这是因为你告诉了 React 它的代码依赖于 roomId，通过将其包含在依赖列表中。

function ChatRoom({ roomId }) { // roomId 属性可能会随时间变化。
  useEffect(() => {
    const connection = createConnection(serverUrl, roomId); // 这个 Effect 读取了 roomId
    connection.connect();
    return () => {
      connection.disconnect();
    };
  }, [roomId]); // 因此，你告诉 React 这个 Effect "依赖于" roomId
  // ...

放在一个 Effect 里，还是两个 Effect 里

每个 Effect 表示一个独立的同步过程。

抵制将与 Effect 无关的逻辑添加到已经编写的 Effect 中，仅仅因为这些逻辑需要与 Effect 同时运行。
例如，假设你想在用户访问房间时发送一个分析事件。
你已经有一个依赖于 roomId 的 Effect，所以你可能会想要将分析调用添加到那里：

function ChatRoom({ roomId }) {
  useEffect(() => {
    logVisit(roomId)
    const connection = createConnection(serverUrl, roomId)
    connection.connect()
    return () => {
      connection.disconnect()
    }
  }, [roomId])
  // ...
}

但是想象一下，如果以后给这个 Effect 添加了另一个需要重新建立连接的依赖项。
如果这个 Effect 重新进行同步，它将为相同的房间调用 logVisit(roomId)，而这不是你的意图。
记录访问行为是一个独立的过程，与连接不同。将它们作为两个单独的 Effect 编写：

function ChatRoom({ roomId }) {
  useEffect(() => {
    logVisit(roomId)
  }, [roomId])

  useEffect(() => {
    const connection = createConnection(serverUrl, roomId)
    // ...
  }, [roomId])
  // ...
}

代码中的每个 Effect 应该代表一个独立的同步过程。

在上面的示例中，删除一个 Effect 不会影响另一个 Effect 的逻辑。
这表明它们同步不同的内容，因此将它们拆分开是有意义的。
另一方面，如果将一个内聚的逻辑拆分成多个独立的 Effects，代码可能会看起来更加“清晰”，但维护起来会更加困难。
这就是为什么你应该考虑这些过程是相同还是独立的，而不是只考虑代码是否看起来更整洁。

Effect 会“响应”于响应式值

Effect 读取了两个变量（serverUrl 和 roomId），但是只将 roomId 指定为依赖项：

const serverUrl = 'https://localhost:1234'

function ChatRoom({ roomId }) {
  useEffect(() => {
    const connection = createConnection(serverUrl, roomId)
    connection.connect()
    return () => {
      connection.disconnect()
    }
  }, [roomId])
  // ...
}

为什么 serverUrl 不需要作为依赖项呢？

这是因为 serverUrl 永远不会因为重新渲染而发生变化。
无论组件重新渲染多少次以及原因是什么，serverUrl 都保持不变。
既然 serverUrl 从不变化，将其指定为依赖项就没有意义。
毕竟，依赖项只有在随时间变化时才会起作用！
另一方面，roomId 在重新渲染时可能会不同。
在组件内部声明的 props、state 和其他值都是响应式的，因为它们是在渲染过程中计算的，并参与了 React 的数据流。

如果 serverUrl 是状态变量，那么它就是响应式的。响应式值必须包含在依赖项中：

function ChatRoom({ roomId }) {
  // Props 随时间变化
  const [serverUrl, setServerUrl] = useState('https://localhost:1234') // State 可能随时间变化

  useEffect(() => {
    const connection = createConnection(serverUrl, roomId) // Effect 读取 props 和 state
    connection.connect()
    return () => {
      connection.disconnect()
    }
  }, [roomId, serverUrl]) // 因此，你告诉 React 这个 Effect "依赖于" props 和 state
  // ...
}

通过将 serverUrl 包含在依赖项中，确保 Effect 在其发生变化后重新同步。

没有依赖项的 Effect 的含义

如果将 serverUrl 和 roomId 都移出组件会发生什么？

const serverUrl = 'https://localhost:1234'
const roomId = 'general'

function ChatRoom() {
  useEffect(() => {
    const connection = createConnection(serverUrl, roomId)
    connection.connect()
    return () => {
      connection.disconnect()
    }
  }, []) // ✅ 声明的所有依赖
  // ...
}

现在 Effect 的代码不使用任何响应式值，因此它的依赖可以是空的 ([])。

从组件的角度来看，空的 [] 依赖数组意味着这个 Effect 仅在组件挂载时连接到聊天室，并在组件卸载时断开连接。
（请记住，在开发环境中，React 仍会额外执行一次来对逻辑进行压力测试。）
然而，如果你从 Effect 的角度思考，根本不需要考虑挂载和卸载。
重要的是，你已经指定了 Effect 如何开始和停止同步。
目前，它没有任何响应式依赖。
但是，如果希望用户随时间改变 roomId 或 serverUrl（它们将变为响应式），Effect 的代码不需要改变。
只需要将它们添加到依赖项中即可。

在组件主体中声明的所有变量都是响应式的

Props 和 state 并不是唯一的响应式值。
从它们计算出的值也是响应式的。
如果 props 或 state 发生变化，组件将重新渲染，从中计算出的值也会随之改变。
这就是为什么 Effect 使用的组件主体中的所有变量都应该在依赖列表中。
假设用户可以在下拉菜单中选择聊天服务器，但他们还可以在设置中配置默认服务器。
假设你已经将设置状态放入了上下文，因此从该上下文中读取 settings。
现在，可以根据 props 中选择的服务器和默认服务器来计算 serverUrl：

function ChatRoom({ roomId, selectedServerUrl }) {
  // roomId 是响应式的
  const settings = useContext(SettingsContext) // settings 是响应式的
  const serverUrl = selectedServerUrl ?? settings.defaultServerUrl // serverUrl 是响应式的
  useEffect(() => {
    const connection = createConnection(serverUrl, roomId) // Effect 读取了 roomId 和 serverUrl
    connection.connect()
    return () => {
      connection.disconnect()
    }
  }, [roomId, serverUrl]) // 因此，当它们中的任何一个发生变化时，它需要重新同步！
  // ...
}

在这个例子中，serverUrl 不是 prop 或 state 变量。它是在渲染过程中计算的普通变量。但是它是在渲染过程中计算的，所以它可能会因为重新渲染而改变。这就是为什么它是响应式的。

组件内部的所有值（包括 props、state 和组件体内的变量）都是响应式的。
任何响应式值都可以在重新渲染时发生变化，所以需要将响应式值包括在 Effect 的依赖项中。

换句话说，Effect 对组件体内的所有值都会“react”。

全局变量或可变值可以作为依赖项吗？

可变值（包括全局变量）不是响应式的。

例如，像 location.pathname 这样的可变值不能作为依赖项。
它是可变的，因此可以在 React 渲染数据流之外的任何时间发生变化。
更改它不会触发组件的重新渲染。因此，即使在依赖项中指定了它，React 也无法知道在其更改时重新同步 Effect。
这也违反了 React 的规则，因为在渲染过程中读取可变数据（即在计算依赖项时）会破坏纯粹的渲染。
相反，应该使用 useSyncExternalStore 来读取和订阅外部可变值。
另外，像 ref.current 或从中读取的值也不能作为依赖项。
useRef 返回的 ref 对象本身可以作为依赖项，但其 current 属性是有意可变的。
它允许跟踪某些值而不触发重新渲染。
但由于更改它不会触发重新渲染，它不是响应式值，React 不会知道在其更改时重新运行 Effect。

正如你将在本页面下面学到的那样，检查工具将自动检查这些问题。

React 会验证是否将每个响应式值都指定为了依赖项

如果检查工具配置了 React，它将检查 Effect 代码中使用的每个响应式值是否已声明为其依赖项。
例如，以下示例是一个 lint 错误，因为 roomId 和 serverUrl 都是响应式的：

这可能看起来像是 React 错误，但实际上 React 是在指出代码中的 bug。roomId 和 serverUrl 都可能随时间改变，但忘记了在它们改变时重新同步 Effect。即使用户在 UI 中选择了不同的值，仍然保持连接到初始的 roomId 和 serverUrl。

要修复这个 bug，请按照检查工具的建议将 roomId 和 serverUrl 作为 Effect 的依赖进行指定：

function ChatRoom({ roomId }) {
  // roomId 是响应式的
  const [serverUrl, setServerUrl] = useState('https://localhost:1234') // serverUrl 是响应式的
  useEffect(() => {
    const connection = createConnection(serverUrl, roomId)
    connection.connect()
    return () => {
      connection.disconnect()
    }
  }, [serverUrl, roomId]) // ✅ 声明的所有依赖
  // ...
}

注意

在某些情况下，React 知道一个值永远不会改变，即使它在组件内部声明。
例如，从 useState 返回的 set 函数和从 useRef 返回的 ref 对象是稳定的 ——它们保证在重新渲染时不会改变。
稳定值不是响应式的，因此可以从列表中省略它们。
包括它们是允许的：它们不会改变，所以无关紧要。

当你不想进行重新同步时该怎么办

在上一个示例中，通过将 roomId 和 serverUrl 列为依赖项来修复了 lint 错误。

然而，可以通过向检查工具“证明”这些值不是响应式值，即它们不会因为重新渲染而改变。
例如，如果 serverUrl 和 roomId 不依赖于渲染并且始终具有相同的值，
可以将它们移到组件外部。现在它们不需要成为依赖项：

const serverUrl = 'https://localhost:1234' // serverUrl 不是响应式的
const roomId = 'general' // roomId 不是响应式的

function ChatRoom() {
  useEffect(() => {
    const connection = createConnection(serverUrl, roomId)
    connection.connect()
    return () => {
      connection.disconnect()
    }
  }, []) // ✅ 声明的所有依赖
  // ...
}

也可以将它们移动到 Effect 内部。它们不是在渲染过程中计算的，因此它们不是响应式的：

function ChatRoom() {
  useEffect(() => {
    const serverUrl = 'https://localhost:1234' // serverUrl 不是响应式的
    const roomId = 'general' // roomId 不是响应式的
    const connection = createConnection(serverUrl, roomId)
    connection.connect()
    return () => {
      connection.disconnect()
    }
  }, []) // ✅ 声明的所有依赖
  // ...
}

Effect 是一段响应式的代码块。它们在读取的值发生变化时重新进行同步。与事件处理程序不同，事件处理程序只在每次交互时运行一次，而 Effect 则在需要进行同步时运行。

不能“选择”依赖项。依赖项必须包括 Effect 中读取的每个响应式值。代码检查工具会强制执行此规则。有时，这可能会导致出现无限循环的问题，或者 Effect 过于频繁地重新进行同步。不要通过禁用代码检查来解决这些问题！下面是一些解决方案：

检查 Effect 是否表示了独立的同步过程。
- 如果 Effect 没有进行任何同步操作，可能是不必要的。
- 如果它同时进行了几个独立的同步操作，将其拆分为多个 Effect。
如果想读取 props 或 state 的最新值，但又不想对其做出反应并重新同步 Effect，
- 可以将 Effect 拆分为具有反应性的部分（保留在 Effect 中）和非反应性的部分（提取为名为 “Effect Event” 的内容）。
- 阅读关于将事件与 Effect 分离的内容。
避免将对象和函数作为依赖项。
- 如果在渲染过程中创建对象和函数，然后在 Effect 中读取它们，它们将在每次渲染时都不同。
- 这将导致 Effect 每次都重新同步。
- 阅读有关从 Effect 中删除不必要依赖项的更多内容。

注意

检查工具是你的朋友，但它们的能力是有限的。

检查工具只知道依赖关系是否错误。
它并不知道每种情况下的最佳解决方法。
如果静态代码分析工具建议添加某个依赖关系，但添加该依赖关系会导致循环，这并不意味着应该忽略静态代码分析工具。
需要修改 Effect 内部（或外部）的代码，使得该值不是响应式的，也不需要成为依赖项。

如果有一个现有的代码库，可能会有一些像这样禁用了检查工具的 Effect：

useEffect(() => {
  // ...
  // 🔴 避免这样禁用静态代码分析工具：
  // eslint-ignore-next-line react-hooks/exhaustive-deps
}, [])

在下一页和之后的页面中，你将学习如何修复这段代码，而不违反规则。修复代码总是值得的！

摘要

组件可以挂载、更新和卸载。
每个 Effect 与周围组件有着独立的生命周期。
每个 Effect 描述了一个独立的同步过程，可以开始和停止。
在编写和读取 Effect 时，要独立地考虑每个 Effect（如何开始和停止同步），而不是从组件的角度思考（如何挂载、更新或卸载）。
在组件主体内声明的值是“响应式”的。
响应式值应该重新进行同步 Effect，因为它们可以随着时间的推移而发生变化。
检查工具验证在 Effect 内部使用的所有响应式值都被指定为依赖项。
检查工具标记的所有错误都是合理的。总是有一种方法可以修复代码，同时不违反规则。

Effect 的生命周期​

为什么同步可能需要多次进行​

从 Effect 的角度思考​

React 如何验证 Effect 可以重新进行同步​

React 如何知道需要重新进行 Effect 的同步​

放在一个 Effect 里，还是两个 Effect 里​

代码中的每个 Effect 应该代表一个独立的同步过程。​

Effect 会“响应”于响应式值​

没有依赖项的 Effect 的含义​

在组件主体中声明的所有变量都是响应式的​

全局变量或可变值可以作为依赖项吗？​

React 会验证是否将每个响应式值都指定为了依赖项​

注意​

当你不想进行重新同步时该怎么办​

注意​

摘要​