Node.js监听文件的变化

1. 监听文件变化

Node.js API 提供了 fs.watchFile 和 fs.watch 两种方法监听文件变化

1.1 watchFile 方法

watchFile 方法通过轮询按照一定时间间隔监测文件变化； 在不同操作系统下行为相对一致；但是用 watchFile 监听过多文件时会导致内存占用过高

fs.watchFile('./file.txt', function (curr, prev) {
    // curr 文件当前的fs.Stats对象；prev 文件修改前的fs.Stats对象
    console.log(`当前修改的时间: ${curr.mtime}`);
    console.log(`上一次修改的时间: ${prev.mtime}`);
});

watchFile方法使用示例 

 

1.2 watch 方法

watch 方法通过监听操作系统提供的各种事件实现对文件变化的监听，相较于 watchFile 方法性能更高，因此优先考虑使用 watch 方法。但是它在某些操作系统的某些情况下不可用（比如在 Windows 上，如果监视目录被移动或重命名，则不会触发任何事件）。此外，watch 方法还能监听文件夹。

fs.watch('./file.txt', function (eventType, filename) {
    // eventType 是 'rename' 或 'change'
    // filename 是触发事件的文件名称
    console.log(eventType);
    console.log(filename);
});

 watch方法使用示例

 

2. 获取新增内容

如果除了监听文件的变化，还需要获取新增的内容。使用 readFile 方法或 readline 模块都必须每次读取文件的所有内容，然后通过对比获取新的内容，这样做比较繁琐而且性能不高。可以用 fs.read 方法从上一次读取到的文件流位置开始直接读取新的内容。

const buf = new Buffer.alloc(1024); // 分配1024字节的缓冲区
const filename = './file.txt';
fs.open(filename, 'r', (err, fd) => { // 打开文件做读操作
  if (err) {
    console.error(err);
    return;
  }
  fs.watch(filename, function (eventType, filename) {
    /*
      fs.read(fd, buffer, offset, length, position, callback)
      参数解释：
        fd 通过 fs.open() 方法返回的文件描述符
        buffer 存储读取内容的缓冲区
        offset 缓冲区buffer的写入偏移量
        length 从文件中一次读取的字节数
        position 从文件中开始读取的偏移量；null 或 -1 表示将从当前文件位置读取数据
        callback: 回调函数，有3个参数：err, bytesRead, buffer，分别表示 错误信息、读取的字节数、缓冲区对象
    */
    fs.read(fd, buf, 0, buf.length, null, (err, bytesRead) => {
      if(bytesRead > 0){
        const txtAdded = buf.slice(0, bytesRead).toString().trim();
        console.log('新增文本内容：' + txtAdded);
      }
    });
  });
});