在前端开发中，日志是非常重要的一部分。我们需要对程序的运行状态进行记录，以便查错和优化。而 log.pets 是一个适用于 Node.js 和浏览器端的开源日志包，为前端开发者提供了便捷的日志记录方式。本文将详细介绍 log.pets 的使用方法，并在其中加入一些实际项目使用时的知识点，以供学习和参考。
安装
要使用 log.pets，首先需要安装它。可以通过 npm 来安装：
npm install log.pets
安装完成后，可以在项目中引入 log.pets：
const logger = require("log.pets");在浏览器端可使用：
<script src="log.pets.min.js"></script>
引入后，即可开始使用。
基本使用
输出日志
log.pets 提供了五个打印方法：log、info、warn、error 和 debug。通过调用这些方法，可以输出不同级别的日志信息。下面的代码示例演示了输出不同级别的日志信息：
logger.log("This is a log message.");
logger.info("This is an info message.");
logger.warn("This is a warn message.");
logger.error("This is an error message.");
logger.debug("This is a debug message.");在控制台中，输出分别如下：
This is a log message. ℹ This is an info message. ⚠️ This is a warn message. ❌ This is an error message. 🐞 This is a debug message.
自定义输出样式
log.pets 可以通过配置自定义输出样式。可以通过 style 方法来设置样式：
logger.style("log", "color: #fff; background-color: #333; padding: 2px 4px;");
logger.style("info", "color: #fff; background-color: #2196F3; padding: 2px 4px;");
logger.style("warn", "color: #fff; background-color: #FFC107; padding: 2px 4px;");
logger.style("error", "color: #fff; background-color: #F44336; padding: 2px 4px;");
logger.style("debug", "color: #fff; background-color: #9E9E9E; padding: 2px 4px;");设置完成后，控制台输出的日志样式将会按照设置的样式进行输出。
打印对象
log.pets 还支持打印对象，可以通过 obj 方法来实现：
logger.obj({ key1: "value1", key2: 2 });输出结果如下：
{ key1: 'value1', key2: 2 }如果要打印的对象是一个嵌套的对象，则可以通过指定最大输出层级数来限制输出：
-- -------------------- ---- -------
----- --- - -
----- ---------
----- --
----- -
----- ---------
----- --
----- -
----- ---------
--
--
--
--------------- ---将会输出：
-- -------------------- ---- -------
-
----- ---------
----- --
----- -
----- ---------
----- --
----- -------- --------
-
-全局配置
可以通过 config 方法来进行全局配置。通过全局配置，可以统一设置所有日志的样式、输出格式等信息。下面是一个全局配置的例子：
-- -------------------- ---- -------
---------------
----------- ----------- --------------
---------- ----
---------- -----
---------- -----
------ -
---- ------------------------------------
----- ------------------------------------
----- ------------------------------------
------ ------------------------------------
------ ------------------------------------
--
---上面代码中，dateFormat 用于设置时间戳格式，maxLength 用于设置日志信息的最大长度，showLevel 用于指定是否在日志中显示级别，useColors 用于指定是否启用控制台输出颜色。而 style 则用于设置不同级别的日志样式。
经验分享
在实际项目中的使用，我们还需要针对不同的需求，对 log.pets 进行一些扩展。下面给出一些常用的扩展方法。
按照日期输出到文件
在实际项目中，将日志按照日期输出到不同的文件中是一个常见的需求。我们可以通过 fs 模块来实现。下面是一个实现的例子：
-- -------------------- ---- ------- ----- -- - -------------- ----- ------ - ------------------ ----- ------ - -------------------- --------------- ----------- ----------- ------------- --- ----- ------- - ---------- -- ------------------------- - ---------------------- - ----- ---- - ------------------------------ ----- ----------- - ---------------------------- ----- ----------- - --------------------------------- - ------ ---- --- -------------- - ----- ------ -- - ----------------------------------------------------------------- ------------------------ ----------- --
上面的代码中，我们在程序运行时，首先创建 $logPath 文件夹，随后根据当前的日期，生成对应的日志文件名，例如 log-2022-01-01.log。而 writeTo 方法用于重写 log.pets 默认的输出方式。通过 writeStream.write 方法，我们将日志信息追加到对应日期的日志文件中。
根据环境输出
我们还可以通过判断环境变量来控制日志信息的输出。下面是一个例子：
const logger = require("log.pets");
if (process.env.NODE_ENV === "dev") {
logger.config({ useColors: true });
} else {
logger.config({ useColors: false });
}在上面的代码中，我们通过 process.env.NODE_ENV 判断当前的环境是否为开发环境。如果是开发环境，则启用颜色，否则关闭。这样可以在生产环境中避免因为一些无关紧要的信息而导致控制台输出太多。
收集错误信息
收集错误信息也是一个常见的需求。我们可以通过 try-catch 语句，将错误信息输出到日志中，并在开发环境下打印堆栈信息。下面是一个例子：
window.onerror = (msg, url, lineNo, columnNo, error) => {
logger.error(msg);
if (process.env.NODE_ENV === "dev" && error) {
logger.obj(error.stack);
}
};在上面的代码中，我们将 window.onerror 事件监听器设置为全局，当网页出现错误时，会自动触发该事件，我们可以通过该事件收集错误信息。error.stack 可以返回错误堆栈信息，我们可以在开发环境下将其打印到控制台，以便排查问题。
结语
本文主要介绍了 log.pets 的安装和基本使用，还介绍了个性化配置和对实际项目的一些经验分享。希望本文提供的内容能够帮助读者更好的实践和应用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005728381e8991b448e8ba3