node.js 如何监视文件变化


Posted in Javascript onSeptember 01, 2020

fs.FSWatcher

fs.FSWatcher类 继承了 EventEmitter,用于监视文件变化,调用 fs.watch 后返回一个 fs.FSWatcher 实例,每当指定监视的文件被修改时,实例会触发事件调用回调函数

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

fs.watch()

fs.watch(filename[, options][, listener]) 监视文件变化,返回 fs.FSWatcher 实例

1.filename:文件或文件夹路径

2.options

  • encoding
  • recursive:默认值 false,应该监视所有子目录,还是仅监视当前目录,仅在 macOS 和 Windows 上支持
  • persistent:默认值 true,指示如果文件已正被监视,进程是否应继续运行
  • listener(eventType, filename):文件变化回调函数

eventType 主要是 renamechange ,在大多数平台上,文件在目录中出现或消失时触发 'rename' 事件,在 Windows 上,如果监视的目录被移动或重命名,则不会触发任何事件,当监视的目录被删除时,则报告 EPERM 错误

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

fs.watchFile()

fs.watchFile(filename[, options], listener) 用于监视文件变化

1.filename

2.options

  • biginit:默认值 false,指定回调 stat 中的数值是否为 biginit 类型
  • persistent:默认值 true,当文件正在被监视时,进程是否应该继续运行
  • interval:默认值 5007,用来指定轮询频率(ms)

3.listener(currentStats, previousStats):listener 有两个参数,当前的 stat 对象和之前的 stat 对象
要在修改文件时收到通知,则需要比较 curr.mtime prev.mtime

const fs = require('fs');

fs.watchFile('./test.txt', { interval: 100 }, (curr, prev) => {
 console.log('当前的最近修改时间是: ' + curr.mtime);
 console.log('之前的最近修改时间是: ' + prev.mtime);
});

const tid = setInterval(() => {
 fs.appendFile('./test.txt', 'Hello, world!\n', err => {
  if (err) throw err;
  console.log('文件修改完成');
 });
}, 300);

setTimeout(() => {
 clearInterval(tid);
 fs.unwatchFile('./test.txt');
}, 2000);

fs.watch() 与 fs.watchFile()

因为 fs.watchFile() 使用轮训方式检测文件变化,如果不设置 interval 或者设置较高的值会发现文件变化的监视有延迟
而 fs.watch() 监听操作系统提供的事件,而且可以监视目录变化,使用 fs.watch() 比 fs.watchFile() 更高效,平常应尽可能使用 fs.watch() 代替 fs.watchFile()

当然 fs.watch() 依赖操作系统的实现,在不同平台上表现会有差异

  • Linux 操作系统使用 inotify
  • 在 macOS 系统使用 FSEvents
  • 在 windows 系统使用 ReadDirectoryChangesW

fs.unwatchFile

fs.unwatchFile(filename[, listener]) 停止监视 filename 的变化,如果指定了 listener,则仅移除此特定监听器,否则将移除所有监听器,从而停止监视 filename

fs.unwatchFile('./test.txt');

社区选择

fs.watchFile() 性能问题,fs.watch() 平台不一致等两个方法都有不尽如人意的地方

Node.js fs.watch:

MacOS 有时候不提供 filename
在部分场景不触发修改事件(MacOS Sublime)
经常一次修改两次触发事件
大部分文件变化 eventType 都是 rename.
未提供简单的监视文件树方式

Node.js fs.watchFile:

事件处理问题和 fs.watch 一样烂
没有嵌套监听
CPU 消耗大

https://www.npmjs.com/package/chokidar

日常在监视文件变化可以选择社区的优秀方案

  1. node-watch
  2. chokidar
const chokidar = require('chokidar');
 
// One-liner for current directory
chokidar.watch('.').on('all', (event, path) => {
 console.log(event, path);
});
// Initialize watcher.
const watcher = chokidar.watch('file, dir, glob, or array', {
 ignored: /(^|[\/\\])\../, // ignore dotfiles
 persistent: true
});
 
// Something to use when events are received.
const log = console.log.bind(console);
// Add event listeners.
watcher
 .on('add', path => log(`File ${path} has been added`))
 .on('change', path => log(`File ${path} has been changed`))
 .on('unlink', path => log(`File ${path} has been removed`));
 
// More possible events.
watcher
 .on('addDir', path => log(`Directory ${path} has been added`))
 .on('unlinkDir', path => log(`Directory ${path} has been removed`))
 .on('error', error => log(`Watcher error: ${error}`))
 .on('ready', () => log('Initial scan complete. Ready for changes'))
 .on('raw', (event, path, details) => { // internal
  log('Raw event info:', event, path, details);
 });

