590 内置模块fs

1.1. 认识fs模块

fs是File System的缩写，表示文件系统。

对于任何一个为服务器端服务的语言或者框架通常都会有自己的文件系统：

• 因为服务器需要将各种数据、文件等放置到不同的地方；
• 比如用户数据可能大多数是放到数据库中的（后面我们也会学习）；
• 比如某些配置文件或者用户资源（图片、音视频）都是以文件的形式存在于操作系统上的；

Node也有自己的文件系统操作模块，就是fs：

• 借助于Node帮我们封装的文件系统，我们可以在任何的操作系统（window、Mac OS、Linux）上面直接去操作文件；
• 这也是Node可以开发服务器的一大原因，也是它可以成为前端自动化脚本等热门工具的原因；

Node文件系统的API非常的多：https://nodejs.org/dist/latest-v14.x/docs/api/fs.html

• 我们不可能，也没必要一个个去学习；
• 这个更多的应该是作为一个API查询的手册，等用到的时候查询即可；
• 学习阶段我们只需要学习最常用的即可；

但是这些API大多数都提供三种操作方式：

• 方式一：同步操作文件：代码会被阻塞，不会继续执行；
• 方式二：异步回调函数操作文件：代码不会被阻塞，需要传入回调函数，当获取到结果时，回调函数被执行；
• 方式三：异步Promise操作文件：代码不会被阻塞，通过 fs.promises 调用方法操作，会返回一个Promise，可以通过then、catch进行处理；

我们这里以获取一个文件的状态为例：

• 注意：都需要引入 fs 模块；

方式一：同步操作文件

// 1.方式一: 同步读取文件const state = fs.statSync('../foo.txt');
console.log(state);
console.log('后续代码执行');

方式二：异步回调函数操作文件

// 2.方式二: 异步读取
fs.stat("../foo.txt", (err, state) => {
  if (err) {
    console.log(err);
    return;
  }
  console.log(state);
})
console.log("后续代码执行");

方式三：异步Promise操作文件

// 3.方式三: Promise方式
fs.promises.stat("../foo.txt").then(state => {
  console.log(state);
}).catch(err => {
  console.log(err);
})
console.log("后续代码执行");

后续代码演练中，我将以异步回调的方式演练：相对更通用一些；

---

01_fs的三种使用方式.js

const fs = require('fs');

// 案例: 读取文件的信息
const filepath = "./abc.txt";

// 1.方式一: 同步操作
const info = fs.statSync(filepath);
console.log("后续需要执行的代码");
console.log(info);

// 2.方式二: 异步操作
// fs.stat(filepath, (err, info) => {
//   if (err) {
//     console.log(err);
//     return;
//   }
//   console.log(info);
//   console.log(info.isFile());
//   console.log(info.isDirectory());
// });
// console.log("后续需要执行的代码");

// 3.方式三: Promise
// fs.promises.stat(filepath).then(info => {
//   console.log(info);
// }).catch(err => {
//   console.log(err);
// });

// console.log("后续需要执行的代码");

---

1.2. 文件描述符

文件描述符（File descriptors）是什么呢？

在 POSIX 系统上，对于每个进程，内核都维护着一张当前打开着的文件和资源的表格。

• 每个打开的文件都分配了一个称为文件描述符的简单的数字标识符。
• 在系统层，所有文件系统操作都使用这些文件描述符来标识和跟踪每个特定的文件。
• Windows 系统使用了一个虽然不同但概念上类似的机制来跟踪资源。
• 为了简化用户的工作，Node.js 抽象出操作系统之间的特定差异，并为所有打开的文件分配一个数字型的文件描述符。

fs.open() 方法用于分配新的文件描述符。一旦被分配，则文件描述符可用于从文件读取数据、向文件写入数据、或请求关于文件的信息。

// 获取文件描述符
fs.open("../foo.txt", 'r', (err, fd) => {
  console.log(fd);

  fs.fstat(fd, (err, state) => {
    console.log(state);
  })
})

---

const fs = require('fs');

