尚硅谷Node.js笔记—fs模块

一、fs模块

1、fs写入文件

1.1 fs是什么

fs 全称为 file system ，称之为 文件系统 ，是 Node.js 中的 内置模块 ，可以对计算机中的磁盘进行操作。

1.2 writeFile异步写入

• 语法： fs.writeFile(file, data[, options], callback)
• 参数说明：

       file 文件名

       data 待写入的数据

       options 选项设置 （可选）

       callback 写入回调

• 返回值： undefined

• 代码示例：

// require 是 Node.js 环境中的'全局'变量，用来导入模块
const fs = require('fs');
//将 『三人行，必有我师焉。』 写入到当前文件夹下的『座右铭.txt』文件中
fs.writeFile('./座右铭.txt', '三人行，必有我师焉。', err => {
//如果写入失败，则回调函数调用时，会传入错误对象，如写入成功，会传入 null
if(err){
console.log(err);
return;
}
console.log('写入成功')；
});

• 运行过程:

---

2、同步和异步

2.1 同步与异步的区分

一般解释：

同步操作是一种阻塞形式的操作，即在执行操作期间，程序会停止进行其他操作，直到操作完成。这意味着如果有多个同步操作，程序将按照顺序逐个执行它们。

异步操作是一种非阻塞形式的操作，即在执行操作期间，程序会继续进行其他操作。异步操作通常会接受一个回调函数，该函数将在操作完成后被调用。这使得程序可以在等待I/O操作或其他耗时操作完成期间执行其他任务，提高了程序的效率和响应能力。

在Node.js中，大多数操作都是异步的，例如文件读写、网络请求等。通过异步操作能力，Node.js可以同时处理多个请求，并在等待某个请求的响应时处理其他请求，从而提高了应用程序的性能和并发性能。因此，了解同步和异步的概念对于理解和使用Node.js非常重要。

通俗解释：

假设你坐在餐馆里需要点一份披萨。现在你告诉服务员你想要披萨，然后等着厨师把披萨做好。在等待的过程中，你不能做其他事情，只能坐在那里等。这就是同步的概念。当你在等待某个任务完成时，你不能进行其他任务，只能等待。

而异步则不同。想象一下你在餐馆点餐，服务员告诉你需要等10分钟才能做好。但在等待的时候，你并不需要一直坐在那里。你可以去看看餐馆里其他的东西，或者和朋友玩耍。只需要在10分钟后回来取披萨就可以了。

2.2 writeFileSync 同步写入

• 语法: fs.writeFileSync(file, data[, options]) 
• 返回值： undefined
• 代码示例：

//导入 fs 模块
const fs = require('fs');
try{
fs.writeFileSync('./座右铭.txt', '三人行，必有我师焉。');
}catch(e){
console.log(e);
}

---

3、文件追加写入

appendFile 作用是在文件尾部追加内容，appendFile 语法与 writeFile 语法完全相同

• 语法:

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

        fs.appendFileSync(file, data[, options])

• 返回值：二者都为 undefined
• 代码示例：

//导入 fs 模块
const fs = require('fs');
fs.appendFile('./座右铭.txt','择其善者而从之，其不善者而改之。', err => {
if(err) throw err;
console.log('追加成功')
});
fs.appendFileSync('./座右铭.txt','\r\n温故而知新, 可以为师矣');

• 运行过程：

---

4、流式写入

• 语法: fs.createWriteStream(path[, options])
• 参数说明：

        path 文件路径

        options 选项配置（ 可选 ）

• 返回值： Object
• 代码示例：

//导入 fs 模块
const fs = require('fs');
let ws = fs.createWriteStream('./观书有感.txt');
ws.write('半亩方塘一鉴开\r\n');
ws.write('天光云影共徘徊\r\n');
ws.write('问渠那得清如许\r\n');
ws.write('为有源头活水来\r\n');
ws.end();

---

5、文件写入场景

下面的场景都用到了文件写入

• 下载文件
• 安装软件
• 保存程序日志，如 Git
• 编辑器保存文件
• 视频录制

---

6、文件读取

6.1 readFile 异步读取

• 语法： fs.readFile(path[, options], callback)
• 参数说明：

        path 文件路径

        options 选项配置

        callback 回调函数

• 返回值： undefined
• 代码示例：

//导入 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);
});

• 运行过程：

 

6.2 readFileSync 同步读取

• 语法： fs.readFileSync(path[, options])
• 参数说明：

        path 文件路径

        options 选项配置

• 返回值： string | Buffer
• 代码示例：

//导入 fs 模块
const fs = require('fs');
let data = fs.readFileSync('./座右铭.txt');
let data2 = fs.readFileSync('./座右铭.txt', 'utf-8');

6.3 createReadStream 流式读取

• 语法： fs.createReadStream(path[, options])
• 参数说明：

        path 文件路径

        options 选项配置（ 可选 ）

• 返回值： Object
• 代码示例：

//导入 fs 模块
const fs = require('fs');
//创建读取流对象
let rs = fs.createReadStream('./观书有感.txt');
//每次取出 64k 数据后执行一次 data 回调
rs.on('data', data => {
console.log(data);
console.log(data.length);
});
//读取完毕后, 执行 end 回调
rs.on('end', () => {
console.log('读取完成')
})

• 运行过程：

---

7、文件复制

7.1 利用readFileSync和writeFileSync

• 即先读取文件，读取完后再写入文件，适用于小文件复制

//导入 fs 模块
const fs = require('fs');
// 方式一 readFile
// 读取文件内容
let data = fs.readFileSync('./座右铭.txt')
// 写入文件
fs.writeFileSync('./座右铭2.txt',data)

• 运行过程

 7.2 利用流式操作

• 即连续读取文件时顺便连续写入文件，适合大文件复制

//导入 fs 模块
const fs = require('fs');
// 方式二 流式操作
// 创建读取流对象
const rs = fs.createReadStream('./座右铭.txt');
// 创建写入流对象
const ws = fs.createWriteStream('./座右铭4.txt');

// 绑定data事件
rs.on('data',chunk=>{
    ws.write(chunk);
})

• 运行过程：

---

8、文件重命名与移动

• 语法：

       fs.rename(oldPath, newPath, callback)

       fs.renameSync(oldPath, newPath)

• 参数说明：

        oldPath 文件当前的路径

        newPath 文件新的路径

        callback 操作后的回调

• 代码示例：

//导入 fs 模块
const fs = require('fs');
fs.rename('./座右铭2.txt', './观书有感.txt', (err) =>{
    if(err) throw err;
    console.log('移动完成')
    });
    // fs.renameSync('./座右铭.txt', './论语/我的座右铭.txt');

• 运行过程：

---

8、文件重命名与移动

• 语法：

        fs.unlink(path, callback)

        fs.unlinkSync(path)

• 参数说明：

        path 文件路径

        callback 操作后的回调

• 代码示例：

const fs = require('fs');
fs.unlink('./座右铭.txt', err => {
if(err) throw err;
console.log('删除成功');
});
fs.unlinkSync('./观书有感.txt');

• 代码示例（fs.rm方法，node 14.14.0 版本之后才有的）

const fs = require('fs');
fs.rm('./座右铭.txt', err => {
if(err) throw err;
console.log('删除成功');
});
fs.rmSync('./观书有感.txt');

• 运行过程：