react進階教學之例外處理機制error Boundaries

2022-08-08 18:00:25

在過去，React元件中的js錯誤通常會汙染React的內部state並且造成它發出一個讓人難以理解的錯誤給下一個Render，我們在控制檯看到的異常往往是由更內層的程式程式碼引起的，但是React並沒有提供一個方式讓我們在元件中優雅的解決他們並恢復業務邏輯。

Error Boundaries介紹

UI的某部分引起的JS錯誤不應該破壞整個程式，為了幫React的使用者解決這個問題，React 16介紹了一種關於錯誤邊界（error boundary)的新觀念。

error boundaries 讓react元件可以捕獲在他們子級元件樹任何地方的錯誤,並且列印出這些錯誤和演示一個預備UI（fallback UI），從而替換那些出現異常的元件樹。Error boundaries在rendering，lifeCyclemethod或處於他們樹層級之下的建構函式中捕獲錯誤。

（註釋：lifecycle method是react固有名詞，包括componentWillUpdate，componentWillReceiveProps,render等方法，這些方法會自動呼叫）

注意： error boundaries並不會捕捉這些錯誤：

1.事件處理器

2.非同步程式碼

3.伺服器端的渲染程式碼

4.在error boundaries區域內的錯誤

在這個lifecycle method： componentDIdCatch(error,info) 裡的類會變成一個 error boundary

class ErrorBoundary extends React.Component {
  constructor(props) {
    super(props);
    this.state = { hasError: false };
  }
 
  componentDidCatch(error, info) {
    // Display fallback UI
    this.setState({ hasError: true });
    // You can also log the error to an error reporting service
    logErrorToMyService(error, info);
  }
 
  render() {
    if (this.state.hasError) {
      // You can render any custom fallback UI
      return <h1>Something went wrong.</h1>;
    }
    return this.props.children;
  }
}

然後你就可以像一個普通元件一樣使用它

<ErrorBoundary>
  <MyWidget />
</ErrorBoundary>

componentDidCatch()方法像JS的catch{}模組一樣工作，但是對於元件，只有class型別的元件(class component)可以成為一個error boundaries，在實際上，大多數情況下你可能只需要在整個程式中定義一個error boundary元件，然後你就可以一直使用它了！

請注意error boundaries僅僅可以捕獲到在他們樹的層級下面的錯誤，而不能捕獲到本層級的錯誤，如果一個error boundaries渲染錯誤資訊失敗了，那麼這個錯誤將會傳播到一個在它層級上面，並且離它最近的error boundary 。這就像js的{}模組的工作機制一樣。

ComponentDidCatch 引數

error: 這是一個已經被丟擲的錯誤
info:這是一個componentStack key。這個屬性有關於丟擲錯誤的元件堆的資訊

componentDidCatch(error, info) {
  
  /* Example stack information:
     in ComponentThatThrows (created by App)
     in ErrorBoundary (created by App)
     in div (created by App)
     in App
  */
  logComponentStackToMyService(info.componentStack);

觸發error boundaries後程式要走向哪裡？

關於error boundaries的後續處理由你做主，你可能會指定一個最高等級的路由元件去給使用者標識某些地方出了問題，就像伺服器端的框架處理異常一樣，你也可以指定一個在錯誤邊界內的個人的小頁面讓整個程式不至於發生崩潰。

對於不能捕獲的錯誤的新處理方式

這種變化有一個重要的新含義，對於React 16，沒有被任何error boundary捕獲的錯誤將會導致整個React元件樹的崩潰。

我們對這個決定有爭論，但是在我們的經驗裡，留下一個崩潰的UI介面比完全移除它要糟糕，例如，在一個產品比如聊天器中，留下一個崩壞的UI介面可能會導致某個人傳送資訊給一個並非他想要傳送的人。同樣的，對於一個支付類的app來說，不要顯示任何東西顯然比顯示一個錯誤的金額數目要好。

這個改動意味著如果你遷移到React 16，你可能會發現一些以前沒有注意到的，並且是確確實實存在的在你程式中的異常，增加error boundaries會讓你在某些地方出現問題的時候可以提供更好的使用者體驗。

舉個例子，facebook的側邊欄，資訊面板，對話記錄以及訊息輸入框處於被分割開來的error boundaries中，如果在他們的UI子元件中發生了崩潰事件，那麼其他的元件還可以正常執行。

我們同樣鼓勵你使用JS 錯誤報道服務（或者你自己建立一個），然後你就可以瞭解到這些未被處理的異常是如何發生的，接著解決他們。

在堆中跟蹤component

React 16 會把所有render過程中發生的錯誤列印給開發者，即使程式意外的包含了它。它不僅僅提供了錯誤資訊和追蹤js堆，也提供了元件的堆路徑，現在你可以精確的看到元件樹中錯誤發生的地方。

你同樣可以在元件的堆追蹤中看到檔案名字和行數，這是creat react app專案的預設設定

如果你沒有使用Create React App ，你也可以通過新增這個外掛，手動的管理你的babel設定。注意：它必須嚴格的限制在開發過程中使用，生產過程一定要剔除。

注意：在堆的追蹤中看到的元件名字取決於 Function.name屬性。如果你想要支援那些現在還沒有原生提供這些的瀏覽器和裝置，比如ie11，consider including a Function.name polyfill in your bundled application, such as function.name-polyfill. 否則，你必須明確的在你所有的元件中都設定displayName.

try/catch 如何?

try/catch是非常棒的但是它只在imperative code(命令式程式碼）中起作用

try {
  showButton();
} catch (error) {
  // ...
}

然而，react元件是宣告式的並且指定應該被渲染的內容

<Button />

Error boundaries保留了React的宣告式性質，並且擁有你期待的表現。比如，即使通過某個在樹的深層setState，在componentDidUpdate攔截中發生了錯誤，它也仍然會被正確的傳送到最近的error boundary。

Event Handlers怎麼樣？

error boundaries並不能捕獲event handles中的異常。

React並不需要error boundaries從event handles中恢復錯誤。與render方法和lifecycle攔截不同的是，event Handles並不會在rendering期間發生。所以如果他們被丟擲，React仍然知道怎麼去渲染。

如果你需要捕獲event handler，使用普通的js程式碼try/catch 宣告

class MyComponent extends React.Component {
  constructor(props) {
    super(props);
    this.state = { error: null };
  }
  
  handleClick = () => {
    try {
      // Do something that could throw
    } catch (error) {
      this.setState({ error });
    }
  }
 
  render() {
    if (this.state.error) {
      return <h1>Caught an error.</h1>
    }
    return <div onClick={this.handleClick}>Click Me</div>
  }
}

注意以上程式碼僅僅展示通常的js習慣，而沒有使用error boundaries。