Node.js - File System

Posted 2021-04-25 Electron

Node对标准POSIX函数进行了简单的封装从而实现文件I/O。可以使用以下语法

导入Node文件系统(fs)模块

var fs = require("fs")

---

同步与异步

fs模块中的每个方法都有同步和异步形式。异步方法以最后一个参数作为完成函数回调，以回调函数的第一个参数作为错误。最好使用异步方法，而不是同步方法，因为前者在执行过程中不会阻塞程序，而后者会阻塞。

举例：

使用下列内容创建一个名为input.txt

Tutorials Point is giving self learning content

to teach the world in simple and easy way!!!!!

 

让我们用下面的代码创建一个名为 main.js 的文件

 

var fs =require("fs");

 

//Asynchronous read

fs.readFile('input.txt',function(err, data){

   if(err){

      return console.error(err);

   }

   console.log("Asynchronousread: "+ data.toString());

});

 

//Synchronous read

var data = fs.readFileSync('input.txt');

console.log("Synchronous read: "+ data.toString());

 

console.log("Program Ended");

现在我们运行main.js来看下结果

$ node main.js

验证输出。

Synchronous read: Tutorials Point is giving self learning content

to teach the world in simple and easy way!!!!!

 

Program Ended

Asynchronous read: Tutorials Point is giving self learning content

to teach the world in simple and easy way!!!!!

 

 

---

本章接下来的段落提供了一组示例关于文件I/O主要方法的使用。

 

打开一个文件

语法

下面是在异步模式下打开文件的方法的语法

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

 

 参数

下面是使用的参数的描述

•   Path −这是字符串文件名称包括路径。

·       Flags—Flags显示文件的行为被打开。下面已经提到了所有可能的值。

·       mode −它设置了文件模式(权限和粘性位)，但只有在文件创建时才设置。它默认为0666，可读和可写。

·       callback −这是得到两个参数(err, fd)的回调函数。

Flags

读/写操作

Flag	Description
r	打开文件阅读。如果文件不存在，则发生异常。
r+	打开文件进行读写。如果文件不存在，则发生异常。
rs	打开文件以同步模式读取。
rs+	打开文件进行读写，请求操作系统同步打开。请参阅有关谨慎使用此功能的“rs”注释。
w	打开文件进行写作。创建文件(如果不存在)或截断文件(如果存在)。
wx	比如“w”，但如果路径存在，就会失败。
w+	打开文件进行读写。创建文件(如果不存在)或截断文件(如果存在)。
wx+	和“w+”一样，但如果路径存在，则失败。
a	打开文件以追加。如果文件不存在，则创建该文件。
ax	就像“a”，但是如果路径存在就会失败。
a+	打开文件以阅读和附加。如果文件不存在，则创建该文件。
ax+	例如“a+”，但如果路径存在，就会失败。

 

 

举例

让我们创建一个名为main.js文件,用以下代码来打开input.txt文件进行读写。

var fs =require("fs");

 

//Asynchronous - Opening File

console.log("Going to open file!");

fs.open('input.txt','r+',function(err, fd){

   if(err){

      return console.error(err);

   }

  console.log("Fileopened successfully!");    

});

现在运行main.js看看结果

$ node main.js

验证输出。

Going to open file!

File opened successfully!

 

 

获取文件信息

语法

下面是获取文件信息的方法的“语法”

fs.stat(path, callback)

 

参数

下面是使用的参数的描述

·       path −这是包含路径的文件名的字符串。

·       callback −这个回调函数获取两个参数(err, stats)， stats是fs. Stats类型的对象。，在下面的示例中打印。

除了下面示例中打印的重要属性外，还有一些有用的方法可以用来检查文件类型的 fs.Stats类。下表给出了这些方法。

Method	Description
stats.isFile()	Returns true if file type of a simple  file.
stats.isDirectory()	Returns true if file type of a  directory.
stats.isBlockDevice()	Returns true if file type of a block  device.
stats.isCharacterDevice()	Returns true if file type of a  character device.
stats.isSymbolicLink()	Returns true if file type of a  symbolic link.
stats.isFIFO()	Returns true if file type of a FIFO.
stats.isSocket()	Returns true if file type of asocket.

 

 

举例

让我们用下面的代码创建一个名为main.js的js文件

var fs =require("fs");

 

console.log("Going to get file info!");

fs.stat('input.txt',function(err, stats){

   if(err){

       return console.error(err);

   }

   console.log(stats);

   console.log("Got fileinfo successfully!");

  

   // Check file type

   console.log("isFile ?"+ stats.isFile());

   console.log("isDirectory? "+ stats.isDirectory());   

});

现在运行main.js来看下结果

$ node main.js

验证输出

Going to get file info!

