React入门（五）错误边界

发表于 更新于 分类于 Waline：
这次我们的主要内容是错误边界。

这篇博客我们继续看React文档的高级指引。

这次我们的主要内容是错误边界。

什么是错误边界

过去，组件内的 JavaScript 错误会导致 React 的内部状态被破坏，并且在下一次渲染时 产生 可能无法追踪的 错误。这些错误基本上是由较早的其他代码（非 React 组件代码）错误引起的，但 React 并没有提供一种在组件中优雅处理这些错误的方式，也无法从错误中恢复。

部分 UI 的 JavaScript 错误不应该导致整个应用崩溃，为了解决这个问题，React 16 引入了一个新的概念 —— 错误边界。

错误边界是一种 React 组件，这种组件可以捕获并打印发生在其子组件树任何位置的 JavaScript 错误，并且，它会渲染出备用 UI，而不是渲染那些崩溃了的子组件树。错误边界在渲染期间、生命周期方法和整个组件树的构造函数中捕获错误。

注意

错误边界无法捕获以下场景中产生的错误：

  • 事件处理（了解更多）
  • 异步代码（例如 setTimeout 或 requestAnimationFrame 回调函数）
  • 服务端渲染
  • 它自身抛出来的错误（并非它的子组件）

如果一个 class 组件中定义了 static getDerivedStateFromError() 或 componentDidCatch() 这两个生命周期方法中的任意一个（或两个）时，那么它就变成一个错误边界。当抛出错误后，请使用 static getDerivedStateFromError() 渲染备用 UI ，使用 componentDidCatch() 打印错误信息。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
class ErrorBoundary extends React.Component {
  constructor(props) {
    super(props);
    this.state = { hasError: false };
  }

  static getDerivedStateFromError(error) {    // 更新 state 使下一次渲染能够显示降级后的 UI    
      return { hasError: true };  
  }
  componentDidCatch(error, errorInfo) {    // 你同样可以将错误日志上报给服务器    
      logErrorToMyService(error, errorInfo);  
  }
  render() {
    if (this.state.hasError) {      // 你可以自定义降级后的 UI 并渲染      
        return <h1>Something went wrong.</h1>;    
    }
    return this.props.children; 
  }
}

然后你可以将它作为一个常规组件去使用：

1
2
3
<ErrorBoundary>
  <MyWidget />
</ErrorBoundary>

错误边界的工作方式类似于 JavaScript 的 catch {}，不同的地方在于错误边界只针对 React 组件。只有 class 组件才可以成为错误边界组件。大多数情况下, 你只需要声明一次错误边界组件, 并在整个应用中使用它。

注意错误边界仅可以捕获其子组件的错误，它无法捕获其自身的错误。如果一个错误边界无法渲染错误信息，则错误会冒泡至最近的上层错误边界，这也类似于 JavaScript 中 catch {} 的工作机制。

错误边界应该放置在哪？

错误边界的粒度由你来决定，可以将其包装在最顶层的路由组件并为用户展示一个 “Something went wrong” 的错误信息，就像服务端框架经常处理崩溃一样。你也可以将单独的部件包装在错误边界以保护应用其他部分不崩溃。

未捕获错误（Uncaught Errors）的新行为

这一改变具有重要意义，自 React 16 起，任何未被错误边界捕获的错误将会导致整个 React 组件树被卸载。

关于 try/catch ？

try / catch 很棒但它仅能用于命令式代码（imperative code）：

1
2
3
4
5
try {
  showButton();
} catch (error) {
  // ...
}

然而，React 组件是声明式的并且具体指出 什么 需要被渲染：

1
<Button />

错误边界保留了 React 的声明性质，其行为符合你的预期。例如，即使一个错误发生在 componentDidUpdate 方法中，并且由某一个深层组件树的 setState 引起，其仍然能够冒泡到最近的错误边界。

关于事件处理器

错误边界无法捕获事件处理器内部的错误。

React 不需要错误边界来捕获事件处理器中的错误。与 render 方法和生命周期方法不同，事件处理器不会在渲染期间触发。因此，如果它们抛出异常，React 仍然能够知道需要在屏幕上显示什么。

如果你需要在事件处理器内部捕获错误，使用普通的 JavaScript try / catch 语句：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
class MyComponent extends React.Component {
  constructor(props) {
    super(props);
    this.state = { error: null };
    this.handleClick = this.handleClick.bind(this);
  }

  handleClick() {
    try {      
        // 执行操作，如有错误则会抛出    
    } catch (error) {      
        this.setState({ error });    
    }  
  }

  render() {
    if (this.state.error) {      
        return <h1>Caught an error.</h1>    
    }    
    return <button onClick={this.handleClick}>Click Me</button>  
  }
}

请注意上述例子只是演示了普通的 JavaScript 行为，并没有使用错误边界。

总结

  • 首先错误边界也是一个组件，只不过是实现了定义了 static getDerivedStateFromError() 或 componentDidCatch() 这两个生命周期方法中的任意一个（或两个）。

  • 这个所谓的错误边界的作用类似try/catch，错误边界中间的内容可以类比成try中的内容，而catch到error之后，在错误边界的 static getDerivedStateFromError() 或 componentDidCatch() 中去处理，前者用于渲染备用UI，后者用来打印log。

  • 错误边界无法捕获以下场景中产生的错误：

    • 事件处理（了解更多）
    • 异步代码（例如 setTimeout 或 requestAnimationFrame 回调函数）
    • 服务端渲染
    • 它自身抛出来的错误（并非它的子组件）