浅谈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是可执行的

使用如下所示:

fs.access('./note.txt',fs.constants.F_OK,(err)=>{
console.log(err?'文件不存在':'文件已经存在');
});

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

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对象,具有以下属性:

{ 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 }

还有以下方法:

stats.isFile()
 stats.isDirectory()
 stats.isBlockDevice()
 stats.isCharacterDevice()
 stats.isSymbolicLink() (only valid with fs.lstat())
 stats.isFIFO()
 stats.isSocket()

使用如下所示:

fs.stat('./app.js',(err,stats)=>{
  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'

使用如下所示:

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

4、文件读取和写入

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

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

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

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

文件写入数据,使用fs.writeFile(file, data[, options], callback)方法,参数含义如下:

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

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

var data = "hello node!";
fs.writeFile('./test1.txt',data,{flag:'w'},(err)=>{
if(err) throw err;
console.log('written ok.');
});
fs.writeFileSync('./test1.txt',data,{flag:'w'});

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

fs.open(path, flags[, mode], 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, buffer, offset, length[, position], callback)方法,将buffer数据写如指定文件中,参数含义如下:
  • offset和length指定buffer的部分
  • position 指定文件的开始写入的文件,若不为数字则从文件当前位置开始写入

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

function copy(src, dest) {
const destFd = fs.openSync(dest, 'w+'),
   srcStat = fs.statSync(src);
const buffer = new Buffer(srcStat.size);
console.log('复制开始...');
console.log(src+'大小:'+srcStat.size)
fs.open(src,'r',(err,fd)=>{
  if(err) throw err;
  fs.read(fd,buffer,0,srcStat.size,null,(err,bytesRead,buff)=>{
    if(err) throw err;
    console.log('实际读取大小:'+bytesRead);
    fs.close(fd,()=>{});
    fs.write(destFd,buff,0,bytesRead,null,(err, 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在同一目录下,则是重命名,否则是移动文件并重命名,使用如下所示:

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

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

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

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

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

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

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

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),mode,function(){
      fs.mkdir(dirpath,mode,cb);
    });
  }
}

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

fs.readdir('./',(err,files)=>{
  if(err) throw err;
  console.log(files);
});

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

function scandir(dirpath){
  var filesArr = {};
  if(!isFileExists(dirpath)) return !1;
  function scan(filepath){
    var statObj = fs.statSync(filepath);
    if(!statObj.isDirectory()) return filesArr.push(filepath);
    var files = fs.readdirSync(filepath);
    files.forEach((file,idx,arr)=>{
      scan(filepath+'/'+file);
    });
  }
  scan(dirpath);
  return filesArr;
}

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

fs.rmdir('./dir',(err)=>{
  if(err) throw err;
  console.log('delete dir success.');
});

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

function deldirs(dirpath){
  var stat = null,
    emptyFoldersArr = [];

  function scan(spath){
    var files = fs.readdirSync(spath);
    emptyFoldersArr.push(spath);
    if(files.length>0){
      files.forEach((file,idx,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[, options], callback)方法可以获取path的绝对路径,callback有(err, resolvedPath)两个参数,使用如下所示:

fs.realpath('./test.txt',(err,resolvePath)=>{
  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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

时间: 2016-12-05

详解nodejs 文本操作模块-fs模块(一)

JS的安全性问题,就决定了JS想要取操作数据库操作文件是不可实现的,而Nodejs作为服务端的JS,如果依然不能操作文件,那么又如何称之为服务端语言呢,所以在Nodejs中,提供了一个fs(File System)模块,以实现文件及目录的读写操作. 写在前面 Nodejs的一大优势就在于,支持异步调用,不管是在读取数据库,还是在读取文件时,都可以使用异步的方式进行处理,这样就可以处理高并发的情况,从本篇开始,开始对Nodejs的fs模块中,一些重要的API,结合源码,进行一些说明学习. fs模块

NodeJS学习笔记之FS文件模块

一,开篇分析 文件系统模块是一个简单包装的标准 POSIX 文件 I/O 操作方法集.可以通过调用 require("fs") 来获取该模块.文件系统模块中的所有方法均有异步和同步版本. (1),文件系统模块中的异步方法需要一个完成时的回调函数作为最后一个传入形参. (2),回调函数的构成由调用的异步方法所决定,通常情况下回调函数的第一个形参为返回的错误信息. (3),如果异步操作执行正确并返回,该错误形参则为null或者undefined.如果使用的是同步版本的操作方法,一旦出现错误

详解nodejs 文本操作模块-fs模块(二)

前一篇学习了文件的打开和关闭,文件操作总不能只包含打开和关闭吧,这里就开始文件的读写操作. fs模块方法 1:read和readSync方法 该方法,是从文件的指定位置处读取文件,一直读取到文件底部,然后江都区到的内容输出到一个缓存区,使用方法如下: fs.read(fd,buffer,offset,length,position,callback); 在read方法中,支持6个参数: fd参数,是文件描述符,是open方法的回调函数中获取到的,是一个数字. buffer,是一个buffer对象

详解nodejs 文本操作模块-fs模块(三)

下面继续nodejs的学习,在前两篇中,已经把文件操作的打开,关闭读写这两个最基本的功能进行了简单的说明,它们的强大之处,让我觉得知道这几种方法之后,基本上就可以随意的操作文件了,但是open,read,write等方法,需要操作的参数确实是有点多的,所以,基于让使用者更简单的完成读写操作,开发者们,继续给这些方法做了进一步的封装,也就是本文接下来将要说的readFile,和writeFile方法,当然也有他们的同步执行方法,只是篇幅有限,并且同步的方法和异步的方法,在内部实现和参数使用中,差别

详解nodejs 文本操作模块-fs模块(五)

fs模块是一个比较庞大的模块,在前面也介绍了该模块中最核心的一点东西,虽然核心的这点东西,在整个fs模块中占据的比例比较小,但是如果只是我们平常使用的话,基本已经够用了,其他的一些方法,属于能力提升时需要学习的的内容了,所以在后面就不再继续了,本篇属于fs模块中的最后一篇,也不是把fs模块中的其他API都给一一列举出来,这里再说最后一个我看来很重要的方法,监听文件或者目录的的方法watchFile. 概总 这里之所以在最后把这个watchFile方法写入到这里,是因为在前端的一个流行的构建工具g

详解nodejs 文本操作模块-fs模块(四)

在前文中,提到了一个概念,就是当我在读取文件时,我需要知道这个文件的数据量的大小,而在readFile的源码中,是使用的fa.fstat方法,获取到了文件的相关数据,而对于使用fstat获取到的一个对象中,所包含的属性和方法代表的具体含义,前文中并没有涉及,本篇就看下,这个State对象中,包含的数据都有哪些,并且他们分别代表的含义是什么. 方法集合 方法集合,不是说的State对象中包含的方法集合,而是说,在调用哪些API时,返回的值时一个State的实例,比如,在fstate就是其中之一.

详解Python文本操作相关模块

详解Python文本操作相关模块 linecache--通过使用缓存在内部尝试优化以达到高效从任何文件中读出任何行. 主要方法: linecache.getline(filename, lineno[, module_globals]):获取指定行的内容 linecache.clearcache():清除缓存 linecache.checkcache([filename]):检查缓存的有效性 dircache--定义了一个函数,使用缓存读取目录列表.使用目录的mtime来实现缓存失效.此外还定义

详解C语言用malloc函数申请二维动态数组的实例

详解C语言用malloc函数申请二维动态数组的实例 C语言在程序运行中动态的申请及释放内存十分方便,一维数组的申请及释放比较简单. Sample one #include <stdio.h> int main() { char * p=(char *)malloc(sizeof(char)*5);//申请包含5个字符型的数组 free(p); return 0; } 是否申请二维动态内存也如此简单呢?答案是否定的.申请二维数组有一下几种方法 Sample two /* 申请一个5行3列的字符型

详解nodeJs文件系统(fs)与流(stream)

一.简介 本文将介绍node.js文件系统(fs)和流(stream)的一些API已经参数使用情况. 二.目录 文件系统将介绍以下方法: 1.fs.readFile 2.fs.writeFile 3.fs.open 4.fs.read 5.fs.stat 6.fs.close 7.fs.mkdir 8.fs.rmdir 9.fs.readdir 10.fs.unlink stream流的四种类型readable,writable,duplex,transform以及stream对象的事件. 三.

详解python 3.6 安装json 模块(simplejson)

JSON 相关概念: 序列化(Serialization):将对象的状态信息转换为可以存储或可以通过网络传输的过程,传输的格式可以是JSON,XML等.反序列化就是从存储区域(JSON,XML)读取反序列化对象的状态,重新创建该对象. JSON(Java Script Object Notation):一种轻量级数据交互格式,相对于XML而言更简单,也易于阅读和编写,机器也方便解析和生成,Json是JavaScript中的一个子集. python2.6版本开始加入了JSON模块,python的j

详解nodeJS中读写文件方法的区别

导言:nodejs中所有与文件相关的操作都在fs模块中,而读写操作又是我们会经常用到的操作,nodejs的fs模块针对读操作为我们提供了readFile,read, createReadStream三个方法,针对写操作为我们提供了writeFile,write, createWriteStream三个方法,下面分析一下它们的区别: 一.readFile和writeFile 1.readFile方法是将要读取的文件内容完整读入缓存区,再从该缓存区中读取文件内容,具体操作如下: fs.readFil