MENU
  1. ホーム
  2. React
  3. Reactでエラー発生時に代替UIを表示するError Boundaryの設計例

Reactでエラー発生時に代替UIを表示するError Boundaryの設計例

React

Reactでアプリケーションを開発していると、予期しないエラーが発生することがあります。特に、クライアントサイドでの動作中にエラーが発生すると、アプリケーション全体がクラッシュし、ユーザー体験が大きく損なわれる可能性があります。Reactでは、こうした問題に対応するために「Error Boundary」という機能が提供されています。Error Boundaryを活用すれば、アプリケーションの一部でエラーが発生した際でも、エラーが他の部分に影響を与えないようにし、代替UIを表示することでユーザー体験を保つことができます。本記事では、Error Boundaryの基本概念から設計例、応用方法までを詳しく解説し、Reactアプリケーションの堅牢性を向上させる方法を紹介します。

目次

Error Boundaryの基本概念


ReactのError Boundaryは、Reactコンポーネントツリーの一部でエラーが発生した際、そのエラーをキャッチしてアプリケーション全体のクラッシュを防ぎます。Error Boundaryを使うことで、エラーが発生した箇所の代わりに代替UIを表示し、他の正常な部分が引き続き動作するようにします。

Error Boundaryの役割


Error Boundaryの主な役割は次の通りです。

  • エラーハンドリング：コンポーネントツリー内で発生するエラーをキャッチします。
  • 影響範囲の限定：エラーがアプリケーション全体に波及するのを防ぎます。
  • 代替UIの表示：エラー発生箇所に代わるフォールバックUIを表示します。

Error Boundaryの適用範囲


Error Boundaryが処理できるのは次のようなエラーです。

  • レンダリング中に発生するエラー
  • ライフサイクルメソッド内で発生するエラー
  • 子コンポーネントで発生するエラー

ただし、以下のようなケースは処理できません。

  • イベントハンドラー内のエラー（try-catchを使用して個別に処理する必要があります）
  • 非同期コード（例: setTimeoutやfetch）で発生するエラー

Error Boundaryを使うべき場面


Error Boundaryは、アプリケーション全体ではなく、特定の重要なセクション（例: ウィジェット、サードパーティコンポーネント）に適用するのが一般的です。これにより、エラーが他の部分に影響を与えないように設計できます。

Error Boundaryの作成手順

ReactでError Boundaryを作成するには、クラスコンポーネントを使用する必要があります。関数コンポーネントではError Boundaryを直接実装できないため、クラスコンポーネントを利用してエラーハンドリングを行います。以下に、Error Boundaryの基本的な作成手順を示します。

1. Error Boundaryクラスコンポーネントの実装


Error Boundaryは、componentDidCatchライフサイクルメソッドとstatic getDerivedStateFromErrorメソッドを使用してエラーをキャッチします。

import React, { Component } from 'react';

class ErrorBoundary extends Component {
  constructor(props) {
    super(props);
    this.state = { hasError: false };
  }

  // エラーが発生した場合に状態を更新
  static getDerivedStateFromError(error) {
    return { hasError: true };
  }

  // エラー情報をキャッチし、ログなどに利用
  componentDidCatch(error, info) {
    console.error("Error caught by ErrorBoundary:", error, info);
  }

  render() {
    if (this.state.hasError) {
      // エラー発生時に表示する代替UI
      return <h1>Something went wrong.</h1>;
    }

    // 通常時は子コンポーネントをレンダリング
    return this.props.children;
  }
}

export default ErrorBoundary;

2. Error Boundaryの使用


作成したError Boundaryを、エラーが発生する可能性があるコンポーネントを囲むように配置します。

import React from 'react';
import ErrorBoundary from './ErrorBoundary';
import MyComponent from './MyComponent';

function App() {
  return (
    <ErrorBoundary>
      <MyComponent />
    </ErrorBoundary>
  );
}

export default App;

3. エラーハンドリングを強化する（オプション）


Error BoundaryのフォールバックUIをカスタマイズすることで、より良いユーザー体験を提供できます。たとえば、リロードボタンやサポートページへのリンクを含むUIを設計できます。

