关于javascript:封装一个处理-react-异常的最简-ErrorBoundary-组件-🎅

前言 📝

👉 从 React 16 开始，引入了 Error Boundaries 概念，它能够捕捉它的子组件中产生的谬误，记录谬误日志，并展现降级内容，具体官网地址。 👈

谬误边界防止一个组件谬误导致整个页面白屏不能应用等状况，应用优雅降级的形式出现备用的 UI，谬误边界能够在渲染期间、生命周期和整个组件树的构造函数中捕捉谬误。自 React 16 起，任何未被谬误边界捕捉的谬误将会导致整个 React 组件树被卸载

ErrorBoundary 意义 🤖

某些 UI 解体，不至于整个 webapp 解体

在浏览页面时，因为后端返回异样或者前端的某些谬误校验，会导致用户体验很差，你想想，你带着老婆，坐着火车，吃着火锅唱着歌，~~忽然被麻匪劫了~~，忽然就报错了，有些场景下，比方正在设置金额，或者查看要害页面时，这样的体验就会很蹩脚，比方你游戏充值了 500，后果因为接口起因显示进去充值NaN，这种显示比不显示还让人苦恼，不过置信大家对 JS 异样捕捉很相熟了，try-catch 一包业务代码就出工了。不过，在组件里对异样捕捉，须要用到的是 React 提供的 Error Boundary 谬误边界个性，用 componentDidCatch 钩子来对页面异样进行捕捉，以至于不会将异样扩散到整个页面，无效避免页面白屏。

官网如何实现 🥔

👉 如果一个 class 组件中定义了 static getDerivedStateFromError() 或 componentDidCatch() 这两个生命周期办法中的任意一个（或两个）时，那么它就变成一个谬误边界。当抛出谬误后，请应用 static getDerivedStateFromError() 渲染备用 UI ，应用 componentDidCatch() 打印错误信息 👈

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

  static getDerivedStateFromError(error) {
    // 更新 state 使下一次渲染可能显示降级后的 UI
    return { hasError: true };
  }

  componentDidCatch(error, errorInfo) {
    // 你同样能够将谬误日志上报给服务器
    logErrorToMyService(error, errorInfo);
  }

  render() {
    if (this.state.hasError) {
      // 你能够自定义降级后的 UI 并渲染
      return <h1>Something went wrong.</h1>;
    }

    return this.props.children;
  }
}

而后你能够将它作为一个惯例组件去应用：

<ErrorBoundary>
  <MyWidget />
</ErrorBoundary>

谬误边界的工作形式相似于 JavaScript 的 catch {}，不同的中央在于谬误边界只针对 React 组件。只有 class 组件才能够成为谬误边界组件。大多数状况下, 你只须要申明一次谬误边界组件, 并在整个利用中应用它，在应用时被包裹组件呈现的谬误或者throw new Error()抛出的异样都能够被谬误边界组件捕捉，并且显示出兜底 UI

封装一个可配置的 ErrorBoundary 🚲

理解了官网实现谬误边界组件的办法，咱们能够封装一个ErrorBoundary组件，造一个好用的轮子，而不是间接写死return <h1>Something went wrong</h1>，学习了react-redux原理后咱们晓得能够用高阶组件来包裹react组件，将store中的数据和办法全局注入，同理，咱们也能够应用高阶组件包裹使其成为一个可能谬误捕捉的 react 组件

1️⃣ 发明一个可配置的 ErrorBoundary 类组件

相比与官网的 ErrorBoundary，咱们能够将日志上报的办法以及显示的 UI 通过承受传参的形式进行动静配置，对于传入的UI，咱们能够设置以react组件的形式或是一个React Element进行承受，而且通过组件的话，咱们能够传入参数，这样能够在兜底 UI 中拿到具体的错误信息

componentDidCatch() : 谬误日志解决的钩子函数
static getDerivedStateFromError() : 它将抛出的谬误作为参数，并返回一个值以更新 state

class ErrorBoundary extends React.Component {
  state = { error: false };
  static getDerivedStateFromError(error) {
    return { error };
  }
  componentDidCatch(error, errorInfo) {
    if (this.props.onError) {
      //上报日志通过父组件注入的函数进行执行
      this.props.onError(error, errorInfo.componentStack);
    }
  }
  render() {
    const { fallback, FallbackComponent } = this.props;
    const { error } = this.state;
    if (error) {
      const fallbackProps = { error };
      //判断是否为React Element
      if (React.isValidElement(fallback)) {
        return fallback;
      }
      //组件形式传入
      if (FallbackComponent) {
        return <FallbackComponent {...fallbackProps} />;
      }
      throw new Error("ErrorBoundary 组件须要传入兜底UI");
    }
    return this.props.children;
  }
}

这样就能够对兜底UI显示和谬误日志进行动静获取，使组件更加灵便，然而又有一个问题呈现，有时候会遇到这种状况：服务器忽然 503、502 了，前端获取不到响应，这时候某个组件报错了，然而过一会又失常了。比拟好的办法是用户点一下被ErrorBoundary封装的组件中的一个办法来从新加载出错组件，不须要重刷页面，这时候须要兜底的组件中应该暴露出一个办法供ErrorBoundary进行解决

在 ErrorBoundary 中增加办法，检测是否有注入重置办法，如果有重置办法就执行并且重置 state 中的 error，使其谬误状态为 false

resetErrorBoundary = () => {
  if (this.props.onReset) this.props.onReset();
  this.setState({ error: false });
};

