NPM 包 Loggester 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在前端开发过程中，调试和记录日志是必不可少的。一般我们使用 console 对象输出日志，但是仅仅使用 console 可能会有诸多限制，例如只能输出到控制台，无法实时远程记录日志等。而 NPM 上的 Loggester 包则提供了一种方便覆盖多种场景，支持实时输出日志的解决方案。

Loggester 简介

Loggester 是一个便捷的 JavaScript 日志框架。它提供了简单的 API，能够以多种方式输出日志，包括控制台，文件和远程 API 等，甚至可以同时输出到多个目标。此外，Loggester 支持可扩展的日志级别设置，从 INFO 到 TRACE，你可以根据需要选择要记录的详细程度。

Loggester 安装

你可以使用以下命令来安装 Loggester：

npm install loggester --save

Loggester 使用

初始化 Loggester

在使用 Loggester 之前，需要先初始化。

const log = require('loggester');

const logger = new log({
  console: true, // 是否输出到控制台
  file: './logs/mylog.log', // 将日志写入文件并指定路径
  url: 'https://my-api.com/logs', // 将日志以 POST 方法发送到远程 API
  methods: ['INFO', 'WARNING', 'ERROR'], // 选择输出的日志级别
});

输出日志

// 打印 INFO 日志
logger.info('This is a INFO log.');

// 打印 WARNING 日志
logger.warn('This is a WARNING log.');

// 打印 ERROR 日志
logger.error('This is a ERROR log.');

日志级别

Loggester 提供 5 个级别: TRACE, DEBUG, INFO, WARNING, ERROR。

你可以通过设置 methods 来选择需要输出的级别，例如：

const logger = new log({
  console: true,
  file: './logs/mylog.log',
  methods: ['INFO', 'WARNING', 'ERROR'],
});

这会抛弃 TRACE 和 DEBUG 日志，只输出 INFO, WARNING, ERROR 三个级别。如果你想要输出所有日志，可以写成：

const logger = new log({
  console: true,
  file: './logs/mylog.log',
  methods: ['TRACE', 'DEBUG', 'INFO', 'WARNING', 'ERROR'],
});

输出到文件

除了控制台输出，你也可以将日志输出到文件。

const logger = new log({
  console: false,
  file: './logs/mylog.log',
  methods: ['INFO', 'WARNING', 'ERROR'],
});

在这种情况下，Loggester 会以以下格式输出日志：

2021-10-03T12:00:00.000Z - INFO - Hello, world!
2021-10-03T12:00:05.000Z - WARNING - Something might go wrong.
2021-10-03T12:00:10.000Z - ERROR - Oops! Something went wrong.

同时，Loggester 会为每个小时生成一个新的日志文件，以免日志过大。

输出到远程 API

如果你想要将日志上传到远程 API，可以使用以下配置。

const logger = new log({
  console: false,
  url: 'https://my-api.com/logs',
  methods: ['INFO', 'WARNING', 'ERROR'],
});

在这种情况下，Loggester 会将日志以 POST 方法发送到指定的 URL 上，其中请求体的 JSON 格式如下：

{
  "type": "INFO",
  "message": "Hello, world!",
  "datetime": "2021-10-03T12:00:00.000Z"
}

扩展 Loggester

如果你想要扩展 Loggester，你可以继承它并重写 logMessage 方法。

class MyLogger extends log {
  logMessage(message, method) {
    message = `Custom prefix: ${message}`;
    super.logMessage(message, method);
  }
}

在例子中，我们添加了一个以 Custom prefix: 为前缀的字符串。

总结

在本文中，我们介绍了 NPM 包 Loggester 的使用教程。通过这个包，我们可以便捷地实现日志输出的功能，并可以选择多种输出方式，包括控制台，文件和远程 API 等。同时，我们还介绍了日志级别的理念以及如何自定义日志输出的格式。希望能对你的日志记录和调试有所帮助！

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600559e581e8991b448d787c