NodeJs 第十章 (path模块)

安利君_AnLijun
331 阅读6分钟

在 Node.js 的开发旅程中，我们常常需要与文件系统打交道，而不同操作系统在路径表示和处理上存在差异本文将使用Node.js 的 path 模块帮助我们轻松应对各种路径处理问题。

posix

POSIX（Portable Operating System Interface for Unix）

  • POSIX 标准由 IEEE（电气和电子工程师协会）制定，旨在为 UNIX 操作系统定义一套统一的接口规范，使得应用程序可以在遵循 POSIX 标准的不同 UNIX 系统或类 UNIX 系统上具有可移植性和兼容性。第一个 POSIX 标准于 1988 年发布。

主要内容

  • 系统调用接口：定义了一系列操作系统提供给应用程序的接口函数，如文件操作（open、read、write 等）、进程管理（fork、exec、wait 等）、信号处理（signal 等）等系统调用，使应用程序能通过这些标准接口来访问操作系统的功能。
  • 命令和工具：规范了一些常用命令的行为和选项，像 ls、cp、mv 等命令，在不同的符合 POSIX 标准的系统中，这些命令的基本功能和使用方式是一致的。
  • 编程语言接口：对 C 语言等编程语言在 UNIX 环境下的接口进行了标准化，包括标准输入输出、字符串处理、时间处理等函数库的规范。
  • 系统环境：规定了系统的运行环境，如环境变量的使用、文件系统的结构和权限等。

这里linux和macOS都很好的遵循 POSIX 标准除了windows

一、Path 模块概述

path 模块是 Node.js 内置的核心模块之一，无需额外安装即可使用。它提供了一系列实用的方法，用于处理和转换文件路径，让我们可以编写跨平台兼容的代码。无论你是在 Windows、Linux 还是 macOS 系统上开发，path 模块都能确保路径处理的正确性。

要使用 path 模块，只需在代码中引入它：

const path = require('path');

二、常用方法/属性详解

1. path.join()

path.join() 方法用于将多个路径片段拼接成一个完整的路径。它会自动处理路径分隔符，确保在不同操作系统上都能生成正确的路径。

示例代码：

const path = require('path');

const fullPath = path.join('user', 'documents', 'file.txt');
console.log(fullPath);

在 Windows 系统上，输出结果可能是 user\documents\file.txt；
而在 Linux 或 macOS 系统上，输出结果则是 user/documents/file.txt。

2. path.resolve()

path.resolve() 方法会将路径或路径片段解析为绝对路径。它从右到左处理路径片段，直到构建出一个绝对路径。如果没有传入路径片段，它会返回当前工作目录的绝对路径。

示例代码：

const path = require('path');

const absolutePath = path.resolve('user', 'documents', 'file.txt');
console.log(absolutePath);

假设当前工作目录是 /home/user，那么输出结果可能是 /home/user/user/documents/file.txt。 image.png

3. path.basename()

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

示例代码：

const path = require('path');

const filePath = '/user/documents/file.txt';
const fileName = path.basename(filePath);
console.log(fileName); //file.txt

const fileNameWithoutExt = path.basename(filePath, '.txt');
console.log(fileNameWithoutExt);  //file

第一个输出 file.txt
第二个输出 file

4. path.dirname()

path.dirname() 方法返回路径的目录名部分，即去除文件名后的路径。

示例代码：

const path = require('path');

const filePath = '/user/documents/file.txt';
const dirName = path.dirname(filePath);
console.log(dirName);

输出结果为 /user/documents。

5. path.extname()

path.extname() 方法用于返回路径的文件扩展名，包括点号（.）。如果路径没有扩展名，则返回空字符串。

示例代码：

const path = require('path');

const filePath = '/user/documents/file.txt';
const extName = path.extname(filePath);
console.log(extName);

输出结果为 .txt。

6. __dirname

__dirname 是一个全局变量，它返回当前执行脚本所在的目录的绝对路径。在处理文件路径时，结合 path 模块使用 __dirname 可以方便地构建相对于当前脚本的路径，避免硬编码路径带来的问题，提高代码的可移植性。 示例代码：

console.log(__dirname);

若当前脚本文件是 /home/user/projects/myproject/scripts/test.js，则上述代码会输出 /home/user/projects/myproject/scripts。

7. __filename

__filename 同样是一个全局变量，它返回当前执行脚本的绝对路径，包含文件名。通过 __filename 我们可以获取到完整的文件路径信息，这在某些需要精确操作文件的场景中非常有用。

