位置: 编程技术 - 正文
详解nodejs 文本操作模块-fs模块（五）(nodejs 文档)
发布时间：2024-02-27推荐整理分享详解nodejs 文本操作模块-fs模块（五）(nodejs 文档)，希望有所帮助，仅作参考，欢迎阅读内容。
文章相关热门搜索词:nodejs writefile,nodejs 文档,nodejs document,nodejs writestream,nodejs writestream,nodejs word,nodejs 文档,nodejs writefile,内容如对您有帮助，希望把文章链接给更多的朋友！
fs模块是一个比较庞大的模块，在前面也介绍了该模块中最核心的一点东西，虽然核心的这点东西，在整个fs模块中占据的比例比较小，但是如果只是我们平常使用的话，基本已经够用了，其他的一些方法，属于能力提升时需要学习的的内容了，所以在后面就不再继续了，本篇属于fs模块中的最后一篇，也不是把fs模块中的其他API都给一一列举出来，这里再说最后一个我看来很重要的方法，监听文件或者目录的的方法watchFile。
概总
这里之所以在最后把这个watchFile方法写入到这里，是因为在前端的一个流行的构建工具grunt中，有一个grunt-contrib-watch模块，可以用于监听整个项目中，文件是否有变化，不知道有没有人去看过该部分的源码，是如何实现这个模块的呢？（我是还没有去看过，基础学习完成之后，再去研究下）
所以，这里提前看下，fs模块中的watchFile是如何实现的，等以后去看grunt中的watch模块时，就可以更得心应手了，所以，想法和我相同的朋友们，就继续看下去吧。。
fs.watchFile方法
该方法是用于监听指定文件的一个方法，其使用方法为
其中：
1:filename：必须，需要被监听的文件的完整的路径以及文件名
2:option：可选，option支持两个参数，persistent属性和interval属性：
interval属性用于指定每隔多少毫秒监听一次文件的是否发生了改变，以及发生了什么改变，默认为（毫秒） persistent属性，用于指定了，当指定了被监视的文件后，是否停止当前正在运行的应用程序，默认为true3:listener：必须，被监听文件发生改变时调用的回调函数
回调函数传入两个参数callback(curr,prev),它们都是fs.Stats的实例，关于该实例的详细介绍，请参考前篇文章，curr表示修改之后的的信息对象，prev表示本次修改之前的信息对象。
下面看下，一个示例：
运行上述代码，然后在与你.js的文件的同目录下，进行操作，创建message.txt，修改，删除等操作，来查看控制台的显示。这只是一个简单的演示，如果需要其他的数据，那么就可以查看curr和prev中，能携带的数据，然后根据不同的数据，完成不同的操作。也就自己实现一些插件的功能。
当然，也可以通过设置option的属性值，使用不同的配置来监听对应的文件，这里关于配置新的示例，就不再占用篇幅了，有兴趣的可以自己测试一下。
watchFile的源码实现
看完了示例，接下来就是源码了，只有了解了最根本的源码实现，才能更好更高效的使用对应的API，请认真看源码中的注释：
注：在前面的源码解释中，出现了几个概念，我认为是有必要在这里补充一下的，因为如果对这几个概念的了解不深刻，那么久可能不理解为什么会这么写，或者意识不到，必须这么写才能保证代码正确的执行的。
1:只继承实例内部属性和方法，涉及代码：EventEmitter.call(this);
2:原型链的断链概念，涉及代码：util.inherits(StatWatcher, EventEmitter);
上述两个概念的一些相关内容，请参考：对象继承的方法小结，原型链断链的原因，浅析赋值表达式?JS基础核心之一。
3:nodejs中的event模块，也就是EventEmitter构造函数的相关信息：nodejs核心模块?events。
4:util模块，也就是util.inherits所在的模块，nodejs核心模块?util。关于watchFile的源码，到这也就结束了，接下来，看unwatchFile的方法，用于解除对某个文件的监听。
fs.unwatchFile方法
该方法是用于解除一个文件的监听事件，其使用方法为
其中：
1:filename：必须，需要被监听的文件的完整路径以及文件名
3:listener：可选，被监听文件发生改变时调用的回调函数
回调函数传入两个参数callback(curr,prev),它们都是fs.Stats的实例，关于该实例的详细介绍，请参考前篇文章，curr表示修改之后的的信息对象，prev表示本次修改之前的信息对象。
这里不在给出示例了，其实unwatchFile就相当于我们常用的off事件（jQuery），所以，这里也有个相同的问题，那就是，如果您不指定listenter的话，那么会把之前绑定的所有的watchFile的回调函数，都去除掉的，再者，匿名函数，是无法单独解除绑定的，所以请注意。
fs.unwatchFile源码
unwatchFile的实现原理是比较简单的，所以，这里就不过多的说明，细节部分，请查看源码中的注释。
看到这里，想必您也会想到一个问题吧，如果我要监听的文件很多，不是要给所有的文件都绑定这个事件，而只要其中一个文件出现了问题，就会导致整个程序崩溃，这样的话，维护成本也太高了吧？
所以说呢，Nodejs的开发者们，也不会做这么为难自己的事情不是，它们提供了一个监听目录的方法，即fs.watch方法。接下来，就看下这个惊人的watch的方法，是如何使用以及实现的吧。
fs.watch方法
该方法是用于监听指定文件或者目录是否修改的方法，其使用方法为：
其中：
1:filename：必须，需要被监听的文件的完整路径的目录或者文件名
2:option：可选，option支持两个参数，persistent属性和recursive属性：
recursive属性用于没有找到它具体完成的是哪个功能，是在源码中看到有设置该属性的，默认值为false，在中文文档：Node.js API 中文版，也没有找到对应的解释，估计只有去翻看C++的源码，才能了解到这些了吧。 persistent属性，用于指定了，当指定了被监视的文件后，是否停止当前正在运行的应用程序，默认为true3:listener：必须，被监听文件发生改变时调用的回调函数
回调函数传入两个参数callback(event,filename),其中event取值为“rename”（目录下有文件被重命名）和“change”（目录下有文件内容被更改）。
看下一个示例：
这个示例，不知道您是否会运行一下，我这里测试本地的，发现一个问题，就是不管在什么时候，event的值都是rename，根本就没有change的时候，这也可以说明一个问题，确实如Node.js API 中文版中所说的一样，这几种方法，确实是不稳定的，所以，还是谨慎使用，当然，我们还是要看下源码中的实现的，因为这是在学习～
fs.watch源码
watch方法的源码中的逻辑，和watchFile方法的源码逻辑基本相同，只是继承的构造函数不同而已。下面就看下源码的实现吧。
到这里，基本上，监听目录和文件相关的API就说完来，这里继续一些补充信息，是之前并没有说到的，首先，watchFile方法的关闭，以及再次绑定事件等，看下面的示例吧。
因为在watch和watchFile使用时，都是返回的它们使用的构造函数的实例，所以，我们自己也可以根据这个实例，进行一些扩展，而且，这个实例，是包含整个event模块的所有的方法的，所以，可以直接绑定一些自定义事件，甚至直接触发一些自定义事件，比如，再看下面的代码：
基本上，这个实例，就是一个EventEmitter的实例。OK，这个说到这里，就基本上结束了。
总结
注：本文将到的watchFile，watch等方法，都是属于不稳定的方法，在有些平台下，或者一些系统的设置下，可能出现获取不到准确值的情况，所以谨慎使用，这个如果可以，应该去花点时间，研究下grunt中，是如何监听文件变化的，进而补充本文中没有实现的一些功能（不稳定）。
关于Nodejs的fs模块的内容，到这里就结束了，接下来就是TCP和UDP的数据通信相关的内容了，也是创建服务器的相关内容，本模块的周期过长，中间工作有点招架不住，一直没有调节好，一直处于比较疲惫的状态下，中间的间隔竟然达到三个月之久，希望以后不会再这样来。
标签: nodejs 文档
本文链接地址:https://www.jiuchutong.com/biancheng/374130.html 转载请保留说明！