以上就是node.js 如何监视文件变化的详细内容,更多关于node.js 监视文件的资料请关注三水点靠木其它相关文章!

Javascript 相关文章推荐
网页打开自动最大化的js代码
Aug 22 Javascript
js 剪切板的用法(clipboardData.setData)与js match函数介绍
Nov 19 Javascript
jQuery实现textarea自动增长宽高的方法
Dec 18 Javascript
jQuery xml字符串的解析、读取及查找方法
Mar 01 Javascript
对比分析Django的Q查询及AngularJS的Datatables分页插件
Feb 07 Javascript
angular ng-repeat数组中的数组实例
Feb 18 Javascript
微信小程序 向左滑动删除功能的实现
Mar 10 Javascript
使用socket.io实现简单聊天室案例
Jan 02 Javascript
vue.js 图片上传并预览及图片更换功能的实现代码
Aug 27 Javascript
webpack优化的深入理解
Dec 10 Javascript
JavaScript实现滚动加载更多
Dec 27 Javascript
Vue+Element UI实现概要小弹窗的全过程
May 30 Vue.js
JS JQuery获取data-*属性值方法解析
Sep 01 #jQuery
谈谈node.js中的模块系统
Sep 01 #Javascript
JavaScript浅层克隆与深度克隆示例详解
Sep 01 #Javascript
VUE子组件向父组件传值详解(含传多值及添加额外参数场景)
Sep 01 #Javascript
vue离开当前页面触发的函数代码
Sep 01 #Javascript
Vue 实现监听窗口关闭事件,并在窗口关闭前发送请求
Sep 01 #Javascript
Node.js web 应用如何封装到Docker容器中
Sep 01 #Javascript
You might like
php 传值赋值与引用赋值的区别
2010/12/29 PHP
深入PHP与浏览器缓存的分析
2013/06/03 PHP
解析php session_set_save_handler 函数的用法(mysql)
2013/06/29 PHP
ThinkPHP打开验证码页面显示乱码的解决方法
2014/12/18 PHP
php获得文件大小和文件创建时间的方法
2015/03/13 PHP
PHP实现XML与数据格式进行转换类实例
2015/07/29 PHP
thinkphp3.2.3版本的数据库增删改查实现代码
2016/09/22 PHP
PDO::lastInsertId讲解
2019/01/29 PHP
jquery实现右键菜单插件
2015/03/29 Javascript
JavaScript实现图片DIV竖向滑动的方法
2015/04/25 Javascript
jquery表单验证需要做些什么
2015/11/17 Javascript
全面解析Angular中$Apply()及$Digest()的区别
2016/08/04 Javascript
AngularJS的依赖注入实例分析(使用module和injector)
2017/01/19 Javascript
socket.io实现在线群聊功能
2017/04/07 Javascript
详谈DOM简介及节点、属性、查找节点的方法
2017/11/16 Javascript
详解小程序rich-text对富文本支持方案
2018/11/28 Javascript
微信小程序如何实现点击图片放大功能
2020/01/21 Javascript
跟老齐学Python之大话题小函数(2)
2014/10/10 Python
Python下实现的RSA加密/解密及签名/验证功能示例
2017/07/17 Python
Python实现按学生年龄排序的实际问题详解
2017/08/29 Python
python去除字符串中的换行符
2017/10/11 Python
Python实现注册、登录小程序功能
2018/09/21 Python
对python实现合并两个排序链表的方法详解
2019/01/23 Python
python调用摄像头拍摄数据集
2019/06/01 Python
解决使用export_graphviz可视化树报错的问题
2019/08/09 Python
PYQT5开启多个线程和窗口,多线程与多窗口的交互实例
2019/12/13 Python
python统计字符串中字母出现次数代码实例
2020/03/02 Python
Windows下pycharm安装第三方库失败(通用解决方案)
2020/09/17 Python
python3中for循环踩过的坑记录
2020/12/14 Python
Saks Fifth Avenue澳洲/亚太地区:萨克斯第五大道精品百货店
2019/06/09 全球购物
专业技术职务聘任书
2014/03/29 职场文书
反四风个人对照检查材料
2014/09/26 职场文书
2014年党支部书记工作总结
2014/12/04 职场文书
web前端之css水平居中代码解析
2021/05/20 HTML / CSS
anaconda python3.8安装后降级
2021/06/11 Python
Python3的进程和线程你了解吗
2022/03/16 Python