详解nodejs 文本操作模块(3)

回调函数传入两个参数callback(curr,prev),它们都是fs.Stats的实例,关于该实例的详细介绍,请参考前篇文章,curr表示修改之后的的信息对象,prev表示本次修改之前的信息对象。

这里不在给出示例了,其实unwatchFile就相当于我们常用的off事件(jQuery),所以,这里也有个相同的问题,那就是,如果您不指定listenter的话,那么会把之前绑定的所有的watchFile的回调函数,都去除掉的,再者,匿名函数,是无法单独解除绑定的,所以请注意。

fs.unwatchFile源码

unwatchFile的实现原理是比较简单的,所以,这里就不过多的说明,细节部分,请查看源码中的注释。

fs.unwatchFile = function(filename, listener) { //判断filename是否合法,不合法,则抛出异常 nullCheck(filename); // 把filename转换成绝对地址 filename = pathModule.resolve(filename); // 判断需要解除绑定文件,是否有缓存StatWatchers的实例, // 如果没有,则表示,没有绑定过监听事件,则不需要去解除绑定 if (!inStatWatchers(filename)) return; var stat = statWatchers[filename]; // 依然觉得,上两行代码,是可以优化一下的,如下: // var stat = inStatWatchers(filename); //if(!stat){return "";} //依然是两行代码,可是却少了一次作用链的查找,和遍历对象的取值 // 判断,第二个参数,是否为一个function,如果是,则移除该function的回调 // 否则,移除该文件所有的监听回调函数 if (util.isFunction(listener)) { stat.removeListener('change', listener); } else { stat.removeAllListeners('change'); } // 判断该文件,是否还有监听的回调函数,如果没有了,则清除 // listenerCount方法,是继承自EventEmitter的原型链中的方法ßßß if (EventEmitter.listenerCount(stat, 'change') === 0) { stat.stop(); statWatchers[filename] = undefined; } };

看到这里,想必您也会想到一个问题吧,如果我要监听的文件很多,不是要给所有的文件都绑定这个事件,而只要其中一个文件出现了问题,就会导致整个程序崩溃,这样的话,维护成本也太高了吧?

所以说呢,Nodejs的开发者们,也不会做这么为难自己的事情不是,它们提供了一个监听目录的方法,即fs.watch方法。接下来,就看下这个惊人的watch的方法,是如何使用以及实现的吧。

fs.watch方法

该方法是用于监听指定文件或者目录是否修改的方法,其使用方法为:

fs.watch(filename,[option],listener);

其中:

1:filename:必须,需要被监听的文件的完整路径的目录或者文件名

2:option:可选,option支持两个参数,persistent属性和recursive属性:

recursive属性用于没有找到它具体完成的是哪个功能,是在源码中看到有设置该属性的,默认值为false,在中文文档:Node.js API 中文版,也没有找到对应的解释,估计只有去翻看C++的源码,才能了解到这些了吧。

persistent属性,用于指定了,当指定了被监视的文件后,是否停止当前正在运行的应用程序,默认为true

3:listener:必须,被监听文件发生改变时调用的回调函数

回调函数传入两个参数callback(event,filename),其中event取值为“rename”(目录下有文件被重命名)和“change”(目录下有文件内容被更改)。

看下一个示例:

var fs = require("fs"); var f = fs.watch("./",function(event,filename){ console.log("event="+event); console.log("filename="+filename); });

这个示例,不知道您是否会运行一下,我这里测试本地的,发现一个问题,就是不管在什么时候,event的值都是rename,根本就没有change的时候,这也可以说明一个问题,确实如Node.js API 中文版中所说的一样,这几种方法,确实是不稳定的,所以,还是谨慎使用,当然,我们还是要看下源码中的实现的,因为这是在学习~

fs.watch源码

watch方法的源码中的逻辑,和watchFile方法的源码逻辑基本相同,只是继承的构造函数不同而已。下面就看下源码的实现吧。

// watch方法使用到的构造函数 function FSWatcher() { // 继承事件模块中的实例内部属性和方法 EventEmitter.call(this); // 缓存this对象,在闭包的回调函数中使用 var self = this; // 获取C++中实现的FSEvent构造函数, // 该获取是否应该放到函数外部去,优化代码 // 就像在StatWatcher构造函数内部的binding.StatWatcher();方法 var FSEvent = process.binding('fs_event_wrap').FSEvent; this._handle = new FSEvent(); this._handle.owner = this; //绑定回调,onchange事件 this._handle.onchange = function(status, event, filename) { // event变了好像是有问题的,我本地测试,event的值一直是“rename” // 根据status的值,作出不同的处理 if (status < 0) { self._handle.close(); self.emit('error', errnoException(status, 'watch')); } else { self.emit('change', event, filename); } }; } // FSWatcher的原型链继承EventEmitter构造函数的原型链的属性和方法 util.inherits(FSWatcher, EventEmitter); // start方法,当初始化构造函数之后,要执行该方法,才能开始监听filename指向的目录或者文件 FSWatcher.prototype.start = function(filename, persistent, recursive) { nullCheck(filename); //调用C++中实现的方法,开始执行监听动作 var err = this._handle.start(pathModule._makeLong(filename), persistent, recursive); // 如果监听时,没有能正确的执行,则关闭该实例,并且抛出一个异常 if (err) { this._handle.close(); throw errnoException(err, 'watch'); } }; // 关闭监听 FSWatcher.prototype.close = function() { this._handle.close(); }; fs.watch = function(filename) { // 判断filename是否合法 nullCheck(filename); var watcher; var options; var listener; // 判断是否有参数 // 初始化参数和回调函数 if (util.isObject(arguments[1])) { options = arguments[1]; listener = arguments[2]; } else { options = {}; listener = arguments[1]; } // 给persistent和recursive设置默认值,这里我依然觉得是可以优化的。 // 既然在后面只是使用persistent和recursive,那么为何不定义着凉变量 // var persistent = options.persistent, // recursive = options.recursive; // if(util.isUndefined(persistent)) persistent = true; // if(util.isUndefined(recursive)) recursive = false; // ... // watcher.start(filename,persistent,recursive); // 我会认为,去一个对象中查找变量,比直接查找到一个变量,要花费多一点点的时间。 if (util.isUndefined(options.persistent)) options.persistent = true; if (util.isUndefined(options.recursive)) options.recursive = false; // 创建FSWatcher的实例,并执行实例中的start方法,开始监听filename的更新事件 watcher = new FSWatcher(); watcher.start(filename, options.persistent, options.recursive); // 如果有回调函数,则添加一个绑定事件,并设置它的回调函数 if (listener) { watcher.addListener('change', listener); } // 返回该实例 return watcher; };

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wwjsgg.html