这篇文章上次修改于 298 天前,可能其部分内容已经发生变化,如有疑问可询问作者。

Node.js文件系统

Node.js 提供一组类似 UNIX(POSIX)标准的文件操作API。使用前需先导入

var fs = require("fs")

Node.js 文件系统(fs 模块)模块中的方法均有异步和同步版本,例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。异步的方法函数最后一个参数为回调函数,回调函数的第一个参数包含了错误信息(error)。

建议使用异步方法,比起同步,异步方法性能更高,速度更快,而且没有阻塞。

打开文件

fs.open(path, flags[, mode], callback)

参数:

  • path --> 文件的路径。
  • flags --> 文件打开的行为。具体值详见下表。
  • mode --> 设置文件模式(权限),文件创建默认权限为 0666(可读,可写)。
  • callback --> 回调函数,带有两个参数如:callback(err, fd)。
Flag描述
r以读取模式打开文件。如果文件不存在抛出异常。
r+以读写模式打开文件。如果文件不存在抛出异常。
rs以同步的方式读取文件。
rs+以同步的方式读取和写入文件。
w以写入模式打开文件,如果文件不存在则创建。
wx类似 'w',但是如果文件路径存在,则文件写入失败。
w+以读写模式打开文件,如果文件不存在则创建。
wx+类似 'w+', 但是如果文件路径存在,则文件读写失败。
a以追加模式打开文件,如果文件不存在则创建。
ax类似 'a', 但是如果文件路径存在,则文件追加失败。
a+以读取追加模式打开文件,如果文件不存在则创建。
ax+类似 'a+', 但是如果文件路径存在,则文件读取追加失败。

eg:

var fs = require("fs");

// 异步打开文件
console.log("准备打开文件!");
fs.open('a.txt', 'rs+', function (err, data) {
  if (err) {
    return console.error(err);
  }
  console.log("文件打开成功!");
});

console.log('end');

输出:

准备打开文件!
end
文件打开成功!

获取文件信息

fs.stat(path, callback)

参数:

  • path --> 文件路径。
  • callback --> 回调函数,带有两个参数如:(err, stats), stats 是 fs.Stats 对象。

fs.stat(path)执行后,会将stats类的实例返回给其回调函数。可以通过stats类中的提供方法判断文件的相关属性。stats类中的方法有:

方法描述
stats.isFile()如果是文件返回 true,否则返回 false。
stats.isDirectory()如果是目录返回 true,否则返回 false。
stats.isBlockDevice()如果是块设备返回 true,否则返回 false。
stats.isCharacterDevice()如果是字符设备返回 true,否则返回 false。
stats.isSymbolicLink()如果是软链接返回 true,否则返回 false。
stats.isFIFO()如果是FIFO,返回true,否则返回 false。FIFO是UNIX中的一种特殊类型的命令管道。
stats.isSocket()如果是 Socket 返回 true,否则返回 false。

eg:

var fs = require("fs");

console.log("准备打开文件!");
fs.stat('a.txt', function (err, stats) {
   if (err) {
       return console.error(err);
   }
   console.log(stats);
   console.log("读取文件信息成功!");
   
   // 检测文件类型
   console.log("isFile ? " + stats.isFile());
   console.log("isDirectory ? " + stats.isDirectory());    
});

输出:

准备打开文件!
Stats {
  dev: 1118232202,
  mode: 33206,
  nlink: 1,
  uid: 0,
  gid: 0,
  rdev: 0,
  blksize: undefined,
  ino: 10696049115632380,
  size: 13,
  blocks: undefined,
  atimeMs: 1573357504420.027,
  mtimeMs: 1573394298816.11,
  ctimeMs: 1573394298816.11,
  birthtimeMs: 1573357504420.027,
  atime: 2019-11-10T03:45:04.420Z,
  mtime: 2019-11-10T13:58:18.816Z,
  ctime: 2019-11-10T13:58:18.816Z,
  birthtime: 2019-11-10T03:45:04.420Z }
读取文件信息成功!
isFile ? true
isDirectory ? false

文件写入

fs.writeFile(file, data[, options], callback)

writeFile 直接打开文件默认是 w 模式,所以如果文件存在,该方法写入的内容会覆盖旧的文件内容。

参数

