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 加载时自动调整图片大小
May 28 Javascript
编写自己的jQuery插件简单实现代码
Apr 19 Javascript
jquery的ajax请求全面了解
Mar 20 Javascript
js+css实现上下翻页相册代码分享
Aug 18 Javascript
jQuery EasyUI学习教程之datagrid点击列表头排序
Jul 09 Javascript
JSON创建键值对(key是中文或者数字)方式详解
Aug 24 Javascript
详解vue mint-ui源码解析之loadmore组件
Oct 11 Javascript
JavaScript屏蔽Backspace键的实现代码
Nov 02 Javascript
vue实现随机验证码功能的实例代码
Apr 30 Javascript
如何在vue项目中嵌入jsp页面的方法(2种)
Feb 06 Javascript
vue 数据遍历筛选 过滤 排序的应用操作
Nov 17 Javascript
微信小程序实现倒计时功能
Nov 19 Javascript
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比你想象的好得多
2014/11/27 PHP
PHP钩子与简单分发方式实例分析
2017/09/04 PHP
关于Anemometer图形化显示MySQL慢日志的工具搭建及使用的详细介绍
2020/07/13 PHP
文字幻灯片
2006/06/26 Javascript
兼容IE/Firefox/Opera/Safari的检测页面装载完毕的脚本Ext.onReady的实现
2009/07/14 Javascript
jquery聚焦文本框与扩展文本框聚焦方法
2012/10/12 Javascript
复选框全选与全不选操作实现思路
2013/08/18 Javascript
自定义ExtJS控件之下拉树和下拉表格附源码
2013/10/15 Javascript
按钮接受回车事件的三种实现方法
2014/06/06 Javascript
原生js实现的贪吃蛇网页版游戏完整实例
2015/05/18 Javascript
浅谈jquery.fn.extend与jquery.extend区别
2015/07/13 Javascript
详解JavaScript的表达式与运算符
2015/11/30 Javascript
浅谈在node.js进入文件目录的问题
2018/05/13 Javascript
vue实现多条件和模糊搜索功能
2019/05/28 Javascript
Flutter部件内部状态管理小结之实现Vue的v-model功能
2019/06/11 Javascript
浅谈Node新版本13.2.0正式支持ES Modules特性
2019/11/25 Javascript
原生javascript制作的拼图游戏实现方法详解
2020/02/23 Javascript
vue 使用async写数字动态加载效果案例
2020/07/18 Javascript
vue制作toast组件npm包示例代码
2020/10/29 Javascript
Python入门篇之正则表达式
2014/10/20 Python
深入理解python多进程编程
2016/06/12 Python
python基本语法练习实例
2017/09/19 Python
Python实现将一个正整数分解质因数的方法分析
2017/12/14 Python
转换科学计数法的数值字符串为decimal类型的方法
2018/07/16 Python
Python使用grequests(gevent+requests)并发发送请求过程解析
2019/09/25 Python
Python中Yield的基本用法
2020/10/18 Python
CSS3 :nth-child()伪类选择器实现奇偶行显示不同样式
2013/11/05 HTML / CSS
HTML5实现表单自动验证功能实例代码
2017/01/11 HTML / CSS
比利时香水网上商店:NOTINO
2018/03/28 全球购物
教师实习自我鉴定
2013/12/11 职场文书
质检员岗位职责
2013/12/17 职场文书
个人学习群众路线心得体会
2014/11/05 职场文书
公司员工奖惩制度
2015/08/04 职场文书
准备去美国留学,那么大学申请文书应该怎么写?
2019/08/12 职场文书
分享MySQL常用 内核 Debug 几种常见方法
2022/03/17 MySQL
kubernetes集群搭建Zabbix监控平台的详细过程
2022/07/07 Servers