Hapi 框架中如何使用 Good 插件进行日志记录？-JavaScript中文网-JavaScript教程资源分享门户

在开发 Web 应用程序时，日志记录是一个非常重要的组成部分。它可以帮助我们追踪应用程序的运行情况、检测错误、以及提供有价值的信息给运维人员。在使用 Hapi 框架时，我们可以使用 Good 插件来实现日志记录。

Good 插件简介

Good 是一个 Hapi 插件，它提供了一个框架来记录和监视应用程序的各种事件。它可以记录 HTTP 请求、响应、服务器错误、数据库查询、以及自定义事件等。Good 插件提供了多种日志输出方式，包括控制台、文件、Elasticsearch、Loggly 等。

安装 Good 插件

在使用 Good 插件之前，我们需要先安装它。可以通过 npm 命令来安装：

npm install good --save

安装完成后，我们需要在 Hapi 应用程序中注册 Good 插件。可以通过以下方式来注册：

// javascriptcn.com 代码示例
const Hapi = require('hapi');
const Good = require('good');

const server = new Hapi.Server();

server.register({
  plugin: Good,
  options: {
    reporters: {
      console: [{
        module: 'good-console'
      }, 'stdout'],
      file: [{
        module: 'good-squeeze',
        name: 'Squeeze',
        args: [{ log: '*', response: '*' }]
      }, {
        module: 'good-squeeze',
        name: 'SafeJson'
      }, './logs/app.log']
    }
  }
}, (err) => {
  if (err) {
    throw err;
  }

  server.start((err) => {
    if (err) {
      throw err;
    }

    console.log(`Server running at: ${server.info.uri}`);
  });
});

在上面的示例中，我们使用 server.register 方法来注册 Good 插件。在 options 中，我们定义了两个 reporters，一个用于将日志输出到控制台，另一个用于将日志输出到文件。我们可以根据需要定义多个 reporters，每个 reporters 可以使用不同的配置。

Good 插件的使用

Good 插件提供了多种事件类型，每种事件类型都有对应的插件来处理它。例如，我们可以使用 good-http 插件来记录 HTTP 请求和响应，使用 good-file 插件来记录文件操作，使用 good-squeeze 插件来过滤日志等。

以下是一些常用的事件类型和对应的插件：

request：记录 HTTP 请求和响应，使用 good-http 插件。
log：记录应用程序日志，使用 good-squeeze 插件。
error：记录服务器错误，使用 good-squeeze 插件。
response：记录 HTTP 响应，使用 good-http 插件。

在使用 Good 插件时，我们需要通过 server.events.on 方法来订阅事件。例如，我们可以使用以下代码来记录 HTTP 请求和响应：

server.events.on('response', (request) => {
  console.log(`${request.method.toUpperCase()} ${request.path} -> ${request.response.statusCode}`);
});

在上面的代码中，我们使用 server.events.on 方法来订阅 response 事件。当有 HTTP 响应时，该事件就会被触发，我们可以在事件处理函数中记录日志。

总结

Good 插件是一个非常强大的日志记录工具，它可以帮助我们快速实现日志记录功能。在使用 Good 插件时，我们需要先安装它，并在 Hapi 应用程序中注册它。然后，我们可以使用 server.events.on 方法来订阅事件，并在事件处理函数中记录日志。通过合理地使用 Good 插件，我们可以更好地了解应用程序的运行情况，及时发现问题，并提供有价值的信息给运维人员。

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