浅谈Node.js：fs文件系统模块

fs文件系统模块，这是一个非常重要的模块，对文件的操作都基于它。该模块的所有方法都有同步和异步两种方式，下面便介绍一下该模块的使用。

1、检测当前进程对文件的权限

使用fs.access(path[,mode],callback)方法检查权限，mode参数是一个整数，有以下常量值：

• fs.constants.F_OK path对调用进程是可见的，既存在
• fs.constants.R_OK path是可读的
• fs.constants.W_OK path是可写的
• fs.constants.X_OK path是可执行的

使用如下所示：

{ console.log(err?'文件不存在':'文件已经存在'); });

同步版本，如果发生异常，则直接抛出异常，否则什么也不做。同步版本可以利用try..catch来做，适用所有方法，如下所示：

rush:js;"> try{ fs.accessSync('./note.txt',fs.constants.F_OK); }catch(ex){ console.log('文件不存在'); }

2、获取文件状态

使用fs.stat(path,callback)，fs.statSync(path)方法来获取指定path的状性，callback有(err,stats)两个参数，stats是fs.stats对象，具有以下属性：

rush:plain;"> { dev: 638212,mode: 33206,nlink: 1,uid: 0,gid: 0,rdev: 0,blksize: undefined,ino: 105553116266564850,size: 1094,blocks: undefined,atime: 2016-11-22T08:45:43.505Z,mtime: 2016-11-22T09:33:13.535Z,ctime: 2016-11-22T09:33:13.535Z,birthtime: 2016-11-22T08:45:43.505Z }

还有以下方法：

rush:js;"> stats.isFile() stats.isDirectory() stats.isBlockDevice() stats.isCharacterDevice() stats.isSymbolicLink() (only valid with fs.lstat()) stats.isFIFO() stats.isSocket()

使用如下所示：

{ if(err) throw err; console.log(stats); }); var stats = fs.statSync('../test.txt');//同步版本

3、文件追加

使用fs.appendFile(file,data[,options],callback)方法向file写入数据，如果file不存在，则创建file，data参数为字符串或buffer，options可选参数是对象或字符串，具有以下属性:

• encoding | default = 'utf8' 编码
• mode default = 0o666 打开模式
• flag default = 'a'

使用如下所示：

{ if(err) throw err; console.log('写入成功'); }); //appendFile同步版本，返回值为undefined fs.appendFileSync('./test.txt','hello nodejs!\r\n');

4、文件读取和写入

文件读取使用fs.readFile(file[,callback)方法，参数含义如下：

• file 文件名或文件描述符
• options 对象或字符串，如果是对象，则包含encoding和flag，前者默认为null，后者为'r'
• callback 参数为(err,data)

如果指定的文件不存在，则直接抛出错误。使用如下所示：

{ if(err) throw err; console.log(data); }); var data = fs.readFileSync('../test4.txt',flag:'r'});

文件写入数据，使用fs.writeFile(file,callback)方法，参数含义如下：

• file 文件名或文件描述符
• data 字符串或buffer
• options 对象或字符串，如果是对象，则包含encoding、mode以及flag，依次默认为utf8，0o666，'w'
• callback 参数err

如果指定的文件不存在，则创建该文件，相反则替换原来的文件。使用如下所示：

{ if(err) throw err; console.log('written ok.'); }); fs.writeFileSync('./test1.txt',{flag:'w'});

我们也可以利用fs的open，read，write，stat等方法来实现文件的读取和写入。

