Node.js文件系统fs的基础知识

た入场券 2023-01-13 01:49 161阅读 0赞

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

# 文件 #

## 打开文件 ##

异步模式下打开文件的语法

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

`path` 文件的路径；`flags` 文件打开的行为；`mode` 设置文件模式（权限），文件创建默认的权限为 0666（可读可写）；`callback` 回调函数，两个参数 `callback(err, fd)`。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MTU3ODI1_size_16_color_FFFFFF_t_70]  
**实例**：创建 `file.js` 文件，并打开 `text.txt` 进行读写

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

## 获取文件信息 ##

异步模式获取文件大小、时间等信息的语法

fs.stat(path, callback)

`path` 文件路径；`callback` 回调函数，带有两个参数 (err, stats) ，stats 是 fs.Stats 对象  
`fs.stat(path)` 执行后，会将 stats 类的实例返回给其回调函数，通过 stats 类中的提供方法判断文件的相关属性

**实例**

fs.stat('new.txt', (error, stats) => { 
      if (error) throw error
      console.log(stats)
      console.log('isFile:' + stats.isFile())
      console.log('isDirectory:' + stats.isDirectory())
      if (stats.isFile()) { 
        console.log('size:' + stats.size)
        console.log('birth time:' + stats.birthtime)
        console.log('modified time:' + stats.mtime)
      }
    })

运行结果  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MTU3ODI1_size_16_color_FFFFFF_t_70 1]

## 文件创建 ##

> fs模块没有直接创建文件的方法。正常情况下，写入文件前需要确认文件是否存在，如果不存在需要创建后才能写入；而 fs 模块不需要这么做，在有写入功能的几个 api 中，如果目标文件不存在， node 会自动创建该文件然后写入。

*  `fs.appendFile()`
 *  `fs.writeFile()`

### 追加文件 ###

// 异步地追加数据到文件，如果文件尚不存在则创建 文件
    fs.appendFile('text.txt', '追加的数据2222', 'utf8', (error) => { 
      if (error) throw error
      console.log('数据已被追加到文件')
    })

### 写入文件 ###

异步模式下写入文件的语法

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

`writeFile` 直接打开文件默认是 `w` 模式，所以如果文件存在，改方法写入的内容会覆盖旧的文件内容，也可以改变默认模式  
`file` 文件名或文件描述符；`data` 要写入文件的数据，可以是 String 字符串或 Buffer 缓冲对象；`options` 参数是一个对象 `{encoding, mode, flag}`，默认编码 utf8，模式0666，flag为 `w`

**实例**

fs.writeFile('new.txt', 'Hello, Node.js fs', (error) => { 
      if (error) throw error
      console.log('数据已被加到文件')
    })

## 读取文件 ##

### `fs.read()` ###

异步模式下读取文件的语法，该方法使用了文件描述符来读取文件

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

`fd` 通过 `fs.open()` 方法返回的文件描述符；`buffer` 数据写入的缓冲区；`length` 要从文件中读取的字节数；`position` 文件读取的起始位置，`callback` 回调函数，三个参数，err 错误信息，bytesRead 读取的字节数，buffer 缓冲区对象  
**实例**

fs.open('new.txt', 'r+', (err, fd) => { 
      if (err) throw err
      console.log('文件打开成功')
      console.log('准备读取文件')
      let buf = new Buffer.alloc(1024)
      fs.read(fd, buf, 0, buf.length, 0, (err, bytes) => { 
        if (err) throw err
        console.log(bytes + ' 字节被读取')
    
        // 仅输出读取的字节
        if (bytes > 0) { 
          console.log(buf.slice(0, bytes).toString())
        }
      })
    })

### `fs.readFile()` ###

// 异步地读取文件的全部内容，如果文件内容是字符串的话，可以指定字符编码
    fs.readFile('new.txt', 'utf8', (err, data) => { 
      if (err) throw err
      console.log(data)
    })

## 关闭文件 ##

异步模式下关闭文件的语法，使用了文件描述符来读取文件

fs.close(fd, callback)

`fd` 通过 `fs.open()` 方法返回的文件描述符；`callback` 回调函数，没有参数

