node之path模块

• 2020 年 12 月 24 日
• 筆記
• javascript, path

路径概念介绍

概念

所谓路径，就是定位一个文件所在的位置时，所必须经过 的目录的层级结构的集合.

绝对路径与相对路径

• windows 下的相对与绝对路径

  资料原文

  完全限定路径(绝对路径)与相对路径

  对于操作文件的 Windows API 函数，文件名通常可以相对于当前目录，而一些 API 需要一个完全限定的路径。如果文件名不是用下列内容之一开头的，则该文件名是相对路径(相对于当前工作目录):

  • 任何格式的通用命名约定(UNC)名称: 总是以两个反斜杠字符(“\”)开头

  • 带冒号与反斜杠的磁盘指示符，例如“C:\”或“d:\”

  • 一个反斜杠，例如，“\directory”或“\file.txt”,这也属于绝对路径

  如果文件名仅以磁盘指示符开头，后面不带冒号加反斜杠的组合，则它将被解释为该磁盘驱动器上当前目录的相对路径。
  注意，当前目录可能是根目录，也可能不是根目录，这取决于最近在该磁盘上进行“更改目录(cd)”操作时将其设置为什么。这种格式的例子如下:

  • “C: tmp.txt”指的是一个在驱动器 C 上的当前目录中,名为“tmp”的文件
  • “C: tempdir \ tmp.txt”指的是 C 驱动器上当前目录的子目录中的一个文件

  代码示例:(DOS)

  cd "C:\windows"
  
  node C:test.js ::执行C:\windows\test.js
  node D:test.js ::执行D:\test.js
  

  如果一个路径包含“双点”，亦即，路径的一个组件是两个连续的点,它也被称为相对路径;。这个特殊的说明符用于表示当前目录之上的目录，也称为“父目录”。这种格式的例子如下:

  • “. . \ tmp.txt”指定一个名为 tmp.txt 的文件，该文件位于当前目录的父目录中。

  • “. . \ . . \ tmp.txt“指定当前目录之上两个目录的文件。

  • “. . \ tempdir \ tmp.txt”指定一个名为 tmp.txt 的文件，它位于一个名为 tempdir 的目录中，该目录是当前目录的对等目录

  相对路径可以组合这两种示例类型使用，例如“C:..\tmp.txt” , 这是有效的,因为,尽管系统持续跟踪记录当前驱动器的当前目录 . 它还跟踪所有驱动器(如果你的系统有不止一个)中的当前目录, 不管当前驱动器是被设置为哪一个.

  DOS 举例：

  cd /d "D:\test1\test2\test3" ::系统追踪记录D盘及D盘当前目录为D:\test1\test2\test3
  cd /d "C:\windows\Boot" ::系统追踪记录C盘及C盘当前目录为C:\windows\Boot
  cd /d "E:\video" ::系统追踪记录E盘及E盘当前目录为E:\video
  
  node D:..\test.js ::执行D:\test1\test2\test.js
  node C:..\test.js ::执行C:\windows\test.js
  ::注意-所谓追踪和记录多个盘的当前目录,指的是在同一个cmd会话之中记录,多个cmd会话之间是不共享的
  

Windows 与 POSIX 的对比

• 什么是 POSIX

  可移植操作系统接口(Portable Operating System Interface，缩写为 POSIX):

  1. 是 IEEE 为要在各种 UNIX 操作系统上运行软件，而定义 API 的一系列互相关联的标准的总称，其正式称呼为 IEEE Std 1003，而国际标准名称为 ISO/IEC 9945

  2. 它基本上是 Portable Operating System Interface（可移植操作系统接口）的缩写，而 X 则表明其对 Unix API 的传承

  3. Linux 基本上逐步实现了 POSIX 兼容，但并没有参加正式的 POSIX 认证。

  简单来看，POSIX 就是 UNIX 与类 UNIX 系统.

• POSIX 与 windows 上路径的区别

  • 路径分隔符

    windows 下使用的是“\”作为分隔符，而 linux 则反其道而行之使用”/”作为分隔符.所以在 windows 环境中获取路径常见 C:\windows\system 的形式，而 linux 常见 /user/share 的形式

  • 绝对路径

    • windows: 以盘符开始,如 C:\a.txt
    • linux: 以根目录/开始, 如/user/share

• 更多参考

path 模块对 windows 与 POSIX 路径的处理方案

• windows 路径的注意事项

  因为 windows 使用反斜杠\作为路径分隔符, 而 js 中的反斜杠被用来对特殊字符进行转义. 因此,直接的 windows 文件路径字符串是不能直接在 node 程序中使用的.举例如下:

  let path = require("path");
  let raw = “C:\Windows\node\”;
  
  console.log(path.basename(rawPath));
  // 输出:
  // Windows
  // ode
  // 原因: \node 中的 \n 被解析为一个换行符
  

不过不需要担心,我们只需要在 js 源代码中注意不要这么草率地直接使用这种字面量即可.像是从另一个文件读取内容这种操作,在读取过程中,node 会自动对其中的反斜杠进行转义,不需要我们来操心.如下例:

