文件系统是一种用于向用户提供底层数据访问的机制,同时也是一套实现了数据的存储、分级组织、访问和获取等操作的抽象数据类型。
  Node.js 中的[fs模块](https://nodejs.org/dist/latest-v18.x/docs/api/fs.html)就是对文件系统的封装,整合了一套标准 POSIX 文件 I/O 操作的集合,包括文件的读写、删除、遍历、重命名等操作。
  fs 模块中的所有方法都提供了三种形式:回调、同步和 Promise ,其中 Promise 是在 Node.js 的版本 10 中引入的。
  本系列所有的示例源码都已上传至Github,[点击此处](https://github.com/pwstrick/node)获取。
## 一、三种形式
  在回调形式的方法中,最后一个参数是其回调函数,会异步地调用,其中回调函数的第一个参数始终为异常预留,不过有个例外是 exists() 方法。
  回调形式不容易书写,很容易就会形成回调地狱。
  虽然同步形式的方法比较容易书写,但是在执行时会阻止 Node.js 事件循环和阻塞 JavaScript 执行,直到操作完成。
  Promise 形式的方法会使用底层的 Node.js 线程池,在事件循环线程之外异步地执行文件系统操作。对同一文件执行多个并发修改时必须小心,有可能会损坏数据。
  以读取文件为例,三种形式的写法如下所示,若不指定编码,那么输出的将是 Buffer 实例。
~~~
const fs = require('fs');
// 回调
fs.readFile('./data.txt', 'utf8', (err, data) => {
if (err) throw err;
console.log(data); // strick
});
// 同步
const data = fs.readFileSync('./data.txt', 'utf8');
console.log(data); // strick
// Promise
const { promises } = fs;
async function readFilePromise() {
const data = await promises.readFile('./data.txt', 'utf8');
console.log(data); // strick
}
readFilePromise();
~~~
## 二、基础使用
**1)判断文件是否存在**
  exists() 方法可用于判断文件是否存在,但在上一小节中曾提到,它已被弃用。
  这是因为此回调的参数与其他回调不一致。通常,Node.js 回调的第一个参数是 err 参数,然后跟可选的其他参数,但 fs.exists() 回调只有一个布尔参数,如下所示。
~~~
fs.exists('./data.txt', isExist => {
console.log(isExist);
});
~~~
  再则是因为 exists() 方法的功能用 access() 方法也能实现,其内部源码如下所示,其实也是调用了 access() 方法。
~~~
function exists(path, callback) {
maybeCallback(callback);
// 构造回调函数
function suppressedCallback(err) {
callback(err ? false : true);
}
try {
fs.access(path, F_OK, suppressedCallback);
} catch {
return callback(false);
}
}
~~~
  其中 F\_OK 是 fs 模块中的一个常量,表示文件是否存在,使用方法如下所示,R\_OK 表示是否可读,W\_OK 表示是否可写。
~~~
const { constants } = require('fs');
const { F_OK, R_OK, W_OK } = constants;
~~~
  注意,在调用 fs.open()、fs.readFile() 或 fs.writeFile() 之前,不能使用 fs.access() 检查文件是否存在。
  因为这样做会引入竞争条件,其他进程可能会在两次调用之间修改文件状态,造成非预期的结果。
  遇到这种场景,推荐的做法是直接打开、读取或写入文件,当文件不可用时再做处理。
  另一种判断文件是否存在的方法是调用 stat(),读取文件属性。
  它有两个方法 isDirectory() 和 isFile() 可分别判断是否是目录和是否是文件,如下所示。
~~~
fs.stat('./data.txt', (err, stats) => {
console.log(stats.isDirectory());
console.log(stats.isFile());
});
~~~
  同样要注意的是,它也不能在调用 fs.open()、fs.readFile() 或 fs.writeFile() 之前,检查文件是否存在。
**2)方法**
  下面罗列的是 fs 模块的一些方法。
