node的fs模块api总结

fs 全拼是 file system 即文件系统。

fs.stat 获取文件夹及文件相关信息

查看文件夹信息

fs.stat('./logs', (err, stats) => {
  if (err) {
    console.log(err);
    return;
  }
  console.log('目录：', stats.isDirectory());
  console.log('文件：', stats.isFile());
  console.log('大小：', stats.size);
});

//打印结果
目录： true
文件： false
大小： 160

查看文件信息

fs.stat('./fs.js', (err, stats) => {
  if (err) {
    console.log(err);
    return;
  }

  console.log('目录：', stats.isDirectory());
  console.log('文件：', stats.isFile());
  console.log('大小：', stats.size);
});

//打印结果
目录： false
文件： true
大小： 2087

fs.mkdir 创建文件夹

// 创建目录
fs.mkdir("./logs", err => {
  if (err) {
    console.log(err);
    return;
  }
  console.log("logs目录创建成功");
});

fs.mkdir 是异步方法，如果你想同步创建可以使用 fs.mkdirSync

fs.mkdirSync('./logs2'); //同步创建文件夹
fs.writeFile 写入内容

fs.writeFile('./logs2/hello.log', '你好~', err => {
  if (err) {
    console.log(err);
    return;
  }
  console.log('写入成功');
});

注意： 若文件不存在则创建文件 若文件中有内容则覆盖
有时候我们不希望内容被覆盖，而是追加，那么可以使用 appendFile 方法。

fs.appendFile("./logs/hello.log", "hello~\n我是程序员", err => {
  if (err) {
    console.log(err);
    return;
  }
  console.log("写入成功");
});

fs.readFile 读取文件内容

// 读取文件内容

fs.readFile("./logs/hello.log", "utf8", (err, stats) => {
  if (err) {
    console.log(err);
    return;
  }
  console.log(stats);
});
fs.readdir 读取文件夹
// 读取文件夹
fs.readdir("./logs", (err, files) => {
  if (err) {
    console.log(err);
    return;
  }
  console.log(files); //返回一个包含所有文件名称的数组
});

//打印结果
[ 'data-write.json', 'data.json', 'traking.log' ]

fs.rename 修改文件名称

// 修改名称 把hello.log修改为tranking.log
fs.rename("./logs/hello.log", "./logs/traking.log", err => {
  if (err) {
    console.log(err);
    return;
  }
  console.log("改名成功");
});

删除目录下所有文件

// 删除目录下文件
fs.readdirSync("./logs").map(file => {
  // 删除文件unlink
  fs.unlink(`./logs/${file}`, err => {
    if (err) {
      console.log(err);
      return;
    }
    console.log("文件删除成功");
  });
});

删除文件夹

// 只能删除空目录 若目录里不为空则会报错 所以要先删除里面的文件 再删除文件夹
fs.rmdir("./logs", err => {
  if (err) {
    console.log(err);
    return;
  }
  console.log("目录删除成功");
});

Stream 流，可理解为水流。只不过这里是数据流。

流的意义在于三点：
有源头
有终点
从源头流到终点
使用 stream 读写文件

const fs = require('fs');
const fileReadStream = fs.createReadStream('./logs/data.json');
const fileWriteStream = fs.createWriteStream('./logs/data-write.json');

/* 通过文件流的事件方式 */
fileReadStream.on('data', chunk => {
  fileWriteStream.write(chunk); // 可写流写入文件 如果文件不存在则创建文件
});

fileReadStream.on('error', err => {
  console.log('错误：', err);
});

fileReadStream.on('end', () => {
  console.log('结束');
});

上面代码中建立了一个流：可读流--->可写流。它满足了上面说的三点：有源头(可读流)、有终点(可写流)、从源头到终点(一个文件里的数据流到了另一个文件里)。

代码中也能看出，Stream 其实也继承了 Events，它含有data、error、end等事件。

使用 pipe

我们把上面代码改一下

// 监听pipe事件
fileWriteStream.on('pipe', source => {
  console.log(source);
});

/* 通过pipe方式 */
fileReadStream.pipe(fileWriteStream);

