Node专栏-path（路径）模块

path (路径)

path模块提供了一些实用工具，用于处理文件和目录的路径。

可以使用以下方式访问：

const path = require('path');

path.basename(path[,ext])

• path <string>
• ext <string> 可选的文件扩展名
• 返回 <string>

path.basename() 方法会返回path的最后一部分，类似于 Unix的 basename命令。 尾部的目录分割符会被忽略。

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

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

尽管 Windows 通常以不区分大小写的方式处理文件名（包括文件扩展名），但是此函数不会这样。 例如， C:\\文件.html 和 C:\\文件.HTML 指向相同的文件，但是 basename 会将扩展名视为区分大小写的字符串：

path.win32.basename('C:\\文件.html', '.html');
// 返回: '文件'

path.win32.basename('C:\\文件.HTML', '.html');
// 返回: '文件.HTML'

如果 path 不是字符串、或给定了 ext 但不是字符串，则抛出 TypeError。

下图演示为macOS中的案例子：

path.delimiter

• <string> 提供平台特定的路径定界符：

• ; 用于 Windows

• : 用于 POSIX 例如，在 POSIX 上

console.log(process.env.PATH);
// 打印: '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'

process.env.PATH.split(path.delimiter);
// 返回: ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']

在 Windows 上：

console.log(process.env.PATH);
// 打印: 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'

process.env.PATH.split(path.delimiter);
// 返回: ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']

下图演示为macOS中的案例子：

path.dirname(path)

• path <string>
• 返回: <string>

path.dirname()方法会返回 path 的目录名，类似于 Unix 的 dirname 命令。 尾部的目录分隔符会被忽略，参见 path.sep。

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

path.extname(path)

• path <string>
• 返回: <string>

path.extname()方法会返回 path的扩展名，即path的最后一部分中从最后一次出现的.(句点)字符直到字符串结束。如果在path的最后一部分中没有.，或者如果path的基本名称（path.basename()）除了第一个字符以外没有.,则返回空字符串。

path.extname('index.html');
// 返回: '.html'

path.extname('index.coffee.md');
// 返回: '.md'

path.extname('index.');
// 返回: '.'

path.extname('index');
// 返回: ''

path.extname('.index');
// 返回: ''

path.extname('.index.md');
// 返回: '.md'

下图演示为macOS中的案例子：

--- 待更新----

path.format(pathObject)

• pathObject<Object>
  • dir <string>
  • root <string>
  • base <string>
  • name <string>
  • ext <string>返回: <string> path.format() 方法从对象返回路径字符串。 与 path.parse() 相反。

当为 pathObject提供属性时，注意以下组合，其中一些属性优先于另一些属性：

- 如果提供了 pathObject.dir，则忽略 pathObject.root。
- 如果 pathObject.base 存在，则忽略 pathObject.ext 和 pathObject.name。

例如，在 POSIX 上：

// 如果提供了 `dir`、 `root` 和 `base`，
// 则返回 `${dir}${path.sep}${base}`。
// `root` 会被忽略。
path.format({
  root: '/ignored',
  dir: '/home/user/dir',
  base: 'file.txt'
});
// 返回: '/home/user/dir/file.txt'

// 如果未指定 `dir`，则使用 `root`。 
// 如果只提供 `root`，或 'dir` 等于 `root`，则将不包括平台分隔符。 
// `ext` 将被忽略。
path.format({
  root: '/',
  base: 'file.txt',
  ext: 'ignored'
});
// 返回: '/file.txt'

// 如果未指定 `base`，则使用 `name` + `ext`。
path.format({
  root: '/',
  name: 'file',
  ext: '.txt'
});
// 返回: '/file.txt'

在window上：

path.format({
  dir: 'C:\\path\\dir',
  base: 'file.txt'
});
// 返回: 'C:\\path\\dir\\file.txt'

下图演示为macOS中的案例子：

path.isAbsolute(path)

path.isAbsolute() 方法检测 path 是否为绝对路径。

• path <string>
• 返回： <boolean>

如果给定的 path是零长度字符串，则返回false.

在POSIX上

path.isAbsolute('/foo/bar'); // true
path.isAbsolute('/baz/..');  // true
path.isAbsolute('qux/');     // false
path.isAbsolute('.');        // false

在Windows上：

path.isAbsolute('//server');    // true
path.isAbsolute('\\\\server');  // true
path.isAbsolute('C:/foo/..');   // true
path.isAbsolute('C:\\foo\\..'); // true
path.isAbsolute('bar\\baz');    // false
path.isAbsolute('bar/baz');     // false
path.isAbsolute('.');           // false

下图演示为macOS中的案例子：

--------2021.2.25日更新------------------

path.join([...paths])

• ...path <string> 路径片段的序列
• 返回： <string>

path.join()方法会将所有给定的path片段连接到一起（使用平台特定的分隔符作为定界符），然后规范化生成的路径。 长度为零的path片段会被忽略。如果连接后的路径字符串为长度为零的字符串，则返回 '.'，表示当前工作目录。

