fs.watch监听文件或目录的更改

fs.watch(filename[, options][, listener])#

• filename <string> | <Buffer> | <URL>
• options <string> | <Object>
  • persistent <boolean> 指示如果文件已正被监视，进程是否应继续运行。默认值: true。
  • recursive <boolean> 指示应该监视所有子目录，还是仅监视当前目录。这适用于监视目录时，并且仅适用于受支持的平台（参见注意事项）。默认值: false。
  • encoding <string> 指定用于传给监听器的文件名的字符编码。默认值: 'utf8'。
• listener <Function> | <undefined> 默认值: undefined。
  • eventType <string>
  • filename <string> | <Buffer>
• 返回: <fs.FSWatcher>

监视 filename 的更改，其中 filename 是文件或目录。
第二个参数是可选的。 如果 options 传入字符串，则它指定 encoding。 否则， options 应传入对象。
监听器回调有两个参数 (eventType, filename)。 eventType 是 'rename' 或 'change'， filename 是触发事件的文件的名称。
在大多数平台上，每当文件名在目录中出现或消失时，就会触发 'rename' 事件。

调用fs.watch方法会返回一个fs.FSWatcher类的对象

fs.FSWatcher类的对象有一个close方法，用来停止监视目标文件的更改，一旦停止，则fs.FSWatcher对象将不再可用

如果监听的是文件:
修改被监视文件的内容触发的事件类型是change
重命名被监视的文件触发的事件类型是rename
删除监视的文件和删除后重建同名文件触发的事件类型都是rename

修改被监视文件名字之后,fs.watch不会继续监听修改名字之后的文件

在 Linux 或 macOS 系统上.删除了被监视的文件之后新建一个同名文件,fs.watch不会监视后来新建的同名文件
在windows系统中,删除了被监听的文件,再新建一个同名文件,fs.watch依然会监视新建的同名文件

如果监听的是目录:
默认情况下,触发事件的文件名filename只能是监听的目录下的直接子文件或子目录的名字,
监听目录的子目录里的内容发生改变,会触发事件,但是触发事件的文件名是那个子目录

不管是监听目录下的第几级子目录里的内容发生改变,都想要filename展示具体触发事件的文件或目录的名字,
需要设置第二个参数对象的属性recursive: true

例1: 监听文件改变

image.png

const fs = require('fs')

fs.watch('./a.text', (eventType, filename) => {
    console.log(eventType)
    console.log(filename)
})

在终端输入node index.js运行文件之后,修改a.text的内容为:你好李银河,保存

image.png

在 Linux 或 macOS 系统上， fs.watch() 解析路径到索引节点并监视该索引节点。 如果删除并重新创建监视的路径，则会为其分配一个新的索引节点。 监视器会因删除而触发事件，但会继续监视原始的索引节点。 不会因新建索引节点而触发事件。 这是预期的行为。

也就是说:在 Linux 或 macOS 系统上fs.watch实际上监视的是文件或目录对应的索引节点,每一个文件或目录在创建的时候都会分配一个索引节点,如果你删除了a.text文件,fs.watch依然会监视原先的索引节点,这时你再创建一个同名的a.text文件,系统会为那个新创建的文件分配一个新的索引节点,因为fs.watch依然监视老的索引节点,所以你修改新的a.text文件的内容不会触发事件

现在执行操作:删除当前的a.text文件

image.png

再执行操作:新建一个a.text文件,

image.png

并输入内容:你好,保存

image.png

我现在使用的是windows系统,说明在windows系统中,删除了被监听的文件,再新建一个同名文件,fs.watch依然会监视新建的同名文件

删除监视的文件和删除后重建同名文件触发的事件类型都是rename
修改被监视文件的内容触发的事件类型是change

现在执行操作:修改文件名a.text为aa.text

image.png

再次修改aa.text的内容并保存:

image.png image.png

也就是修改文件名字之后,fs.watch不会继续监听修改名字之后的文件

例2: 监听目录的改变

image.png

const fs = require('fs')

fs.watch('./assets',  (eventType, filename) => {
    console.log(eventType)
    console.log(filename)
})

1.修改assets/a.text内容

image.png

2.把assets/a.text重命名为assets/aa.text

image.png

3.删除assets/b.text

image.png

4.新建assets/c.text

image.png

5.修改assets/img/c.text内容

image.png image.png

修改被监听目录assets的直接子目录img下的任何内容,触发的事件类型都是chang,触发事件的文件的名字都是img

例3:监听目录,设置第二可选参数的属性recursive: true

const fs = require('fs')

fs.watch('./assets', {recursive: true}, (eventType, filename) => {
    console.log(eventType)
    console.log(filename)
})

修改assets/img/c.text内容

image.png image.png image.png