在 render 中增加函数组件类型进行渲染，能够将重置的办法以及错误信息当做参数进行传递到以后组件进行解决

  render() {
    const { fallback, FallbackComponent, fallbackRender } = this.props;
    const { error } = this.state;
    if (error) {
      const fallbackProps = {
        error,
        resetErrorBoundary: this.resetErrorBoundary,
      };
      ...
      if (typeof fallbackRender === "function")return fallbackRender(fallbackProps);
      ...
    }
    return this.props.children;
  }

2️⃣ 将 ErrorBoundary 通过高阶函数进行包裹返回

import React from "react";
import DefaultErrorBoundary from "./core";
const catchreacterror = (Boundary = DefaultErrorBoundary) => InnerComponent => {
  return props => (
    <Boundary {...props}>
      <InnerComponent {...props} />
    </Boundary>
  );
};

2、应用&测试 🏁

通过一个点击自增的 Demo，当数字到达某值，抛出异样，这里别离对 class 组件和 Function 组件作为发动异样的组件进行测试

发动异样的组件

//Function组件
const fnCount1 = ({ count }) => {
  if (count == 3) throw new Error("count is three");
  return <span>{count}</span>;
};
//Class组件
class fnCount2 extends React.Component {
  render() {
    const { count } = this.props;
    if (count == 2) throw new Error("count is two");
    return <span>{count}</span>;
  }
}

处理错误异样的函数组件

const errorbackfn = ({ error: { message }, resetErrorBoundary }) => (
  <div>
    <p>出错啦</p>
    <pre>{message}</pre>
    <button onClick={resetErrorBoundary}>Try again</button>
  </div>
);

处理错误异样的一般组件

const errorbackcom = () => <h1>出错啦,不可撤销</h1>;

测试组件

//对发动异样的组件进行包裹解决，返回一个能够处理错误编辑的高阶组件
const SafeCount1 = catchreacterror()(fnCount1);
const SafeCount2 = catchreacterror()(fnCount2);

//测试主组件
const App = () => {
  const [count, setCount] = useState(0);
  const ListenError = (arg, info) => console.log("出错了:" + arg.message, info); //谬误时进行的回调
  const onReset = () => setCount(0); //点击重置时进行的回调
  return (
    <div className="App">
      <section>
        <button onClick={() => setCount(count => count + 1)}>+</button>
        <button onClick={() => setCount(count => count - 1)}>-</button>
      </section>
      <hr />
      <div>
        Class componnet:
        <SafeCount2
          count={count}
          fallbackRender={errorbackfn}
          onReset={onReset}
          onError={ListenError}
        />
      </div>
      <div>
        Function componnet:
        <SafeCount1
          count={count}
          FallbackComponent={errorbackcom}
          onError={ListenError}
        />
      </div>
    </div>
  );
};

功败垂成！

遇到的问题&总结 💢

有很多时候 react 谬误边界不是万能的比方

事件谬误

下面 this.o 不存在，会报错，window.onerror 能够捕捉，然而谬误边界捕捉不到。

异步代码

服务端渲染和谬误边界本人的谬误

总结

抽离组件 ✔
谬误反馈 ✔
UI 抽离 ✔
谬误重置 ✔
抽离 hook 模式 ✖
服务端 ✖

至此，谢谢各位在百忙之中点开这篇文章，心愿对你们能有所帮忙，置信你对 react 中的谬误边界有了大略的认实，也会编写一个简略的ErrorBoundary总的来说优化的点还有很多，如有问题欢送各位大佬斧正。

👋：跳转 github

参考文献

🍑：React.js |谬误边界组件
🍑：捕捉 React 异样
🍑：造一个 React 谬误边界的轮子
🍑：谬误边界(Error Boundaries)
🍑：深入浅出 React 的异样谬误边界

求个 star，谢谢大家了

关于javascript:封装一个处理-react-异常的最简-ErrorBoundary-组件-🎅

前言 📝

ErrorBoundary 意义 🤖

官网如何实现 🥔

封装一个可配置的 ErrorBoundary 🚲

1️⃣ 发明一个可配置的 ErrorBoundary 类组件

2️⃣ 将 ErrorBoundary 通过高阶函数进行包裹返回

2、应用&测试 🏁

遇到的问题&总结 💢

参考文献

评论

发表回复取消回复

更多文章

DDN HPC 存储硬件架构设计深度分析

探秘IO500：从Lustre并行文件系统出发，开启HPC存储性能新征程

苹果iOS打包的ipa应用无法安装？一篇文章带你了解可能的原因及排查方法

图解Golang：从零开始实现简易版过期LRU缓存

关于javascript:封装一个处理-react-异常的最简-ErrorBoundary-组件-🎅

前言 📝

ErrorBoundary 意义 🤖

官网如何实现 🥔

封装一个可配置的 ErrorBoundary 🚲

1️⃣ 发明一个可配置的 ErrorBoundary 类组件

2️⃣ 将 ErrorBoundary 通过高阶函数进行包裹返回

2、应用&测试 🏁

遇到的问题&总结 💢

参考文献

评论

发表回复 取消回复

更多文章

DDN HPC 存储硬件架构设计深度分析

探秘IO500：从Lustre并行文件系统出发，开启HPC存储性能新征程

苹果iOS打包的ipa应用无法安装？一篇文章带你了解可能的原因及排查方法

图解Golang：从零开始实现简易版过期LRU缓存

发表回复取消回复