Winston 是一个非常受欢迎的 Node.js 日志库，旨在让开发者能够以简单灵活的方式记录日志并进行相应的处理。而 winston-customise-logger 是 Winston 的定制化扩展包，便于快捷地建立自定义的 Logger。
本篇文章将详细介绍如何使用 winston-customise-logger 这个 npm 包，并结合具体示例代码进行讲解，帮助大家更加深入地了解这个库的使用方法以及优越性，从而提高我们的前端开发效率。
安装
要使用 winston-customise-logger，需要首先安装它。可以使用 npm 安装，命令如下：
npm install winston-customise-logger
如果你是使用 yarn 来管理依赖的话，可以使用以下命令安装：
yarn add winston-customise-logger
安装完成后就能在项目中使用 winston-customise-logger 了。
基本使用
winston-customise-logger 的使用方法非常简单。在 winston 中调用 createLogger(customSettings) 方法即可。其中， customSettings 是一个对象，用来自定义 Logger 的一些属性。
例如，可以定义一个名称为 winston-custom 的 Logger，其写入级别为 info，日志格式是 json，同时将日志打印到控制台和文件中。代码如下所示：
-- -------------------- ---- -------
----- ------- - ------------------
----- ------------ - -----------------------------------
----- ------- - -
-------- -----------------
--------- -------
------- -------
-------- -----
----- -
--------- ---------
-
-
----- ------ - ----------------------------------
------------------- ---------------------------通过这段代码，即可快速创建一个名为 winston-custom 的 Logger，并将日志以 json 格式写入到文件 app.log 中，在控制台中也会输出相应的日志信息。
自定义 Logger
winston-customise-logger 的魅力在于它允许我们根据实际需求，自由地扩展和定制 Logger，让 Logger 满足各个方面的需求。
而 Logger 的配置项，就是通过 customSettings 进行定义和传递的。下面，让我们来详细讲解一下这些配置项。
appName
appName 用于设置 Logger 的名称。默认为 winston-custom.
const options = {
appName: 'my-app'
}logLevel
通过 logLevel 可以设置写入日志的级别。支持的级别有：error, warn, info, verbose, debug, silly，默认为 info。
const options = {
logLevel: 'debug'
}format
通过 format 可以设置日志的格式，支持的格式有：json, simple, align, combine, timestamp, printf。默认为 json。
const options = {
format: 'printf'
}console
通过 console 可以设置是否将日志输出到控制台。默认为 true。
const options = {
console: false
}file
通过 file 可以设置将日志写入到文件的相关配置，包括 filename, maxsize, maxFiles 等。默认不开启文件日志写入。
const options = {
file: {
filename: 'app.log',
maxsize: 1024,
maxFiles: 5
}
}customTransports
通过 customTransports 可以自定义日志写入的 Transport，可以是任何 winston 内置的 Transport 或自定义的 Transport。
-- -------------------- ---- -------
----- ------- - -
----------------- -
--- -------------------------
----- ------------
----- -----
----- -------
------ -------
--
-
-customize
通过 customize 可以完全自定义 Logger，比如自定义添加 Transports，修改日志的写入格式等等。
是的， customize 是个非常强大的配置项，它接收一个函数作为参数，我们可以在这个函数中完全自定义 Logger 的行为。
例如，我们可以使用 customize 来增加一个 colorize Transport，来让在控制台中输出的日志变得更加醒目易读。
-- -------------------- ---- -------
----- ------- - -
---------- ---------------- -- -
---------------------- ----------------------------
------- -----------------------
--------------------------
-----------------------
-
---
--
-------- ----
-在这个示例中，colorize Transport 的作用是将输出的日志进行颜色标记以区分日志级别。同时，我们将其添加到了 Logger 的扩展配置项中。
这样，就能在控制台清晰地看到不同颜色的日志输出，跟实际需要做对比，就可以比较方便地进行调试和排查问题。
完整的自定义示例代码如下所示：
-- -------------------- ---- -------
----- ------- - ------------------
----- ------------ - -----------------------------------
----- ------- - -
---------- ---------------- -- -
---------------------- ----------------------------
------- -----------------------
--------------------------
-----------------------
-
---
--
-------- -----
----- -
--------- ---------
-
-
----- ------ - ----------------------------------
------------------- ---------------------------
------------------ -- -- ----- ----------通过这个例子，我们展示了如何使用 customize 来自定义 Logger，也可以帮助读者更好地理解 customSettings 所有配置项的含义，进而去尝试自定义更多的 Logger 行为。
可选控制台输出级别
如果设置了 console 为 true， winston-customise-logger 默认会输出所有级别的日志到控制台中。但有时候，我们只希望输出指定级别以上的日志到控制台。
这时候可以通过设置新的可选控制台输出级别 consoleLevel 来实现。如下所示：
const options = {
console: true,
consoleLevel: 'warn' // 输出 warn 级别及以上的日志到控制台
}这样设置后，只有级别为 warn, error, 和 debug 的日志才会输出到控制台，info 级别的日志将不会输出到控制台。
总结
通过本篇文章的讲解，我们可以了解到 winston-customise-logger 这个 npm 包的用法以及优越性。它可以帮助我们快速、灵活地建立符合各种需求的自定义 Logger。
总之，在开发过程中，好的日志系统是非常重要的，可以提供很多好处。 winston-customise-logger 给我们带来了很多好处，它能够帮助我们轻松地维护一个全面和高效的日志管道，从而增强我们系统的可靠性和可维护性。
代码见： https://github.com/kerlomz/snips/blob/master/winston-customize-logger/app.js
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671108dd3466f61ffe32f