简介

nodejs 应用了异步 IO 来晋升服务端的解决效率。而 IO 中一个十分重要的方面就是文件 IO。明天咱们会具体介绍一下 nodejs 中的文件系统和 IO 操作。

nodejs 中的文件系统模块

nodejs 中有一个十分重要的模块叫做 fs。这个模块提供了许多十分实用的函数来拜访文件系统并与文件系统进行交互。

简略统计一下，fs 提供了上面这么多种应用的文件操作方法：

• fs.access(): 查看文件是否存在，以及 Node.js 是否有权限拜访。
• fs.appendFile(): 追加数据到文件。如果文件不存在，则创立文件。
• fs.chmod(): 更改文件（通过传入的文件名指定）的权限。相干办法：fs.lchmod()、fs.fchmod()。
• fs.chown(): 更改文件（通过传入的文件名指定）的所有者和群组。相干办法：fs.fchown()、fs.lchown()。
• fs.close(): 敞开文件描述符。
• fs.copyFile(): 拷贝文件。
• fs.createReadStream(): 创立可读的文件流。
• fs.createWriteStream(): 创立可写的文件流。
• fs.link(): 新建指向文件的硬链接。
• fs.mkdir(): 新建文件夹。
• fs.mkdtemp(): 创立长期目录。
• fs.open(): 设置文件模式。
• fs.readdir(): 读取目录的内容。
• fs.readFile(): 读取文件的内容。相干办法：fs.read()。
• fs.readlink(): 读取符号链接的值。
• fs.realpath(): 将绝对的文件门路指针（.、..）解析为残缺的门路。
• fs.rename(): 重命名文件或文件夹。
• fs.rmdir(): 删除文件夹。
• fs.stat(): 返回文件（通过传入的文件名指定）的状态。相干办法：fs.fstat()、fs.lstat()。
• fs.symlink(): 新建文件的符号链接。
• fs.truncate(): 将传递的文件名标识的文件截断为指定的长度。相干办法：fs.ftruncate()。
• fs.unlink(): 删除文件或符号链接。
• fs.unwatchFile(): 进行监督文件上的更改。
• fs.utimes(): 更改文件（通过传入的文件名指定）的工夫戳。相干办法：fs.futimes()。
• fs.watchFile(): 开始监督文件上的更改。相干办法：fs.watch()。
• fs.writeFile(): 将数据写入文件。相干办法：fs.write()。

留神，下面 fs 提供的办法都是异步的，所谓异步的意思是，这些办法都提供了回调函数，不便异步触发相应的解决逻辑。

咱们举一个简略的读取文件的例子：

const fs = require('fs')

fs.readFile('/tmp/flydean.txt', 'utf8' , (err, data) => {if (err) {console.error(err)
    return
  }
  console.log(data)
})

下面的例子中，咱们从 /tmp 文件中读取了一个 flydean.txt 文件。并在 callback 函数中别离对异样和失常的数据进行了解决。

fs 在提供异步办法的同时，还提供了同步的办法调用，这个同步的办法就是在异步办法前面加上 Sync：

const fs = require('fs')

try {const data = fs.readFileSync('/tmp/flydean.txt', 'utf8')
  console.log(data)
} catch (err) {console.error(err)
}

看下将下面的办法改写成同步办法之后的样子。

两者的区别就是，同步办法会阻塞，始终等到 file 读取实现。

Promise 版本的 fs

异步操作怎么能少得了 Promsie, 因为 fs 中的操作都是异步的，如果大家不想通过 callback 来应用 fs 的话，fs 也提供了 Promise 版本。

还是刚刚的 readfile 的例子，咱们看看如果应用 Promise 该怎么解决：

const fs = require('fs/promises');

