【前端】NodeJS：fs模块
文章目录
- fs模块
- 1 文件写入
-
- 1.1 writeFile异步写入
- 1.2 writeFileSync同步写入
- 1.3 appendFile / appendFileSync追加写入
- 1.4 createWriteStream流式写入
- 1.5 写入文件的场景
- 2 文件读取
-
- 2.1 readFile异步读取
- 2.2 readFileSync同步读取
- 2.3 createReadStream流式读取
- 2.4 读取文件应用场景
- 3 文件移动与重命名
- 4 文件删除
- 5 文件夹操作
-
- 5.1 mkdir创建文件夹
- 5.2 readdir读取文件夹
- 5.3 rmdir删除文件夹
- 6 查看资源状态
- 7 相对路径问题
- 8 __dirname
- 9 练习
fs模块
fs全称为file system，称之为文件系统，是Node.js中的内置模块，可以对计算机中的磁盘进行操作。
1 文件写入
Node.js中的磁盘操作是由其他线程完成的，结果的处理有两种模式：
- 同步处理：JavaScript主线程会等待其他线程的执行结果，然后再继续执行主线程的代码，效率较低。
- 异步处理：JavaScript主线程不会等待其他线程的执行结果，直接执行后续的主线程代码，效率较好。
1.1 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('写入成功');
});
1.2 writeFileSync同步写入
- 语法：fs.writeFileSync(file, data[, options])
- 参数与 fs.writeFile 大体一致，只是没有 callback 参数
- 返回值：undefined
//同步写入
fs.writeFileSync('./data.txt', 'test');
1.3 appendFile / appendFileSync追加写入
- appendFile作用是在文件尾部追加内容，appendFile语法与writeFile语法完全相同
- 语法:
fs.appendFile(file, data[, options], callback)
fs.appendFileSync(file, data[, options]) - 返回值： 二者都为 undefined
const fs = require('fs');
//调用appendFile
fs.appendFile('./座右铭.txt', ',择其善者而从之, 择期不善者而改之', err => {
if(err){
console.log('写入失败~~');
return;
}
console.log('追加写入成功');
});
//fs.appendFileSync('./座右铭.txt', '\r\n温故而知新, 可以为师矣');
//writeFile实现追加写入
fs.writeFile('./座右铭.txt', 'love love love',{flag: 'a'}, err => {
if(err) {
console.log('写入失败~');
return;
}
console.log('写入成功');
});
1.4 createWriteStream流式写入
- 语法：fs.createWriteStream(path[, options])
- 参数说明：
path 文件路径
options 选项配置（ 可选 ） - 返回值： Object
- 程序打开一个文件是需要消耗资源的，流式写入可以减少打开关闭文件的次数
- 流式写入方式适用于大文件写入或者频繁写入的场景，writeFile适合于写入频率较低的场景
const fs = require('fs');
//创建写入流对象
const ws = fs.createWriteStream('./观书有感.txt');
//write
ws.write('半亩方塘一鉴开\r\n');
ws.write('天光云影共徘徊\r\n');
ws.write('问渠那得清如许\r\n');
ws.write('为有源头活水来\r\n');
//关闭通道
//ws.close();
1.5 写入文件的场景
- 下载文件
- 安装软件
- 保存程序日志，如 Git
- 编辑器保存文件
- 视频录制
2 文件读取
2.1 readFile异步读取
- 语法：fs.readFile(path[, options], callback)
- 参数说明：
path 文件路径
options 选项配置
callback 回调函数 - 返回值：undefined
fs.readFile('./观书有感.txt', 'utf-8', (err, data) => {
if(err) {
console.log('读取失败~~');
return;
}
console.log(data.toString());
});
2.2 readFileSync同步读取
- 语法：fs.readFileSync(path[, options])
- 参数说明：
path 文件路径
options 选项配置 - 返回值：string | Buffer
let data = fs.readFileSync('./观书有感.txt');
console.log(data); //Buffer
//console.log(data.toString()); //文字
2.3 createReadStream流式读取
- 语法：fs.createReadStream(path[, options])
- 参数说明：
path 文件路径
options 选项配置（ 可选 ） - 返回值：Object
//创建读取流对象
const rs = fs.createReadStream('../资料/笑看风云.mp4');
//绑定data事件 chunk：块儿
//每次取出64k数据后执行一次data回调
rs.on('data', chunk => {
console.log(chunk.length); // 65536 字节 => 64KB
//console.log(chunk.toString()); // 65536 字节 => 64KB
});
//end：可选事件
//读取完毕后, 执行end回调
rs.on('end', () => {
console.log('读取完成');
});
2.4 读取文件应用场景
- 电脑开机
- 程序运行
- 编辑器打开文件
- 查看图片
- 播放视频
- 播放音乐
- Git查看日志
- 上传文件
- 查看聊天记录
3 文件移动与重命名
- 使用rename或renameSync来移动或重命名文件或文件夹
- 语法：
fs.rename(oldPath, newPath, callback)
fs.renameSync(oldPath, newPath) - 参数说明：
oldPath 文件当前的路径
newPath 文件新的路径
callback 操作后的回调
fs.rename('./data.txt', '../资料/data.txt', err => {
if(err) {
console.log('操作失败~');
return;
}
console.log('操作成功');
});
fs.renameSync('./座右铭.txt', './论语/我的座右铭.txt');
4 文件删除
- 使用unlink或unlinkSync来删除文件
- 语法：
fs.unlink(path, callback)
fs.unlinkSync(path) - 参数说明：
path 文件路径
callback 操作后的回调
fs.unlink('./观书有感.txt', err => {
if(err) {
console.log('删除失败~');
return;
}
console.log('删除成功');
});
fs.unlinkSync('./test2.txt');
//调用rm方法 14.4 rmSync
fs.rm('./论语.txt', err => {
if (err) {
console.log('删除失败~');
return;
}
console.log('删除成功');
});
5 文件夹操作
5.1 mkdir创建文件夹
- 使用mkdir或mkdirSync来创建文件夹
- 语法：
fs.mkdir(path[, options], callback)
fs.mkdirSync(path[, options]) - 参数说明：
path 文件夹路径
options 选项配置（ 可选 ）
callback 操作后的回调
//异步创建文件夹 mk make 制作 dir directory 文件夹
fs.mkdir('./html', err => {
if(err) {
console.log('创建失败~');
return;
}
console.log('创建成功');
});
//递归异步创建文件夹
fs.mkdir('./a/b/c', {recursive: true},err => {
if(err) {
console.log('创建失败~');
return;
}
console.log('创建成功');
});
//递归同步创建文件夹
fs.mkdirSync('./a/b/c', {recursive: true});
5.2 readdir读取文件夹
- 使用readdir或readdirSync来读取文件夹
- 语法：
fs.readdir(path[, options], callback)
fs.readdirSync(path[, options]) - 参数说明：
path 文件夹路径
options 选项配置（ 可选 ）
callback 操作后的回调
//读取文件夹 read 读取 dir directory 文件夹
fs.readdir('../资料', (err, data) => {
if(err){
console.log('读取失败');
return;
}
console.log(data);
});
let data = fs.readdirSync('./论语');
5.3 rmdir删除文件夹
- 使用rmdir或rmdirSync来删除文件夹
- 语法：
fs.rmdir(path[, options], callback)
fs.rmdirSync(path[, options]) - 参数说明：
path 文件夹路径
options 选项配置（ 可选 ）
callback 操作后的回调
//删除文件夹 rm remove 移除
fs.rmdir('./html', err => {
if(err){
console.log('删除失败');
return;
}
console.log('删除成功');
});
//递归删除 不推荐使用
fs.rmdir('./a', {recursive: true},err => {
if(err){
console.log(err);
return;
}
console.log('删除成功');
});
//建议使用
fs.rm('./a', {recursive: true},err => {
if(err){
console.log(err);
return;
}
console.log('删除成功');
});
6 查看资源状态
- 使用stat或statSync来查看资源的详细信息
- 语法：
fs.stat(path[, options], callback)
fs.statSync(path[, options]) - 参数说明：
path 文件夹路径
options 选项配置（ 可选 ）
callback 操作后的回调
//stat 方法 status 缩写 状态
fs.stat('../资料/笑看风云.mp4', (err, data) => {
if(err){
console.log('操作失败');
return;
}
// console.log(data);
// isFile
console.log(data.isFile());
// isDirectory
console.log(data.isDirectory());
});
- 结果值对象结构：
size 文件体积
birthtime 创建时间
mtime 最后修改时间
isFile 检测是否为文件
isDirectory 检测是否为文件夹
…
7 相对路径问题
fs 模块对资源进行操作时，路径的写法有两种：
- 相对路径：
./座右铭.txt 当前目录下的座右铭.txt
座右铭.txt 等效于上面的写法
…/座右铭.txt 当前目录的上一级目录中的座右铭.txt - 绝对路径：
D:/Program Files windows 系统下的绝对路径
/usr/bin Linux 系统下的绝对路径 - 相对路径中所谓的当前目录，指的是命令行的工作目录，而并非是文件的所在目录，所以当命令行的工作目录与文件所在目录不一致时，会出现一些BUG
8 __dirname
- __dirname与require 类似，都是Node.js环境中的’全局’变量
- __dirname保存着当前文件所在目录的绝对路径，可以使用__dirname与文件名拼接成绝对路径
- 使用fs模块的时候，尽量使用__dirname将路径转化为绝对路径，这样可以避免相对路径产生的Bug
//相对路径参照物: 命令行的工作目录
fs.writeFileSync('./index.html', 'love');
//绝对路径'全局变量'保存的是：所在文件的所在目录的绝对路径
console.log(__dirname);
fs.writeFileSync(__dirname + '/index.html', 'love');
9 练习
- 1 编写一个JS文件，实现复制文件的功能
//导入 fs 模块
const fs = require('fs');
//读取 code 文件夹
const files = fs.readdirSync('./code');
//遍历数组
files.forEach(item => {
//拆分文件名
let data = item.split('-');
let [num, name] = data;
//判断
if(Number(num) < 10){
num = '0' + num;
}
//创建新的文件名
let newName = num + '-' + name;
//重命名
fs.renameSync(`./code/${item}`, `./code/${newName}`); //模板字符串，使用反引号``
})
- 2 文件重命名
//导入 fs 模块
const fs = require('fs');
//读取 code 文件夹
const files = fs.readdirSync('./code');
//遍历数组
files.forEach((item, index) => {
//拆分
let [num, name] = item.split('-');
//index 自增
index++;
//判断
index = index < 10 ? '0' + index : index;
//拼接新的名字
let newName = index + '-' + name;
//移动文件
fs.renameSync(`./code/${item}`, `./code/${newName}`);
});