前言
在 web 开发中，日志记录是非常重要的一环。当你的应用程序部署在生产环境中时，你需要时刻监控它的运行状态，并对各种用户行为进行记录，以便对错误进行快速反应，并为今后的运营提供有价值的参考。
在本文中，我们将介绍如何使用 Koa 和 log4js 这两个 Node.js 模块来实现 api 日志记录。
Koa
Koa 是一个 Node.js 的 web 框架，致力于提供更优雅、更简洁的 web 开发体验。Koa 相比于 Express，它的中间件机制更加灵活，而且适配 ES6 的 Generator 和 async/await 语法，可读性更好。
-- -------------------- ---- ------- ----- --- - --------------- ----- --- - --- ------ ------------- ----- ----- -- - -------- - ------ -------- ----- ------- --- -----------------
如上代码，Koa 框架在运行时调用 app.use 方法进行中间件的注册。ctx 是 Koa 框架的核心对象，代表了 request 和 response，它包含了请求的方法、url、头部、参数以及响应的状态、头部以及消息体等信息。
log4js
Log4js 是 Node.js 的一个日志记录模块，它支持文件、控制台、邮件、数据库等多种日志输出方式，并且可以自定义各种日志格式。这里我们采用 file 输出。
定义一个简单的日志导出：
-- -------------------- ---- -------
----- ------ - ------------------
------------------
---------- -
-------- - ----- --------- --
----- -
----- -------
--------- ---------------
----------- --------
-------- --
--------- ----
-
--
----------- -
-------- - ---------- ----------- -------- ------ ------ -
-
---
----- ------ - -------------------
------------ - --------
-------------- - -------在这个例子里我们配置了两个 appender，一个是 console，用来输出到控制台；另一个是 file，用来输出到文件。可以通过定义不同的 category 来指定不同的 appender 和日志级别。如果需要定义新的 category，只需要在 categories 中新增一个新的对象即可。
Koa-log4js
在了解了 Koa 和 log4js 的基本使用后，我们下面将介绍如何将它们结合起来，实现 api 日志记录。
我们将编写一个 logger.js 模块，用于记录 api 日志：
-- -------------------- ---- -------
----- ------ - ------------------
------------------
---------- -
-------- - ----- --------- --
---- -
----- -------
--------- ---------------
----------- --------
-------- --
--------- ----
-
--
----------- -
-------- - ---------- ----------- ------- ------ ------ -
-
---
----- ------ - -------------------
-------------- - -------- -- -
------ ----- ----- ----- -- -
----- ----- - --- -------
----- -------
----- -- - --- ------ - ------
-------------------------- ---------- ------------- - ----------
-
--在这个例子中，我们定义了一个中间件方法，并将它导出作为 logger 模块。中间件的实现在方法里面，首先记录了进入的时间，并在 next 之后再次记录结束时间。最后使用 logger 记录日志文件。这段代码的参数为 context，即 Koa 的上下文对象，其中包含了请求的方法、url、状态以及耗费时间。
现在我们可以在 Koa 项目中使用这个 logger 来记录 api 的访问日志。这里是一个简单的 Koa 例子：
-- -------------------- ---- -------
----- --- - ---------------
----- ---------- - --------------------------
----- ------ - --------------------
----- --- - --- ------
----------------------
------------------
------------- ----- ----- -- -
-------- - ------ --------
---
-----------------在这个例子中，我们初始化了 app 对象并添加了 body 解析模块和 logger 中间件模块，然后定义了一个处理 GET 请求的中间件模块。当我们访问 http://localhost:3000/ 的时候，控制台和 logs/api.log 文件中将会显示以下内容：
GET / 200 - 2ms
这个记录包含的信息包括请求的方法、url、状态以及耗费时间。
总结
在本文中，我们将 Koa 和 Log4js 这两个前端类 Node.js 模块结合使用，实现了 api 访问日志记录。这一记录方式在生产环境中非常重要，对于应用程序的监控和运营都有非常大的帮助，强烈建议在项目里使用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65029f9b95b1f8cacdfdcb67