Node.js学习笔记（十三、文件）

2021-11-09 15:00:57

在前面stteam流里其实已经搞过Node.js的文件读写，读写是目的，流是实现方式。

异步和同步

Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。

异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息(error)。

异步方法，相对而言，性能更高，速度更快，而且没有阻塞，使用的要多一些。

实例

创建input.txt，随便输点什么都行。

inCompare.js:

var fs = require("fs");
// 执行前创建一个空的 /test 目录
console.log("准备删除目录 ../test/temp");
fs.rmdir("../test/temp",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("读取 /tmp 目录");
   fs.readdir("../test/",function(err, files){
      if (err) {
          return console.error(err);
      }
      files.forEach( function (file){
          console.log( file );
      });
   });
});

执行：

Node.js学习笔记（十三、文件）

打开文件

语法：

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

参数：

参数使用说明如下：

path - 文件的路径。

flags - 文件打开的行为。具体值详见下文。

mode - 设置文件模式(权限)，文件创建默认权限为 0666(可读，可写)。

callback - 回调函数，带有两个参数如：callback(err, fd)。

flags 参数可以是以下值：

flag	描述
r	以读取模式打开文件。如果文件不存在抛出异常。
r+	以读写模式打开文件。如果文件不存在抛出异常。
rs	以同步的方式读取文件。
rs+	以同步的方式读取和写入文件。
w	以写入模式打开文件，如果文件不存在则创建。
wx	类似 ‘w’，但是如果文件路径存在，则文件写入失败。
w+	以读写模式打开文件，如果文件不存在则创建。
wx+	类似 ‘w+’，但是如果文件路径存在，则文件读写失败。
a	以追加模式打开文件，如果文件不存在则创建。
ax	类似 ‘a’，但是如果文件路径存在，则文件追加失败。
a+	以读取追加模式打开文件，如果文件不存在则创建。
ax+	类似 ‘a+’，但是如果文件路径存在，则文件读取追加失败。

实例：

fileInput.js，从input.txt中读取数据：

var fs = require("fs");

// 异步打开文件
console.log("准备打开文件！");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
  console.log("文件打开成功！");     
});

运行：

Node.js学习笔记（十三、文件）

获取文件信息

异步获取文件信息：

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。

实例：

fileStats.js，获取input.txt文件的相应信息：

var fs = require("fs");

console.log("准备打开文件！");
fs.stat('input.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());    
});

执行：

写入文件

语法：

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

参数：

file - 文件名或文件描述符。

data - 要写入文件的数据，可以是 String(字符串) 或 Buffer(缓冲) 对象。

options - 该参数是一个对象，包含 {encoding, mode, flag}。默认编码为 utf8, 模式为 0666 ， flag 为 ‘w’

callback - 回调函数，回调函数只包含错误信息参数(err)，在写入失败时返回。

实例：

fileOutput.js，向input.txt中写入数据：

var fs = require("fs");

console.log("准备写入文件");
fs.writeFile('input.txt', '我是通 过fs.writeFile 写入文件的内容',  function(err) {
   if (err) {
       return console.error(err);
   }
   console.log("数据写入成功！");
   console.log("--------我是分割线-------------")
   console.log("读取写入的数据！");
   fs.readFile('input.txt', function (err, data) {
      if (err) {
         return console.error(err);
      }
      console.log("异步读取文件数据: " + data.toString());
   });
});

运行：

读取文件

语法：

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

参数：

fd - 通过 fs.open() 方法返回的文件描述符。

buffer - 数据写入的缓冲区。

offset - 缓冲区写入的写入偏移量。

length - 要从文件中读取的字节数。

position - 文件读取的起始位置，如果 position 的值为 null，则会从当前文件指针的位置读取。

callback - 回调函数，有三个参数err, bytesRead, buffer，err 为错误信息， bytesRead 表示读取的字节数，buffer 为缓冲区对象。