render() {
  if (this.state.hasError) {
    return (
      <div>
        <h1>Something went wrong.</h1>
        <button onClick={() => window.location.reload()}>Reload</button>
      </div>
    );
  }
  return this.props.children;
}

これにより、ユーザーにエラーが発生したことを知らせつつ、アプリケーションの復旧方法を提供できます。

代替UIの設計ポイント

Error Boundaryを活用してエラー発生時に表示する代替UI（フォールバックUI）は、ユーザー体験を保つために重要な役割を果たします。適切な設計によって、ユーザーがエラーに対して冷静に対処できるようにすることが可能です。以下に代替UIを設計する際の主要なポイントを解説します。

1. ユーザーにエラーの存在を明確に伝える


エラー発生時には、ユーザーに問題が起きたことを分かりやすく知らせるメッセージを表示します。このメッセージは、技術的な詳細よりもユーザーに共感を示す文言を含めるべきです。

例:

<h1>Oops! Something went wrong.</h1>
<p>We apologize for the inconvenience. Please try again later.</p>

2. 次の行動を提案する


エラーからの回復を支援するために、次に何をすべきかを明示します。これには、再読み込みボタン、サポートページへのリンク、またはカスタマーサービスの連絡先情報が含まれます。

例:

<div>
  <button onClick={() => window.location.reload()}>Retry</button>
  <a href="/support">Contact Support</a>
</div>

3. デザインの一貫性を保つ


フォールバックUIのデザインは、アプリケーション全体のデザインと調和する必要があります。これにより、エラー発生時もブランドイメージやアプリケーションの印象が損なわれることを防ぎます。UIライブラリやCSSを活用して、既存のスタイルガイドに基づいたデザインを作成してください。

4. 状況に応じた情報を提供する


エラーが発生した原因に基づき、ユーザーに役立つ情報を提示します。たとえば、特定の条件でエラーが起きる場合、その解決策を提示することが有効です。

例:

  • ネットワークエラーの場合：「インターネット接続を確認してください。」
  • 認証エラーの場合：「ログイン情報を再確認してください。」

5. エラー情報の記録と通知


代替UIには直接関係しませんが、エラー発生時にはエラー内容を記録し、管理者や開発者に通知する仕組みを統合することが重要です。これにより、ユーザーが見えない部分で問題を解決する準備を整えられます。

componentDidCatch(error, info) {
  logErrorToService(error, info); // ログを外部サービスに送信
}

6. ユーザーの心理的負担を軽減する


エラーはユーザーに不安やストレスを与える可能性があります。そのため、代替UIに親しみやすいイラストやポジティブな文言を取り入れ、心理的負担を軽減する工夫をしましょう。

例:

<img src="/images/error-illustration.png" alt="Error Illustration" />
<p>Don’t worry! Our team is working on it.</p>

適切な代替UIを設計することで、エラーが発生した際にもユーザーが安心して次のステップに進める環境を提供できます。

Error Boundaryの活用シナリオ

Error Boundaryは、特定のエラーが発生する可能性があるコンポーネントやアプリケーションのセクションに対して適用されます。以下に、Error Boundaryを活用できる具体的なシナリオを解説します。

1. サードパーティ製コンポーネントの使用時


サードパーティ製のUIライブラリやウィジェットを使用する際、それらが予期しないエラーを引き起こす可能性があります。Error Boundaryを適用することで、アプリケーション全体への影響を防ぎ、エラーが発生した部分のみを切り離せます。

例:

<ErrorBoundary>
  <ThirdPartyWidget />
</ErrorBoundary>

2. 動的にレンダリングされるコンポーネント


Reactでは、ユーザーの操作や状態によって動的にレンダリングされるコンポーネントがあります。これらのコンポーネントがエラーを引き起こす場合、Error Boundaryを利用することでエラー部分の影響を最小限に抑えられます。

例:

<ErrorBoundary>
  {isVisible && <DynamicComponent />}
</ErrorBoundary>

3. 高トラフィックの主要機能部分


アプリケーションの中でも、エラーが発生した場合にユーザー体験が大きく損なわれる可能性のある機能部分（例: カート機能、検索機能）には、Error Boundaryを適用することで重要な部分の安定性を確保できます。

例:

