fs 文件系统模块

fs 模块是 Node.js 官方提供的、用来操作文件的模块。它提供了一系列的方法和属性，用来满足用户对文件的操作需求

• fs.readFile() 方法，用来读取指定文件中的内容

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

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

const fs = require('fs')

读取指定文件中的内容

fs.readFile() 的语法格式

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

fs.readFile(path[, options], callback)

参数解读：

1. 参数1：必选参数，字符串，表示文件的路径

2. 参数2：可选参数，表示以什么编码格式来读取文件

3. 参数3：必选参数，文件读取完成后，通过回调函数拿到读取的结果

示例代码

// 1. 导入 fs 模块
const fs = require('fs')

// 2. 调用 fs.readFile() 方法读取文件
//  参数 1： 读取文件的存放路径
//  参数 2： 读取文件时候的编码格式，一般默认是 utf8
//  参数 3： 回调函数，拿到读取失败和成功的结果， err 以及 data
fs.readFile('./Tom.txt', 'utf8', function (err, data) {
  // 3. err
  // 如果读取失败，则 err 的值为 null
  // 如果读取失败，则 err 的值为错误对象， data 的值为 undefined
  console.log(err)

  // 4. data 打印成功的结果
  console.log(data)
})

判断文件是否读取成功

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

1. 结果是 null ，说明文件读取成功

2. 如果不为 null，说明文件读取失败

const fs = require('fs')

fs.readFile('./Tom.txt', 'utf8', function (err, data) {
  // 判断 err 对象是否为 null
  if (err) {
    return console.log('文件读取失败：', err.message)
  }

  console.log('文件读取成功，内容是：', data)
})

向指定的文件中写入内容

fs.writeFile() 的语法格式

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

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

参数解读：

1. 参数1：必选参数，需要指定一个文件路径的字符串，表示文件的存放路径

2. 参数2：必选参数，表示要写入的内容

3. 参数3：可选参数，表示以什么格式写入文件内容，默认值是 utf8

4. 参数4：必选参数，文件写入完成后的回调函数

示例代码

 

// 1. 导入 fs 文件系统模块
const fs = require('fs')

// 2. 调用 fs.writeFile() 方法，写入文件的内容
//  参数 1：表示文件的存放路径
//  参数 2：表示要写入的内容
//  参数 3：回调函数
fs.writeFile('./Tom.txt', ' Jerry', function (err) {
  // 3. err
  // 3.1 如果文件写入成功，则 err 的值等于 null
  // 3.2 如果文件写入失败，则 err 的值等于一个错误对象 
  console.log(err)
})

判断文件是否写入成功

可以判断 err 对象是否为 null，从而知晓文件写入的结果

const fs = require('fs')

fs.writeFile('./Tom.txt', 'Tom And Jerry', function (err) {
  if (err) {
    return console.log('文件写入失败', err.message)
  }

  console.log('文件写入成功')
})

fs 路径问题

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

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

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

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

使用 __dirname 解决路径拼接问题
__dirname 属性 Node 给提供的一个全局的属性，表示当前文件所处的目录

const fs = require('fs')

// __dirname 属性解决路径拼接问题
fs.readFile(__dirname + '/Tom.txt', 'utf8', function (err, data) {
  // 判断 err 对象是否为 null
  if (err) {
    return console.log('文件读取失败：', err.message)
  }

  console.log('文件读取成功，内容是：', data)
})