* fs.open():打开文件,可设置文件模式。
* fs.close():关闭文件描述符。
* fs.createReadStream():创建可读的文件流。
* fs.createWriteStream():创建可写的文件流。
* fs.readFile():读取文件的内容,相关方法:fs.read()。
* fs.writeFile():写入文件,相关方法:fs.write()。
* fs.link():新建指向文件的硬链接。
* fs.unlink():删除文件或符号链接。
* fs.mkdir():新建文件夹。
* fs.rmdir():删除文件夹。
* fs.readdir():读取目录的内容。
* fs.stat():读取文件属性,相关方法:fs.fstat()、fs.lstat()。
* fs.access():检查文件是否存在,以及 Node.js 是否有权限访问。
* fs.rename():重命名文件或文件夹。
* fs.appendFile():追加数据到文件,如果文件不存在,则创建文件。
* fs.copyFile():拷贝文件,可覆盖文件内容。
* fs.chmod():更改文件(通过传入的文件名指定)的权限,相关方法:fs.lchmod()、fs.fchmod()。
* fs.chown():更改文件(通过传入的文件名指定)的所有者和群组,相关方法:fs.fchown()、fs.lchown()。
* fs.watchFile():开始监控文件的更改,相关方法:fs.watch()。
* fs.unwatchFile():停止监控文件的更改。
**3)路径**
  路径处理并不是在 fs 模块,而是在[path模块](https://nodejs.org/dist/latest-v18.x/docs/api/path.html),它的方法包括。
* path.basename():读取路径的最后一部分。
* path.dirname():读取路径的目录部分。
* path.extname():读取路径的文件扩展名。
* path.isAbsolute():判断是否是绝对路径。
* path.join():将多个部分合并成一个完整的路径。
* path.normalize():当包含类似 .、.. 或 // 等相对的说明符时,就尝试计算实际的路径。
* path.parse():解析成路径对象。
* path.relative():基于当前目录,返回从第一个路径到第二个路径的相对路径。
* path.resolve():将相对路径计算成绝对路径。
~~~
path.basename('../06/data.txt') // data.txt
path.dirname('../06/data.txt'); // ../06
path.extname('../06/data.txt'); // .txt
path.isAbsolute('../06/data.txt'); // false
path.join('../', '06', 'data.txt'); // ../06/data.txt
path.normalize('/../06/data.txt'); // /06/data.txt
// { root: '', dir: '../06', base: 'data.txt', ext: '.txt', name: 'data' }
path.parse('../06/data.txt');
path.relative('../', '../06/data.txt'); // 06/data.txt
path.resolve('../06/data.txt'); // /Users/code/web/node/06/data.txt
~~~
参考资料:
[判断文件存在](https://www.nodejs.red/#/nodejs/modules/fs-file-exists-check)
[深入Node.js源码之文件系统](https://yjhjstz.gitbooks.io/deep-into-node/content/chapter11/chapter11-2.html)
[Node.js官网文档](http://nodejs.cn/learn/working-with-file-descriptors-in-nodejs) [API文件系统](https://nodejs.org/dist/latest-v18.x/docs/api/fs.html)
[饿了么File](https://github.com/ElemeFE/node-interview/blob/master/sections/zh-cn/io.md#file)
*****
> 原文出处:
[博客园-Node.js精进](https://www.cnblogs.com/strick/category/2154090.html)
[知乎专栏-前端性能精进](https://www.zhihu.com/column/c_1611672656142725120)
已建立一个微信前端交流群,如要进群,请先加微信号freedom20180706或扫描下面的二维码,请求中需注明“看云加群”,在通过请求后就会把你拉进来。还搜集整理了一套[面试资料](https://github.com/pwstrick/daily),欢迎浏览。
![](https://box.kancloud.cn/2e1f8ecf9512ecdd2fcaae8250e7d48a_430x430.jpg =200x200)
推荐一款前端监控脚本:[shin-monitor](https://github.com/pwstrick/shin-monitor),不仅能监控前端的错误、通信、打印等行为,还能计算各类性能参数,包括 FMP、LCP、FP 等。
- ES6
- 1、let和const
- 2、扩展运算符和剩余参数
- 3、解构
- 4、模板字面量
- 5、对象字面量的扩展
- 6、Symbol
- 7、代码模块化
- 8、数字
- 9、字符串
- 10、正则表达式
- 11、对象
- 12、数组
- 13、类型化数组
- 14、函数
- 15、箭头函数和尾调用优化
- 16、Set
- 17、Map
- 18、迭代器
- 19、生成器
- 20、类
- 21、类的继承
- 22、Promise
- 23、Promise的静态方法和应用
- 24、代理和反射
- HTML
- 1、SVG
- 2、WebRTC基础实践
- 3、WebRTC视频通话
- 4、Web音视频基础
- CSS进阶
- 1、CSS基础拾遗
- 2、伪类和伪元素
- 3、CSS属性拾遗
- 4、浮动形状
- 5、渐变
- 6、滤镜
- 7、合成
- 8、裁剪和遮罩
- 9、网格布局
- 10、CSS方法论
- 11、管理后台响应式改造
- React
- 1、函数式编程
- 2、JSX
- 3、组件
- 4、生命周期
- 5、React和DOM
- 6、事件
- 7、表单
- 8、样式
- 9、组件通信
- 10、高阶组件
- 11、Redux基础
- 12、Redux中间件
- 13、React Router
- 14、测试框架
- 15、React Hooks
- 16、React源码分析
- 利器
- 1、npm
- 2、Babel
- 3、webpack基础
- 4、webpack进阶
- 5、Git
- 6、Fiddler
- 7、自制脚手架
- 8、VSCode插件研发
- 9、WebView中的页面调试方法
- Vue.js
- 1、数据绑定
- 2、指令
- 3、样式和表单
- 4、组件
- 5、组件通信
- 6、内容分发
- 7、渲染函数和JSX
- 8、Vue Router
- 9、Vuex
- TypeScript
- 1、数据类型
- 2、接口
- 3、类
- 4、泛型
- 5、类型兼容性
- 6、高级类型
- 7、命名空间
- 8、装饰器
- Node.js
- 1、Buffer、流和EventEmitter
- 2、文件系统和网络
- 3、命令行工具
- 4、自建前端监控系统
- 5、定时任务的调试
- 6、自制短链系统
- 7、定时任务的进化史
- 8、通用接口
- 9、微前端实践
- 10、接口日志查询
- 11、E2E测试
- 12、BFF
- 13、MySQL归档
- 14、压力测试
- 15、活动规则引擎
- 16、活动配置化
- 17、UmiJS版本升级
- 18、半吊子的可视化搭建系统
- 19、KOA源码分析(上)
- 20、KOA源码分析(下)
- 21、花10分钟入门Node.js
- 22、Node环境升级日志
- 23、Worker threads
- 24、低代码
- 25、Web自动化测试
- 26、接口拦截和页面回放实验
- 27、接口管理
- 28、Cypress自动化测试实践
- 29、基于Electron的开播助手
- Node.js精进
- 1、模块化
- 2、异步编程
- 3、流
- 4、事件触发器
- 5、HTTP
- 6、文件
- 7、日志
- 8、错误处理
- 9、性能监控(上)
- 10、性能监控(下)
- 11、Socket.IO
- 12、ElasticSearch
- 监控系统
- 1、SDK
- 2、存储和分析
- 3、性能监控
- 4、内存泄漏
- 5、小程序
- 6、较长的白屏时间
- 7、页面奔溃
- 8、shin-monitor源码分析
- 前端性能精进
- 1、优化方法论之测量
- 2、优化方法论之分析
- 3、浏览器之图像
- 4、浏览器之呈现
- 5、浏览器之JavaScript
- 6、网络
- 7、构建
- 前端体验优化
- 1、概述
- 2、基建
- 3、后端
- 4、数据
- 5、后台
- Web优化
- 1、CSS优化
- 2、JavaScript优化
- 3、图像和网络
- 4、用户体验和工具
- 5、网站优化
- 6、优化闭环实践
- 数据结构与算法
- 1、链表
- 2、栈、队列、散列表和位运算
- 3、二叉树
- 4、二分查找
- 5、回溯算法
- 6、贪心算法
- 7、分治算法
- 8、动态规划
- 程序员之路
- 大学
- 2011年
- 2012年
- 2013年
- 2014年
- 项目反思
- 前端基础学习分享
- 2015年
- 再一次项目反思
- 然并卵
- PC网站CSS分享
- 2016年
- 制造自己的榫卯
- PrimusUI
- 2017年
- 工匠精神
- 2018年
- 2019年
- 前端学习之路分享
- 2020年
- 2021年
- 2022年
- 2023年
- 日志
- 2020