<ErrorBoundary>
  <ShoppingCart />
</ErrorBoundary>

4. リモートデータを扱うコンポーネント


APIコールや非同期データの取得中に予期しないエラーが発生する場合があります。Error Boundaryを適用することで、データ取得エラーによるアプリケーション全体のクラッシュを防ぎます。

例:

<ErrorBoundary>
  <DataFetchingComponent />
</ErrorBoundary>

5. マイクロフロントエンドの統合時


複数の独立したチームが開発したコンポーネントを統合するマイクロフロントエンドアーキテクチャでは、各コンポーネントの動作が原因でエラーが発生することがあります。Error Boundaryを統合部分に設置することで、エラーの影響を限定できます。

例:

<ErrorBoundary>
  <MicroFrontendApp />
</ErrorBoundary>

6. デバッグと開発中の活用


開発中に予期しないエラーが発生する場合、Error Boundaryを活用してエラーをキャッチし、ログを記録することで、問題の特定が容易になります。また、フォールバックUIにエラー内容を表示することで、デバッグに役立てることができます。

例:

<ErrorBoundary>
  <ComponentUnderDevelopment />
</ErrorBoundary>

7. 複数のError Boundaryの適用


Error Boundaryはツリー構造で複数配置することが可能です。これにより、エラー発生箇所に応じたフォールバックUIを表示することができます。

例:

<ErrorBoundary>
  <Header />
</ErrorBoundary>
<ErrorBoundary>
  <MainContent />
</ErrorBoundary>

これらのシナリオを活用することで、Error Boundaryはアプリケーションの安定性とエラー回復力を向上させる重要なツールとなります。

Error Boundaryの制約と限界

Error BoundaryはReactにおける強力なエラーハンドリング機能ですが、その適用範囲には制約や限界があります。これを理解し、適切に利用することが、堅牢なReactアプリケーションを構築する上で重要です。以下にError Boundaryの制約と限界について詳しく解説します。

1. キャッチできるエラーの範囲


Error Boundaryがキャッチできるのは、以下のような特定のエラーに限られます。

  • レンダリング中に発生するエラー
  • ライフサイクルメソッド（例: componentDidMount）で発生するエラー
  • 子コンポーネント内で発生するエラー

これら以外のエラー（例: イベントハンドラーや非同期処理中のエラー）はError Boundaryではキャッチできません。

例: 非同期エラーの例

function ComponentWithAsyncError() {
  useEffect(() => {
    async function fetchData() {
      throw new Error("Async error!");
    }
    fetchData();
  }, []);
  return <div>Component</div>;
}

// Error Boundaryではキャッチできない
<ErrorBoundary>
  <ComponentWithAsyncError />
</ErrorBoundary>


非同期エラーに対応するには、try-catch構文やカスタムエラーハンドリングロジックを追加する必要があります。

2. イベントハンドラーのエラー


Error Boundaryは、Reactのイベントハンドラー内で発生するエラーをキャッチしません。この場合、開発者が独自にエラー処理を行う必要があります。

例:

function ComponentWithEventError() {
  const handleClick = () => {
    throw new Error("Event error!");
  };
  return <button onClick={handleClick}>Click me</button>;
}

// Error Boundaryではキャッチできない
<ErrorBoundary>
  <ComponentWithEventError />
</ErrorBoundary>


このようなエラーを処理するには、イベントハンドラー内でtry-catchを使用する必要があります。

3. パフォーマンスへの影響


Error Boundaryは、すべてのエラーに対応するための万能ツールではありません。Error Boundaryが過剰に使用されると、アプリケーションのレンダリングが複雑になり、パフォーマンスに影響を与える可能性があります。適用範囲を限定し、必要最低限のコンポーネントにのみError Boundaryを設置することが推奨されます。

4. UIの一貫性の課題


Error Boundaryがエラーをキャッチすると、フォールバックUIに切り替わりますが、これが突然の変化としてユーザーに映る場合があります。フォールバックUIのデザインがアプリケーション全体と調和していないと、ユーザー体験が損なわれる可能性があります。

5. クライアントサイドでの限界


Error Boundaryはクライアントサイドのエラーを処理するものです。サーバーサイドで発生するエラーや、外部API呼び出しでの失敗については別のエラーハンドリング手法が必要です。

