Node-内置模块：路径 path

目录

• 获取路径/文件名/拓展名
• 路径组合
• 路径解析
• 获取相对路径
• 判断是否为绝对路径

1、获取路径/文件名/拓展名

• 获取路径：path.dirname(filepath)
• 获取文件名：path.basename(filepath)
• 获取扩展名：path.extname(filepath)

1.1 获取路径 path.dirname()

const path = require('path');

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

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

1.2 获取文件名 path.basename()

严格意义上来说，path.basename(filepath) 只是输出路径的最后一部分，并不会判断是否文件名。

var path = require('path');

// 输出：test.js
console.log( path.basename('/tmp/demo/js/test.js') );

// 输出：test
console.log( path.basename('/tmp/demo/js/test/') );

// 输出：test
console.log( path.basename('/tmp/demo/js/test') );

如果只想获取文件名，单不包括文件扩展呢？可以用上第二个参数。

// 输出：test
console.log( path.basename('/tmp/demo/js/test.js', '.js') );

1.3 获取文件扩展名 path.extname()

var path = require('path');
var filepath = '/tmp/demo/js/test.js';

// 输出：.js
console.log( path.extname(filepath));

更详细的规则是如下：（假设 path.basename(filepath) === B ）
- 从B的最后一个 . 开始截取，直到最后一个字符。
- 如果B中不存在 . ，或者B的第一个字符就是 . ，那么返回空字符串。

官方文档上面的例子

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

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

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

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

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

2、路径组合

• path.join([…paths])
• path.resolve([…paths])

2.1 path.join()

path.join() 方法使用平台特定的分隔符把全部给定的 path 片段连接到一起，并规范化生成的路径，会调用 path.normalize()。

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

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

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

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

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

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

2.2 path.resolve()

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

给定的路径的序列是从右往左被处理的，后面每个 path 被依次解析，直到构造完成一个绝对路径。 例如，给定的路径片段的序列为：/foo、/bar、baz，则调用 path.resolve('/foo', '/bar', 'baz') 会返回 /bar/baz。

如果处理完全部给定的 path 片段后还未生成一个绝对路径，则当前工作目录会被用上。

生成的路径是规范化后的，且末尾的斜杠会被删除，除非路径被解析为根目录。

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

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

path.resolve('/foo/bar', './baz');
// 返回: '/foo/bar/baz'

path.resolve('/foo/bar', '/tmp/file/');
// 返回: '/tmp/file'

path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif');
// 如果当前工作目录为 /home/myself/node，
// 则返回 '/home/myself/node/wwwroot/static_files/gif/image.gif'

3、路径解析

• path.normalize(path)
• path.parse(path)
• path.format(path)

3.1 path.normalize

path.normalize(path) 方法会规范化给定的 path，并解析 '..' 和 '.' 片段。

• 当发现多个连续的路径分隔符时（如 POSIX 上的 / 与 Windows 上的 \ 或 /），它们会被单个的路径分隔符来代替。
• 末尾的多个分隔符会被保留。
• 如果 path 是一个空字符串，则返回 '.'，表示当前工作目录。

path.normalize('/foo/bar//baz/asdf/quux/..');
// 返回: '/foo/bar/baz/asdf'，解析了 .. ，返回了上一层目录

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

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

path.normalize('/foo/bar//baz/asdf/quux//');
// 返回: '/foo/bar/baz/asdf/quux/', 末尾的多个分隔符，只保留了一个

path.normalize('');
// 返回：'.'，表示当前工作目录

3.2 path.parse(path)

path.parse() 方法返回一个对象，对象的属性表示 path 的元素。 尾部文件分隔符会被忽略。

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

path.parse('/home/user/dir/file/');
// 返回:
// { root: '/',
//   dir: '/home/user/dir',
//   base: 'file',
//   ext: '',
//   name: 'file' }
// 尾部的文件分隔符会被忽略

3.3 path.format(pathObject)

path.format() 方法会从一个对象返回一个路径字符串。 与 path.parse() 相反。

当 pathObject 提供的属性有组合时，有些属性的优先级比其他的高：
- 如果提供了 pathObject.dir, 则 pathObject.root 会被忽略；
- 如果提供了 pathObject.base 存在，则 pathObject.ext 和 pathObject.name 会被忽略

// 如果提供了 `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'

4、获取相对路径

• path.relative(from, to)

描述：从 from 路径，到 to 路径的相对路径（基于当前工作目录）

边界：
- 如果from， to 指向同个路径，那么返回空字符串；
- 如果from， to 中任一者为空，则当前工作目录会被用于代替空字符串

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

path.relative('/data/orandea', '/data/orandea');
// 返回: ''

path.relative('./path.md', '');
// 返回: '..'

5、判断是否为绝对路径 path.isAbsolute(path)

path.isAbsolute() 方法会判定 path 是否为一个绝对路径。

如果给定的 path 是一个长度为零的字符串，则返回 false。

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

参考资料

模块概览

Node.js 中文官网