在前端开发中,调试和输出信息是至关重要的,能够有效的提高开发效率以及项目的必要性。mihoka-logger 就提供了一种方便灵活的日志输出方式。下面将详细介绍如何使用该 npm 包,以及展示其功能。
安装
可以通过 npm 进行包的安装:
npm install mihoka-logger --save
导入
使用时,需要先在你的项目中导入该包:
import {Logger} from "mihoka-logger";
或者,也可以通过 require 的方式:
const {Logger} = require("mihoka-logger");
创建日志实例
接下来,我们就可以创建一个日志实例了:
const logger = new Logger("myLogger");
在这里,第一个参数即为日志的名称,建议给予一个有意义的名称,它将会出现在后续输出的日志中。
日志级别
mihoka-logger 提供丰富的日志级别来满足不同的需求,包含以下五种级别:
TRACE
:细粒度最高的日志级别,用于跟踪追踪代码执行流程,由于粒度较细,因此输出时比较繁琐。DEBUG
:调试级别的日志,输出有关程序中变量值的信息。INFO
:用于在程序中输出运行时状态信息,输出非常重要的信息。WARN
:警告级别的日志,用于表示当前程序运行过程中出现了一些异常场景,但并不致命,程序仍可以继续执行。ERROR
:错误级别的日志,用于发现和记录程序中的异常和错误。
在创建日志实例的时候,可以设置实例的日志级别:
const logger = new Logger("myLogger", "error");
如果不设置,则默认日志级别为 info
。实例的日志级别只会在该实例上有效。
日志输出
有了日志实例以后,下面就可以开始输出日志了。
以 info
级别输出一个信息:
logger.info("这是一条信息");
输出结果为:
[myLogger][info]这是一条信息
可以看到,输出结果包含了日志名称、日志级别以及具体的日志信息。
还可以以其他四种级别输出日志:
logger.debug("debug 信息"); logger.warn("警告信息"); logger.error("错误信息"); logger.trace("追踪信息");
输出结果分别为:
[myLogger][debug]debug 信息 [myLogger][warn]警告信息 [myLogger][error]错误信息 [myLogger][trace]追踪信息
格式化输出
除了直接输出字符串以外,mihoka-logger 还支持格式化输出的方式。
例如:
logger.info("格式化字符串:%s,%d", "test", 666);
输出结果为:
[myLogger][info]格式化字符串:test,666
可以看到,${...}
里的参数被替换为给定的值。
如果使用其他符号,例如:
logger.info("格式化字符串:{0},{1}", "test", 666);
输出结果为:
[myLogger][info]格式化字符串:test,666
还可以结合对象输出:
logger.info("对象输出:%o", {a: 1, b: "test"});
输出结果为:
[myLogger][info]对象输出:{a: 1, b: "test"}
日志记录器
在实际项目中,有可能需要对不同的日志分别进行记录,mihoka-logger 提供了日志记录器的功能恰好满足这个需求。
可以通过 Logger.getLogger
方法来获得一个记录器,该记录器会继承原有的日志级别、打印函数等属性。
const logger2 = Logger.getLogger("myLogger2"); logger2.info("这是 logger2 中的信息");
输出结果为:
[myLogger2][info]这是 logger2 中的信息
结束语
通过本文的介绍,相信大家已经了解了如何使用 npm 包 mihoka-logger 进行日志输出以及定位。可以充分发挥其优势提高前端开发的效率。
最后,希望大家在实习过程中多使用并加深理解,将之运用在实际开发中,提高自己的技术水平。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055fd081e8991b448dd5c4