node总结之文件操作系列（一）

- 日理万妓 2022-05-14 15:05 119阅读 0赞

Node.js 提供一组类似 UNIX（POSIX）标准的文件操作API，我们来看下Node 导入文件系统模块(fs)语法，如下：

var fs = require("fs")

Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。其中，异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息(error)。个人建议大家使用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞，来看测试文件input.txt 文件，内容如下：

luyaran is my lover

先来看一个实例：

var fs = require("fs");
    
    // 异步读取
    fs.readFile('input.txt', function (err, data) {
       if (err) {
           return console.error(err);
       }
       console.log("异步读取: " + data.toString());
    });
    
    // 同步读取
    var data = fs.readFileSync('input.txt');
    console.log("同步读取: " + data.toString());
    
    console.log("程序执行完毕。");

我们来看下在异步模式下打开文件的语法格式，如下：

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

参数描述如下：

*  **path** \- 文件的路径。
 *  **flags** \- 文件打开的行为。具体值详见下文。
 *  **mode** \- 设置文件模式(权限)，文件创建默认权限为 0666(可读，可写)。
 *  **callback** \- 回调函数，带有两个参数如：callback(err, fd)。

来看下flags 参数具体可以使用那些值：

<table> 
 <tbody> 
  <tr> 
   <th>Flag</th> 
   <th>描述</th> 
  </tr> 
  <tr> 
   <td>r</td> 
   <td>以读取模式打开文件。如果文件不存在抛出异常。</td> 
  </tr> 
  <tr> 
   <td>r+</td> 
   <td>以读写模式打开文件。如果文件不存在抛出异常。</td> 
  </tr> 
  <tr> 
   <td>rs</td> 
   <td>以同步的方式读取文件。</td> 
  </tr> 
  <tr> 
   <td>rs+</td> 
   <td>以同步的方式读取和写入文件。</td> 
  </tr> 
  <tr> 
   <td>w</td> 
   <td>以写入模式打开文件，如果文件不存在则创建。</td> 
  </tr> 
  <tr> 
   <td>wx</td> 
   <td>类似 'w'，但是如果文件路径存在，则文件写入失败。</td> 
  </tr> 
  <tr> 
   <td>w+</td> 
   <td>以读写模式打开文件，如果文件不存在则创建。</td> 
  </tr> 
  <tr> 
   <td>wx+</td> 
   <td>类似 'w+'， 但是如果文件路径存在，则文件读写失败。</td> 
  </tr> 
  <tr> 
   <td>a</td> 
   <td>以追加模式打开文件，如果文件不存在则创建。</td> 
  </tr> 
  <tr> 
   <td>ax</td> 
   <td>类似 'a'， 但是如果文件路径存在，则文件追加失败。</td> 
  </tr> 
  <tr> 
   <td>a+</td> 
   <td>以读取追加模式打开文件，如果文件不存在则创建。</td> 
  </tr> 
  <tr> 
   <td>ax+</td> 
   <td>类似 'a+'， 但是如果文件路径存在，则文件读取追加失败。</td> 
  </tr> 
 </tbody> 
</table>

看下实例：

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

再来看下通过异步模式获取文件信息的语法格式：

fs.stat(path, callback)

参数描述如下：

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

fs.stat(path)执行后，会将stats类的实例返回给其回调函数，我们可以通过stats类中的提供方法判断文件的相关属性。来看下判断是否为文件的实例：

var fs = require('fs');
    
    fs.stat('/Users/liuht/code/itbilu/demo/fs.js', function (err, stats) {
        console.log(stats.isFile());         //true
    })

再来看下stats类中的方法：

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

实例如下：

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)

可能有过经验的知道，writeFile 直接打开文件默认是 w 模式，所以如果文件存在，该方法写入的内容会覆盖旧的文件内容，但是，fs.writeFile 并不一定是覆盖原来文件内容，而是取决于打开文件时带的 **flags**。如果我们是通过 **writeFile** 直接打开文件，那么默认是 w 模式，但是也可以通过 **open** 打开文件指定模式，然后通过 **writeFile** 来写文件，来看实例：

fs.open(fileName, "a+", function(err, fd){
        if (err) {
            return console.error(err);
        }
        fs.writeFile(fd, "bb", function(err){
            if (err){
                return console.error(err);
            }
        });
    });

上述代码的**writeFile** 是追加模式写文件。

咱接着刚刚的来，看下参数描述：

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

来看完整实例：

最后就是异步模式下读取文件的语法格式：

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

这个方法会使用文件描述符来读取文件，来看参数描述：

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

实例如下：

好啦，本次记录就到这里了。

如果感觉不错的话，请多多点赞支持哦。。。