6. 開発中のデバッグ支援の制約


開発中にError Boundaryがエラーをキャッチすると、Reactのエラーバウンス（エラーを直接表示する開発者向けの機能）が無効になる場合があります。これにより、問題の特定が難しくなることがあります。このため、開発時にはError Boundaryを一時的に無効にすることが有効です。

例: 開発時のError Boundary無効化

if (process.env.NODE_ENV === 'development') {
  // Error Boundaryを無効化
  console.error = console.log;
}

まとめ


Error Boundaryは、エラーの影響範囲を限定し、アプリケーション全体の安定性を向上させる重要なツールです。しかし、すべてのエラーを処理できるわけではなく、その制約を理解し、他のエラーハンドリング手法と組み合わせて利用する必要があります。Error Boundaryの特性を正しく理解することで、より効果的なエラー管理が可能になります。

Error Boundaryとカスタムフックの組み合わせ

Error Boundaryはクラスコンポーネントとして実装されるため、関数コンポーネントでのエラーハンドリングに制限があります。ただし、React Hooksを活用することで、Error Boundaryとカスタムフックを組み合わせた柔軟な設計が可能です。以下にその方法を解説します。

1. カスタムフックを使ったエラーステート管理


Error Boundaryで検知したエラーをReactの状態として管理し、アプリケーション内で動的に利用できるようにします。

カスタムフックの例:

import { useState, useEffect } from 'react';

export function useError() {
  const [error, setError] = useState(null);

  const throwError = (error) => {
    setError(error);
  };

  useEffect(() => {
    if (error) {
      console.error("Logged error:", error);
    }
  }, [error]);

  return { error, throwError };
}

このフックを使うことで、関数コンポーネント内でエラーを検知し、状態を管理できます。

2. Error Boundaryとカスタムフックの統合


Error Boundaryを使い、アプリケーションの大枠でエラーをキャッチしつつ、カスタムフックを利用してより細かなエラーハンドリングを実現します。

例:

import React from 'react';
import { useError } from './useError';

function ErrorBoundaryWrapper({ children }) {
  const { error } = useError();

  if (error) {
    return <h1>An error occurred: {error.message}</h1>;
  }

  return children;
}

export default function App() {
  return (
    <ErrorBoundaryWrapper>
      <MyComponent />
    </ErrorBoundaryWrapper>
  );
}

3. 特定の機能でのエラーハンドリング


カスタムフックを特定のコンポーネントで利用することで、エラーが発生した場合の代替処理やフォールバックUIを動的に設定できます。

例:

function MyComponent() {
  const { throwError } = useError();

  const handleClick = () => {
    try {
      // エラーが発生する処理
      throw new Error("Test error!");
    } catch (err) {
      throwError(err);
    }
  };

  return <button onClick={handleClick}>Trigger Error</button>;
}

4. カスタムフックを用いたフォールバックUIの動的生成


カスタムフックを活用して、エラー情報に基づいたフォールバックUIを生成します。

例:

function ErrorFallback() {
  const { error } = useError();

  if (!error) return null;

  return (
    <div>
      <h1>Error Detected!</h1>
      <p>{error.message}</p>
      <button onClick={() => window.location.reload()}>Reload</button>
    </div>
  );
}

5. 複雑なエラーシナリオでの柔軟性


Error Boundaryの限界（非同期処理のエラーやイベントハンドラー内のエラー）を補完する形でカスタムフックを使えば、複雑なエラーシナリオに対応可能です。

例:

function AsyncComponent() {
  const { throwError } = useError();

  useEffect(() => {
    async function fetchData() {
      try {
        const response = await fetch("/api/data");
        if (!response.ok) {
          throw new Error("Failed to fetch data");
        }
      } catch (err) {
        throwError(err);
      }
    }

    fetchData();
  }, [throwError]);

  return <div>Data loaded</div>;
}

まとめ


Error Boundaryとカスタムフックの組み合わせにより、Reactアプリケーションのエラーハンドリングをより柔軟に、かつ強力にすることができます。この設計手法を活用すれば、クラスコンポーネントの制約を超え、関数コンポーネントや非同期処理にも対応した堅牢なアプリケーションを構築することが可能です。

