@mightyminds/logger 是一款 Node.js 的 NPM 包，它提供了强大且易于使用的日志记录功能，可让前端开发者更加方便地进行错误排查和调试。本文将介绍如何使用 @mightyminds/logger 包，详细介绍其 API 和用法，并提供示例代码进行速成学习和实践。
安装包
要使用 @mightyminds/logger 包，需要先安装它。
在您的项目中，通过 npm 安装 @mightyminds/logger：
npm install @mightyminds/logger --save-dev
或者使用 yarn：
yarn add @mightyminds/logger --dev
配置
在项目中使用 @mightyminds/logger，需要先对其进行配置。在您的项目根目录下创建一个 logger.js 文件，然后添加以下代码：
const { Logger } = require('@mightyminds/logger');
const logger = new Logger({
// 配置项
});
module.exports = logger;在 logger.js 文件中，我们通过调取 Logger 实例来创建一个实例对象。需要传入的参数是一个配置项，该配置项决定了该实例对象的日志行为。
下面我们来看看如何配置 Logger 实例：
const logger = new Logger({
level: 'info', // 日志等级
path: './logs', // 日志输出路径
maxSize: 1, // 每个日志文件最大大小，单位是 MB
maxFiles: 5, // 日志文件最多保留的数量
fileName: 'app', // 日志文件名
format: (info) => `${info.timestamp} [${info.level}]: ${info.message}`, // 日志格式化函数
});您可以调整配置项来满足您的特定需求。下面我们逐个解释这些配置项：
level: 日志等级，可以是'error','warn','info','verbose','debug','silly'中的任何一个。该等级之上的所有等级都将被记录。例如，如果设置了等级为'info'，则'error','warn','info'等级的日志都将被记录，而'verbose','debug','silly'等级的日志就会被过滤掉。默认值为'silly'。path: 日志输出路径，日志文件将保存在该路径下。默认为项目根目录的logs文件夹。maxSize: 每个日志文件的最大大小，超过该大小将自动创建新的日志文件。单位是 MB。默认为10。maxFiles: 日志文件最多保留的数量，默认为5。fileName: 日志文件名，默认为'app'。format: 日志格式化函数，用于将日志信息转换成可读的字符串。默认为(info) =>${info.timestamp} [${info.level}]: ${info.message}``。
使用
使用 Logger 实例非常简单。在您的代码中，只需引入 logger.js 文件，然后调用 Logger 实例上的方法即可。例如：
const logger = require('./logger');
logger.info('This is a info log.');
logger.warn('This is a warning log.');
logger.error('This is a error log.');当日志级别大于或等于当前配置的日志级别时，日志信息将会被记录下来。在本例中，前两条日志将被成功记录，而第三条日志将被过滤掉。
进阶
除了上述基础用法之外，@mightyminds/logger 包还提供了许多其他的扩展功能，下面简要介绍一些：
格式化
Logger 实例提供了一个 format 方法，用于格式化日志信息，方便您记录自定义的日志信息。
例如，您可以使用以下代码格式化一个对象并记录在日志文件中：
const logger = require('./logger');
const user = {
name: 'John Doe',
age: 20,
};
logger.info('User information: %o', user);在日志文件中将显示：
2022-01-01T00:00:00.000Z [info]: User information: {"name":"John Doe","age":20}在上面的例子中，我们使用 %o 占位符来表示要输出的对象 user，Logger 实例会自动将其格式化为 JSON 字符串。
文件名
默认情况下，Logger 实例使用 'app' 作为日志文件名。您可以将其改为其他名称，例如：
const logger = new Logger({
fileName: 'myapp',
});这将把日志文件名设置为 'myapp'。
日志文件后缀
默认情况下，Logger 实例使用 .log 作为日志文件的后缀。您可以将其改为其他名称，例如：
const logger = new Logger({
fileExtension: '.txt',
});这将把日志文件后缀设置为 .txt。
日志旋转
Logger 实例提供了日志旋转功能，它可以在达到一定条件时自动创建一个新的日志文件并记录日志信息。这对于避免日志文件过大或过多是非常有用的。
例如，您可以设置每个日志文件最大允许 1 MB，最多保留 5 个日志文件：
const logger = new Logger({
maxSize: 1, // 每个日志文件最大大小，单位 MB
maxFiles: 5, // 日志文件最多保留的数量
});当一个日志文件达到 1 MB 时，Logger 实例会自动创建一个新的日志文件并开始记录日志信息。最多只保留 5 个日志文件，超出的日志文件将会被删除。
示例
最后，我们提供一个示例代码，让您可以快速掌握 @mightyminds/logger 包的用法：
-- -------------------- ---- -------
----- - ------ - - -------------------------------
----- ------ - --- --------
------ ------- -- ----
----- --------- -- ------
-------- -- -- -------------- --
--------- -- -- -----------
--------- ------ -- -----
------- ------ -- ------------------ ---------------- ----------------- -- -------
---
----------------- -- - ---- -------
----------------- -- - ------- -------
------------------ -- - ----- -------至此，@mightyminds/logger 使用教程已经结束。如果您有任何问题或建议，欢迎在 Issues 中提出，我们将非常乐意为您解答！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055ebd81e8991b448dc756