实例：

fileRead.js，从input…txt中读取数据：

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

console.log("准备打开已存在的文件！");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   console.log("文件打开成功！");
   console.log("准备读取文件：");
   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());
      }
   });
});

运行：

Node.js学习笔记（十三、文件）

关闭文件

语法：

fs.close(fd, callback)

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

参数

fd - 通过 fs.open() 方法返回的文件描述符。

callback - 回调函数，没有参数。

实例：

fileClose.js:

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

console.log("准备打开文件！");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   console.log("文件打开成功！");
   console.log("准备读取文件！");
   fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
      if (err){
         console.log(err);
      }

      // 仅输出读取的字节
      if(bytes > 0){
         console.log(buf.slice(0, bytes).toString());
      }

      // 关闭文件
      fs.close(fd, function(err){
         if (err){
            console.log(err);
         } 
         console.log("文件关闭成功");
      });
   });
});

运行：

Node.js学习笔记（十三、文件）

截取文件

语法：

fs.ftruncate(fd, len, callback)

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

参数：

fd - 通过 fs.open() 方法返回的文件描述符。

len - 文件内容截取的长度。

callback - 回调函数，没有参数。

实例：

fileCat.js，根据长度截取Input.txt中读取的数据：

var buf = new Buffer.alloc(1024);

console.log("准备打开文件！");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   console.log("文件打开成功！");
   console.log("截取10字节内的文件内容，超出部分将被去除。");
   
   // 截取文件
   fs.ftruncate(fd, 10, function(err){
      if (err){
         console.log(err);
      } 
      console.log("文件截取成功。");
      console.log("读取相同的文件"); 
      fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
         if (err){
            console.log(err);
         }

         // 仅输出读取的字节
         if(bytes > 0){
            console.log(buf.slice(0, bytes).toString());
         }

         // 关闭文件
         fs.close(fd, function(err){
            if (err){
               console.log(err);
            } 
            console.log("文件关闭成功！");
         });
      });
   });
});

运行：

删除文件

语法：

fs.unlink(path, callback)

参数

path - 文件路径。

callback - 回调函数，没有参数。

实例：fileDelete.js，删除input.txt:

var fs = require("fs");

console.log("准备删除文件！");
fs.unlink('input.txt', function(err) {
   if (err) {
       return console.error(err);
   }
   console.log("文件删除成功！");
});

运行：

Node.js学习笔记（十三、文件）

创建目录

语法：

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

参数：

path - 文件路径。

options 参数可以是：

recursive - 是否以递归的方式创建目录，默认为 false。

mode - 设置目录权限，默认为 0777。

callback - 回调函数，没有参数。

实例：

creatPath.js:

var fs = require("fs");
// tmp 目录必须存在
console.log("创建目录 /test/");
fs.mkdir("/test/",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("目录创建成功。");
});

运行：

Node.js学习笔记（十三、文件）

读取目录

语法：

fs.readdir(path, callback)

参数：

path - 文件路径。

callback - 回调函数，回调函数带有两个参数err, files，err 为错误信息，files 为目录下的文件数组列表。

实例：

readPath.js:

var fs = require("fs");

console.log("查看 /project 目录");
fs.readdir("/project/",function(err, files){
   if (err) {
       return console.error(err);
   }
   files.forEach( function (file){
       console.log( file );
   });
});

运行：

Node.js学习笔记（十三、文件）

删除目录

语法：

fs.rmdir(path, callback)

参数：

path - 文件路径。

callback - 回调函数，没有参数。

实例：

deletePath.js:

var fs = require("fs");
// 执行前创建一个空的 /test 目录
console.log("准备删除目录 ../test/temp");
fs.rmdir("../test/temp",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("读取 /tmp 目录");
   fs.readdir("../test/",function(err, files){
      if (err) {
          return console.error(err);
      }
      files.forEach( function (file){
          console.log( file );
      });
   });
});