pipe 可理解为水管，在可读流和可写流之间连接了水管，不需要再监听 data 事件，使用起来很方便 能达到同样的效果。

文件描述符

文件描述符是一个非负整数。它是一个索引值，操作系统可以根据它来找到对应的文件。

在 fs 的很多底层 api 中，需要用到文件描述符。在文档中，描述符通常用fd来代表。例如：fs.read(fd, buffer, offset, length, position, callback)。与这个 api 相对应的是：fs.readFile(path[, options], callback)。

因为操作系统对文件描述符的数量有限制，因此在结束文件操作后，别忘记 close:

const fs = require("fs");
fs.open("./db.json", "r", (err, fd) => {
    if (err) throw err;
    // 文件操作...
    // 完成操作后，关闭文件
    fs.close(fd, err => {
        if (err) throw err;
    });
});

同步、异步与 Promise

所有文件系统的 api 都有同步和异步两种形式。

同步写法

不推荐使用同步 api，会阻塞线程。

try {
    const buf = fs.readFileSync("./package.json");
    console.log(buf.toString("utf8"));
} catch (error) {
    console.log(error.message);
}

异步写法

异步写法写起来容易进入回调地狱。

fs.readFile("./package.json", (err, data) => {
    if (err) throw err;
    console.log(data.toString("utf8"));
});

(推荐)Promise 写法

在 node v12 之前，需要自己借助 promise 封装：

function readFilePromise(path, encoding = "utf8") {
    const promise = new Promise((resolve, reject) => {
        fs.readFile(path, (err, data) => {
            if (err) return reject(err);
            return resolve(data.toString(encoding));
        });
    });
    return promise;
}
readFilePromise("./package.json").then(res => console.log(res));

在 node v12 中，引入了 fs Promise api。它们返回 Promise 对象而不是使用回调。 API 可通过 require('fs').promises 访问。如此一来，开发成本更低了。

const fsPromises = require("fs").promises;

fsPromises
    .readFile("./package.json", {
        encoding: "utf8",
        flag: "r"
    })
    .then(console.log)
    .catch(console.error);

目录与目录项

fs.Dir 类：封装了和文件目录相关的操作
fs.Dirent 类：封装了目录项的相关操作。例如判断设备类型（字符、块、FIFO 等）。

它们之间的关系，通过代码展示：

const fsPromises = require("fs").promises;

async function main() {
    const dir = await fsPromises.opendir(".");
    let dirent = null;
    while ((dirent = await dir.read()) !== null) {
        console.log(dirent.name);
    }
}

main();

文件信息

fs.Stats 类：封装了文件信息相关的操作。它在fs.stat()的回调函数中返回。

fs.stat("./package.json", (err, stats) => {
    if (err) throw err;
    console.log(stats);
});

注意，关于检查文件是否存在：

不建议在调用 fs.open()、 fs.readFile() 或 fs.writeFile() 之前使用 fs.stat() 检查文件是否存在。而是应该直接打开、读取或写入文件，如果文件不可用则处理引发的错误。
要检查文件是否存在但随后并不对其进行操作，则建议使用 fs.access()。
ReadStream 与 WriteStream
在 nodejs 中，stream 是个非常重要的库。很多库的 api 都是基于 stream 来封装的。例如下面要说的 fs 中的 ReadStream 和 WriteStream。

fs 本身提供了 readFile 和 writeFile，它们好用的代价就是性能有问题，会将内容一次全部载入内存。但是对于几 GB 的大文件，显然会有问题。

那么针对大文件的解决方案自然是：一点点读出来。这就需要用到 stream 了。以 readStream 为例，代码如下：

const rs = fs.createReadStream("./package.json");
let content = "";

rs.on("open", () => {
    console.log("start to read");
});

rs.on("data", chunk => {
    content += chunk.toString("utf8");
});

rs.on("close", () => {
    console.log("finish read, content is:\n", content);
});

借助 stream 的 pipe，一行快速封装一个大文件的拷贝函数：

function copyBigFile(src, target) {
    fs.createReadStream(src).pipe(fs.createWriteStream(target));
}

参考：
深入Nodejs模块fs - 文件系统操作
Nodejs核心模块简介