什么是 Fastify?
Fastify 是一个高性能的 Web 框架,它极其快速,轻量级,模块化,且具有低开销的结构。
它侧重于低延迟处理和大量路由的情况,尤其适合与现代的单页应用程序配合使用。Fastify 支持全异步编程,可以轻松地与其他技术栈集成,为构建成熟的、高度可扩展的 Web 应用程序提供了更好的基础。
打印日志在日常开发中是非常重要的一项任务,通过日志可以定位和解决问题,记录系统的状态和运行信息。
Fastify 中打印日志比较简单,开箱即用,无需安装其他工具库。
使用 Fastify 内置日志模块
我们可以在 Fastify 实例中使用内置的日志模块,如下所示:
const fastify = require('fastify')() fastify.register(function (instance, opts, next) { instance.log.info('logging with pino') next() }) fastify.listen(3000)
上面的代码展示了如何在 Fastify 实例中使用不带配置的内置日志记录器,这是一种基于 Pino 的内置日志记录器。此日志记录器支持以下日志等级:
fatal
error
warn
info
debug
trace
以上列出的级别会打印指定其名称的消息,所有未列出的级别的消息都会被忽略。
消息级别可以指定阈值来控制,例如,将日志级别设置为 info
可以输出 info、warn、error、fatal 这四种级别的日志消息。
我们可以在 Fastify 实例对象上调用 log.<level>
方法来记录不同级别的日志。例如:
fastify.log.info('Server listening on http://localhost:' + fastify.server.address().port)
自定义日志记录器
Fastify 还支持自定义日志记录器。在这里,我们可以使用任何标准的 Node.js 日志记录库(如 Pino、Bunyan、Winston 等)或自己定义的记录器。我们需要在注册插件时配置日志记录器。
例如,在使用 Pino 记录器的情况下,可以这样:
-- -------------------- ---- ------- ----- ------- - -------------------- ----------------------------------------- - -- ---- ----- -- ------------------------- ---------- ----- ----- - -------------------------- ---- ------ ------ -- --------------------
上面的代码使用了 Fastify 的 Pino 插件,并将其配置传递为 fastify-pino
的选项。我们可以使用任何记录器而不仅仅是Pino,例如,使用 Bowlog库:
-- -------------------- ---- ------- ----- ------- - -------------------- -------------------------------------------------- - -- ------ ----- -- ------------------------- ---------- ----- ----- - -------------------------- ---- -------- ------ -- --------------------
在上面的例子中,我们使用了 log方法,并结合 Bynyan 记录器来记录日志。
日志消息格式化
Fastify 支持在记录日志消息时自动格式化它们。这通过 Pino 实现。
我们可以使用 Pino 的默认格式化程序,也可以编写自定义格式化程序。
下面的代码演示了如何使用默认格式:
-- -------------------- ---- ------- ----- ------- - -------------------- ------------------------- ---------- ----- ----- - ------------------- ----- --------- -- ------- -------- -- ------- ------------------------------- -------------------------------------------------------------------------- ------ -- --------------------
我们在这里调用 log.info
方法,并传递一个 JSON 对象作为参数,该对象传递了名称值。我们还传递了一个字符串作为第二个参数。由于 Pino 默认格式化所有字段,因此日志输出将包含 name 和 msg 字段。
自定义日志格式化程序可以在 Fastify 中使用 logger 插件来配置。例如,这里是一个使用 Pino 的自定义记录器的示例:
-- -------------------- ---- ------- ----- ------- - -------------------- ----------------------------------------- - -- --- ---- ------- ----------- - ----- ------- - ------ - ------ ----- - -- -------- -- - ------ - -------- --------- - - - -- ------------------------- ---------- ----- ----- - ------------------------- ----- - ---- ----- -- -------- --------- -- ------- -------------------------------------------------------------------------------- --- ------- ----------------------------------------- ------ -- --------------------
在上面的代码中,我们使用 formatters
对象配置我们的自定义格式程序。我们定义了两个格式化程序:level
和myFields
。
level
格式程序接受level字符串,并返回将用于JSON日志的字段对象。在此示例中,我们仅使用 level 字段。
myFields
格式程序用于返回一个包含附加字段的对象,示例中的myField字段表示字符串'myValue'。
然后,在处理 sample log
的记日志中,我们传递JSON对象和另一个字符串。 Pino 日志格式化程序将这些合并到单个日志消息中,并包括我们定义的自定义字段。
总结
Fastify 是一个令人兴奋的框架,它提供了许多有用的功能,可以加速我们在 Node.js 上构建 Web 应用程序的过程。本文介绍了在 Fastify 中如何记录日志,以及如何自定义日志记录器和格式化程序。熟悉这些日志记录技巧可以使我们更好地了解应用程序运行的状态,并帮助我们解决任何问题。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/645b2aae968c7c53b0d86fa9