{

   dev: 1792,

   mode: 33188,

   nlink: 1,

   uid: 48,

   gid: 48,

   rdev: 0,

   blksize: 4096,

   ino: 4318127,

   size: 97,

   blocks: 8,

   atime: Sun Mar 22 2015 13:40:00GMT-0500 (CDT),

   mtime: Sun Mar 22 2015 13:40:57GMT-0500 (CDT),

   ctime: Sun Mar 22 2015 13:40:57GMT-0500 (CDT)

}

Got file info successfully!

isFile ? true

isDirectory ? false

 

 

写入文件

语法

下面是写入文件的方法之一的语法

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

如果文件已经存在，此方法将重写该文件。如果您想要写入一个现有的文件，那么您应该使用另一个可用的方法。

 

 

 

参数

下面是使用的参数的描述

·       path −这是包含路径的文件名的字符串。

·       data −这是要写入文件的字符串或缓冲区。

·       options −第三个参数是一个对象，它将保存{编码、模式、标志}。默认情况下。编码为utf8，模式为八进制值0666。标志是w

·       callback −这是一个回调函数，它获取一个参数err，在出现写入错误时返回一个错误。

 

举例

让我们用以下代码创建一个名为main.js的js文件

var fs =require("fs");

 

console.log("Going to write into existing file");

fs.writeFile('input.txt','Simply Easy Learning!',  function(err){

   if(err){

      return console.error(err);

   }

  

   console.log("Datawritten successfully!");

   console.log("Let's readnewly written data");

   fs.readFile('input.txt',function(err, data){

      if(err){

         return console.error(err);

      }

      console.log("Asynchronousread: "+ data.toString());

   });

});

现在我们运行main.js来看结果

$ node main.js

验证输出

Going to write into existing file

Data written successfully!

Let's read newly written data

Asynchronous read: Simply Easy Learning!

 

 

读取文件

语法

下面是要从文件中读取的方法之一的语法

 

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

 

此方法将使用文件描述符读取文件。如果您想直接使用文件名读取文件，那么您应该使用另一个可用的方法。

 

参数

下面是使用的参数的描述

·       fd −这是fs.open()返回的文件描述符。

·       buffer −这是将数据写入的缓冲区。

·       offset −这是缓冲区中开始写入的偏移量。

·       length −这是一个指定要读取的字节数的整数。

·       position −这是一个整数，指定从哪里开始在文件中读取。如果位置为空，将从当前文件位置读取数据。

·       callback −这个回调函数获取三个参数(err、bytesRead、buffer)。

 

 

举例

让我们用以下代码创建一个名为main.js的js文件

 

var fs =require("fs");

var buf =newBuffer(1024);

 

console.log("Going to open an existing file");

fs.open('input.txt','r+',function(err, fd){

   if(err){

      return console.error(err);

   }

   console.log("Fileopened successfully!");

   console.log("Going toread the file");

   fs.read(fd, buf,0, buf.length,0,function(err, bytes){

      if(err){

         console.log(err);

      }

      console.log(bytes +" bytes read");

     

      // Print only read bytes to avoid junk.

      if(bytes >0){

         console.log(buf.slice(0, bytes).toString());

      }

   });

});

现在运行main.js看下结果

$ node main.js

检查输出

Going to open an existing file

File opened successfully!

Going to read the file

97 bytes read

Tutorials Point is giving self learning content

to teach the world in simple and easy way!!!!!

 

 

关闭文件

语法

下面是关闭打开的文件的语法

 

fs.close(fd, callback)

参数

下面是使用的参数的描述

·       fd −这是文件fs.open()方法返回的文件描述符。

·       callback −这是回调函数，除了一个可能的异常之外，没有其他参数被赋给完成回调。

举例

用以下代码创建文件

var fs =require("fs");

var buf =newBuffer(1024);

 

console.log("Going to open an existing file");

fs.open('input.txt','r+',function(err, fd){

   if(err){

      return console.error(err);

   }

   console.log("Fileopened successfully!");

   console.log("Going toread the file");

  

   fs.read(fd, buf,0, buf.length,0,function(err, bytes){

      if(err){

         console.log(err);

      }

 

      // Print only read bytes to avoid junk.

      if(bytes >0){

         console.log(buf.slice(0, bytes).toString());

      }

 

      // Close the opened file.

      fs.close(fd,function(err){

         if(err){

            console.log(err);

         }

         console.log("Fileclosed successfully.");

      });

   });

});

现在运行main.js看下结果

 

$ node main.js

检查输出

 

Going to open an existing file

File opened successfully!

Going to read the file

Tutorials Point is giving self learning content

to teach the world in simple and easy way!!!!!

 

File closed successfully.

 

 

截断文件

语法

下面是截断打开的文件的方法的语法

 

fs.ftruncate(fd, len, callback)

参数

下面是使用的参数的描述

·       fd −这是fs.open()返回的文件描述符。

