在前端开发中，日志记录是非常重要的一项技术，可以帮助我们快速地定位代码问题，优化代码性能。因此，今天我来介绍一款便捷的 npm 包——egg-log。
什么是 egg-log？
egg-log 是阿里 egg.js 框架提供的一款日志记录工具。它提供了以下功能：
- 支持多种日志级别，包括 debug、info、warn、error、none。
- 支持将日志保存到文件或者数据库中，以便后续查看和分析。
- 支持输出日志的格式化，可以按照时间戳、模块名、日志级别等进行筛选和排序。
- 支持按照时间轮换日志文件，避免日志文件过大，并可以进行压缩。
如何使用 egg-log？
首先，在你的 egg 项目中安装 egg-log，可以使用以下命令：
npm install egg-log --save
配置 egg-log
在项目根目录下的 config 文件夹内新建一个文件，命名为 config.logger.js，这个文件就是 egg-log 的配置文件。
-- -------------------- ---- -------
-- -----------------------
-------------- - -
------- -
---- -------
----------- ----------
------------ -----------
------- -----
------ --------
------------- --------
------------------------- -----
--
--这个配置文件中 logger 下的属性分别表示：
dir: 存放日志文件的文件夹名称；appLogName：应用日志文件名；coreLogName：核心日志文件名；buffer: 是否开启输出流缓冲；level：默认日志级别；consoleLevel：日志输出到控制台的最低级别；disableConsoleAfterReady： 是否在应用启动后禁止控制台的日志输出。
在代码中使用 egg-log
在你的 JS 代码中，你可以直接使用 app.logger 来记录日志，例如：
// app/controller/home.js
exports.index = async ctx => {
ctx.logger.debug('this is a debug log');
ctx.logger.info('this is an info log');
ctx.logger.warn('this is a warn log');
ctx.logger.error('this is an error log');
ctx.body = 'Hello World!';
};通过以上代码，你可以在日志文件中看到类似于以下的日志：
2019-04-25 11:19:35.213 DEBUG 14816 --- [troller.home.js] this is a debug log 2019-04-25 11:19:35.213 INFO 14816 --- [troller.home.js] this is an info log 2019-04-25 11:19:35.213 WARN 14816 --- [troller.home.js] this is a warn log 2019-04-25 11:19:35.213 ERROR 14816 --- [troller.home.js] this is an error log
另外，如果希望对某些特定的日志进行输出，也可以使用以下方法：
-- -------------------- ---- -------
-- ----------------------------
-------------- - --------- ---- -- -
------ ----------------------------------- -
-- -------------------- --------
---------- ------ ---- -- -
--------------------- ------ ------ ------
--
---
--总结
通过这篇文章，你可以了解到 egg-log 的基本使用方法，并能够在项目中引入和配置 egg-log，以及在代码中使用 egg-log 记录和输出日志。希望这篇文章能够对你有所帮助，让你在前端开发中更加方便地追踪代码问题，提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065f8d238a385564ab6ecc