Fastify 日志记录 - 如何记录应用程序的日志
在前端的开发中，日志记录是一个非常重要的方面，它可以帮助开发者了解应用程序的运行情况以及出错原因等。在本文中，我们将介绍一个快速的 Node.js Web 框架——Fastify，以及如何使用它来记录应用程序的日志。
Fastify 是一个 Node.js Web 框架，它旨在提供高效的性能和低内存占用。它与其他 Node.js Web 框架相比，可以更快地处理请求。在 Fastify 中，你可以使用其内置的插件来实现日志记录。我们将使用 fastify-plugin 插件，它是 Fastify 的插件系统。该插件可以在 Fastify 实例上注册插件，可以使插件的代码属于许多作用域之一。
日志记录功能的主要目的是记录应用程序的状态和事件。如下是一些常用的日志等级：
- trace - 详细、低频度的信息
- debug - 细微的动作的信息
- info - 运行过程中的信息
- warn - 需要注意但不需要紧急的信息
- error - 错误事件，但不能终止应用程序
- fatal - 致命的错误事件，导致应用程序终止
在 Fastify 中，需要使用 fastify-plugin，先安装它：
npm install fastify-plugin
然后我们定义一个日志插件：
// javascriptcn.com 代码示例
const fp = require('fastify-plugin')
module.exports = fp(
async (fastify, opts) => {
fastify.decorate('logger', function (request, reply, done) {
const logLevel = reply.statusCode >= 500 ? 'error' : 'info'
fastify.log[logLevel]({
method: request.method,
path: request.raw.url,
statusCode: reply.statusCode
})
done()
})
}
)在上述代码中，我们为 Fastify 添加了一个添加日志的装饰器。他使用 fastify-plugin 插件系统，将我们的 logger 代码添加到 Fastify 的实例中去。与其他的 Fastify 插件一样，它需要一个函数作为参数。该函数的第一个参数是 Fastify 实例，第二个是配置对象。在这个例子中，我们传入了一个匿名的 async 函数和 fastify 实例，如上面的代码所示。
在该函数中，我们为 Fastify 实例添加了 logger 装饰器，它接受三个参数，分别是查询对象 request，响应对象 reply 和回调函数 done。然后我们定义了一个变量 logLevel 来决定日志级别。如果响应的状态码大于等于 500，它就会被记录为 error 等级，否则为 info 等级。
最后，我们使用 fastify.log[logLevel] 方法实现了记录，使用了一个对象来传递记录信息的重要参数，如请求方法、请求路径和响应状态码。
要在 Fastify 实例上注册插件，我们需要在应用程序入口文件中将插件传递给 Fastify 实例：
// javascriptcn.com 代码示例
const fastify = require('fastify')()
fastify.register(require('./logger'))
fastify.get('/', (req, res) => {
res.send('Hello, World!')
})
fastify.listen(3000, (err) => {
if (err) {
fastify.log.error(err)
process.exit(1)
}
})在这段代码中，我们将 logger 模块作为插件传递给了 Fastify 的 register 方法，然后定义了一个路由，最后开启了 Fastify 的监听服务。
如果你现在启动该应用程序并访问其中的 / 路径，你会看到 Fastify 实例正在记录每个请求。
我们可以同时在控制台打印日志以及将日志写入到文件。你可以使用 pino 模块来实现这个功能，使用命令：
npm install pino pino-pretty fastify-pino-logger
然后在我们的插件中使用插件 fastify-pino-logger：
// javascriptcn.com 代码示例
const pino = require('pino')
const fastifyPlugin = require('fastify-plugin')
const FastifyPino = require('fastify-pino-logger')
module.exports = fastifyPlugin(async function (fastify, opts) {
const logger = pino({
level: 'info',
prettyPrint: true
})
fastify.register(FastifyPino, { logger })
})在这段代码中，我们使用 pino 来创建了一个日志记录器，然后使用插件 fastify-pino-logger 来记录请求的时候把日志记录器传递给 Fastify。
我们可以在开发期间使用 prettyPrint 为 true ，在生产环境中关闭 prettyPrint。如果你使用 Node.js 生态系统中的其他日志库，它们使用的 API 通常也很相似。
总结
在本文中，我们介绍了 Fastify 及其内置的插件来记录应用程序的日志。
首先，我们通过 fastify-plugin 插件系统创建装饰器 logger，然后通过 Fastify 实例注册它。然后，我们将 pino 模块用于记录日志并与 fastify-pino-logger 插件一起使用。
日志记录是 Web 应用程序的必要部分。它可以帮助开发人员了解应用程序中出现的问题并追踪到其根本原因。Fastify 能够为日志记录提供一个轻量级且高效的解决方案，同时也使它们更加易于使用。
示例代码：https://github.com/seanpmaxwell/fastify-logger-example
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/653ce67e7d4982a6eb6da185