raw.txt:

C:\Windows\node

test.js

let path = require("path");
let fs = require("fs");

let raw = fs.readFileSync("./raw.txt", "utf-8"); //文件读取时,会将C:\Windows\node自动转义为C:\\Windows\\node
console.log(path.basename(raw)); //node

• path 模块对 windows 与 POSIX 的解决方案

  path 提供了 path.win32 与 path.posix 两个属性来分别解决 windows 与 posix 类型的路径.

  let path = require("path");
  
  console.log("path:\n");
  console.log(Object.keys(path).length);
  console.log(Object.keys(path));
  
  console.log("path.win32:\n");
  console.log(Object.keys(path.win32).length);
  console.log(Object.keys(path.win32));
  
  console.log("path.posix:\n");
  console.log(Object.keys(path.posix).length);
  console.log(Object.keys(path.posix));
  
  // 输出:
  // path:
  // 16
  // [
  //   'resolve',    'normalize',
  //   'isAbsolute', 'join',
  //   'relative',   'toNamespacedPath',
  //   'dirname',    'basename',
  //   'extname',    'format',
  //   'parse',      'sep',
  //   'delimiter',  'win32',
  //   'posix',      '_makeLong'
  // ]
  // path.win32:
  // 16
  // [
  //   'resolve',    'normalize',
  //   'isAbsolute', 'join',
  //   'relative',   'toNamespacedPath',
  //   'dirname',    'basename',
  //   'extname',    'format',
  //   'parse',      'sep',
  //   'delimiter',  'win32',
  //   'posix',      '_makeLong'
  // ]
  // path.posix:
  // 16
  // [
  //   'resolve',    'normalize',
  //   'isAbsolute', 'join',
  //   'relative',   'toNamespacedPath',
  //   'dirname',    'basename',
  //   'extname',    'format',
  //   'parse',      'sep',
  //   'delimiter',  'win32',
  //   'posix',      '_makeLong'
  // ]
  

  三个对象都拥有完全一样的属性与方法.path 中的主要方法都有对应的 win32 和 posix 版本来分别处理两种不同的路径风格.

路径组件获取

说明: 路径组件的获取函数(方法),都只是基于最基本的字符匹配模式的操作,不会对.或..进行解析和运算.

path.basename

语法

path.basename(path[, ext])

• 返回 path 的最后一部分

• 尾部的分隔符会被忽略

• 传入可选参数 ext(扩展名),可在结果中过滤掉扩展名

  • ext 参数区分大小写(.html 与.HTML 为不同扩展名)

  • 这与 windows 无视文件扩展名大小写的行为不同.

  • 其实质可以视为:

    path.basename(path).replace(ext,"")

  path.basename("/目录1/目录2/文件.html");
  // 返回: '文件.html'
  path.basename("/目录1/目录2/文件.html", ".html");
  // 返回: '文件'
  path.basename("/目录1/目录2/文件.HTML", ".html");
  // 返回: '文件.HTML'
  

path.dirname

语法

path.dirname(path)

• 返回 path 的目录名
• 尾部的目录分隔符(path.sep)会被忽略

path.dirname('/目录1/目录2/目录3');
// 返回: '/目录1/目录2'

说明: 路径组件的获取函数(方法),都只是基于最基本的字符匹配模式的操作,不会对.或..进行解析和运算.
举例如下:

let path = require("path");

let p1 = "c:\\windows\\node\\test\\..\\";
console.log(path.basename(p1)); //输出 ..

let p2 = "c:\\windows\\node\\..\\test\\test.md";
console.log(path.dirname(p2)); //输出 c:\windows\node\..\test

path.delimiter

这是一个属性值，返回平台特定的路径定界符

• windows: 分号;
• posix: 冒号:

path.extname

这是一个属性值,返回路径中的扩展名

扩展名:

• path 的最后一部分中从最后一次出现 . （句点）字符直到字符串结束
• path 最后一部分中没有.，或者 path 的基本名称(basename)除了第一个字符以外没有.，则返回空字符
  串

path.sep

这是一个属性值,平台特定的路径片段(组件)分隔符

• Windows: 反斜杠\
• POSIX: 正斜杠/

路径处理函数

说明: 路径处理函数,不同于路径组件的获取函数,会对路径中的.及..进行解析,也就是基于相对路径语法进行路径运算.

path 模块的内容:

• 错误处理: ERR_INVALID_ARG_TYPE
• 关键字符的 unicode 码点常量: require 自 internal/constants
• 字符串类型验证: validateString
• 工具函数
  • 路径分隔符判断: isPathSeparato
  • POSIX 分隔符判断: isPosixPathSeparator
  • windows 盘符判断: isWindowsDeviceRoot
  • 相对路径解析(解析.或..): normalizeString
  • path 对象格式化为字符串: _format
• windows 平台系列处理函数封装: win32 对象
• POSIX 平台系列处理函数封装： posix 对象

主要函数的调用关系

win32 与 posix 对象

• 各自包含一整套特定于对应平台的路径获取与路径处理函数
• 各自包含指向对方的引用

示例图：