示例代码：

console.log(__filename);

若当前脚本文件是 /home/user/projects/myproject/scripts/test.js，则上述代码会输出 /home/user/projects/myproject/scripts/test.js。

8. path.isAbsolute()

path.isAbsolute() 方法判断路径是否为绝对路径。

console.log(path.isAbsolute('/foo/bar')); // 输出 true
console.log(path.isAbsolute('./foo/bar')); // 输出 false

9. path.normalize()

path.normalize() 方法规范路径字符串，将多余的斜杠、点符号等转换成标准格式。

console.log(path.normalize('/foo/bar//baz/asdf/quus')); // 输出 '/foo/bar/baz/asdf/quus'
console.log(path.normalize('foo/bar/baz')); // 输出 'foo/bar/baz'
console.log(path.normalize('foo/bar//baz/../quus')); // 输出 'foo/bar/quus'

10. path.parse()

path.parse() 方法将路径字符串解析为对象，包含各个组成部分。

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

11. path.format()

path.format() 方法将路径对象转换为路径字符串。

const obj = { root: '/', dir: '/home/user/dir', base: 'file.txt', ext: '.txt', name: 'file' };
console.log(path.format(obj)); // 输出 '/home/user/dir/file.txt'

12. path.delimiter

path.delimiter 属性返回用于分隔环境变量路径的字符。在不同操作系统中，这个分隔符是不同的，在 Windows 上是分号 ;，在 POSIX 系统（如 Linux、macOS）上是冒号 :。

我们可以利用这个属性来处理环境变量中的路径列表，比如将 process.env.PATH 分割成一个个单独的路径。

示例代码：

const path = require('path');
console.log(process.env.PATH.split(path.delimiter));

这段代码会将环境变量 PATH 中的所有路径分割成一个数组并打印出来。

13. path.posix 和 path.win32

path 模块提供了两种不同的路径操作模式：POSIX 和 Windows。通过 path.posix 和 path.win32，可以分别针对不同的操作系统进行路径操作。

  • path.posix：遵循 POSIX（可移植操作系统接口）标准，适用于类 Unix 系统（如 Linux、macOS），路径分隔符使用斜杠 /。
  • path.win32：遵循 Windows 系统的路径规则，路径分隔符使用反斜杠 ``。

示例代码：

const path = require('path');
console.log(path.posix.join('/foo', 'bar')); // 输出 '/foo/bar'
console.log(path.win32.join('C:\', 'Users', 'username', 'Documents')); 
// 在 Windows 环境下输出 'C:\Users\username\Documents'

三、实际应用场景(了解即可下一章讲解)

1. 读取文件

在读取文件时，我们可以使用 path.join() 方法构建正确的文件路径，确保代码在不同操作系统上都能正常工作。

示例代码：

const fs = require('fs');
const path = require('path');

const filePath = path.join(__dirname, 'data', 'file.txt');
fs.readFile(filePath, 'utf8', (err, data) => {
    if (err) {
        console.error('Error reading file:', err);
        return;
    }
    console.log(data);
});

这里的 __dirname 是 Node.js 的全局变量，表示当前模块的目录名。

2. 构建静态文件服务器

在构建静态文件服务器时，我们可以使用 path.resolve() 方法将相对路径转换为绝对路径，以确保能够正确找到文件。

示例代码：

const http = require('http');
const fs = require('fs');
const path = require('path');

const server = http.createServer((req, res) => {
    const filePath = path.resolve(__dirname, 'public', req.url.slice(1));
    fs.readFile(filePath, (err, data) => {
        if (err) {
            res.writeHead(404, { 'Content-Type': 'text/plain' });
            res.end('File not found');
        } else {
            res.writeHead(200, { 'Content-Type': 'text/html' });
            res.end(data);
        }
    });
});

const port = 3000;
server.listen(port, () => {
    console.log(`Server running on port ${port}`);
});

四、总结

Node.js 的 path 模块为我们提供了强大而便捷的路径处理功能，让我们能够轻松应对不同操作系统的路径差异。通过掌握 path.join()、path.resolve()、path.basename() 等常用方法，我们可以编写出更加健壮、跨平台兼容的代码。在实际开发中，合理运用 path 模块能够提高我们的开发效率，减少因路径处理不当而引发的错误。希望本文能帮助你更好地理解和使用 path 模块，让你的 Node.js 开发之路更加顺畅。

avatar
文章
阅读
粉丝