深入Nodejs模块fs – 文件系统操作

作者 : 开心源码 本文共2701个字,预计阅读时间需要7分钟 发布时间: 2022-05-13 共240人阅读

image

node 的fs文档密密麻麻的 api 非常多,毕竟全面支持对文件系统的操作。文档组织的很好,操作基本分为文件操作、目录操作、文件信息、流这个大方面,编程方式也支持同步、异步和 Promise。

本文记录了几个文档中没详细描写的问题,可以更好地串联fs文档思路:

  • 文件形容符
  • 同步、异步与 Promise
  • 目录与目录项
  • 文件信息
  • stream

?? 关注公众号“心谭博客” / ?? 前往 xxoo521.com / 欢迎交流和指正

文件形容符

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

在 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));}

参考链接

  • 文件形容符
  • Socket 套接字
  • Nodejs 基础:stream 模块入门详情与使用
  • Fastest way to copy file in node.js
  • Using Node.js to Read Really, Really Large Datasets & Files (Pt 1)

??扫码关注,查看「前台图谱」&「算法题解」,您的支持是我升级的动力??

image

说明
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是摆设,本站源码仅提供给会员学习使用!
7. 如遇到加密压缩包,请使用360解压,如遇到无法解压的请联系管理员
开心源码网 » 深入Nodejs模块fs – 文件系统操作

发表回复