什么是 fs ?
Node.js 内置的fs模块就是文件系统模块,负责读写文件。
Node.js 文件系统(fs 模块)模块中的方法均有异步和同步版本,例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。
异步的方法函数最后一个参数为回调函数,回调函数的第一个参数包含了错误信息(error)。
建议大家使用异步方法,比起同步,异步方法性能更高,速度更快,而且没有阻塞。
fs.readFile()方法, 用来读取指定文件中内容
fs.writeFile()方法, 用来向指定的文件中写入内容
fs文件系统模块是NodeJS核心模块之一,用于对系统文件及目录进行读写操作,官方文档讲解了fs模块主要提供三种API机制以供开发者使用。
-
基于Promise的方式
fs/promises API 提供了返回 promise 的异步的文件系统方法。 -
注意
:Promise API 使用底层的 Node.js 线程池在事件循环线程之外执行文件系统操作。 这些操作不是同步的也不是线程安全的。 对同一文件执行多个并发修改时必须小心,否则可能会损坏数据。 -
基于callback回调方式
回调的 API 异步地执行所有操作,不会阻塞事件循环,然后在完成或错误时调用回调函数。 -
注意
:回调的 API 使用底层 Node.js 线程池在事件循环线程之外执行文件系统操作。 这些操作不是同步的也不是线程安全的。 对同一文件执行多个并发修改时必须小心,否则可能会损坏数据。 -
基于同步的方式
同步的 API 同步地执行所有操作,阻塞事件循环,直到操作完成或失败。
读取文件内容
使用readFile方法读取文件的内容
// 1.导入 fs 模块,来操作文件
const fs = require('fs')
// 2.调用 fs.readFile() 方法读取文件
// 参数一:读取文件的存放路径
// 参数二:读取文件时候采用的编码格式,一般默认指定 utf8
// 参数三:回调函数,拿到读取失败和成功的结果 err dataStr
// 读取 files 文件夹下 1.txt 文件
fs.readFile('./files/1.txt', 'utf8', function (err,dataStr) {
// 2.1打印失败的结果
// 如果读取成功,则 err 的值为 null,dataStr 的值为 1.txt 里的内容
// 如果读取失败,则 err 的值为 错误对象,dataStr 的值为 undefined
console.log(err)
console.log("-----")
// 2.2打印成功的结果
console.log(dataStr)
})
判断文件是否读取成功
// 导入 fs 模块,来操作文件
const fs = require('fs')
fs.readFile('./files/1.txt', 'utf8', function (err, dataStr) {
// 判断 err 里的值是否为 null,如果不是则 err 转为 true,读取失败
if (err) {
return console.log("读取文件失败! "+ err.message)
}
console.log("读取文件成功,内容为:"+ dataStr)
})
写入文件内容
// 导入 fs 文件系统模块
const fs = require('fs')
// 调用 fs.writeFile() 方法,写入文件的内容
// 参数一:表示文件的存放路径
// 参数二:表示要写入的内容
// 参数三:回调函数
fs.writeFile('./files/2.txt', '调用 fs.writeFile() 添加的内容', function (err) {
// 2.1如果写入成功,则 err 的值等于 null
// 2.2如果写入失败,则 err 的值等于一个 错误对象
// 判断 err 里的值是否为 null,如果不是则 err 转为 true,读取失败
if (err) {
return console.log("文件写入失败!" + err.message)
}
console.log("文件写入成功!")
} )
处理路径问题
const fs = require('fs')
// 出现路径拼接错误的问题,是因为提供了 ./ 或 .// 开头的相对路径
// 如果要解决这个问题,可以直接提供一个完整的文件存放路径就行
// fs.readFile('./files/1.txt', function (err, data) {
// if (err) {
// return console.log("页面读取失败")
// }
// console.log("页面读取成功")
// })
// 移植性非常差,不利于维护(不推荐使用)
// fs.readFile('D:\\大华教育\\node.js\\js\\files\\1.txt', function (err, data) {
// if (err) {
// return console.log("页面读取失败")
// }
// console.log("页面读取成功")
// })
// __dirname 表示当前文件所处的目录(推荐使用)
// console.log(__dirname)
fs.readFile(__dirname + '/files/1.txt', function (err, data) {
if (err) {
return console.log("页面读取失败")
}
console.log("页面读取成功")
})
成绩整理案例
核心实现步骤:
- 导入需要的fs文件系统模块
- 使用fs.readFile方法读取素材目录下的成绩.txt文件
- 判断文件是否读取成功
- 文件读取成功够,处理成绩数据
- 将处理完成的数据,调用fs.writeFile()写入到新文件“成绩-ok.txt”中
需要完成条件示例:
完成所需代码:
// 导入 fs 文件系统模块
const fs = require('fs')
// 调用 fs.readFile() 方法读取内容
fs.readFile('./files/成绩.txt', function (err, dataStr) {
// 判断文件是否读取成功
if (err) {
return console.log("读取文件失败!"+err.message)
}
// console.log("读取文件成功!" + dataStr)
// 4.1先把成绩的数据,按照空格进行分割
const arrOld = dataStr.toString().split(' ')
// 4.2循环分割后的数组,对每一项数据,进行字符串的替换操作
const arrNew = []
arrOld.forEach((item) => {
arrNew.push(item.replace('=',':'))
})
// 4.3把新数组中的每一项,进行合并,得到一个新的字符串
const newStr = arrNew.join('\r\n')
console.log(newStr)
// 5.调用 fs.writeFile() 方法,把处理完毕的成绩,写入到新文件中
fs.writeFile('./files/新成绩.txt', newStr, function (err) {
if (err) {
return console.log("写入文件失败!"+err.message)
}
console.log("成绩写入成功!")
})
})
总结:
以上就是 node.js 中 fs 的使用,不懂得也可以在评论区里问我,以后会持续添加一些新的功能,敬请关注。
我的其他文章:https://blog.csdn.net/weixin_62897746?type=blog