Node 文件系统

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

var fs =require("fs")

异步和同步

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

• 异步的 fs.readFile()
• 同步的 fs.readFileSync()

异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息(error)。
建议大家使用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞。

创建 input.txt 文件，内容如下：

xxxxxx
xxxxxx
xxxxxx

创建 file.js 文件, 代码如下：

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

接下来，让我们来具体了解下 Node.js 文件系统的方法。

打开文件

以下为在异步模式下打开文件的语法格式：

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

参数使用说明如下：

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

flags 参数可以是以下值：

接下来我们创建 file.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("文件打开成功！")
})

获取文件信息

以下为通过异步模式获取文件信息的语法格式：

fs.stat(path, callback)

参数使用说明如下：

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

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

var fs = require('fs');
fs.stat('input.txt', function (err, stats) {
  console.log(stats.isFile());         //true
})

获得本地静态资源目录下的文件列表

const fs = require("fs");
const path = require('path');
// 获得本地静态资源目录下的文件列表
const getLocalAssets = (staticFolder) => {
  // 返回的文件列表
  let fileArr = [];
  // 遍历文件，并返回列表
  let fileEach = function (dir) {
    let files = fs.readdirSync(dir);
    files.forEach(function (file){
      file = path.resolve(dir, file);
      let fileType = fs.statSync(file);
      if (fileType.isDirectory()){
        fileEach(file);
      } else {
        fileArr.push(file);
      }
    });
  }
  // 放入文件列表数组
  fileEach(staticFolder);
  // 返回文件列表
  return fileArr;
}

stats类中的方法有：

接下来我们创建 file.js 文件，代码如下所示：

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())
})
/* 
准备打开文件！
Stats {
  dev: 16777223,
  mode: 33188,
  nlink: 1,
  uid: 501,
  gid: 20,
  rdev: 0,
  blksize: 4096,
  ino: 12240423,
  size: 47,
  blocks: 8,
  atimeMs: 1629099260960.2869,
  mtimeMs: 1629099260036.6033,
  ctimeMs: 1629099260036.6033,
  birthtimeMs: 1629099249058.782,
  atime: 2021-08-16T07:34:20.960Z,
  mtime: 2021-08-16T07:34:20.037Z,
  ctime: 2021-08-16T07:34:20.037Z,
  birthtime: 2021-08-16T07:34:09.059Z
}
读取文件信息成功！
是否为文件(isFile) ? true
是否为目录(isDirectory) ? false 
*/

读取文件

使用 fs.readFile 读取文件

const fs = require("fs")
fs.readFile("input.txt", function (err, data) {
  console.log(data.toString())
})

使用 fs.read 读取文件

该方法使用了文件描述符来读取文件。
以下为异步模式下读取文件的语法格式：

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

参数使用说明如下：

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

创建 input.txt 文件，内容如下：

xxxxxx
xxxxxx
xxxxxx

接下来我们创建 file.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) }
    console.log(bytes + "  字节被读取")
    // 仅输出读取的字节
    if (bytes > 0) {
      console.log(buf.slice(0, bytes).toString())
    }
  })
})
/*
准备打开已存在的文件！
文件打开成功！
准备读取文件：
20  字节被读取
xxxxxx
xxxxxx
xxxxxx
*/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())
    }
  })
})
/* 
准备打开已存在的文件！
文件打开成功！
准备读取文件：
20  字节被读取
xxxxxx
xxxxxx
xxxxxx 
*/

写入文件

使用 fs.writeFile 写入文件

writeFile 直接打开文件默认是 w 模式，所以如果文件存在，该方法写入的内容会覆盖旧的文件内容。
以下为异步模式下写入文件的语法格式：

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

参数使用说明如下：

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

接下来我们创建 file.js 文件，代码如下所示：

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.write 写入文件

var fs = require("fs")
// var buf = new Buffer.alloc(1024)
var buf = Buffer.from("一缕清风")
console.log("准备打开文件！")
fs.open('input.txt', 'r+', function (err, fd) {
  if (err) { return console.error(err) }
  console.log("文件打开成功！")
  console.log("准备读取文件！")
  fs.write(fd, buf, 0, buf.length, 0, function (err, bytes) {
    if (err) { return console.log(err) }
    // 关闭文件
    fs.close(fd, function (err) {
      if (err) { return console.log(err) }
      console.log("文件关闭成功")
    })
  })
})
/*
准备打开文件！
文件打开成功！
准备读取文件！
xxxxxx
xxxxxx
xxxxxx
文件关闭成功
*/

关闭文件

