走进node.js - 文件持续创作，加速成长！这是我参与「掘金日新计划 · 6 月更文挑战」的第25天，点击查看活动详

持续创作，加速成长！这是我参与「掘金日新计划 · 6 月更文挑战」的第25天，点击查看活动详情

node.js - 文件学习目标

同步和异步概念

基本的文件读写

path 模块基本使用

文件操作的相对路径

同步和异步

fs 模块对文件的几乎所有操作都有同步和异步两种形式，例如：readFile() 和 readFileSync()。

同步与异步文件系统调用的区别

同步调用立即执行，会阻塞后续代码继续执行，如果想要捕获异常需要使用 try-catch
异步调用不会阻塞后续代码继续执行，需要回调函数作为额外的参数，通常包含一个错误作为回调函数的第一个参数
异步调用通过判断第一个 err 对象来处理异常
异步调用结果往往通过回调函数来进行获取

Node 只在文件 IO 操作中，提供了同步调用和异步调用两种形式，两者可以结合使用，但是推荐能使用异步调用解决问题的情况下，少用同步调用。

对于文件操作，Node 几乎为所有的文件操作 API 提供了同步操作和异步操作两种方式。

同步会阻塞程序的执行，效率低（知道就行）
异步相当于多找了一个人帮你干活，效率高
所以建议：尽量使用异步

常用 API

API	作用	备注
fs.access(path, callback)	判断路径是否存在
fs.appendFile(file, data, callback)	向文件中追加内容
fs.copyFile(src, callback)	复制文件
fs.mkdir(path, callback)	创建目录
fs.readDir(path, callback)	读取目录列表
fs.rename(oldPath, newPath, callback)	重命名文件/目录
fs.rmdir(path, callback)	删除目录	只能删除空目录
fs.stat(path, callback)	获取文件/目录信息
fs.unlink(path, callback)	删除文件
fs.watch(filename[, options][, listener])	监视文件/目录
fs.watchFile(filename[, options], listener)	监视文件

path 模块

path 是 Node 本身提供的一个核心模块，专门用来处理路径。

使用它的第一步就是先加载：

const path = require("path");

path.basename

获取一个路径的文件名部分

path.basename("/foo/bar/baz/asdf/quux.html");
// Returns: 'quux.html'

path.basename("/foo/bar/baz/asdf/quux.html", ".html");
// Returns: 'quux'

path.dirname

path.dirname("/foo/bar/baz/asdf/quux");
// Returns: '/foo/bar/baz/asdf'

path.extname

获取一个路径的后缀名部分

path.extname("index.html");
// Returns: '.html'

path.extname("index.coffee.md");
// Returns: '.md'

path.extname("index.");
// Returns: '.'

path.extname("index");
// Returns: ''

path.extname(".index");
// Returns: ''

path.parse

将一个路径转换为一个对象，得到路径的各个组成部分

path.parse("/home/user/dir/file.txt");
// Returns:
// { root: '/',
//   dir: '/home/user/dir',
//   base: 'file.txt',
//   ext: '.txt',
//   name: 'file' }

path.format(pathObject)

将具有特定属性的对象转换为一个路径

// If `dir`, `root` and `base` are provided,
// `${dir}${path.sep}${base}`
// will be returned. `root` is ignored.
path.format({
  root: "/ignored",
  dir: "/home/user/dir",
  base: "file.txt"
});
// Returns: '/home/user/dir/file.txt'

// `root` will be used if `dir` is not specified.
// If only `root` is provided or `dir` is equal to `root` then the
// platform separator will not be included. `ext` will be ignored.
path.format({
  root: "/",
  base: "file.txt",
  ext: "ignored"
});
// Returns: '/file.txt'

// `name` + `ext` will be used if `base` is not specified.
path.format({
  root: "/",
  name: "file",
  ext: ".txt"
});
// Returns: '/file.txt'

path.join

将多个路径拼接为一个

path.join("/foo", "bar", "baz/asdf", "quux", "..");
// Returns: '/foo/bar/baz/asdf'

path.join("foo", {}, "bar");
// throws 'TypeError: Path must be a string. Received {}'

文件操作的相对路径

操作文件使用相对路径都使用 path.join() 方法结合 __dirname 来避免问题。

路径分类

和大多数路径规则一样，在 Node 中的路径规则同样遵守以下方式：

绝对路径

以 / 开头的路径，例如 /a/b/c
- 在 Linux 中就是操作系统的根路径
- 在 Windows 中是当前 JavaScript 脚本所属磁盘根路径
以 c:/ 开头的盘符路径，例如 c:/a/b/c
- 相对路径
以 ./ 开头的相对路径，例如 ./a/b/c
- 在这里 ./ 可以省略，a/b/c 等价于 ./a/b/c
- 注意，. 不能省略，否则 /a/b/c 就是一个绝对路径
以 ../ 开头的相对路径，例如 ../a/b/c

// 相对于当前路径
fs.readFile("./README.md");

// 相对当前路径，可以省略 ./
// 注意：加载模块中的标识路径不能省略 ./
fs.readFile("README.md");

// 绝对路径
fs.readFile("c:/README.md");

// 绝对路径，当前 js 脚本所处磁盘根目录
fs.readFile("/README.md");

__dirname 和 __filename

在每个模块中，除了 require、exports 等模块成员之外，还有两个特殊的成员：

__dirname 动态获取 当前文件模块所属目录的绝对路径
__filename 动态获取 当前文件的绝对路径 dirname和__filename` 是不受执行 node 命令所属路径影响的

走进node.js - 文件

往期推荐