参数使用说明如下:

  • file - 文件名或文件描述符。
  • data - 要写入文件的数据,可以是 String(字符串) 或 Buffer(缓冲) 对象。
  • options - 该参数是一个对象,包含 {encoding, mode, flag}。默认编码为 utf8, 模式为 0666 , flag 为 'w'
  • callback - 回调函数,回调函数只包含错误信息参数(err),在写入失败时返回。

eg:

var fs = require("fs");

fs.writeFile('a.txt', 'writed ???',  function(err) {
   if (err) {
       return console.error(err);
   }
   fs.readFile('a.txt', function (err, data) {
      if (err) {
         return console.error(err);
      }
      console.log("read: " + data.toString());
   });
});

ouput:

read: writed ???

读取文件

fs.read(fd, buffer, offset, length, position, callback)

该方法使用了文件描述符来读取文件。

参数

参数使用说明如下:

  • fd - 通过 fs.open() 方法返回的文件描述符。
  • buffer - 数据写入的缓冲区。
  • offset - 缓冲区写入的写入偏移量。
  • length - 要从文件中读取的字节数。
  • position - 文件读取的起始位置,如果 position 的值为 null,则会从当前文件指针的位置读取。
  • callback - 回调函数,有三个参数err, bytesRead, buffer,err 为错误信息, bytesRead 表示读取的字节数,buffer 为缓冲区对象。

eg:

var fs = require("fs");
var buf = new Buffer.alloc(1024);

fs.open('a.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
      if (err){
         console.log(err);
      }
      console.log(bytes + "  字节被读取");
      
      // 仅输出读取的字节
      if(bytes > 0){
         console.log(buf.slice(0, bytes).toString());
      }
   });
});

output:

10  字节被读取
writed ???

关闭文件

fs.close(fd,callback) 异步关闭文件

  1. fd:通过fs.open()方法返回的文件描述符
  2. callback:回调函数
var fs = require("fs");
fs.open('a.txt','r+',(err,fd) => {
    if(err){
        return console.error(err);
    }
    console.log('文件打开成功!');
    fs.close(fd,()=>{
        console.log('文件关闭成功!');
    })
}) 
console.log('code end');

// output
code end
文件打开成功!
文件关闭成功!

fs.closeSync(fd) 同步关闭文件

  1. fd:通过fs.open()方法返回的文件描述符
fs.open('a.txt','r+' ,(err,fd) => {
    if(err){
        return console.error(err);
    }
    console.log('文件打开成功!');
    fs.closeSync(fd);
    console.log('文件关闭成功!');
}) 
console.log('code end');

// output
code end
文件打开成功!
文件关闭成功!

截取文件

fs.ftruncate(fd,len,callback) 异步截取

  1. fd:通过fs.open()方法返回的文件描述符
  2. len:文件内容截取的长度
  3. callback:回调函数
var fs = require("fs");
fs.open('a.txt','r+',(err,fd) => {
  if(err){
      return console.error(err);
  }
  console.log('打开文件成功!');
  console.log('开始截取文件');
  fs.ftruncate(fd,10,() => {
      console.log('截取文件成功!');
      fs.close(fd,() =>{
          console.log('文件关闭成功!');
      })
  });
})

// output
打开文件成功!
开始截取文件
截取文件成功!
文件关闭成功!

删除文件

fs.unlink(path,callback);

  1. path:文件路径
  2. callback:回调函数
var fs = require("fs");
fs.writeFile('b.txt','2333333',(err)=> {
  if(err){
      return console.error(err);
  }
  console.log('写入文件成功!');
  fs.unlink('b.txt',()=>{
      console.log('删除b.txt成功');
  })
})

// output
写入文件成功!
删除b.txt成功

创建目录

fs.mkdir(path,[options],callback)

  1. path:文件路径
  2. options:

    1. recursive:是否以递归的方式创建目录,默认为false
    2. mode:设置目录权限,默认为0777
  3. callback:回调函数
fs.mkdir('/test1/test/app',{recursive:true},(err) => {
    if(err){
        return console.log(err);
    }
    console.log('test目录创建成功');
})

读取目录

fs.readdir(path,callback)

  1. path:文件路径
  2. callback:回调函数,回调函数带有两个参数,err,files,err为错误信息,files是目录下的文件数组列表
fs.readdir('test/',(err,files) => {
    if(err){
        return console.error(err);
    }
    console.log(files); //['test']
}) 

删除目录

fs.rmdir(path,callback)

  1. path:文件路径
  2. callback:回调函数
fs.rmdir('test/test/',(err) => {
    if(err){
        return err;
    }
    console.log('删除成功!');
})