Error Boundaryとログ記録の連携方法

Error Boundaryを使用してエラーをキャッチした際に、エラー情報をログとして記録し、サーバーや外部サービスに送信することで、エラーのトラブルシューティングやモニタリングを効率化できます。このセクションでは、Error Boundaryとログ記録の連携方法を解説します。

1. componentDidCatchでのログ記録


Error BoundaryのcomponentDidCatchメソッドを利用して、エラー情報をキャッチし、ログとして処理します。

例:

import React, { Component } from 'react';

class ErrorBoundary extends Component {
  constructor(props) {
    super(props);
    this.state = { hasError: false };
  }

  static getDerivedStateFromError(error) {
    return { hasError: true };
  }

  componentDidCatch(error, errorInfo) {
    console.error("Error caught by ErrorBoundary:", error, errorInfo);
    this.logErrorToService(error, errorInfo);
  }

  logErrorToService(error, errorInfo) {
    // エラーを外部ログサービスに送信
    fetch("/api/log-error", {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({ error: error.toString(), info: errorInfo })
    });
  }

  render() {
    if (this.state.hasError) {
      return <h1>Something went wrong.</h1>;
    }
    return this.props.children;
  }
}

export default ErrorBoundary;

2. 外部ログサービスとの統合


エラー情報をモニタリングツールやログ管理サービス（例: Sentry、LogRocket、Datadog）に送信することで、リアルタイムのエラー監視と解析が可能になります。

Sentryとの統合例:

import React, { Component } from 'react';
import * as Sentry from "@sentry/react";

Sentry.init({
  dsn: "https://your-dsn-key@o0.ingest.sentry.io/123456",
});

class ErrorBoundary extends Component {
  constructor(props) {
    super(props);
    this.state = { hasError: false };
  }

  static getDerivedStateFromError(error) {
    return { hasError: true };
  }

  componentDidCatch(error, errorInfo) {
    Sentry.captureException(error, { extra: errorInfo });
  }

  render() {
    if (this.state.hasError) {
      return <h1>An unexpected error occurred.</h1>;
    }
    return this.props.children;
  }
}

export default ErrorBoundary;

3. ユーザーコンテキスト情報の添付


エラーの原因を特定しやすくするために、現在のユーザー情報やアプリケーションの状態をログに含めます。

例:

componentDidCatch(error, errorInfo) {
  const userContext = {
    userId: "12345",
    username: "testUser",
    sessionId: "abc123",
  };

  this.logErrorToService(error, { ...errorInfo, userContext });
}

4. ログ記録の非同期化


エラー情報の送信は非同期で行い、アプリケーションのパフォーマンスに影響を与えないようにします。

例:

logErrorToService(error, errorInfo) {
  setTimeout(() => {
    fetch("/api/log-error", {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({ error: error.toString(), info: errorInfo })
    });
  }, 0);
}

5. ユーザー通知とログ記録の分離


エラー発生時にユーザーへの通知（代替UIの表示）とログ記録処理を明確に分離することで、UXを損なうことなくエラー情報を収集できます。

例:

render() {
  if (this.state.hasError) {
    return (
      <div>
        <h1>Something went wrong.</h1>
        <p>We are working to fix this issue. Please try again later.</p>
      </div>
    );
  }
  return this.props.children;
}

6. ログデータの活用方法

  • リアルタイムモニタリング: エラー発生状況を即座に把握。
  • トレンド分析: エラー発生率を可視化し、改善すべき部分を特定。
  • トラブルシューティング: エラーの詳細情報を活用して迅速に修正。

まとめ


Error Boundaryとログ記録を連携させることで、エラーの特定や修正を効率化し、より堅牢なReactアプリケーションを構築できます。適切なツールや手法を選択し、エラー管理を最適化しましょう。

Error Boundaryのテストとデバッグ

Error Boundaryの正しい動作を確認するためには、テストとデバッグが不可欠です。ここでは、Error Boundaryをテストする方法と、発生する問題を効率的にデバッグする手法について解説します。

1. 単体テストでError Boundaryを検証

