Nodejs监听文件

概述

使用fs.watchfile

fs.watchFile(dir, (curr, prev) => {});

问题: 回调存在一定的延迟,因为watchfile是通过轮询检测文件变化,而且只能监听一个文件。

使用fs.watch

fs.watch(dir, (event, filename) => {});

watch 通过操作系统提供的文件更改通知机制,在 Linux 操作系统使用 inotify,在 macOS 系统使用 FSEvents,在 windows 系统使用 ReadDirectoryChangesW,而且可以用来监听目录的变化,在监听文件夹的场景中,比创建 N 个 fs.watchfile 效率高出很多。

user@LAPTOP-DC22I3FC MINGW64 /d/gitpro/example/node
$ node index.js
test.md    change
test.md    change

因而可以进一步判断是否触发状态是 change:

fs.watch(dir, (event, filename) => {
  if (filename && event === "change") {
    console.log(`${filename} file Changed`);
  }
});

问题: 回调使用了2次,原因是文件被写入时,可能触发多次写操作,即使只保存了一次。但我们不需要这么敏感的回调,因为通常认为一次保存就是一次修改,系统底层写了几次文件我们并不关心。

作者要表达的意思是,在不同平台下,fs.watch 的规则可能会不同,原因是 fs.watch 分别使用了各平台提供的 api,所以无法保证这些 api 实现规则的统一性。

时间判断

let previousMTime = new Date(0);

fs.watch(dir, (event, filename) => {
  if (filename) {
    const stats = fs.statSync(filename);
    if (stats.mtime.valueOf() === previousMTime.valueOf()) {
      return;
    }
    previousMTime = stats.mtime;
    console.log(`${filename} file Changed`);
  }
});

log 由 4 个变成了 3 个,但依然存在问题。我们认为文件内容变化才算有修改,但操作系统考虑的因素更多,所以我们再尝试对比文件内容是否变化。

校验文件 md5

let md5Previous = null;

fs.watch(dir, (event, filename) => {
  if (filename) {
    const md5Current = md5(fs.readFileSync(buttonPressesLogFile));
    if (md5Current === md5Previous) {
      return;
    }
    md5Previous = md5Current;
    console.log(`${filename} file Changed`);
  }
});

作者讨论了一些实现文件夹监听的基本方式,可以看出,使用了各平台原生 API 的 fs.watch 并不那么靠谱,但这也我们监听文件的唯一手段,所以需要基于它进行一系列优化。

而实际场景中,还需要考虑区分文件夹与文件、软连接、读写权限等情况。

另外用在生产环境的库,也基本使用 50 到 100 毫秒解决重复触发的问题。

所以无论 chokidarnode-watch,都大量使用了文中提及的技巧,再加上对边界条件的处理,对软连接、权限等情况处理,将所有可能情况都考虑到,才能提供较为准确的回调。

可以看出,第三方 npm 库都采取不信任操作系统回调的方式,根据文件信息完全重写了判断逻辑。

可见,信任操作系统的回调,就无法抹平所有操作系统间的差异,唯有统一重写文件的 “写入”、“删除”、“修改” 等逻辑,才能保证在全平台的兼容性。

总结

利用 nodejs 监听文件夹变化很容易,但提供准确的回调却很难,主要难在两点:

  • 抹平操作系统间的差异,这需要在结合 fs.watch 的同时,增加一些额外校验机制与延时机制。
  • 分清楚操作系统预期与用户预期,比如编辑器的额外操作、操作系统的多次读写都应该被忽略,用户的预期不会那么频繁,会忽略极小时间段内的连续触发。
    另外还有兼容性、权限、软连接等其他因素要考虑,fs.watch 并不是一个开箱可用的工程级别 api。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容