path.join('/目录1', '目录2', '目录3/目录4', '目录5', '..');
// 返回: '/目录1/目录2/目录3/目录4'

path.join('目录1', {}, '目录2');
// 抛出 'TypeError: Path must be a string. Received {}'

下图演示为macOS中的案例子：

path.normalize(path)

• path <string>
• 返回: <string> path.normalize() 方法规范化给定的 path，解析 '..' 和 '.' 片段。

当找到多个连续的路径段分隔字符时（例如 POSIX 上的 /、Windows 上的 \ 或/），则它们将被替换为单个平台特定的路径段分隔符（POSIX 上的 /、Windows 上的 \）。 尾部的分隔符会保留。

如果 path 是零长度的字符串，则返回 '.'，表示当前工作目录。 在 POSIX 上：

path.normalize('/foo/bar//baz/asdf/quux/..');
// 返回: '/foo/bar/baz/asdf'

在 Windows 上：

path.normalize('C:\\temp\\\\foo\\bar\\..\\');
// 返回: 'C:\\temp\\foo\\'

由于 Windows 识别多种路径分隔符，因此这些分隔符都将被替换为 Windows 首选的分隔符（\）：

path.win32.normalize('C:////temp\\\\/\\/\\/foo/bar');
// 返回: 'C:\\temp\\foo\\bar'

下图演示为macOS中的案例子：

path.parse(path)

• path <string>
• 返回: <Object>
• path.parse() 方法会返回一个对象，其属性表示 path 的有效元素。

返回的对象具有以下属性：

• dir <string>
• root <string>
• base <string>
• name <string>
• ext <string>

在POSIX:

path.parse('/目录1/目录2/文件.txt');
// 返回:
// { root: '/',
//   dir: '/目录1/目录2',
//   base: '文件.txt',
//   ext: '.txt',
//   name: '文件' }

在 Windows 上：

path.parse('C:\\目录1\\目录2\\文件.txt');
// 返回:
// { root: 'C:\\',
//   dir: 'C:\\目录1\\目录2',
//   base: '文件.txt',
//   ext: '.txt',
//   name: '文件' }

下图演示为macOS中的案例子：

path.posix

新增于: v0.11.15

path.posix 属性提供对 path 方法的 POSIX 特定实现的访问。

下图演示为macOS中的案例子：

path.relative(from,to)

• from <string>
• to <string>
• 返回: <string>

path.relative() 方法根据当前工作目录返回 from到 to 的相对路径。 如果 from 和 to 各自解析到相同的路径（分别调用 path.resolve() 之后），则返回零长度的字符串。

如果将零长度的字符串传入 from 或 to，则使用当前工作目录代替该零长度的字符串。

在 POSIX 上：

path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb');
// 返回: '../../impl/bbb'

在windows上：

path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb');
// 返回: '..\\..\\impl\\bbb'

path.resolve([...paths])

• ...paths <string> 路径或路径片段的序列。
• 返回: <string>

path.resolve() 方法会将路径或路径片段的序列解析为绝对路径。

给定的路径序列会从右到左进行处理，后面的每个 path 会被追加到前面，直到构造出绝对路径。 例如，给定的路径片段序列：/目录1、 /目录2、 目录3，调用 path.resolve('/目录1', '/目录2', '目录3') 会返回 /目录2/目录3，因为 '目录3' 不是绝对路径，但 '/目录2' + '/' + '目录3' 是。

如果在处理完所有给定的path 片段之后还未生成绝对路径，则会使用当前工作目录。

生成的路径会被规范化，并且尾部的斜杠会被删除（除非路径被解析为根目录）。

零长度的path 片段会被忽略。

如果没有传入 path 片段，则 path.resolve() 会返回当前工作目录的绝对路径。

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

path.resolve('/目录1/目录2', '/目录3/目录4/');
// 返回: '/目录3/目录4'

path.resolve('目录1', '目录2/目录3/', '../目录4/文件.gif');
// 如果当前工作目录是 /目录A/目录B，
// 则返回 '/目录A/目录B/目录1/目录2/目录4/文件.gif'

下图演示为macOS中的案例子：

path.sep

• <string>

提供平台特定的路径片段分隔符：

• Windows 上是 \。
• POSIX 上是 /。 在POSIX上：

'foo/bar/baz'.split(path.sep);
// 返回: ['foo', 'bar', 'baz']

在Windows上：

'foo\\bar\\baz'.split(path.sep);
// 返回: ['foo', 'bar', 'baz']

在 Windows 上，正斜杠（/）和反斜杠（\）都被接受为路径片段分隔符。 但是， path 方法只添加反斜杠（\）。

path.toNamespacedPath(path)

• path <string>
• 返回: <string>

仅在 Windows 系统上，返回给定 path 的等效名称空间前缀路径。 如果 path 不是字符串，则将返回 path 而不进行修改。

此方法仅在 Windows 系统上有意义。 在 POSIX 系统上，该方法不可操作，并且始终返回 path 而不进行修改。

macOS中呈现：

path.win32

• <Object> path.win32 属性提供对特定于 Windows 的 path 方法的实现的访问。

macOS中呈现：