Node.js 在本地生成日志文件的方法

更新時間：2020年02月07日 11:23:52 作者：allan91

這篇文章主要介紹了Node.js 在本地生成日志文件的方法,本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，具有一定的參考借鑒價值，需要的朋友可以參考下

平常都使用console來打印 node 腳本執(zhí)行時需要看到的信息，但這些信息也就只能在控制臺查看。假如你希望將打印的信息輸出到日志（log）文件查看的話，那就往下看看吧。

1、前言

期望：

每次運(yùn)行腳本時，生成log日志存儲到本地
每次執(zhí)行腳本，之前日志內(nèi)容清空

需要了解的知識點(diǎn)：

fs
new console.Console

2、什么是 fs

使用 node.js 對日志進(jìn)行存儲，就一定會對本地文件的增刪改查，那么我們需要用到fs。

如果你寫過 node，想必你應(yīng)該見過它fs，fs全稱為文件系統(tǒng)（File System）。文件系統(tǒng)簡單來說就是通過 Node 來操作系統(tǒng)中的文件。

fs 不需要 npm install，node 中自帶，直接引用即可:

const fs = require('fs');

本文將會使用 fs 的fs.createWriteStream(path, options)方法，用于創(chuàng)建可讀流，用法如下：

/**
 * @param1 path
 * @param2 options
 */
let fs = require('fs');
let ws = fs.createWriteStream('./1.txt',{
 flags:'w'//文件的打開模式
 ,mode:0o666//文件的權(quán)限設(shè)置
 ,encoding:'utf8'//寫入文件的字符的編碼
 ,highWaterMark:3//最高水位線
 ,start:0 //寫入文件的起始索引位置  
 ,autoClose:true//是否自動關(guān)閉文檔
})

以此用于在日志記錄后于本地生成日志文件。

3、new console.Console(stdout[, stderr][, ignoreErrors])

在 node.js 中 console 模塊提供了基礎(chǔ)的調(diào)試功能。使用很簡單，常用的API主要有 console.log()、console.error()。

此外，可以基于Console類，方便的擴(kuò)展出自己的console實(shí)例，比如把調(diào)試信息打印到文件里，而部署輸出在控制臺上。

const fs = require('fs');
const file = fs.createWriteStream('./outPut.txt');
let logger = new console.Console(file, file);
// 調(diào)用
logger.log('hello');

此時，調(diào)用logger.log內(nèi)容將會輸出到 outPut.txt里，而不是打印到控制臺。

4、node.js 生成日志文件方法

在了解完 node 的兩個模塊fs和console后，我們開始寫這個簡單而實(shí)用的方法，先創(chuàng)建 index.js

// index.js
const fs = require('fs');

let opions = {
 flags: 'a', // 
 encoding: 'utf8', // utf8編碼
}
let stderr = fs.createWriteStream('./a.log', options);
// 創(chuàng)建logger
let logger = new console.Console(stderr);
// 真實(shí)項(xiàng)目中調(diào)用下面即可記錄錯誤日志
logger.log('這是一條日志1');
logger.log('這是一條日志2');
logger.log('這是一條日志3');

打開終端執(zhí)行node logger.js:

$ node index.js

此時根目錄將會生成 a.log 文件

好了，最簡易版的就這樣完成了。但是當(dāng)時在此執(zhí)行node logger.js時，日志將會累加上去，這樣會增加本地存儲的負(fù)擔(dān)。所以我希望的是每次執(zhí)行的時候清空一下。

那就來改寫一下 index.js， node.js 中改寫依舊使用fs的方法fs.writeFile：

// 清空a.log內(nèi)容
fs.writeFile('./a.log', '', function (err) {
 if(err){
  console.log(err);
 }
});

至此，我期望得到的日志文件就完成了。完整代碼為：

const fs = require('fs');
let options = {
 flags: 'a', // 
 encoding: 'utf8', // utf8編碼
}
let stderr = fs.createWriteStream('./a.log', options);
// 創(chuàng)建logger
let logger = new console.Console(stderr);
fs.writeFile('./a.log', '', function (err) {
 if(err){
  console.log(err);
 }
});
// 真實(shí)項(xiàng)目中調(diào)用下面即可記錄錯誤日志
logger.log('這是一條日志1');
logger.log('這是一條日志2');
logger.log('這是一條日志3');

可以將此封裝起來，然后在需要的地方去調(diào)用。logger.log('你需要記錄的日志')即可。

5、其他

當(dāng)然在此基礎(chǔ)上你可以拓展其它內(nèi)容，比如給日志中增加時間戳、區(qū)分日志類型儲存等。

以上，如有問題或建議歡迎指正。

參考資料：

nodejs.cn/api/console…

nodejs.cn/api/fs.html

總結(jié)

以上所述是小編給大家介紹的Node.js 在本地生成日志文件的方法，希望對大家有所幫助！

您可能感興趣的文章: