Node.js 的 path 模块提供了一些实用的方法，用于处理文件和目录的路径。该模块使得在不同操作系统中处理路径时更加便捷，尤其是处理路径分隔符不同的问题，如 Windows 使用反斜杠 (\) 而 POSIX 使用正斜杠 (/)。

本文将详细介绍 path 模块的所有属性、方法及其使用方式，涵盖文档的所有内容。

1. 模块引入

path 模块是 Node.js 的内置模块，无需安装第三方库，使用 require('path') 即可引入。

const path = require('path');

2. 属性和常量

2.1 path.sep

path.sep 是当前操作系统的路径分隔符。在 POSIX 系统上（如 Linux 和 macOS），它是 /；在 Windows 系统上，它是 \。

console.log(path.sep);  // 输出：/ (在 POSIX 系统上) 或 \ (在 Windows 上)

2.2 path.delimiter

path.delimiter 是用于分隔环境变量中的多个路径的分隔符。在 POSIX 系统上是 :，在 Windows 系统上是 ;。

console.log(path.delimiter);  // 输出：: (在 POSIX 系统上) 或 ; (在 Windows 上)

2.3 path.posix

path.posix 提供了适用于 POSIX 系统的路径操作方法。这些方法在 POSIX 系统中默认使用。

const posixPath = path.posix.join('/foo', 'bar', 'baz/asdf');
console.log(posixPath);  // 输出：/foo/bar/baz/asdf

2.4 path.win32

path.win32 提供了适用于 Windows 系统的路径操作方法。在 Windows 上，默认使用 path.win32，但即使在非 Windows 系统上也可以使用它进行 Windows 风格的路径操作。

const winPath = path.win32.join('C:', 'foo', 'bar');
console.log(winPath);  // 输出：C:\foo\bar

3. 路径方法

3.1 path.basename()

path.basename() 返回路径的最后一部分，即文件名或目录名。你还可以传递第二个参数来去除文件扩展名。

const filePath = '/home/user/file.txt';

console.log(path.basename(filePath));  // 输出：file.txt
console.log(path.basename(filePath, '.txt'));  // 输出：file

3.2 path.dirname()

path.dirname() 返回路径的目录部分，不包含文件名。

const filePath = '/home/user/file.txt';

console.log(path.dirname(filePath));  // 输出：/home/user

3.3 path.extname()

path.extname() 返回路径中文件的扩展名。如果路径没有扩展名，返回空字符串。

const filePath = '/home/user/file.txt';

console.log(path.extname(filePath));  // 输出：.txt

3.4 path.format()

path.format() 接受一个对象并返回一个路径字符串。对象中的字段包括：

• dir: 文件路径所在的目录
• root: 根目录
• base: 文件名（包含扩展名）
• name: 文件名（不包含扩展名）
• ext: 文件扩展名

const filePathObject = {
  dir: '/home/user',
  base: 'file.txt'
};

console.log(path.format(filePathObject));  // 输出：/home/user/file.txt

3.5 path.join()

path.join() 使用正确的分隔符将多个路径片段拼接成一个路径字符串。

const joinedPath = path.join('/home', 'user', 'file.txt');
console.log(joinedPath);  // 输出：/home/user/file.txt (在 POSIX 上) 或 \home\user\file.txt (在 Windows 上)

3.6 path.normalize()

path.normalize() 会规范化给定路径，解析 .. 和 . 等相对路径片段，并修正重复的分隔符。

const normalizedPath = path.normalize('/home/user/../file.txt');
console.log(normalizedPath);  // 输出：/home/file.txt

3.7 path.parse()

path.parse() 返回一个对象，包含路径的各个部分：root、dir、base、name 和 ext。

const filePath = '/home/user/file.txt';
const parsedPath = path.parse(filePath);

console.log(parsedPath);
/*
输出：
{
  root: '/',
  dir: '/home/user',
  base: 'file.txt',
  ext: '.txt',
  name: 'file'
}
*/

3.8 path.relative()

path.relative() 计算从一个路径到另一个路径的相对路径。

const from = '/home/user/docs';
const to = '/home/user/photos';

console.log(path.relative(from, to));  // 输出：../photos

3.9 path.resolve()

path.resolve() 将路径片段解析为绝对路径。它从右到左处理路径片段，直到构造出绝对路径。如果未提供根路径，它将使用当前工作目录。

const resolvedPath = path.resolve('foo', 'bar', 'baz');
console.log(resolvedPath);  // 输出：/current/working/directory/foo/bar/baz

3.10 path.isAbsolute()

path.isAbsolute() 检查给定的路径是否为绝对路径。

console.log(path.isAbsolute('/home/user'));  // 输出：true
console.log(path.isAbsolute('user/file.txt'));  // 输出：false

4. 示例代码

示例 1: 获取文件的基本路径信息

const path = require('path');

const filePath = '/home/user/docs/report.txt';

console.log('文件名:', path.basename(filePath));  // 输出：report.txt
console.log('目录名:', path.dirname(filePath));   // 输出：/home/user/docs
console.log('扩展名:', path.extname(filePath));   // 输出：.txt

示例 2: 拼接与解析路径

const path = require('path');

const directory = '/home/user';
const fileName = 'data.txt';

// 拼接路径
const fullPath = path.join(directory, fileName);
console.log('完整路径:', fullPath);  // 输出：/home/user/data.txt

// 解析为绝对路径
const absolutePath = path.resolve('data.txt');
console.log('绝对路径:', absolutePath);  // 输出：/current/working/directory/data.txt

示例 3: 规范化路径

const path = require('path');

const messyPath = '/home//user/./docs/../file.txt';

console.log('规范化路径:', path.normalize(messyPath));  // 输出：/home/user/file.txt

5. 总结

Node.js 的 path 模块为处理文件和目录路径提供了便捷且跨平台的方法，特别是在处理文件系统操作和路径解析时尤为重要。无论是获取文件路径的各个部分，还是在不同平台之间的路径兼容性问题上，path 模块都能为开发者提供极大的便利。通过灵活运用这些方法，开发者可以编写出更加健壮的代码。