Error Boundaryがエラーを正しくキャッチし、フォールバックUIを表示するかをテストすることが重要です。JestとReact Testing Libraryを使用してテストを行う例を示します。

テスト例:

import React from 'react';
import { render, screen } from '@testing-library/react';
import ErrorBoundary from './ErrorBoundary';

function ProblematicComponent() {
  throw new Error("Test error");
}

test("renders fallback UI when an error occurs", () => {
  render(
    <ErrorBoundary>
      <ProblematicComponent />
    </ErrorBoundary>
  );

  expect(screen.getByText("Something went wrong.")).toBeInTheDocument();
});

2. フォールバックUIの表示確認

Error Boundaryがエラー発生時にフォールバックUIを正しく表示するかを手動で確認することも重要です。以下のように問題を意図的に発生させて確認します。

例:

function ProblematicComponent() {
  if (true) {
    throw new Error("Intentional error");
  }
  return <div>No error</div>;
}

<ErrorBoundary>
  <ProblematicComponent />
</ErrorBoundary>


アプリケーションを実行し、期待通りのフォールバックUIが表示されるか確認します。

3. ログ記録の確認

componentDidCatchで記録したログが正しく出力されているか確認します。ブラウザのコンソールや外部サービス（例: Sentry）でエラー内容が収集されていることを検証します。

例:

componentDidCatch(error, errorInfo) {
  console.log("Error:", error);
  console.log("Error Info:", errorInfo);
}


コンソールに表示されるログを確認し、期待通りの内容が出力されているかを確認します。

4. エラーシナリオごとのテスト

Error Boundaryがさまざまなエラーシナリオで正しく動作することを確認するため、以下のようなテストケースを網羅します。

  • 子コンポーネントのレンダリング中に発生するエラー
  • ライフサイクルメソッドで発生するエラー
  • サードパーティライブラリで発生するエラー

例:

test("handles errors in child component lifecycle methods", () => {
  class ProblematicComponent extends React.Component {
    componentDidMount() {
      throw new Error("Lifecycle error");
    }
    render() {
      return <div>Component</div>;
    }
  }

  render(
    <ErrorBoundary>
      <ProblematicComponent />
    </ErrorBoundary>
  );

  expect(screen.getByText("Something went wrong.")).toBeInTheDocument();
});

5. デバッグ時のポイント

エラーがキャッチされない場合やフォールバックUIが表示されない場合、以下のポイントを確認します。

  • Error Boundaryの適用範囲: 子コンポーネントがError Boundaryで正しくラップされているか確認します。
  • 非同期処理のエラー: Error Boundaryがキャッチできない非同期エラーが発生していないか検証します。
  • エラーメッセージの詳細確認: エラーオブジェクトに含まれるスタックトレースやメッセージを調査します。

6. 開発環境でのError Boundaryの一時無効化

開発中には、Error Boundaryを一時的に無効化することで、Reactの開発者向けエラーメッセージを直接確認できます。

例:

if (process.env.NODE_ENV === 'development') {
  console.error = console.log;
}

まとめ


Error Boundaryのテストとデバッグは、アプリケーション全体の安定性を確保するために不可欠です。単体テストやログ記録、さまざまなエラーシナリオへの対応を通じて、Error Boundaryが適切に機能していることを確認しましょう。これにより、予期しないエラーに強いReactアプリケーションを構築できます。

まとめ

本記事では、ReactにおけるError Boundaryの基本概念から設計例、活用方法、制約、ログ記録との連携、テストとデバッグ手法までを詳しく解説しました。Error Boundaryは、アプリケーションの一部で発生したエラーを他の部分に影響させず、代替UIを提供することでユーザー体験を損なわない強力なツールです。

Error Boundaryを効果的に利用するには、以下のポイントが重要です：

  • 基本的な使い方を理解し、適切な範囲で適用する。
  • カスタムフックやログ記録機能と組み合わせて柔軟性を高める。
  • テストやデバッグを通じて、期待どおりの動作を確認する。

Error Boundaryを適切に実装することで、Reactアプリケーションの堅牢性と信頼性を大幅に向上させることができます。これを機に、エラー管理の最適化に取り組み、ユーザーに優れた体験を提供しましょう。

React
React UI設計 Error Boundary

コメント

コメントする

目次