Hapi 框架中使用 Good 插件实现日志记录-JavaScript中文网-JavaScript教程资源分享门户

作为一名前端工程师，我们每天都要与各种各样的框架打交道，其中 Hapi 框架是比较常用的一款后端的框架之一。在使用 Hapi 框架进行开发时，我们需要实现一些功能，比如日志记录。 Good 插件就是 Hapi 框架自带的一个插件，能够帮助我们很好地实现日志记录。

Good 插件支持多种日志格式，比如 JSON、CSV 和线程安全的格式等。通过使用 Good 插件，我们可以方便地在终端或者文件中输出日志。Good 插件还支持多种事件，比如请求和响应事件，可以很方便地记录各种操作和信息。

前置知识

在开始使用 Good 插件之前，需要对 Hapi 框架有一定的了解，同时还需要一些基础的 Node.js 编程技能。如果你对这些内容不太熟悉，可以先去学习一下相关知识。

安装和使用

首先我们需要在项目中安装 Good 插件。可以直接使用 npm 安装：

npm install hapi-good

安装完成后，在 Hapi 项目中引入 Good 插件：

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

const server = Hapi.server({ port: 3000 });

const init = async () => {
    await server.register({
        plugin: Good,
        options: {
            ops: {
                interval: 1000
            },
            reporters: {
                console: [
                    {
                        module: '@hapi/good-squeeze',
                        name: 'Squeeze',
                        args: [{ log: '*', response: '*' }]
                    },
                    {
                        module: '@hapi/good-console'
                    },
                    'stdout'
                ]
            }
        }
    });

    await server.start();
    console.log(`Server running on ${server.info.uri}`);
};

init();

在上面的代码中，我们使用 register 方法引入 Good 插件，同时配置了日志记录的相关设置。在 options 中，我们可以定义 reporters，并指定类似 JSON、CSV 或者 console 等输出格式。

示例代码

在下面的示例代码中，我们将使用 Good 插件记录 Hapi 的请求和响应事件。

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

const server = Hapi.server({ port: 3000 });

server.route({
    method: 'GET',
    path: '/',
    handler: (request, h) => {
        return 'Hello Hapi!';
    }
});

const init = async () => {
    await server.register({
        plugin: Good,
        options: {
            ops: {
                interval: 1000
            },
            reporters: {
                console: [
                    {
                        module: '@hapi/good-squeeze',
                        name: 'Squeeze',
                        args: [{ log: '*', response: '*' }]
                    },
                    {
                        module: '@hapi/good-console'
                    },
                    'stdout'
                ]
            }
        }
    });

    await server.start();
    console.log(`Server running on ${server.info.uri}`);
};

init();

在这个示例中，我们的请求路由在根路径下，并返回字符串 "Hello Hapi!"。通过使用 Good 插件，我们将在终端输出请求和响应信息：

// javascriptcn.com 代码示例
[09/28/2021, 5:03:37 PM] [hapi] response: {
    "instance": "localhost",
    "request": {
        "id": "1632827017416:localhost:3092:84vhu8bd:10000",
        "method": "get",
        "url": "/",
        "headers": {
            "user-agent": "PostmanRuntime/7.26.10",
            "accept": "*/*",
            "cache-control": "no-cache",
            "postman-token": "8d7ddd4d-25c4-4a3b-8c7e-2d514a011430",
            "host": "localhost:3000",
            "accept-encoding": "gzip, deflate, br",
            "connection": "keep-alive"
        },
        "remoteAddress": "127.0.0.1"
    },
    "response": {
        "statusCode": 200,
        "headers": {
            "cache-control": "no-cache",
            "content-type": "text/html; charset=utf-8"
        },
        "source": "Hello Hapi!",
        "request": {
            "id": "1632827017416:localhost:3092:84vhu8bd:10000",
            "method": "get",
            "url": "/",
            "headers": {
                "user-agent": "PostmanRuntime/7.26.10",
                "accept": "*/*",
                "cache-control": "no-cache",
                "postman-token": "8d7ddd4d-25c4-4a3b-8c7e-2d514a011430",
                "host": "localhost:3000",
                "accept-encoding": "gzip, deflate, br",
                "connection": "keep-alive"
            },
            "remoteAddress": "127.0.0.1"
        },
        "isBoom": false,
        "redirected": false,
        "source": "Hello Hapi!"
    },
    "timestamp": 1632827017703
}

总结

在 Hapi 框架中使用 Good 插件，我们可以方便地实现日志记录。Good 插件能够输出多种格式的日志，并支持多种事件类型，能够满足我们对日志的各种需求。在实际的项目开发中，我们可以根据自己的需要进行配置，以实现最佳的日志记录效果。

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