GlobalErrorHandler: Tangkap ralat yang berlaku melalui jari ErrorBoundary!

ErrorBoundary ialah alat yang hebat untuk menangkap ralat yang dilemparkan daripada komponen React. Anda boleh memberikan mesej ralat tersuai mengikut sifat dan penempatan ralat itu sendiri. Tetapi tidak semua lontaran ralat dikendalikan oleh ErrorBoundary! Apa yang anda lakukan dengan mereka?

Apabila mempertimbangkan kedua-dua ralat async dan ralat membuang dari luar React, ErrorBoundary menjadi pendek. Untuk mengurangkan ini, saya ada dalam aplikasi saya mencipta apa yang saya panggil GlobalErrorHandler. Komponen berfungsi yang hanya A) Paparkan dialog ralat, memberitahu pengguna bahawa sesuatu telah berlaku, B) Log ralat ke pelayan, supaya kami boleh menyiasat dan mencari penyelesaian.

Ideanya mudah sahaja. Kami mahukan satu GlobalErrorHandler dalam akar aplikasi kami. Pengendali ini harus hanya mengendalikan ralat yang tidak ditangkap oleh ErrorBoundary. Apatah lagi, ia harus diketepikan dengan mudah oleh pengguna, dan kita harus menganggap bahawa aplikasi itu masih boleh digunakan.

Jadi strateginya adalah begini: GlobalErrorHandler tidak melakukan apa-apa langsung, kecuali memberikan anak-anaknya, secara lalai. Tetapi, ia menyediakan dua pendengar acara, mendengar semua ralat dan peristiwa penolakan yang tidak dikendalikan dalam penyemak imbas. Kemudian ia memeriksa ralat, dan melihat sama ada ia telah dikendalikan oleh mana-mana ErrorBoundaries. Akhir sekali, jika itu tidak berlaku, ia muncul Dialog, memberitahu pengguna bahawa sesuatu telah berlaku di suatu tempat dan membenarkan pengguna mengetepikan dialog dan terus menggunakan aplikasi.

Adakah ralat itu sudah diuruskan

Sebelum mengganggu pengguna akhir dengan dialog yang tidak perlu DI ATAS pengendalian yang dilakukan oleh ErrorBoundary, kita perlu mulakan dengan bertanya ralat: Adakah anda sudah dikendalikan? Penyelesaian saya untuk ini, ialah memperkenalkan medan baharu pada objek ralat isHandledByBoundary. Ini ditetapkan kepada benar dalam ErrorBoundary:

  componentDidCatch(error: Error, errorInfo: ErrorInfo) {
    (error as any).isHandledByBoundary = true;
    ....
  }

Dengan adanya ini dalam semua komponen ErrorBoundary (dan jentera lain yang mengendalikan ralat yang tidak ditangkap), kami bersedia untuk mula mentakrifkan GlobalErrorHandler kami.

Rangka yang kosong

Kemudian kami boleh membina rangka GlobalErrorHandler kami. Ia secara terus terang memberikan anak-anaknya, dan ia juga menjadikan "ErrorDialog" yang ditakrifkan di tempat lain. (Jika anda ingin berkongsi komponen ini merentas aplikasi, ErrorDialog boleh menjadi prop sebaliknya.)

import { useState, useEffect, ReactNode } from 'react';
import { ErrorDialog } from '../Components/ErrorDialog';

type Props = {
  children: ReactNode;
};

export function GlobalErrorHandler({ children }: Props) {
  const [error, setError] = useState<Error | string | null>(null);
  const [isDialogOpen, setDialogOpen] = useState(false);

  useEffect(() => {
    ....
  }, []);

  function handleCloseDialog() {
    setDialogOpen(false);
    setError(null);
  }

  return (
    <>
      {children}

      {isDialogOpen && error && (
        <ErrorDialog
          actionName="Unhandled error"
          error={error}
          loggFeilmelding={true}
          onClose={handleCloseDialog}
        />
      )}
    </>
  );
}

Satu-satunya perkara yang kita kurang sekarang, ialah pengendalian ralat itu sendiri, ditakrifkan dalam useEffect.

Mengendalikan kesilapan

Semua kod dalam bahagian ini harus terletak dalam fungsi useEffect!

Mula-mula kami mentakrifkan handleWindowError. Ini akan dihantar kepada pengendali acara ralat pada objek tetingkap. Tiada apa-apa yang misteri di sini, tetapi saksikan bahawa peristiwa ralat itu juga mengandungi maklumat tentang sumber, nombor baris dan nombor kol. Yang mungkin berharga untuk dikumpulkan.

Biasanya maklumat ini juga ditemui dalam objek ralat, tetapi saya perlu membuat lebih banyak penyiasatan empirikal tentang perkara ini. Mungkin kita sentiasa perlu mengekalkan nombor baris dan kol seperti yang dilaporkan oleh peristiwa ralat? Dalam kes itu, kami juga boleh mempunyai keadaan untuk ini dalam GlobalErrorHandler (dan pastikan ini dihantar semasa mengelog ralat).

  componentDidCatch(error: Error, errorInfo: ErrorInfo) {
    (error as any).isHandledByBoundary = true;
    ....
  }

Kami juga akan menentukan pengendali handleUnhandledRejection. Ini adalah untuk ralat yang ditimbulkan dalam janji, tetapi apabila kita terlupa untuk menulis klausa .catch().

import { useState, useEffect, ReactNode } from 'react';
import { ErrorDialog } from '../Components/ErrorDialog';

type Props = {
  children: ReactNode;
};

export function GlobalErrorHandler({ children }: Props) {
  const [error, setError] = useState<Error | string | null>(null);
  const [isDialogOpen, setDialogOpen] = useState(false);

  useEffect(() => {
    ....
  }, []);

  function handleCloseDialog() {
    setDialogOpen(false);
    setError(null);
  }

  return (
    <>
      {children}

      {isDialogOpen && error && (
        <ErrorDialog
          actionName="Unhandled error"
          error={error}
          loggFeilmelding={true}
          onClose={handleCloseDialog}
        />
      )}
    </>
  );
}

Kemudian apa yang perlu kita lakukan, ialah menyediakan pendengar dan mengalih keluar pendengar apabila GlobalErrorHandler tidak dipaparkan lagi:

   function handleWindowError(
      message: string | Event,
      source?: string,
      lineno?: number,
      colno?: number,
      error?: Error
    ) {
      if (error && (error as any).isHandledByBoundary) {
        return true;
      }

      const errorMessage = error
        ? error
        : `Error: ${message} at ${source}:${lineno}:${colno}`;
      setError(errorMessage);
      setDialogOpen(true);
      return true;
    }

Pernyataan pemulangan, sudah tentu, di mana kita kembali daripada fungsi yang kita suapkan useEffect. Ini memastikan bahawa kami mula mendengar acara dan mengendalikannya apabila komponen dipaparkan dan berhenti apabila komponen tidak dipaparkan lagi.

Oleh itu, kami mempunyai GlobalEventHandler, untuk menangani ralat menjengkelkan dalam aplikasi React kami yang sama ada dibuang daripada sumber tak segerak atau dibuang dari luar komponen React!

Atas ialah kandungan terperinci GlobalErrorHandler: Tangkap ralat yang berlaku melalui jari ErrorBoundary!. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!