(async function(path) {
  try {
    await fs.readFile(path, 'utf8'）;
    console.log(` 读取文件胜利 ${path}`);
  } catch (error) {console.error('出错：', error.message);
  }
})('/tmp/flydean.txt');

fs 的 promise 版本在 fs/promises 上面，下面的例子中咱们应用了 async 和 await，以同步的形式编写异步程序，十分的不便。

文件描述符

文件描述符就是指在 nodejs 中，当咱们应用 fs.open 办法取得的这个返回值。

咱们能够通过这个文件描述符来提高和文件进行交互操作。

const fs = require('fs')

fs.open('/tmp/flydean.txt', 'r', (err, fd) => {//fd 是文件描述符。})

下面的 open 办法的第二个参数示意以只读的形式关上文件。

咱们看下罕用的文件系统标记：

• ‘r’: 关上文件用于读取。如果文件不存在，则会产生异样。
• ‘r+’: 关上文件用于读取和写入。如果文件不存在，则会产生异样。
• ‘w’: 关上文件用于写入。如果文件不存在则创立文件，如果文件存在则截断文件。
• ‘w+’: 关上文件用于读取和写入。如果文件不存在则创立文件，如果文件存在则截断文件。
• ‘a’: 关上文件用于追加。如果文件不存在，则创立该文件。
• ‘a+’: 关上文件用于读取和追加。如果文件不存在，则创立该文件。

当然，下面的例子也能够用 openSync 来改写：

const fs = require('fs')

try {const fd = fs.openSync('/tmp/flydean.txt', 'r')
} catch (err) {console.error(err)
}

fs.stat 文件状态信息

nodejs 提供了一个 fs.Stats 类，用来形容文件的状态信息。

Stats 提供了一些十分有用的办法来判断文件的状态：

比方：
stats.isDirectory()，stats.isFile()，stats.isSocket()，stats.isSymbolicLink()，stats.ctime 等。

stats 还提供了一些对于文件工夫相干的选项：

• atime “ 拜访工夫 ” – 上次访问文件数据的工夫。
• mtime “ 批改工夫 ” – 上次批改文件数据的工夫。
• ctime “ 更改工夫 ” – 上次更改文件状态（批改索引节点数据）的工夫。
• birthtime “ 创立工夫 ” – 创立文件的工夫。

咱们看一下怎么获取到 fs.stat:

const fs = require('fs')
fs.stat('/tmp/flydean.txt', (err, stats) => {if (err) {console.error(err)
    return
  }

  stats.isFile() //true
  stats.isDirectory() //false
  stats.isSymbolicLink() //false
  stats.size // 文件大小
})

fs.Stats 将会作为 fs.stat 的回调函数参数传入。通过 fs.Stats，咱们再进行一系列的操作。

fs 的文件读写

下面咱们介绍了应用 fs 进行文件读取操作，上面咱们来介绍怎么应用 fs 来进行文件写入操作：

const fs = require('fs')

const content = 'www.flydean.com'

fs.writeFile('/tmp/flydean.txt', content, err => {if (err) {console.error(err)
    return
  }
  // 文件写入胜利。})

下面是一个 callback 版本的，咱们再看一个同步版本的：

const fs = require('fs')

const content = 'www.flydean.com'

try {const data = fs.writeFileSync('/tmp/flydean.txt', content)
  // 文件写入胜利。} catch (err) {console.error(err)
}

writeFile 还反对一个额定的 options 参数，在 options 参数中，咱们能够指定文件写入的 flag 标记位，比方：r+，w+，a，a+ 等等。

fs.writeFile('/tmp/flydean.txt', content, { flag: 'a+'}, err => {})

当然，除了应用 a + 示意 append 到文件开端之外，fs 还提供了一个 appendFile 办法来向文件开端输入：

const fs = require('fs')

const content = 'www.flydean.com'

fs.appendFile('/tmp/flydean.txt', content, err => {if (err) {console.error(err)
    return
  }
  // 文件 append 胜利。})

fs 的文件夹操作

有文件就有文件夹，fs 提供了一系列的文件夹操作，比方：

mkdir，readdir，rename rmdir 操作。

readdir 相对而言负责点，咱们举例说明：

const fs = require('fs')
const folderPath = '/tmp'

fs.readdir(folderPath, function(err,files){if(err){console.log(err);
    }
    files.map(file => console.log(file));
})

fs.readdirSync(folderPath).map(fileName => {console.log(fileName);
})

下面的例子中，咱们别离应用了 readdir 和 readdirSync 两种形式来读取目录中的文件。

大家能够看下其中的区别。

path 操作

最初，咱们介绍一个和 file 特地相干的 path 操作，它提供了一些实用工具，用于解决文件和目录的门路。

path 代表的是门路。咱们通过上面的形式来应用 path：

const path = require('path')

为什么须要 path 呢？咱们晓得这个世界上大概有两种格调的操作系统，windows 和 POSIX。

在这两种操作系统中，门路的表达方式是不一样的。所以，咱们须要一个通用的 path 模块来为咱们解决这个差别。

咱们能够通过一个例子来察看这个差别：

在 windows 上：

path.basename('C:\\temp\\myfile.html');
// 返回: 'myfile.html'

在 POSIX 上：

path.basename('C:\\temp\\myfile.html');
// 返回: 'C:\\temp\\myfile.html'

咱们先来看一下 path.basename 这个办法，是用来返回 path 的最初一部分。

下面的例子中，咱们向 windows 传入了一个 windows 格调的 path，所以能够失常解析，失去失常的后果。

而在 POSIX 环境中，咱们传入了一个 windows 格调的门路，无奈失常解析，间接返回整个的后果。

path 还有很多十分有用的办法，比方：

const notes = '/tmp/notes.txt'

path.dirname(notes) // /tmp
path.basename(notes) // notes.txt
path.extname(notes) // .txt

path.join('/', 'tmp', 'notes.txt') //'/tmp/notes.txt'

path.resolve('notes.txt') //'/Users/flydean/notes.txt' 从当前目录开始解析，取得相对路径的绝对路径

path.normalize('/tmp/flydean..//test.txt') ///tmp/test.txt  尝试计算理论的门路 

本文作者：flydean 程序那些事

本文链接：http://www.flydean.com/nodejs-file-system/

本文起源：flydean 的博客

欢送关注我的公众号:「程序那些事」最艰深的解读，最粗浅的干货，最简洁的教程，泛滥你不晓得的小技巧等你来发现！