NPM酷庫(kù)：debug，控制調(diào)試日志

funnyZhang 發(fā)布于2019-08-21 18:38 / 1535人閱讀

摘要：今天我們要了解的庫(kù)是，一個(gè)專門用來(lái)控制輸出調(diào)試日志的庫(kù)。但是，隨著項(xiàng)目規(guī)模增加，控制臺(tái)輸出的日志就會(huì)堆積很多而不可讀。庫(kù)就是一款專門控制日志輸出的庫(kù)，能夠完美解決我們的上述需求。

NPM酷庫(kù)，每天兩分鐘，了解一個(gè)流行NPM庫(kù)。

今天我們要了解的庫(kù)是debug，一個(gè)專門用來(lái)控制輸出調(diào)試日志的庫(kù)。

通常，我們直接使用 console.log 輸出調(diào)試日志，使用console對(duì)象直接將日志輸出到控制臺(tái)，由于Node.js和瀏覽器環(huán)境都默認(rèn)支持console對(duì)象，所以，這種方式是最直接和最簡(jiǎn)潔的。

但是，隨著項(xiàng)目規(guī)模增加，console 控制臺(tái)輸出的日志就會(huì)堆積很多而不可讀。另一方面，我們需要在開發(fā)調(diào)試環(huán)境才打開日志，而線上生產(chǎn)環(huán)境就不需要輸出過(guò)多的日志。使用 console 對(duì)象控制日志輸出，我們會(huì)自然而然地以“加注釋”、“去注釋”的方式來(lái)控制日志的輸出。這樣很笨。

debug庫(kù)就是一款專門控制日志輸出的庫(kù)，能夠完美解決我們的上述需求。

首先，debug庫(kù)會(huì)判斷DEBUG環(huán)境變量，所以我們不需要修改代碼，只調(diào)整一下程序運(yùn)行環(huán)境就可以控制日志是否輸出。另外，debug庫(kù)不是簡(jiǎn)單地布爾判斷DEBUG環(huán)境變量，而是會(huì)對(duì)DEBUG環(huán)境變量進(jìn)行解析，允許我們選擇性地控制輸出哪些模塊的日志，有效地解決了調(diào)試程序時(shí)候控制臺(tái)日志堆積問(wèn)題，因?yàn)槲覀兛梢钥刂芼ebug，讓其只輸出我們關(guān)心的程序模塊的日志。

下面就是一段使用了debug庫(kù)的程序示例。

const Debugger = require("debug");

const a = Debugger("worker:a");
const b = Debugger("worker:b");

function work() {
  a("doing lots of uninteresting work");
  setTimeout(work, Math.random() * 1000);
}

work();

function workb() {
  b("doing some work");
  setTimeout(workb, Math.random() * 2000);
}

workb();

如果設(shè)置環(huán)境變量DEBUG為 worker:* 那么就會(huì)輸出所有的日志：

如果設(shè)置環(huán)境變量DEBUG為 worker:a 那么就只會(huì)輸出worker:a 的日志：

從上述例子中，得知DEBUG環(huán)境變量的設(shè)置支持通配符*。假設(shè)，我們的程序中存在如下調(diào)試器 "connect:bodyParser"、"connect:compress"、"connect:session"，我們可以將DEBUG設(shè)置為DEBUG=connect:bodyParser,connect:compress,connect:session ，或者簡(jiǎn)單地使用通配符 DEBUG=connect:*，如果我們需要調(diào)試非connect相關(guān)的其他信息，可以使用 - 符號(hào)，“減去” connect，DEBUG=*,-connect:* 。

在瀏覽器端，debug也能夠很好地運(yùn)行，不過(guò)在瀏覽器端開啟調(diào)試，并不是使用DEBUG環(huán)境變量，因?yàn)闉g覽器端不支持process.env.DEBUG訪問(wèn)。在瀏覽器端，使用localStorage 對(duì)象控制debug：