Skip to content

文件系统模块

1 什么是fs文件系统模块

fs模块是 Nodejs 官方提供的、用来操作文件的模块。他提供了一系列的方法和属性,用来满足用户对文件的操作需求。
例如:

  • fs.readFile()方法,用来读取指定文件的内容
  • fs.writeFile()方法,用来向指定的文件中写入内容

如果要在 JavaScript 代码中,使用 fs模块来操作文件,则需要使用如下的方式先导入它:

js
const fs = require('fs')
const fs = require('fs')

2 读取指定文件中的内容

2.1 fs.readFile() 的语法格式

使用fs.readFile()方法,可以读取指定文件中的内容,语法格式如下:

js
fs.readFile(path[, oprions], callback)
fs.readFile(path[, oprions], callback)

参数解读:

  • 参数1:必选参数,字符串,表示文件的路径
  • 参数2:可选参数,表示以什么编码格式来读取文件
  • 参数3:必选 参数,文件读取完成后,通过回调函数拿到读取的结果

2.2 fs.read() 的示例代码

utf-8的编码格式,读取指定文件的内容,并打印 err 和 dataStr 的值:

js
const fs = require('fs')
fs.readFile('./files/11.txt', 'utf-8', function(err, dataStr) {
    console.log(err)
    console.log('----------')
    console.log(dataStr)
})
const fs = require('fs')
fs.readFile('./files/11.txt', 'utf-8', function(err, dataStr) {
    console.log(err)
    console.log('----------')
    console.log(dataStr)
})

2.3 判断文件是否读取成功

可以判断 err 对象是否为 null,从而知晓文件读取的结果:

js
const fs = require('fs')
fs.readFile('./files/1.txt', 'utf-8', function (err, result) {
    if (err) {
        return console.log('文件读取失败!' + err.message)
    }
    console.log('文件读取成功,内容是:' + result)
})
const fs = require('fs')
fs.readFile('./files/1.txt', 'utf-8', function (err, result) {
    if (err) {
        return console.log('文件读取失败!' + err.message)
    }
    console.log('文件读取成功,内容是:' + result)
})

3 向指定的文件中写入内容

3.1 fs.write() 的语法格式

使用fs.writeFile()方法,可以向指定的文件中写入内容,语法格式如下:

js
fs.writeFile(file, data[, options], callback)
fs.writeFile(file, data[, options], callback)

参数解读:

  • 参数1:必选参数,需要指定一个文件路径的字符串,表示文件的存放路径。
  • 参数2:必选参数,表示要写入的内容。
  • 参数3:可选参数,表示以什么格式写入文件内容,默认值是 utf-8

4 fs模块 - 路径动态拼接的问题

在使用 fs 模块操作文件时,如果提供的操作路径是以./../开头的相对路径时,很容易出现路径动态拼接错误的问题。

原因:

代码在运行的时候,会以执行 node 命令时所处的目录,动态拼接出被操作文件的完整路径。

演示

js
fs.readFile('./files/1.txt', 'utf-8', function(err, data) {
    .....
})
fs.readFile('./files/1.txt', 'utf-8', function(err, data) {
    .....
})

动态路径错误问题

当你在 E:\node-basis> node ./fs.js 实际读取的路径是:E:\node-basis\files\1.txt
因此,当你 cd .. 切换到 E:\> node ./fs.js 实际读取的路径是:E:\files\1.txt (并没有这个文件!!!报错)

解决方案1(移植性很差、不利于维护)

在使用 fs 模块操作文件时,直接提供完整的路径,不要提供./或../开头的相对路径,从而防止路径动态拼接的问题。

解决方案2(移植性好、利于维护)

使用 __dirname (代表当前文件所处的目录)

js
fs.readFile(__dirname + '/files/1.txt', 'utf-8', function(err, data) {
    .....
})
fs.readFile(__dirname + '/files/1.txt', 'utf-8', function(err, data) {
    .....
})

这样就不会出现路径动态拼接错误问题了

用心去做高质量的专业前端内容网站,欢迎 star ⭐ 让更多人发现