·       len −这是文件的长度，在此之后文件将被截断。

·       callback −这是回调函数，除了一个可能的异常之外，没有其他参数被赋给完成回调。

 

举例

让我们用以下代码创建一个名为main.js的js文件

var fs =require("fs");

var buf =newBuffer(1024);

 

console.log("Going to open an existing file");

fs.open('input.txt','r+',function(err, fd){

   if(err){

      return console.error(err);

   }

   console.log("Fileopened successfully!");

   console.log("Going totruncate the file after 10 bytes");

  

   // Truncate the opened file.

   fs.ftruncate(fd,10,function(err){

      if(err){

         console.log(err);

      }

      console.log("Filetruncated successfully.");

      console.log("Going toread the same file");

     

      fs.read(fd, buf,0, buf.length,0,function(err, bytes){

         if(err){

            console.log(err);

         }

 

         // Print only read bytes to avoid junk.

         if(bytes >0){

            console.log(buf.slice(0, bytes).toString());

         }

 

         // Close the opened file.

         fs.close(fd,function(err){

            if(err){

               console.log(err);

            }

            console.log("Fileclosed successfully.");

         });

      });

   });

});

现在运行main.js看下结果

 

$ node main.js

检查输出

 

Going to open an existing file

File opened successfully!

Going to truncate the file after 10 bytes

File truncated successfully.

Going to read the same file

Tutorials

File closed successfully.

 

 

全部删除

语法

下面是删除文件的方法的语法

fs.unlink(path, callback)

 

参数

下面是使用的参数的描述

·       path −这是包含路径的文件名。

·       callback −这是回调函数，除了一个可能的异常之外，没有其他参数被赋给完成回调。

 

举例

让我们用以下代码创建一个名为main.js的js文件

 

var fs =require("fs");

 

console.log("Going to delete an existing file");

fs.unlink('input.txt',function(err){

   if(err){

      return console.error(err);

   }

   console.log("Filedeleted successfully!");

});

 

现在运行main.js看下结果

 

$ node main.js

检查输出

 

Going to delete an existing file

File deleted successfully!

 

 

创建一个目录

语法

下面是创建目录的方法的语法

 

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

Parameters

参数

下面是使用的参数的描述

·       path −这是包含路径的目录名。

·       mode −这是要设置的目录权限。默认为0777。

·       callback −这是回调函数，除了一个可能的异常之外，没有其他参数被赋给完成回调。

·        

举例

让我们用以下代码创建一个名为main.js的js文件

 

var fs =require("fs");

 

console.log("Going to create directory /tmp/test");

fs.mkdir('/tmp/test',function(err){

   if(err){

      return console.error(err);

   }

   console.log("Directorycreated successfully!");

});

现在运行main.js看下结果

 

$ node main.js

检查输出

 

Going to create directory /tmp/test

Directory created successfully!

 

读取目录

语法

下面是读取目录的方法的语法

 

fs.readdir(path, callback)

参数

下面是使用的参数的描述

·       path −这是包含路径的目录名。

·       callback −这是一个回调函数，它获取两个参数(err，文件)，其中文件是不包括'的目录中文件名称的数组。”和“. .”。

举例

让我们用以下代码创建一个名为main.js的js文件

 

 

var fs =require("fs");

 

console.log("Going to read directory /tmp");

fs.readdir("/tmp/",function(err, files){

   if(err){

      return console.error(err);

   }

   files.forEach(function(file){

      console.log( file );

   });

});

现在运行main.js看下结果

 

$ node main.js

检查输出

Going to read directory /tmp

ccmzx99o.out

ccyCSbkF.out

employee.ser

hsperfdata_apache

test

test.txt

 

 

 

删除目录

语法

下面是删除目录的方法的语法

 

fs.rmdir(path, callback)

参数

下面是使用的参数的描述

   ·       path −这是包含路径的目录名。

• callback −这是一个没有参数的回调函数，除非发生了异常会传递给这个回调函数

 

举例

让我们用以下代码创建一个名为main.js的js文件

 

var fs =require("fs");

 

console.log("Going to delete directory /tmp/test");

fs.rmdir("/tmp/test",function(err){

   if(err){

      return console.error(err);

   }

   console.log("Going toread directory /tmp");

  

   fs.readdir("/tmp/",function(err, files){

      if(err){

         return console.error(err);

      }

      files.forEach(function(file){

         console.log( file );

      });

   });

});

现在运行main.js看下结果

 

$ node main.js

检查输出

Going to read directory /tmp

ccmzx99o.out

ccyCSbkF.out

employee.ser

hsperfdata_apache

test.txt

 

有关详细信息，请参阅官方文档。

声明：微信公号转载翻译此文，是出于传递更多信息之目的。若文章、图片等来源标注错误或侵犯了您的合法权益，欢迎留言，我们将及时更正、删除。