// 获取文件描述符
// fd：file description
fs.open("./abc.txt", (err, fd) => {
  if (err) {
    console.log(err);
    return;
  }

  // 通过描述符去获取文件的信息，文件映射到文件描述符
  fs.fstat(fd, (err, info) => {
    console.log(info);
  })
})

---

1.3. 文件的读写

如果我们希望对文件的内容进行操作，这个时候可以使用文件的读写：

• fs.readFile(path[, options], callback)：读取文件的内容；
• fs.writeFile(file, data[, options], callback)：在文件中写入内容；

文件写入：

fs.writeFile('../foo.txt', content, {}, err => {
  console.log(err);
})

在上面的代码中，你会发现有一个大括号没有填写任何的内容，这个是写入时填写的option参数：

• flag：写入的方式。
• encoding：字符的编码；

我们先来看flag：

• flag的值有很多：https://nodejs.org/dist/latest-v14.x/docs/api/fs.html#fs_file_system_flags
• • w 打开文件写入，默认值；
  • w+打开文件进行读写，如果不存在则创建文件；
  • r+ 打开文件进行读写，如果不存在那么抛出异常；
  • r打开文件读取，读取时的默认值；
  • a打开要写入的文件，将流放在文件末尾。如果不存在则创建文件；
  • a+打开文件以进行读写，将流放在文件末尾。如果不存在则创建文件

我们再来看看编码：

• 我之前在简书上写过一篇关于字符编码的文章：https://www.jianshu.com/p/899e749be47c
• 目前基本用的都是UTF-8编码；

文件读取：

• 如果不填写encoding，返回的结果是Buffer；

fs.readFile('../foo.txt', {encoding: 'utf-8'}, (err, data) => {
  console.log(data);
})

文件读取：

const fs = require('fs');

fs.readFile('../foo.txt', {encoding: 'utf-8'}, (err, data) => {
  console.log(data);
})

---

03_文件的读写.js

const fs = require('fs');

// 1.文件写入
// const content = "你好啊,哈哈哈";

// fs.writeFile('./abc.txt', content, {flag: "a"}, err => {
//   console.log(err);
// });

// 2.文件读取
fs.readFile("./abc.txt", { encoding: 'utf-8' }, (err, data) => {
  console.log(data);
});

---

1.4. 文件夹操作

新建一个文件夹

使用fs.mkdir()或fs.mkdirSync()创建一个新文件夹：

const fs = require('fs');

const dirname = '../why';

if (!fs.existsSync(dirname)) {
  fs.mkdir(dirname, (err) => {
    console.log(err);
  })
}

获取文件夹的内容

// 读取文件夹
function readFolders(folder) {
  fs.readdir(folder, {withFileTypes: true} ,(err, files) => {
    files.forEach(file => {
      if (file.isDirectory()) {
        const newFolder = path.resolve(dirname, file.name);
        readFolders(newFolder);
      } else {
        console.log(file.name);
      }
    })
  })
}

readFolders(dirname);

文件重命名

fs.rename('../why', '../coder', err => {
  console.log(err);
})

---

04_文件夹操作.js

const fs = require('fs');
const path = require('path');

// 1.创建文件夹
const dirname = './kobe';

if (!fs.existsSync(dirname)) {
  fs.mkdir(dirname, err => {
    console.log(err);
  });
}

// 2.读取文件夹中的所有文件
fs.readdir(dirname, (err, files) => {
  console.log(files); // 数组
});

function getFiles(dirname) {
  fs.readdir(dirname, { withFileTypes: true }, (err, files) => {
    for (let file of files) {
      // fs.stat(file) // 可以, 但是有点麻烦
      if (file.isDirectory()) {
        const filepath = path.resolve(dirname, file.name);
        getFiles(filepath);
      } else {
        console.log(file.name);
      }
    }
  });
}

getFiles(dirname);

// 3.重命名
fs.rename("./why", "./kobe", err => {
  console.log(err);
})


// 3.文件夹的重命名
// 补充的
fs.rename('./jianjie/kobe/lilei', './jianjie/kobe/jie', err => console.log(err))