使用 Hapi.js 插件进行错误处理

在前端开发中，错误处理是一个非常重要的环节。应用中可能会出现各种各样的错误，因此在一定程度上需要通过手动编写处理代码来排查问题。Hapi.js 提供了一些插件，可以简化这个过程。

Hapi.js 简介

Hapi.js 是一个 Node.js 的框架，专为构建应用程序 API 设计。它是一个强大的框架，具有可扩展的插件架构和完整的工具套件，为构建可重用的服务和应用程序提供了工具。

安装 Hapi.js

首先，需要全局安装 Hapi.js：

npm i -g hapi

或者通过npm在项目中安装：

npm i hapi

错误处理

Hapi.js 提供了很多内置的错误处理功能。如果你从来没有接触到 Hapi.js，那么第一步是了解如何使用 Hapi.js 框架自带的处理方式。

使用 server.events.on 监听错误事件

Hapi.js 框架提供了一个方法来监听全局错误事件，这个方法是 server.events.on。你可以监听任何你想监听的事件，比如 request-error，并且执行相应的操作。

const Hapi = require('@hapi/hapi');

const init = async () => {
  const server = Hapi.server({
    port: 3000,
    host: 'localhost'
  });

  server.events.on('request-error', (request, error) => {
    console.log(error);
  });

  await server.start();
  console.log('Server running on %s', server.info.uri);
};

process.on('unhandledRejection', err => {
  console.log(err);
  process.exit(1);
});

init();

在上述的代码示例中，我们使用 server.events.on 监听 'request-error' 类型的事件，并且在事件触发时将错误信息输出到控制台中。

使用 boom 处理错误响应

Boom 是一个可以在 Hapi.js 中生成 HTTP 错误处理的插件。这个插件提供了一些方法用于生成 HTTP 错误，并自动添加错误页头，内容类型和有效负载。

开发人员可以使用这个插件将基本错误代码转换成自定义响应，例如以下代码：

const Boom = require('@hapi/boom');

const handler = (request, h) => {
    if (!request.auth.isAuthenticated) {
        return Boom.unauthorized('Your authentication failed.');
    }
    return h.view('index');
};

Hapi.js 插件

除了自带的错误处理方式，Hapi.js 还提供了许多插件来帮助我们更好地处理错误。下面我们介绍两种可用的插件: hapi-dev-errors 和 hapijs-status-monitor，并带上一些示例代码。

使用 hapi-dev-errors 插件

hapi-dev-errors 是 Hapi.js 的一个插件，可以帮助我们以更直观的方式查看错误信息。安装方法：

npm i hapi-dev-errors

给 Hapi.js APIs 加上插件：

server.register(require('hapi-dev-errors'), (err) => {

        if (err) {
            console.log('Failed loading hapi-dev-errors');
            console.log(err);
        }
    });

以上代码启用了 hapi-dev-errors 插件，并在 Hapi.js API 中添加了一个路由。在这个路由中，如果服务器无法响应，它将返回一个 500 状态，并输出完整的错误信息。此外，这个插件还可以帮助我们快速定位错误。

使用 hapijs-status-monitor 插件

hapijs-status-monitor 是 Hapi.js 的另一个插件，可以帮助我们监控和分析实时应用程序信息。它将提供一个界面，你可以查看 HTTP 或 WebSocket 连接，请求周期和处理时间。安装方法：

npm i hapijs-status-monitor

添加插件：

const statusMonitor = require('hapijs-status-monitor');
    server.register({
        plugin: statusMonitor,
        options: {
            title: 'My Status Monitor'
        }
    });

hapijs-status-monitor 插件将在默认的 localhost:8080/status 上提供一个网站，在这个网站上你可以查看实时的 Hapi.js 应用程序运行信息。

总结

本文介绍了 Hapi.js 框架自带的错误处理方式，以及两个 Hapi.js 插件——hapi-dev-errors 和 hapijs-status-monitor。这些插件可以使我们在排除错误和监控应用程序时更加便捷和高效。

当然，还有其他的插件可供选择。选择合适的插件可以使我们少花时间在编写错误处理和监控代码上，更专注地去构建应用程序本身。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/65927635eb4cecbf2d740344