NodeJS监视文件

对于如何监视文件更改这个问题，我第一时间还是想到了Node内置的fs库，果然发现了有这样一个操作。

fs

使用fs.watch来做到最基本的监视文件，这里先写出来一个最简单的示例：

const fs = require('fs')

fs.watch('./file.txt', {}, (event, filename) => {
    console.log(`File: ${event}, ${filename}`)
})

在运行之前，现在当前目录下创建一个file.txt，然后我打开了file.txt，写了几个字保存，看到了这些输出：

1 2	File: change, file.txt File: change, file.txt

然后把它删掉，看到这些输出：

1	File: rename, file.txt

我明明是删掉了，为什么告诉我是改名？还有我明明是改了一下，却给我反回来了两个输出？

这些问题就是下面要说的。

原理

那么通过查源码我发现了，对于第一个我们接到的event对象，是这样定义的：

1	export type WatchEventType = 'rename' \| 'change'

所以说，在node眼里他就只有改名和修改两种事件。

其次，因为有些编辑器在做修改工作的时候是把文件内容都清了之后再写入当前文件，所以它监听到了两个change事件。

那么怎么解决呢? 其实是有方法的。

不依赖第三方库

借助fs.stat或者fs.statSync获取文件的状态对象，然后可以进行一系列的判断来确定到底发生了什么事情。

不过这不是本文所要探讨的内容，这里只说一下这个思路。

使用chokidar

这里贴出来它的Github仓库地址。

第一步自然是安装：

1	npm install chokidar

它的API比较简洁，函数只有一个watch，返回一个FSWatcher对象：

export function watch(
  paths: string | ReadonlyArray<string>,
  options?: WatchOptions
): FSWatcher

那么对于这个可选的options对象，先把代码贴上来，再分析：

const watcher = chokidar.watch('./file.txt', {
    depth: 0,
    ignored: /(^|[\/\\])\../, // ignore dotfiles
})

这里我只用到了两个配置项，至于更多的大家可以翻阅文档：

depth 指的就是监测的文件夹深度了。这里我只需要监视当前文件夹，所以填0。
ignored 是一个正则，用来匹配忽略的文件。这里写的是官方用来匹配点开头的文件的正则。

那么对于这个watcher对象，我们就可以做一个监视的操作了：

1
2
3

watcher.on('all', (event, path) => {
    console.log(`File: ${event}, ${path}`)
}).on('ready', () => console.log('Ready'))

此时直接运行，会发现输出了这样的内容：

1 2	File: add, file.txt Ready

可以注意到，它先检测到了有一个添加的事件，然后才响应到了ready。
如果说我们不需要它的初始化，只要这样做就行（我不知道它的原生API支不支持取消初始化，这里是自己添加的逻辑）：

let ready = false

watcher.on('all', (event, path) => {
    if (ready) {
        console.log(`File: ${event}, ${path}`)
    }
}).on('ready', () => {
    ready = true
    console.log('Ready')
})

做一个简单的状态检查，就可以达到我们的效果了。