详解nodejs 文本操作模块-fs模块(五)
fs模块是一个比较庞大的模块,在前面也介绍了该模块中最核心的一点东西,虽然核心的这点东西,在整个fs模块中占据的比例比较小,但是如果只是我们平常使用的话,基本已经够用了,其他的一些方法,属于能力提升时需要学习的的内容了,所以在后面就不再继续了,本篇属于fs模块中的最后一篇,也不是把fs模块中的其他API都给一一列举出来,这里再说最后一个我看来很重要的方法,监听文件或者目录的的方法watchFile。
概总
这里之所以在最后把这个watchFile方法写入到这里,是因为在前端的一个流行的构建工具grunt中,有一个grunt-contrib-watch模块,可以用于监听整个项目中,文件是否有变化,不知道有没有人去看过该部分的源码,是如何实现这个模块的呢?(我是还没有去看过,基础学习完成之后,再去研究下)
所以,这里提前看下,fs模块中的watchFile是如何实现的,等以后去看grunt中的watch模块时,就可以更得心应手了,所以,想法和我相同的朋友们,就继续看下去吧。。
fs.watchFile方法
该方法是用于监听指定文件的一个方法,其使用方法为
fs.watchFile(filename,[option],listener);
其中:
1:filename:必须,需要被监听的文件的完整的路径以及文件名
2:option:可选,option支持两个参数,persistent属性和interval属性:
- interval属性用于指定每隔多少毫秒监听一次文件的是否发生了改变,以及发生了什么改变,默认为5007(毫秒)
- persistent属性,用于指定了,当指定了被监视的文件后,是否停止当前正在运行的应用程序,默认为true
3:listener:必须,被监听文件发生改变时调用的回调函数
回调函数传入两个参数callback(curr,prev),它们都是fs.Stats的实例,关于该实例的详细介绍,请参考前篇文章,curr表示修改之后的的信息对象,prev表示本次修改之前的信息对象。
狼蚁网站SEO优化看下,一个示例:
var fs = require("fs"); fs.watchFile("./message.txt",function(curr,prev){ if(Date.parse(prev.ctime) == 0){ console.log("message.txt被创建"); }else if(Date.parse(curr.ctime) == 0){ console.log("message.txt被删除"); }else if(Date.parse(prev.mtime) != Date.parse(curr.mtime)){ console.log("message.txt被修改"); } });
运行上述代码,然后在与你.js的文件的同目录下,进行操作,创建message.txt,修改,删除等操作,来查看控制台的显示。这只是一个简单的演示,如果需要其他的数据,那么就可以查看curr和prev中,能携带的数据,然后根据不同的数据,完成不同的操作。也就自己实现一些插件的功能。
当然,也可以通过设置option的属性值,使用不同的配置来监听对应的文件,这里关于配置新的示例,就不再占用篇幅了,有兴趣的可以自己测试一下。
watchFile的源码实现
看完了示例,接下来就是源码了,只有了解了最根本的源码实现,才能更好更高效的使用对应的API,请认真看源码中的注释:
// Stat Change Watchers // StatWatcher构造函数定义 function StatWatcher() { //把EventEmitter内部的实例化属性添加到this对象上去。 //而EventEmitter的原型链属性和方法,不会被添加到this对象 //所以,基本上,也就是把EventEmitter实例中的domain,_events,_maxListeners这三个属性 //添加到了this对象上去了。 EventEmitter.call(this); //把this缓存到self变量中,便于狼蚁网站SEO优化的闭包回调使用该创建闭包时的this对象 var self = this; //调用C++实现的StatWatcher构造函数,并把返回的对象,赋值到this对象的_handle属性上 this._handle = new binding.StatWatcher(); // uv_fs_poll is a little more powerful than ev_stat but we curb it for // the sake of backwards compatibility var oldStatus = -1; //当C++中实现的StatWatcher实例化后的对象,定义它的onchange事件。 // 我测试过new binding.StatWatcher();实例化之后,是没有onchange属性的 // 所以,这里应该是属于直接定义改属性的,那么定义之后,在nodejs的C++代码实现中 // 是如何判断这个属性存在,然后在符合一定的条件下,又去执行这个属性的呢? // 这是我疑惑的地方,这个需要当学习到更多这方面的知识后,再去了解一下。 // 经过我的测试,这个属性,是在实例的start执行时需要的,如果没有定义该属性 // 那么,在使用start方法,开始监听事件时,会被抛出异常的 // 抛出异常,是因为你监听的文件,当前不存在~~ // 如果监听的文件,当前已经存在,则不会执行onchange的回调 this._handle.onchange = function(current, previous, newStatus) { // 当实例被话之后,当被监听的文件,被更改时,都会触发该属性的回调函数 // 并且传入三个参数 // 这里的三个判断,当前不知道为什么会在这个时候,不执行~~ if (oldStatus === -1 && newStatus === -1 && current.nlink === previous.nlink) return; oldStatus = newStatus; // 触发self对象的中的change事件,并且把current和previous对象, // 传入到change事件的回调函数 // 在本构造函数内部,是没有继承EventEmitter构造函数原型链中的方法的 // 但是这里,却使用了原型链中的emit方法。why? self.emit('change', current, previous); }; this._handle.onstop = function() { self.emit('stop'); }; } // 把EventEmitter原型链的属性和方法,扩展到StatWatcher对象的原型链中 // 更确切的说明就是,StatWatcher.prototype = EventEmitter.prototype; util.inherits(StatWatcher, EventEmitter); // 在StatWatcher重新定义来原型链之后,再执行其他的扩展,以防止原型链断链的情况 StatWatcher.prototype.start = function(filename, persistent, interval) { nullCheck(filename); this._handle.start(pathModule._makeLong(filename), persistent, interval); }; StatWatcher.prototype.stop = function() { this._handle.stop(); }; //缓存Watcher的一个对象 var statWatchers = {}; function inStatWatchers(filename) { //判断filename是否在statWatchers中,如果是则返回缓存的实例 return Object.prototype.hasOwnProperty.call(statWatchers, filename) && statWatchers[filename]; } fs.watchFile = function(filename) { //判断fileName是否合法 //如果不合法,则抛出一个异常然后停止执行 nullCheck(filename); //调用path模块的方法,返回文件的绝对路径 filename = pathModule.resolve(filename); var stat; var listener; //默认的配置信息,这里也说明来下,为何监听间隔为5007ms, //只是,我表示,我是没有看懂狼蚁网站SEO优化的英文注释要说啥的 var options = { // Poll interval in milliseconds. 5007 is what libev used to use. It's // a little on the slow side but let's stick with it for now to keep // behavioral changes to a minimum. interval: 5007, persistent: true }; //对参数进行判断,判断是否有自定义的option,如果有,使用自定义的 //没有定义的,使用默认值 //回调函数赋值 if (util.isObject(arguments[1])) { options = util._extend(options, arguments[1]); listener = arguments[2]; } else { listener = arguments[1]; } //回调函数是必须的,如果没有回调函数,则直接抛出一个异常,并停止运行 if (!listener) { throw new Error('watchFile requires a listener function'); } //看完上面的inStatWatchers的源码之后,觉得这里是否可以再次优化一次? //stat =inStatWatchers(filename); //if(!stat){ //stat = statWatchers[filename] = new StatWatcher(); //stat.start(filename,options.persistent,options.interval); /