fs.open(path,flags[,callback)方法打开一个文件获取句柄，flags参数有以下这些：

• 'r' - 以只读方式打开文件，若文件不存在则报错。
• 'r+' - 以读写方式打开文件，若文件不存在则报错。
• 'rs+' 在同步模式下，以读写方式打开文件
• 'w' - 以写方式打开文件，若文件不存在则创建
• 'wx' - 以写方式打开文件，若文件不存在则抛出异常.
• 'w+' - 以读写方式打开文件，若文件不存在则创建，相反则清空文件.
• 'wx+' - 以读写方式打开文件，若文件不存在则抛出异常.
• 'a' - 以追加方式打开文件，若文件不存则创建文件
• 'ax' - 以追加方式打开文件，若文件不存则抛出异常.
• 'a+' - 以追加和读方式打开文件，若文件不存则创建文件
• 'ax+' - 以追加和读方式打开文件，若文件不存则失败

callback回调函数有(err,fd)两个参数。

fs.read(fd,buffer,offset,length,position,callback)方法，从一个文件中读取数据存入buffer中，参数含义如下：

• buffer Buffer对象，用来存储读取的数据
• offset buffer开始写的位置
• length 需要读取的长度
• position 指定从文件的哪个位置开始读取，若设置为null，则从文件当前位置开始读取
• callback 有三个参数(err,bytesRead,buffer) bytesRead为实际读取字节数
• fs.write(fd,length[,position],callback)方法，将buffer数据写如指定文件中，参数含义如下：
• offset和length指定buffer的部分
• position 指定文件的开始写入的文件，若不为数字则从文件当前位置开始写入

下面是一个使用open,write,read,stat方法实现的文件内容复制的函数，如下所示：

{ if(err) throw err; fs.read(fd,srcStat.size,null,buff)=>{ if(err) throw err; console.log('实际读取大小：'+bytesRead); fs.close(fd,()=>{}); fs.write(destFd,buff,written,buffer)=>{ if(err) throw err; console.log('已完成复制，向'+dest+'写入了'+written); fs.close(destFd,()=>{}); }); }); }); } copy('./app.js','./appbak.js');

执行结果如下：

E:\developmentdocument\nodejsdemo>node fs-examples.js 复制开始... ./app.js大小：1094 实际读取大小：1094 已完成复制，向./appbak.js写入了1094

5、文件重命名、删除

方法fs.rename(oldpath,newPath,callback)可以实现文件的重命名，还能实现文件的移动，如果oldpath与newPath在同一目录下，则是重命名，否则是移动文件并重命名，使用如下所示：

{ if(err) throw err; console.log('rename success.'); }); fs.renameSync('../test2.txt','../test4.txt');

文件删除需要用到fs.unlink(path,callback)方法，使用也很简单，如下所示：

{ if(err) throw err; console.log('delete file success.'); }); fs.unlinkSync('./dir/11.txt');

6、创建、读取、删除目录

创建目录使用的是fs.mkdir(path[,callback)方法，mode参数默认为0o777，但是该方法只能创建一级目录，否则抛出异常，如下所示：

{ if(err) throw err; console.log('mkdir success'); }); //mkdir的同步版本，返回值为undefined fs.mkdirsync('./test',0o777);

为了能够创建多级目录，可以自己定义一个函数来实现，需要用到path模块的dirname方法，如下所示：

rush:js;"> function isFileExists(filePath){ var bool = !0; try{ fs.accessSync(filePath,fs.F_OK); }catch(err){ bool = !1; } return bool; } function mkdirp(dirpath,mode,cb){ if(isFileExists(dirpath)){ cb(dirpath); }else{ mkdirp(path.dirname(dirpath),function(){ fs.mkdir(dirpath,cb); }); } }

扫描目录需要用到fs.readdir(path[,callback)方法，options参数为字符串或对象，callback回调函数有(err,files)两个参数，files是一个文件名数组，该方法也是只能扫描一级目录，使用如下所示：

{ if(err) throw err; console.log(files); });

如果要实现可以递归扫描目录，可以自己定义一个函数，如下所示：

{ scan(filepath+'/'+file); }); } scan(dirpath); return filesArr; }

删除目录使用fs.rmdir(path,callback)方法，只能删除一级目录且目录须为空，使用如下所示：

{ if(err) throw err; console.log('delete dir success.'); });

要实现类似rm -rf的递归删除效果，可以使用如下代码：

function scan(spath){
var files = fs.readdirSync(spath);
emptyFoldersArr.push(spath);
if(files.length>0){
files.forEach((file,arr)=>{
if(fs.statSync(spath+'/'+file).isDirectory()){
scan(spath+'/'+file);
}else{
return fs.unlinkSync(spath+'/'+file),!0;
}
});
}
}
scan(dirpath);
for(var l=emptyFoldersArr.length-1,i=l;i>=0;i--){
fs.rmdirsync(emptyFoldersArr[i]);
}
}

7、获取路径的绝对路径

使用fs.realpath(path[,callback)方法可以获取path的绝对路径，callback有(err,resolvedpath)两个参数，使用如下所示：

{ if(err) throw err; console.log(resolvePath); }); console.log(fs.realpathSync('./test.txt'));

执行结果如下所示：

E:\developmentdocument\nodejsdemo>node fs-examples.js E:\developmentdocument\nodejsdemo\test.txt

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持编程之家。