fs模块
fs模块的全称为file system，称之为文件系统，是Node.js中的内置模块，可以对计算机中的磁盘进行操作。
一、文件写入
文件写入就是将数据保存到文件中，我们可以使用如下几个方法来实现该效果
| 方法 | 说明 |
|---|---|
| writeFile | 异步写入 |
| writeFileSync | 同步写入 |
| appendFile/appendFileSync | 追加写入 |
| createWriteStream | 流式写入 |
1.1 writeFile异步写入
语法：fs.writeFile(file,data,options,callback)
参数说明：
- file 文件名
- data 待写入的数据
- options 选项设置
(可选) - callback 写入回调
返回值：undefined
代码示例：文章来源：https://www.toymoban.com/news/detail-523501.html
// require 是 Node.js 环境中的'全局'变量，用来导入模块
const fs = require('fs');
//将 『三人行，必有我师焉。』 写入到当前文件夹下的『座右铭.txt』文件中
fs.writeFile('./座右铭.txt', '三人行，必有我师焉。', err => {
//如果写入失败，则回调函数调用时，会传入错误对象，如写入成功，会传入 null
if(err){
console.log(err);
return;
}
console.log('写入成功')；
});
1.2 writeFileSync 同步写入
语法：fs.writeFileSync(file,data,options)
参数与fs.writeFile大体一致，只是没有callback参数
返回值:undefined
代码示例：
try{
fs.writeFileSync('./座右铭.txt', '三人行，必有我师焉。');
}catch(e){
console.log(e);
}
ps:
Node.js中的磁盘操作是由其他线程完成的，结果的处理有两种模式：
- 同步处理JavaScript主线程
会等待其他线程的执行结果，然后再继续执行主线程的代码，效率较低 - 异步处理JavaScript主线程
不会等待其他线程的执行结果，直接执行后续的主线程代码，效率较好
1.3 appendFile/appendFileSync追加写入
appendFile作用是在文件尾部追加内容，appendFile语法与writeFile完全相同
语法：
fs.appendFile(file,data,options,callback)
fs.appendFileSync(file,data,options)
返回值：二者都为undefined
实例代码：
fs.appendFile('./座右铭.txt','择其善者而从之，其不善者而改之。', err => {
if(err) throw err;
console.log('追加成功')
});
fs.appendFileSync('./座右铭.txt','\r\n温故而知新, 可以为师矣');
1.4 createWriteStream流式写入
语法：fs.createWriteStream(path,options)
参数说明：
- path文件路径
- options选项配置(可选)
- 返回值：
Object
代码示例：
let ws = fs.createWriteStream('./观书有感.txt');
ws.write('半亩方塘一鉴开\r\n');
ws.write('天光云影共徘徊\r\n');
ws.write('问渠那得清如许\r\n');
ws.write('为有源头活水来\r\n');
ws.end();
ps:
程序打开一个文件是需要消耗资源的，流式写入可以减少打开关闭文件的次数。
流式写入方法适用于大文件写入或者频繁写入的场景，write适合于写入频率较低的场景
1.5 写入文件的场景
文件写入在计算机中是一个非常常见的操作，下面的场景都用到了文件写入
- 下载文件
- 安装文件
- 保存程序日志，如Git
- 编辑器保存文件
- 视频录制
ps：当需要持久化保存数据的时候，应该想到文件写入
二、文件读取
文件读取顾名思义，就是通过程序从文件中取出其中的数据，我们可以使用如下几种方式：
| 方法 | 说明 |
|---|---|
| readFile | 异步读取 |
| readFileSync | 同步读取 |
| createReadStream | 流式读取 |
2.1 readFile 异步读取
语法：fs.readFile(path,options,callback)
参数说明：
- path 文件路径
- options 选项配置
- callback 回调函数
代码示例：
//导入 fs 模块
const fs = require('fs');
fs.readFile('./座右铭.txt', (err, data) => {
if(err) throw err;
console.log(data);
});
fs.readFile('./座右铭.txt', 'utf-8',(err, data) => {
if(err) throw err;
console.log(data);
});
2.2 readFileSync同步读取
语法：fs.readFileSync(path,options)
参数说明：
- path 文件路径
- options 选项配置
返回值：string|Buffer
代码示例：
let data = fs.readFileSync('./座右铭.txt');
let data2 = fs.readFileSync('./座右铭.txt', 'utf-8');
2.3 createReadStream流式读取
语法：fs.createReadStream(path,options)
参数说明：
- path 文件路径
- options 选项配置（可选）
返回值：Object
代码示例：
//创建读取流对象
let rs = fs.createReadStream('./观书有感.txt');
//每次取出 64k 数据后执行一次 data 回调
rs.on('data', data => {
console.log(data);
console.log(data.length);
});
//读取完毕后, 执行 end 回调
rs.on('end', () => {
console.log('读取完成')
})
2.4 读取文件应用场景
- 电脑开机
- 程序运行
- 编辑器打开文件
- 查看图片
- 播放视频
- 播放音乐
- Git查看日志
- 上传文件
- 查看聊天记录
三、文件移动与重命名
在Node.js中，我们可以使用rename或renameSync来移动或重命名文件或文件夹
语法：
fs.rename(oldPath,newPath,callback)
fs.renameSync(oldPath,newPath)
参数说明：
- oldPath 文件当前的路径
- newPath 文件的新路径
- callback 操作后的回调
代码示例：
fs.rename('./观书有感.txt', './论语/观书有感.txt', (err) =>{
if(err) throw err;
console.log('移动完成')
});
fs.renameSync('./座右铭.txt', './论语/我的座右铭.txt');
四、文件删除
在Node.js中，我们可以使用unlink或unlinkSync来删除文件
语法：
fs.unlink(path,callback)
fs.unlinkSync(path)
参数说明：
- path 文件路径
- callback 操作后的回调
代码示例：
const fs = require('fs');
fs.unlink('./test.txt', err => {
if(err) throw err;
console.log('删除成功');
});
fs.unlinkSync('./test2.txt');
五、文件夹操作
借助Node.js的能力，我们可以对文件夹进行创建、读取、删除等操作
| 方法 | 说明 |
|---|---|
| mkdir/mkdirSync | 创建文件夹 |
| readdir/readdirSync | 读取文件夹 |
| rmdir/rmdirSync | 删除文件夹 |
5.1 mkdir创建文件夹
在Node.js中，我们可以使用mkdir或mkdirSync来创建文件夹
语法：
fs.mkdir(path,options,callback)
fs.mkdirSync(path,options)
参数说明：
- path 文件夹路径
- options 选项配置（可选）
- callback 操作后的回调
示例代码：
fs.mkdir('./page', err => {
if(err) throw err;
console.log('创建成功');
});
//递归异步创建
fs.mkdir('./1/2/3', {recursive: true}, err => {
if(err) throw err;
console.log('递归创建成功');
});
//递归同步创建文件夹
fs.mkdirSync('./x/y/z', {recursive: true});
5.2 readdir 读取文件夹
在Node.js中，我们可以使用readdir或readdirSync来读取文件夹
语法：
fs.readdir(path,options,callback)
fs.readdirSync(path,options)
参数说明：
- path 文件夹路径
- options 选项配置（可选）
- callback 操作后的回调
示例代码：
//异步获取状态
fs.stat('./data.txt', (err, data) => {
if(err) throw err;
console.log(data);
});
//同步获取状态
let data = fs.statSync('./data.txt');
结果值对象结构：
- size 文件体积
- birhtime 创建时间
- mtime 最后修改时间
- isFile 检测是否为文件
- isDirectory 检测是否为文件夹
七、相对路径问题
fs模块对资源进行操作时，路径的写法有两种：
-
相对路径
-
./座右铭.txt当前目录下的座右铭.txt -
座右铭.txt等效于上面的写法 -
../座右铭.txt当前目录的上一级目录中的座右铭.txt
-
-
绝对路径
-
D:/Program Fileswindows系统下的绝对路径 -
/user/binLinux系统下的绝对路径
-
ps：相对路径中所谓的当前目录,指的是命令行的工作目录，而并非是文件的所在目录
所以当命令行的工作目录与文件所在目录不一致时，会出现一些BUG
八、__dirname
__dirname与require类似，都是Node.js环境中的’全局’变量
__dirname保存着当前文件所在目录的绝对路径,可以使用__dirname与文件名拼接成绝对路径
代码示例：
let data = fs.readFileSync(__dirname + '/data.txt');
console.log(data);
ps:使用fs模块的时候，尽量使用__dirname将路径转化为绝对路径，这样可以避免相对路径产生的Bug文章来源地址https://www.toymoban.com/news/detail-523501.html
到了这里，关于Node.js--fs模块的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！
