[[438303]]

大家好，我卡頌。

本文會講解React中Error Boundaries的完整實現邏輯。

一張圖概括：

這里簡單講解下React工作流程，后文有用。分為三步：

1. 觸發更新
2. render階段：計算更新會造成的副作用
3. commit階段：在宿主環境執行副作用

副作用有很多，比如：

• 插入DOM節點
• 執行useEffect回調

好了，讓我們進入主題。

什么是Error BoundariesReact

提供了兩個與「錯誤處理」相關的API：

• getDerivedStateFromError：靜態方法，當錯誤發生后提供一個機會渲染fallback UI
• componentDidCatch：組件實例方法，當錯誤發生后提供一個機會記錄錯誤信息

使用了這兩個API的ClassComponent通常被稱為Error Boundaries(錯誤邊界)。

在Error Boundaries的「子孫組件」中發生的所有「React工作流程內」的錯誤都會被Error Boundaries捕獲。

通過開篇的介紹可以知道，「React工作流程」指：

• render階段
• commit階段

考慮如下代碼：

class ErrorBoundary extends Component { 
  componentDidCatch(e) { 
    console.warn(“發生錯誤”, e); 
  } 
  render() { 
    return <div>{this.props.children}</div>; 
  } 
} 
 
const App = () => ( 
 <ErrorBoundary> 
    <A><B/></A> 
    <C/> 
 <ErrorBoundary> 
) 

 A、B、C作為ErrorBoundary的子孫組件，當發生「React工作流程內」的錯誤，都會被ErrorBoundary中的componentDidCatch方法捕獲。

步驟1:捕獲錯誤

首先來看「工作流程中的錯誤都是何時被捕獲的」。

render階段的核心代碼如下，發生的錯誤會被handleError處理：

do { 
  try { 
    // 對于并發更新則是workLoopConcurrent 
workLoopSync(); 
    break; 
  } catch (thrownValue) { 
    handleError(root, thrownValue); 
  } 
} while (true); 

commit階段包含很多工作，比如：

• componentDidMount/Update執行
• 綁定/解綁ref
• useEffect/useLayoutEffect callback與destroy執行

這些工作會以如下形式執行，發生的錯誤被captureCommitPhaseError處理：

try { 
// …執行某項工作  
} catch (error) { 
  captureCommitPhaseError(fiber, fiber.return, error); 
} 

步驟2:構造callback

可以發現，即使沒有Error Boundaries，「工作流程」中的錯誤已經被React捕獲了。而正確的邏輯應該是：

• 如果存在Error Boundaries，執行對應API
• 拋出React的提示信息
• 如果不存在Error Boundaries，拋出「未捕獲的錯誤」

所以，不管是handleError還是captureCommitPhaseError，都會從發生錯誤的節點的父節點開始，逐層向上遍歷，尋找最近的Error Boundaries。

一旦找到，就會構造：

• 用于「執行Error Boundaries API」的callback
• 用于「拋出React提示信息」的callback

React錯誤提示信息，包括提示語和錯誤堆棧

  // ...為了可讀性，邏輯有刪減 
function createClassErrorUpdate() { 
  if (typeof getDerivedStateFromError === 'function') { 
// 用于執行getDerivedStateFromError的callback 
    update.payload = () => { 
      return getDerivedStateFromError(error); 
}; 
// 用于拋出React提示信息的callback 
    update.callback = () => { 
      logCapturedError(fiber, errorInfo); 
    }; 
  } 
  if (inst !== null && typeof inst.componentDidCatch === 'function') { 
// 用于執行componentDidCatch的callback 
    update.callback = function callback() { 
      this.componentDidCatch(error); 
    }; 
  } 
  return update; 
} 

如果沒有找到Error Boundaries，繼續向上遍歷直到根節點。

此時會構造：

• 用于「拋出未捕獲錯誤」的callback
• 用于「拋出React提示信息」的callback

// ...為了可讀性，邏輯有刪減 
funffction createRootErrorUpdate() { 
  // 用于拋出“未捕獲的錯誤”及“React的提示信息”的callback 
  update.callback = () => { 
    onUncaughtError(error); 
    logCapturedError(fiber, errorInfo); 
  }; 
  return update; 
} 

執行callback

構造好的callback在什么時候執行呢?

在React中有兩個「執行用戶自定義callback」的API：

• 對于ClassComponent， this.setState(newState, callback)中newState和callback參數都能傳遞Function作為callback

所以，對于Error Boundaries，相當于主動觸發了一次更新：

this.setState(() => { 
  // 用于執行getDerivedStateFromError的callback 
}, () => { 
  // 用于執行componentDidCatch的callback 
  //  以及 用于拋出React提示信息的callback 
}) 

• 對于根節點，執行ReactDOM.render(element, container, callback)中callback參數能傳遞Function作為callback

所以，對于「沒有Error Boundaries」的情況，相當于主動執行了如下函數：

ReactDOM.render(element, container, () => { 
// 用于拋出“未捕獲的錯誤”及“React的提示信息”的callback 
}) 

所以，Error Boundaries的實現可以看作是：React利用已有API實現的新功能。

總結

經常有人問：為什么Hooks沒有Error Boundaries?

可以看到，Error Boundaries的實現借助了this.setState可以傳遞callback的特性，useState暫時無法完全對標。

最后，給你留個作業，在官方文檔[1]介紹了4種情況的錯誤不會被Error Boundaries捕獲。

利用本文知識，你能分析下他們為什么不會被捕獲么?

參考資料

[1]官方文檔:

https://reactjs.org/docs/error-boundaries.html#introducing-error-boundaries