该方法使用了文件描述符来读取文件。
以下为异步模式下关闭文件的语法格式：

fs.close(fd, callback)

参数使用说明如下：

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

接下来我们创建 file.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) { return console.log(err) }
    // 仅输出读取的字节
    if (bytes > 0) {
      console.log(buf.slice(0, bytes).toString())
    }
    // 关闭文件
    fs.close(fd, function (err) {
      if (err) {return console.log(err) }
      console.log("文件关闭成功")
    })
  })
})
/*
准备打开文件！
文件打开成功！
准备读取文件！
xxxxxx
xxxxxx
xxxxxx
文件关闭成功
*/

截取文件

该方法使用了文件描述符来读取文件。
以下为异步模式下截取文件的语法格式：

fs.ftruncate(fd, len, callback)

参数使用说明如下：

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

接下来我们创建 file.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("截取12字节内的文件内容，超出部分将被去除。")
  // 截取文件
  fs.ftruncate(fd, 12, 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- 回调函数，没有参数。

接下来我们创建 file.js 文件，代码如下所示：

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

创建目录

以下为创建目录的语法格式：

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

参数使用说明如下：

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

接下来我们创建 file.js 文件，代码如下所示：

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

读取目录

以下为读取目录的语法格式：

fs.readdir(path, callback)

参数使用说明如下：

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

接下来我们创建 file.js 文件，代码如下所示：

var fs = require("fs")
console.log("查看 /Users/ken 目录")
fs.readdir("/Users/ken", function (err, files) {
  if (err) { return console.error(err) }
  files.forEach(function (file) {
    console.log(file)
  })
})

删除目录

以下为删除目录的语法格式：

fs.rmdir(path, callback)

参数使用说明如下：

• path- 文件路径。
• callback- 回调函数，没有参数。

接下来我们创建 file.js 文件，代码如下所示：

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

文件模块方法参考手册

以下为 Node.js 文件模块相同的方法列表：

| | 44 | fs.utimesSync(path, atime, mtime)
修改文件时间戳，文件通过指定的文件路径。 | | 45 | fs.futimes(fd, atime, mtime, callback)

| | 46 | fs.futimesSync(fd, atime, mtime)
修改文件时间戳，通过文件描述符指定。 | | 47 | fs.fsync(fd, callback)
异步 fsync.回调函数没有参数，但可能抛出异常。 | | 48 | fs.fsyncSync(fd)
同步 fsync. | | 49 | fs.write(fd, buffer, offset, length[, position], callback)
将缓冲区内容写入到通过文件描述符指定的文件。 | | 50 | fs.write(fd, data[, position[, encoding]], callback)
通过文件描述符 fd 写入文件内容。 | | 51 | fs.writeSync(fd, buffer, offset, length[, position])
同步版的 fs.write()。 | | 52 | fs.writeSync(fd, data[, position[, encoding]])
同步版的 fs.write(). | | 53 | fs.read(fd, buffer, offset, length, position, callback)
通过文件描述符 fd 读取文件内容。 | | 54 | fs.readSync(fd, buffer, offset, length, position)
同步版的 fs.read. | | 55 | fs.readFile(filename[, options], callback)
异步读取文件内容。 | | 56 | fs.readFileSync(filename[, options])

| | 57 | fs.writeFile(filename, data[, options], callback)
异步写入文件内容。 | | 58 | fs.writeFileSync(filename, data[, options])
同步版的 fs.writeFile。 | | 59 | fs.appendFile(filename, data[, options], callback)
异步追加文件内容。 | | 60 | fs.appendFileSync(filename, data[, options])
The 同步 version of fs.appendFile. | | 61 | fs.watchFile(filename[, options], listener)
查看文件的修改。 | | 62 | fs.unwatchFile(filename[, listener])
停止查看 filename 的修改。 | | 63 | fs.watch(filename[, options][, listener])
查看 filename 的修改，filename 可以是文件或目录。返回 fs.FSWatcher 对象。 | | 64 | fs.exists(path, callback)
检测给定的路径是否存在。 | | 65 | fs.existsSync(path)
同步版的 fs.exists. | | 66 | fs.access(path[, mode], callback)
测试指定路径用户权限。 | | 67 | fs.accessSync(path[, mode])
同步版的 fs.access。 | | 68 | fs.createReadStream(path[, options])
返回ReadStream 对象。 | | 69 | fs.createWriteStream(path[, options])
返回 WriteStream 对象。 | | 70 | fs.symlink(srcpath, dstpath[, type], callback)
异步 symlink().回调函数没有参数，但可能抛出异常。 |

更多内容，请查看官网文件模块描述：File System。