**实例**

## 截取文件 ##

异步模式下截取文件的语法格式，使用了文件描述符来读取文件

fs.ftruncate(fd, len, callback)

`fd` 通过 `fs.open()` 方法返回的文件描述符；`len` 文件内容截取的长度；`callback` 回调函数，没有参数

**实例**

fs.ftruncate(fd, 10, err => { 
        if (err) throw err
        console.log('文件截取成功')
        console.log('读取相同的文件')
        fs.read(fd, buf, 0, buf.length, 0, (err, bytes) => { 
          if (err) throw err
          console.log(bytes + ' 字节被读取')
      
          // 仅输出读取的字节
          if (bytes > 0) { 
            console.log(buf.slice(0, bytes).toString())
          }
      
          // 关闭文件
          fs.close(fd, err => { 
            if (err) throw err
            console.log('文件关闭成功')
          })
        })
      })
    })

## 删除文件 ##

fs.unlink(path, callback)

`path` 文件路径；`callback` 回调函数，没有参数

**实例**

fs.unlink('e.txt', err => { 
      if (err) throw err
      console.log('文件删除成功')
    })

## 检查文件是否存在 ##

如果只是要检查文件是否存在，但没有更多的操作，建议使用 `fs.access()`

不建议在调用 `fs.open()` 、`fs.readFile()`、`fs.writeFile()` 之前使用 `fs.stat()` 检查文件的存在性，而是应该直接地打开、读取或写入文件  
不建议在调用 `fs.open()` 、`fs.readFile()`、`fs.writeFile()` 之前使用 `fs.access()` 检查文件的可访问性，这样做会引入竞态条件，因为其他进程可能会在两个调用之间更改文件的状态，而是应该直接地打开、读取或写入文件  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MTU3ODI1_size_16_color_FFFFFF_t_70 2]  
**实例**

// 检查文件是否存在于当前目录中
    fs.access('new.txt', fs.constants.F_OK, err => { 
      if (err) throw err
      console.log(`file ${ err ? '不存在' : '存在'}`)
    })

## 重命名文件 ##

fs.rename(oldPath, newPath, callback)

异步的把 `oldPath` 文件重命名为 `newPath` 提供的路径名，如果 `newPath` 已存在，则覆盖它

**实例**

fs.rename('text.txt', 'new.txt', (error) => { 
      if (error) throw error
      console.log('重命名完成！')
    })

# 目录 #

## 创建目录 ##

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

`path` 文件路径；`options` 参数一 `recursive` 是否以递归的方式创建目录，默认是 false，参数二 `mode` 设置目录权限，默认为 0777；`callback` 回调函数，没有参数

**实例1**

// dir 目录必须存在
    fs.mkdir('dir/dir2', (err) => { 
      if (err) throw err
      console.log('创建目录成功')
    })

**实例2**

// 不管创建的目录 dir 和 dir/dir1 是否存在
    fs.mkdir('dir/dir1', {  recursive: true }, (err) => { 
      if (err) throw err
      console.log('创建目录成功')
    })

## 读取目录 ##

fs.readdir(path, callback)

`path` 文件路径；`callback` 回调函数，回调函数有两个参数 err, files err 为错误信息， files 为目录下的文件数组列表  
**实例**

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

结果： `['dir1']`

## 删除目录 ##

fs.rmdir(path, callback)

`path` 文件路径；`callback` 回调函数，没有参数  
**实例**

fs.rmdir('dir/dir2', err => { 
      if (err) throw err
      console.log('读取 dir 目录')
      fs.readdir('dir', (err, files) => { 
        if (err) throw err
        console.log(files)
      })
    })

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MTU3ODI1_size_16_color_FFFFFF_t_70]: /images/20221022/8529b5b3303b441db67e19e76fda4e80.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MTU3ODI1_size_16_color_FFFFFF_t_70 1]: /images/20221022/5d852108965e4ca89796c1088769c520.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MTU3ODI1_size_16_color_FFFFFF_t_70 2]: /images/20221022/9dcbf8d4a98241d4a7a94289486085c6.png