fs 文件系统模块
读取指定文件中的内容
1. fs.readFile() 的语法格式
示例:以 utf8 的编码格式,读取指定文件的内容,并打印 err 和 dataStr 的值:
js
// 1.导入fs 模块,来操作文件
const fs = require('fs')
// 2.调用 fs.readFile() 方法读取文件
// 参数1:读取文件的存放路径
// 参数2:读取文件时候采用的编码格式,默认指定 utf8
// 参数3:回调函数,拿到读取失败和成功的结果 err dataStr
fs.readFile('./files/1.txt', 'utf8', function (err, dataStr) {
// 2.1 打印失败的结果
// 如果读取成功,则 err 的值为 null
// 如果读取失败,则 err 的值为 错误对象,dataStr 的值为 undefined
console.log(err)
console.log('-----------')
// 2.2 打印成功的结果
console.log(dataStr)
})

判断文件是否读取成功
可以判断 err 对象是否为 null,从而知晓文件读取的结果:
js
// 1.导入fs 模块,来操作文件
const fs = require('fs')
// 2.调用 fs.readFile() 方法读取文件
// 参数1:读取文件的存放路径
// 参数2:读取文件时候采用的编码格式,默认指定 utf8
// 参数3:回调函数,拿到读取失败和成功的结果 err dataStr
fs.readFile('./files/1.txt', 'utf8', function (err, dataStr) {
// 2.1 打印失败的结果
if (err) {
return console.log('文件读取失败!' + err.message)
}
// 2.2 打印成功的结果
console.log('文件读取成功,内容是:' + dataStr)
})

向指定的文件中写入内容
2. fs.writeFile() 的语法格式
使用 fs.writeFile() 方法,可以向指定的文件中写入内容,语法格式如下:
fs.writeFile(file,data[,options],callback)
示例:向指定的文件路径中,写入文件内容:
js
const fs = require('fs')
// 参数1:表示文件的存放路径
// 参数2:表示要写入的内容
// 参数3:回调函数
// 默认编码是 :utf8
fs.writeFile('./files/2.txt', 'abcd', function (err) {
// 如果文件写入成功,则 err 的值等于 null
// 如果文件写入失败,则 err 的值等于错误对象
console.log(err)
})

判断文件是否写入成功
可以判断 err 对象是否为 null,从而知晓文件写入的结果:
js
const fs = require('fs')
// 参数1:表示文件的存放路径
// 参数2:表示要写入的内容
// 参数3:回调函数
// 默认编码是 :utf8
fs.writeFile('./files/3.txt', 'Hello! Nodejs', function (err) {
// 如果文件写入成功,则 err 的值等于 null
// 如果文件写入失败,则 err 的值等于错误对象
if (err) {
return console.log('文件写入失败!' + err.message)
}
console.log('文件写入成功!')
})

路径动态拼接的问题
在使用 fs 模块操作文件时,如果提供的操作路径是以 ./ 或者 ../ 开头的相对路径时,很容易出现路径动态拼接错误的问题.
原因:代码在运行的时候,会以执行 node 命令时所处的目录,动态拼接出被操作文件的完整录.
解决方案:在使用 fs 模块操作文件时,直接提供完整的路径,不要提供 ./ 或 ../ 开头的相对路径,从而防止路径动态拼接的问题.
注意:
完整路径也有缺点:移植性非常差、不利于维护,这时候我们可以使用 __dirname
来获取文件所处路径
js
const fs = require('fs')
// 出现路径拼接错误的问题,是因为提供了 ./ 或 ../ 开头的相对路径
// 如果要解决这个问题,可以直接提供一个完整的文件存放路径就可以
// fs.readFile('./files/1.txt', 'utf8', function (err, dataStr) {
// if (err) {
// return console.log('读取文件失败' + err.message)
// }
// console.log('读取文件成功!' + dataStr)
// })
// 移植性非常差、不利于维护
// fs.readFile('C:\\Users\\LXY\\Desktop\\nodewebMemory\\day1\\code\\files\\1.txt', 'utf8', function (err, dataStr) {
// if (err) {
// return console.log('读取文件失败' + err.message)
// }
// console.log('读取文件成功!' + dataStr)
// })
// __dirname 表示当前文件所处的目录
// console.log(__dirname)
fs.readFile(__dirname + '/files/1.txt', 'utf8', function (err, dataStr) {
if (err) {
return console.log('读取文件失败' + err.message)
}
console.log('读取文件成功!' + dataStr)
})
path 路径模块
path 模块是 Node.js 官方提供的、用来处理路径的模块。它提供了一系列的方法和属性,用来满足用户对路径的处理需求。
例如:
- path.join() 方法,用来将多个路径片段拼接成一个完整的路径字符串
- path.basename() 方法,用来从路径字符串中,将文件名解析出来
路径拼接
path.join() 的语法格式
使用 path.join() 方法,可以把多个路径片段拼接为完整的路径字符串,语法格式如下:
path.join([...paths])
, 返回值是 string
js
const path = require('path')
const fs = require('fs')
// 注意:../ 会抵消前面的路径(/c) ./不会抵消
// const pathStr = path.join('/a', '/b/c', '../', './d', 'e')
// console.log(pathStr)
fs.readFile(path.join(__dirname, '/files/1.txt'), 'utf8', function (err, dataStr) {
if (err) {
return console.log('读取文件失败' + err.message)
}
console.log('读取文件成功!' + dataStr)
})
注意:今后凡是涉及到路径拼接的操作,都要使用 path.join() 方法进行处理。不要直接使用 + 进行字符串的拼接.
获取路径中的文件名
path.basename() 的语法格式
使用 path.basename() 方法,可以获取路径中的最后一部分,经常通过这个方法获取路径中的文件名,语法格式如下:
path.basename(path[,ext])
参数解读:
- path <string> 必选参数,表示一个路径的字符串
- ext <string> 可选参数,表示文件扩展名
- 返回:<string> 表示路径中的最后一部分
js
const path = require('path')
// 定义文件的存放路径
const fpath = '/a/b/c/index.html'
// const fullName = path.basename(fpath)
// console.log(fullName) // 结果:index.html
const nameWithoutExt = path.basename(fpath, '.html') // 把文件名中的扩展名去掉,只保留文件名
console.log(nameWithoutExt) // 结果:index

获取路径中的文件扩展名
path.extname() 的语法格式
使用 path.extname() 方法,可以获取路径中的扩展名部分,语法格式如下:
path.extname(path)
参数解读:
- path <string>必选参数,表示一个路径的字符串
- 返回:<string> 返回得到的扩展名字符串
js
const path = require('path')
// 这是文件的存放路径
const fpath = '/a/b/c/index.html'
const fext = path.extname(fpath)
console.log(fext)
