Error Boundaries--React中的错误捕获和上报

错误边界介绍

部分 UI 中的 JavaScript 错误不应该破坏整个应用程序。 为了解决 React 用户的这个问题,React 16引入了一个 “错误边界(Error Boundaries)” 的新概念。
错误边界是 React 组件,它可以在子组件树的任何位置捕获 JavaScript 错误,记录这些错误,并显示一个备用 UI ,而不是使整个组件树崩溃。 错误边界(Error Boundaries) 在渲染,生命周期方法以及整个组件树下的构造函数中捕获错误。

使用方法

如果一个类组件定义了生命周期方法中的任何一个(或两个)static getDerivedStateFromError()componentDidCatch(),那么它就成了一个错误边界。 使用static getDerivedStateFromError()在抛出错误后渲染回退UI。 使用 componentDidCatch() 来记录错误信息。

捕获范围

组件内异常,也就是异常边界组件能够捕获的异常,主要包括:

  1. 渲染过程中异常;
  2. 生命周期方法中的异常;
  3. 子组件树中各组件的constructor构造函数中异常。

不能捕获的异常,主要是异步及服务端触发异常:

  1. 事件处理器中的异常;
    处理方法: 使用try/catch代码进行捕获
  2. 异步任务异常,如setTiemout,ajax请求异常等;
    处理方法:使用全局事件window.addEventListener捕获
  3. 服务端渲染异常;
  4. 异常边界组件自身内的异常;
    处理方法:将边界组件和业务组件分离,各司其职,不能在边界组件中处理逻辑代码,也不能在业务组件中使用didcatch

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

如何放置错误边界

错误边界的粒度完全取决于你的应用。你可以将其包装在最顶层的路由组件并为用户展示一个 “发生异常(Something went wrong)“的错误信息,就像服务端框架通常处理崩溃一样。你也可以将单独的插件包装在错误边界内部以保护应用不受该组件崩溃的影响。

借鉴Facebook的message项目,他们应用错误边界的方式是将大的模块应用错误边界包裹,这样当一个主要模块因为意外的错误崩溃后,其它组件仍然能够正常交互

错误边界实战

首先我定义了一个高阶组件

import React from 'react'

const ErrorBoundary = errorInfo => WrapComponent => {
    return class ErrorBoundary extends React.Component{
        constructor(props) {
            super(props);
            this.state = { hasError: false };
        }
        // 这个静态方法和componentDidCatch方法定义一个即可
        static getDerivedStateFromError(error) {
            // 当发生错误时,设置hasError为true,然后展示自己的错误提示组件
            return { hasError: true };
        }

        componentDidCatch(error, info) {
            // 这里可以将报错信息上报给自己的服务
            // logErrorToMyService(error, info);
        }

        render() {
            if (this.state.hasError) {
                return <h1>{errorInfo}</h1>;
            }
            return <WrapComponent/>;
        }
    }
}
export default ErrorBoundary

接下来可以使用边界组件包裹业务组件,这里列举我认为react项目中可以处理的错误方式,例如事件处理器的错误,异步错误,promise错误,渲染错误等

import React from 'react'
import ErrorBoundary from '../../utils/ErrorBoundary'
@ErrorBoundary('i am not ok')
export default class Error extends React.Component{
    constructor() {
        super()
    }
    componentWillMount() {
        window.addEventListener('error', event => {
            console.log(event)
        }, true)
        window.addEventListener('unhandledrejection', event => {
            console.log(event)
        })
    }
    // 这个异步错误 ErrorBoundary组件不会捕获到 但是在入口写的全局window.onerror事件捕获到了
    componentDidMount() {
        setTimeout(() => {
            // console.log(b)
        }, 100)
    }
    // 事件处理器中的错误 onerror也可以捕获到
    // 这里如果想要hold住错误 需要使用try catch
    handleEventError = () => {
        console.log(error)
    }
    // promise 如果reject 但是没有写catch语句的话 会报错 
    // 但是onerror和try-catch和ErrorBoundary组件都无法捕获
    // 需要写一个全局unhandledrejection 事件捕获
    handlePromiseError = () => {
        const promise = new Promise((resolve, reject) => {
            reject()
        })
        promise.then()
    }
    render() {
        return <div>
            <div>hi i am fine</div>
            <button onClick={this.handleEventError}>handle event error</button>
            <button onClick={this.handlePromiseError}>handle promise error</button>
        </div>
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 210,978评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 89,954评论 2 384
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,623评论 0 345
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,324评论 1 282
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,390评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,741评论 1 289
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,892评论 3 405
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,655评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,104评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,451评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,569评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,254评论 4 328
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,834评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,725评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,950评论 1 264
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,260评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,446评论 2 348

推荐阅读更多精彩内容

  • 1、通过CocoaPods安装项目名称项目信息 AFNetworking网络请求组件 FMDB本地数据库组件 SD...
    阳明先生_X自主阅读 15,969评论 3 119
  • 今日和企划部商讨品宣包装,细化三四月份的营销方案。品牌定位品牌理念不清晰,营销动作就没有主打方向,没法聚焦,就没法...
    一世惊鸿阅读 75评论 0 0