fs模块的全称为file system
,称之为文件系统
,是Node.js中的内置模块
,可以对计算机中的磁盘进行操作。
文件写入就是将数据
保存到文件
中,我们可以使用如下几个方法来实现该效果
方法 | 说明 |
---|---|
writeFile | 异步写入 |
writeFileSync | 同步写入 |
appendFile/appendFileSync | 追加写入 |
createWriteStream | 流式写入 |
语法:fs.writeFile(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('写入成功');
});
语法:fs.writeFileSync(file,data,options)
参数与fs.writeFile大体一致,只是没有callback参数
返回值:undefined
代码示例:
try{
fs.writeFileSync('./座右铭.txt', '三人行,必有我师焉。');
}catch(e){
console.log(e);
}
ps:
Node.js中的磁盘操作是由其他线程
完成的,结果的处理有两种模式:
会等待
其他线程的执行结果,然后再继续执行主线程的代码,效率较低
不会等待
其他线程的执行结果,直接执行后续的主线程代码,效率较好
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温故而知新, 可以为师矣');
语法:fs.createWriteStream(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适合于写入频率较低的场景
文件写入
在计算机中是一个非常常见的操作,下面的场景都用到了文件写入
ps:当需要持久化保存数据
的时候,应该想到文件写入
文件读取顾名思义,就是通过程序从文件中取出其中的数据,我们可以使用如下几种方式:
方法 | 说明 |
---|---|
readFile | 异步读取 |
readFileSync | 同步读取 |
createReadStream | 流式读取 |
语法:fs.readFile(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);
});
语法:fs.readFileSync(path,options)
参数说明:
返回值:string|Buffer
代码示例:
let data = fs.readFileSync('./座右铭.txt');
let data2 = fs.readFileSync('./座右铭.txt', 'utf-8');
语法:fs.createReadStream(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('读取完成')
})
在Node.js中,我们可以使用rename
或renameSync
来移动或重命名文件或文件夹
语法:
fs.rename(oldPath,newPath,callback)
fs.renameSync(oldPath,newPath)
参数说明:
代码示例:
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)
参数说明:
代码示例:
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 | 删除文件夹 |
在Node.js中,我们可以使用mkdir
或mkdirSync
来创建文件夹
语法:
fs.mkdir(path,options,callback)
fs.mkdirSync(path,options)
参数说明:
示例代码:
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});
在Node.js中,我们可以使用readdir
或readdirSync
来读取文件夹
语法:
fs.readdir(path,options,callback)
fs.readdirSync(path,options)
参数说明:
示例代码:
//异步获取状态
fs.stat('./data.txt', (err, data) => {
if(err) throw err;
console.log(data);
});
//同步获取状态
let data = fs.statSync('./data.txt');
结果值对象结构:
fs模块对资源进行操作时,路径的写法有两种:
相对路径
./座右铭.txt
当前目录下的座右铭.txt座右铭.txt
等效于上面的写法../座右铭.txt
当前目录的上一级目录中的座右铭.txt绝对路径
D:/Program Files
windows系统下的绝对路径/user/bin
Linux系统下的绝对路径ps:相对路径中所谓的当前目录
,指的是命令行的工作目录
,而并非是文件的所在目录
所以当命令行的工作目录与文件所在目录不一致时,会出现一些BUG
__dirname
与require
类似,都是Node.js环境中的’全局’变量
__dirname
保存着当前文件所在目录的绝对路径
,可以使用__dirname与文件名拼接成绝对路径
代码示例:
let data = fs.readFileSync(__dirname + '/data.txt');
console.log(data);
ps:使用fs模块的时候,尽量使用__dirname将路径转化为绝对路径,这样可以避免相对路径产生的Bug