无论是处理用户上传的文件,还是组织项目目录结构,路径操作都是 Node.js 开发中绕不开的日常任务,让我们一起来掌握这个看似简单实则暗藏玄机的 Path 模块!
文章目录
一、为什么需要 Path 模块?
举个🌰,假设我们要读取当前目录下的 config.yaml
文件,很多新手这样写:
const fs = require('fs')
// 不要学这种 🚫
fs.readFile(__dirname + '/../config.yaml', (err, data) => {
// ...
})
潜在问题:
- 不同操作系统路径分隔符不同(Windows用
\
,Max/Linux用/
) - 容易出现
..//
之类的非法路径 - 路径拼接容易出错(特别是相对路径)
正确处理方式
假设当前文件路径为:/home/user/project/src/app.js
const configPath = path.join(__dirname, '..', 'config.yaml');
// 相当于:
// __dirname(当前文件所在目录) + 上一级目录 + config.yaml
路径变化过程:
__dirname
->/home/user/project/src
..
-> 退到上级目录 ->/home.user/project
- 拼接
config.yaml
->/home/user/project/config.yaml
其他常见相对路径符号
符号 | 含义 | 示例 | 结果路径 |
---|---|---|---|
. |
当前目录 | path.join(__dirname, '.') |
/home/user/project/src |
.. |
上一级目录 | path.join(__dirname, '..') |
/home/user/project |
... |
无效路径符号 | 世界报错 | |
../.. |
上两级目录 | path.join(__dirname, '../..') |
/home/user |
二、Path 模块核心 API 全家桶
1.路径拼接三剑客
(1) path.join()
:安全拼接
// 自动处理分隔符和相对路径
console.log(path.join('src', 'app', '../utils'))
// 输出:src/utils (自动处理../, 跳出app)
console.log(path.join('/user', 'documents', '//reports'))
// 输出: /user/documents/reports
(2)path.resolve()
:绝对路径生成器
// 从右向左解析,返回绝对路径
console.log(path.resolve('src', 'app.js'))
// 假设当前目录是 /home/user
// 输出: /home/user/src/app,js
console.log(path.resolve('/var', 'www', '../html'))
// 输出: /var/html
(3)path.relative()
:计算相对路径
// 找两个路径之间的相对关系
console.log(path.relative('/var/lib', '/var/www/html'))
// 输出: ../../www/html
2. 路径拆解大师
const fullPath = '/home/user/docs/report.pdf'
// 获取文件名
path.basename(fullPath) // 'report.pdf'
// 获取目录部分
path.dirname(fullPath) // '/home/user/docs'
// 获取扩展名
path.extname(fullPath) // '.pdf'
// 完整解析
path.parse(fullPath)
/* 输出:
{
root: '/',
dir: '/home/user/docs',
base: 'report.pdf',
ext: '.pdf',
name: 'report'
} */
3. 系统相关属性
// 路径分隔符(不同系统不同)
console.log(path.sep) // Linux/mac: / ,Windows: \
// 环境变量分隔符
console.log(path.delimiter) // Linux/mac: : ,Windows: ;
三、实战案例:打造安全文件服务器
const http = require('http')
const path = require('path')
const fs = require('fs').promises
const server = http.createServer(async (req, res) => {
try {
// 1. 过滤非法路径
const safePath = req.url.replace(/\.\./g, '')
// 2. 拼接绝对路径
const absPath = path.resolve(
path.join(__dirname, 'public'),
path.normalize(safePath)
)
// 3. 防止越权访问
if (!absPath.startsWith(path.join(__dirname, 'public'))) {
res.statusCode = 403
return res.end('Forbidden!')
}
// 4. 读取文件
const data = await fs.readFile(absPath)
res.end(data)
} catch (err) {
res.statusCode = 404
res.end('File not found')
}
})
server.listen(3000, () => {
console.log('安全文件服务器已启动:http://localhost:3000')
})
关键安全措施:
- 过滤
..
防止路径遍历攻击 - 使用
path.resolve
确保绝对路径 - 验证最终路径是否在允许范围内
四、跨平台开发必备技巧
Windows vs Linux 路径差异对比表
特点 | Windows | Linux/macOS |
---|---|---|
根目录 | c:\ 或 \\server |
/ |
路径分隔符 | \ |
/ |
示例路径 | C:\User\docs\file |
/home/user/file |
统一路径格式的两种方法
方法1:强制转换为 POSIX 格式
function toUnixPath(pathStr) {
return pathStr.replace(/\\/g, '/')
}
console.log(toUnixPath('C:\\User\\docs')) // C:/User/docs
方法2:使用 path.posix
const posixPath = path.posix.join('src', 'app.js')
// 始终生成Linux风格路径
五、高级进阶:你不知道的Path技巧
1.路径校验黑科技
// 检查路径是否在指定目录下
function isSafePath(base, target) {
const relative = path.relative(base, target)
return !relative.startsWith('..') && !path.isAbsolute(relative)
}
console.log(isSafePath('/var/www', '/var/www/uploads')) // true
console.log(isSafePath('/var/www', '/etc/passwd')) // false
2.路径操作与URL转换
const { URL } = require('url')
// 处理文件URL
const fileUrl = new URL('file:///C:/path/to/file.txt')
console.log(path.parse(fileUrl.pathname))
// 输出Windows路径解析结果
// 转换路径为file协议URL
const filePath = path.resolve('test.txt')
const url = new URL(`file://${filePath}`)
3.动态处理不同系统路径
// 根据系统选择处理方式
const pathUtil = process.platform === 'win32'
? path.win32
: path.posix
console.log(pathUtil.join('src', 'app.js'))
六、常见问题答疑
Q1:__dirname
和 process.cwd()
有什么区别?
__dirname
:当前文件所在目录process.cwd()
:Node进程启动目录
Q2:为什么我的路径在Windows上不工作?
试试path
模块的自动转换,或显式使用 path.win32
/path.posix
Q3:如何处理用户上传的文件路径?
// 根据系统选择处理方式
const pathUtil = process.platform === 'win32'
? path.win32
: path.posix
console.log(pathUtil.join('src', 'app.js'))
七、扩展知识:路径处理最佳实践
- 黄金法则: 永远不要手动拼接字符串路径
- 防御性编程: 处理用户输入路径时,一定要进行标准化和校验
- 缓存常用路径: 避免重复计算
const PUBLIC_DIR = path.join(__dirname, 'public')
八、总结与资源推荐
Path模块核心方法速查表:
方法 | 作用 | 示例 |
---|---|---|
path.join() |
安全路径拼接 | join('src', 'app.js') |
path.resolve() |
解析绝对路径 | resolve('src') |
path.parse() |
分解路径对象 | parse('/home/file.txt') |
path.relative() |
计算相对路径 | relative('/var‘, '/www') |
path.normalize() |
规范化路径 | normalize('/user//docs') |