Node.js提供了fs模块可以让我们对电脑上的文件进行操作,今天就来了解一下fs关于文件操作的几个简单的api。
1.读取文件。
在Node环境中我们如何读取一个文件的内容呢?这里需要使用到的是fs模块里的readFile方法。
fs.readFile(filePath,encode,callback)
这个方法是异步读取文件,实际项目项目中,我们读取文件大多数情况都是使用异步的方法,同步会阻塞进程,降低效率,一般不推荐使用。
filePath:要读取的文件的路径。
encode:编码格式,一般选用utf8
callback:当读取文件完成后的回调函数。
//引入fs模块,这是node.js内部提供的模块,只要下载了node.js就可以导入使用
const fs = require('fs');
fs.readFile('./demo.txt',{encoding:'utf8'},(error,data)=>{
//回调函数中的第一个参数表示文件读取发生错误的原因,第二个参数是文件读取成功后的数据
//如果文件读取成功error的结果是null
if(!error){
console.log("read file success ",data);
return;
}
console.log('read file error ',error);
})
2.向文件中写入内容
Node中如何向文件中写入内容呢?
fs.writeFile(filePath,data,callback)?这里需要使用到的是fs模块里的fs.writeFile方法。
filePath:要读取的文件的路径。
data:你要往文件中写入的内容。
callback:当读取文件完成后的回调函数。
const fs = require('fs');
const data = 'very good!';
fs.writeFile('./demo.txt',data,(error)=>{
//写入函数的回调函数中只有一个error参数,如果写入成功error=null
if(!error){
console.log('数据写入成功');
return;
}
console.log('数据写入失败');
});
你肯定发现了,原先不是有hello node.js的文本吗?现在怎么是剩下了very good!。这是因为这个writeFile方法把原本的数据给覆盖了。
这里要注意,往文件中写入的内容要是下面的类型
如果你试图往文件中写入undefined等数据是不会成功的。
3.向文本中追加数据
既然writeFile会把原来的数据删除了,那有没有什么办法可以文本中追加内容而不是替换原来的内容呢?
方法一:这里我们可以先读取原来文件中的文本内容,然后把你要写入的内容和读取出来的内容通过拼接的方式合在一起,然后写入文件中就可以了。
//文件操作系统之向文件中追加数据
const fs = require('fs');
//1.先把文件中原有的数据读取出来
//2.把要写入的数据和读取出来的数据拼接起来
let addData = 'node.js'
fs.readFile('./demo.txt','utf-8',(err,data)=>{
if(!err){
console.log('文件读取成功');
fs.writeFile('./demo.txt',data+addData,(error)=>{
if(!error){
console.log('数据追加成功');
return;
}
console.log('数据追加失败');
});
return;
}
console.log('文件读取失败');
});
相信很多人觉得这也太麻烦了吧,还要读取什么的,而且这个代码很容易出现回调地狱的问题啊,就不能一个api搞定吗? 当然可以,就是使用fs.writeFile()这个方法
方法二:fs.writeFile()
const fs = require('fs');
fs.writeFile('./demo.txt','add data by writeFile function',{flag:'a',encoding:'utf-8'},(err)=>{
if(!err){
console.log('数据追加成功');
}
});
writeFile可以写入4个参数,从左到右分别是:写入文件的路径,要写入的内容,配置项,回调函数
这里能满足我们的就是第三个参数配置项:options,这是一个对象。
flag:a就是表示追加内容,
encoding:utf-8写入数据的格式。
下面就是关于writeFile中options中flag配置的标识和对应的意义。
https://nodejs.org/api/fs.html#file-system-flags
有的同学可能要说了,那能不能不用writeFile这个方法来追加内容啊,这也太麻烦了吧,本来函数中的参数也多,还要写options中的flag,知道flag某个标识对应某个意义,真麻烦。
方法三:fs.appendFile()
当然可以,这里有一个不需要写options就可以向文件中添加内容的api:fs.appendFile(filePath,data,callback);相信大家对这三个参数已经不陌生了吧?
//通过fs.appendFile向文件中追加内容
const fs = require('fs');
fs.appendFile('./demo.txt','add data by appendFile function',(err)=>{
if(!err){
console.log('add data by appendFile function success');
}
});
好了,基本的文件操作就写到这里了,下次我会写一下关闭require和import这两个关于模块导入的内容。