Fast Refresh
Fast Refresh 是一种热模块替换体验,可让你在对 React 组件进行编辑时立即获得反馈。
Fast Refresh 是集成到 Next.js 中的一项 React 特性,它允许你在保存文件更改时实时重新加载浏览器页面,同时保留临时的客户端状态。在 9.4 或更高版本的所有 Next.js 应用中,它默认启用。启用 Fast Refresh 后,大多数编辑都会在一秒内显示出来。
工作原理#
- 如果你编辑的文件只导出 React 组件,Fast Refresh 将只更新该文件的代码,并重新渲染你的组件。你可以编辑该文件中的任何内容,包括样式、渲染逻辑、事件处理器或 effect。
- 如果你编辑的文件包含非 React 组件的导出,Fast Refresh 将重新运行该文件以及导入它的其他文件。因此,如果
Button.js和Modal.js都导入了theme.js,编辑theme.js会同时更新这两个组件。 - 最后,如果你编辑的文件被 React 树之外的文件导入,Fast Refresh 将回退为执行完整重新加载。你可能会遇到这样的情况:某个文件渲染了 React 组件,但同时也导出了一个被非 React 组件导入的值。例如,你的组件可能还导出了一个常量,而某个非 React 工具文件导入了它。在这种情况下,可以考虑将该常量迁移到单独的文件中,并在两个文件中分别导入。这样就能让 Fast Refresh 重新正常工作。其他情况通常也可以用类似方式解决。
错误恢复能力#
语法错误#
如果你在开发过程中出现语法错误,可以修复它并再次保存文件。错误会自动消失,无需重新加载应用。你不会丢失组件状态。
运行时错误#
如果你犯了导致组件内部出现运行时错误的错误,你会看到一个上下文遮罩层。修复错误后,遮罩层会自动关闭,无需重新加载应用。
如果错误不是在渲染期间发生的,组件状态将被保留。如果错误确实发生在渲染期间,React 会使用更新后的代码重新挂载你的应用。
如果你在应用中使用了错误边界(这在生产环境中实现优雅失败是个好主意),它们会在渲染错误后的下一次编辑时重试渲染。这意味着使用错误边界可以防止你总是被重置到根应用状态。不过,请记住错误边界不应划分得过于细粒度。React 在生产环境中使用它们,因此应始终有意识地设计它们。
限制#
Fast Refresh 会尝试保留你正在编辑的组件中的本地 React 状态,但前提是这样做是安全的。以下是一些可能导致每次编辑文件时本地状态都被重置的原因:
- 类组件不会保留本地状态(只有函数组件和 Hook 会保留状态)。
- 你正在编辑的文件可能除了 React 组件之外还有其他导出。
- 有时,文件会导出调用高阶组件的结果,例如
HOC(WrappedComponent)。如果返回的组件是类组件,其状态将被重置。 - 像
export default () => <div />;这样的匿名箭头函数会导致 Fast Refresh 无法保留本地组件状态。对于大型代码库,你可以使用name-default-componentcodemod。
随着代码库中越来越多的代码迁移到函数组件和 Hook,你可以预期在更多情况下状态都会被保留。
技巧#
- Fast Refresh 默认会保留函数组件(和 Hook)中的 React 本地状态。
- 有时你可能希望强制重置状态并重新挂载组件。例如,当你正在调整一个只在挂载时发生的动画时,这会很方便。为此,你可以在正在编辑的文件中的任意位置添加
// @refresh reset。该指令只作用于当前文件,它会指示 Fast Refresh 在每次编辑时重新挂载该文件中定义的组件。 - 在开发过程中,你可以在所编辑的组件中放入
console.log或debugger;。 - 请记住,导入是区分大小写的。如果导入与实际文件名不匹配,快速刷新和完整刷新都可能失败。例如,
'./header'与'./Header'。
Fast Refresh 与 Hook#
在可能的情况下,Fast Refresh 会尝试在编辑之间保留组件的状态。具体而言,只要你不更改 useState 和 useRef 的参数或 Hook 调用的顺序,它们就会保留之前的值。
带有依赖项的 Hook——例如 useEffect、useMemo 和 useCallback——在 Fast Refresh 期间始终会更新。在 Fast Refresh 发生时,它们的依赖项列表将被忽略。
例如,当你将 useMemo(() => x * 2, [x]) 编辑为 useMemo(() => x * 10, [x]) 时,即使 x(依赖项)没有变化,它也会重新运行。如果 React 不这样做,你的编辑就不会反映在屏幕上!
有时,这可能会导致意想不到的结果。例如,即使是一个依赖项为空数组的 useEffect,在 Fast Refresh 期间也仍会重新运行一次。
不过,即使没有 Fast Refresh,编写能够适应 useEffect 偶尔重新运行的代码也是一种良好实践。这会让你以后更容易为它引入新的依赖项,并且这也是 React Strict Mode 所强制要求的,我们强烈建议启用它。