Nodejs基础:路径处理模块path总结

开发 前端
在nodejs中,path是个使用频率很高,但却让人又爱又恨的模块。部分因为文档说的不够清晰,部分因为接口的平台差异性。

[[176221]]

模块概览

在nodejs中,path是个使用频率很高,但却让人又爱又恨的模块。部分因为文档说的不够清晰,部分因为接口的平台差异性。

将path的接口按照用途归类,仔细琢磨琢磨,也就没那么费解了。

获取路径/文件名/扩展名

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

获取所在路径

例子如下:

  1. var path = require('path'); 
  2. var filepath = '/tmp/demo/js/test.js'
  3.  
  4. // 输出:/tmp/demo/js 
  5. console.log( path.dirname(filepath) );  

获取文件名

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

但大部分时候,我们可以用它来作为简易的“获取文件名“的方法。

  1. var path = require('path'); 
  2.  
  3. // 输出:test.js 
  4. console.log( path.basename('/tmp/demo/js/test.js') ); 
  5.  
  6. // 输出:test 
  7. console.log( path.basename('/tmp/demo/js/test/') ); 
  8.  
  9. // 输出:test 
  10. console.log( path.basename('/tmp/demo/js/test') );  

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

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

获取文件扩展名

简单的例子如下:

  1. var path = require('path'); 
  2. var filepath = '/tmp/demo/js/test.js'
  3.  
  4. // 输出:.js 
  5. console.log( path.extname(filepath) );  

更详细的规则是如下:(假设 path.basename(filepath) === B )

  • 从B的***一个.开始截取,直到***一个字符。
  • 如果B中不存在.,或者B的***个字符就是.,那么返回空字符串。

直接看官方文档的例子

  1. path.extname('index.html'
  2. // returns '.html' 
  3.  
  4. path.extname('index.coffee.md'
  5. // returns '.md' 
  6.  
  7. path.extname('index.'
  8. // returns '.' 
  9.  
  10. path.extname('index'
  11. // returns '' 
  12.  
  13. path.extname('.index'
  14. // returns ''  

路径组合

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

path.join([...paths])

把paths拼起来,然后再normalize一下。这句话反正我自己看着也是莫名其妙,可以参考下面的伪代码定义。

例子如下:

  1. var path = require('path'); 
  2.  
  3. // 输出 '/foo/bar/baz/asdf' 
  4. path.join('/foo''bar''baz/asdf''quux''..');  

path定义的伪代码如下:

  1. module.exports.join = function(){ 
  2.   var paths = Array.prototye.slice.call(arguments, 0); 
  3.   return this.normalize( paths.join('/') ); 
  4. };  

path.resolve([...paths])

这个接口的说明有点啰嗦。你可以想象现在你在shell下面,从左到右运行一遍cd path命令,最终获取的绝对路径/文件名,就是这个接口所返回的结果了。

比如 path.resolve('/foo/bar', './baz') 可以看成下面命令的结果

  1. cd /foo/bar 
  2. cd ./baz  

更多对比例子如下:

  1. var path = require('path'); 
  2.  
  3. // 假设当前工作路径是 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path 
  4.  
  5. // 输出 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path 
  6. console.log( path.resolve('') ) 
  7.  
  8. // 输出 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path 
  9. console.log( path.resolve('.') ) 
  10.  
  11. // 输出 /foo/bar/baz 
  12. console.log( path.resolve('/foo/bar''./baz') ); 
  13.  
  14. // 输出 /foo/bar/baz 
  15. console.log( path.resolve('/foo/bar''./baz/') ); 
  16.  
  17. // 输出 /tmp/file 
  18. console.log( path.resolve('/foo/bar''/tmp/file/') ); 
  19.  
  20. // 输出 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path/www/js/mod.js 
  21. console.log( path.resolve('www''js/upload''../mod.js') );  

路径解析

path.parse(path)

path.normalize(filepath)

从官方文档的描述来看,path.normalize(filepath) 应该是比较简单的一个API,不过用起来总是觉得没底。

为什么呢?API说明过于简略了,包括如下:

  • 如果路径为空,返回.,相当于当前的工作路径。
  • 将对路径中重复的路径分隔符(比如linux下的/)合并为一个。
  • 对路径中的.、..进行处理。(类似于shell里的cd ..)
  • 如果路径***有/,那么保留该/。

感觉stackoverflow上一个兄弟对这个API的解释更实在,原文链接。

In other words, path.normalize is "What is the shortest path I can take that will take me to the same place as the input"

代码示例如下。建议读者把代码拷贝出来运行下,看下实际效果。

  1. var path = require('path'); 
  2. var filepath = '/tmp/demo/js/test.js'
  3.  
  4. var index = 0; 
  5.  
  6. var compare = function(desc, callback){ 
  7.   console.log('[用例%d]:%s', ++indexdesc); 
  8.   callback(); 
  9.   console.log('\n'); 
  10. }; 
  11.  
  12. compare('路径为空'function(){ 
  13.   // 输出 . 
  14.   console.log( path.normalize('') ); 
  15. }); 
  16.  
  17. compare('路径结尾是否带/'function(){ 
  18.   // 输出 /tmp/demo/js/upload 
  19.   console.log( path.normalize('/tmp/demo/js/upload') ); 
  20.  
  21.   // /tmp/demo/js/upload/ 
  22.   console.log( path.normalize('/tmp/demo/js/upload/') ); 
  23. }); 
  24.  
  25. compare('重复的/'function(){ 
  26.   // 输出 /tmp/demo/js 
  27.   console.log( path.normalize('/tmp/demo//js') ); 
  28. }); 
  29.  
  30. compare('路径带..'function(){ 
  31.   // 输出 /tmp/demo/js 
  32.   console.log( path.normalize('/tmp/demo/js/upload/..') ); 
  33. }); 
  34.  
  35. compare('相对路径'function(){ 
  36.   // 输出 demo/js/upload/ 
  37.   console.log( path.normalize('./demo/js/upload/') ); 
  38.  
  39.   // 输出 demo/js/upload/ 
  40.   console.log( path.normalize('demo/js/upload/') ); 
  41. }); 
  42.  
  43. compare('不常用边界'function(){ 
  44.   // 输出 .. 
  45.   console.log( path.normalize('./..') ); 
  46.  
  47.   // 输出 .. 
  48.   console.log( path.normalize('..') ); 
  49.  
  50.   // 输出 ../ 
  51.   console.log( path.normalize('../') ); 
  52.  
  53.   // 输出 / 
  54.   console.log( path.normalize('/../') ); 
  55.    
  56.   // 输出 / 
  57.   console.log( path.normalize('/..') ); 
  58. });  

感兴趣的可以看下 path.normalize(filepath) 的node源码如下:传送门

文件路径分解/组合

  • path.format(pathObject):将pathObject的root、dir、base、name、ext属性,按照一定的规则,组合成一个文件路径。
  • path.parse(filepath):path.format()方法的反向操作。

我们先来看看官网对相关属性的说明。

首先是linux下

  1. ┌─────────────────────┬────────────┐ 
  2. │          dir        │    base    │ 
  3. ├──────┬              ├──────┬─────┤ 
  4. │ root │              │ name │ ext │ 
  5. "  /    home/user/dir / file  .txt " 
  6. └──────┴──────────────┴──────┴─────┘ 
  7. (all spaces in the "" line should be ignored -- they are purely for formatting)  

然后是windows下

  1. ┌─────────────────────┬────────────┐ 
  2. │          dir        │    base    │ 
  3. ├──────┬              ├──────┬─────┤ 
  4. │ root │              │ name │ ext │ 
  5. " C:\      path\dir   \ file  .txt " 
  6. └──────┴──────────────┴──────┴─────┘ 
  7. (all spaces in the "" line should be ignored -- they are purely for formatting)  

path.format(pathObject)

阅读相关API文档说明后发现,path.format(pathObject)中,pathObject的配置属性是可以进一步精简的。

根据接口的描述来看,以下两者是等价的。

  • root vs dir:两者可以互相替换,区别在于,路径拼接时,root后不会自动加/,而dir会。
  • base vs name+ext:两者可以互相替换。
  1. var path = require('path'); 
  2.  
  3. var p1 = path.format({ 
  4.   root: '/tmp/',  
  5.   base: 'hello.js' 
  6. }); 
  7. console.log( p1 ); // 输出 /tmp/hello.js 
  8.  
  9. var p2 = path.format({ 
  10.   dir: '/tmp',  
  11.   name'hello'
  12.   ext: '.js' 
  13. }); 
  14. console.log( p2 );  // 输出 /tmp/hello.js  

path.parse(filepath)

path.format(pathObject) 的反向操作,直接上官网例子。

四个属性,对于使用者是挺便利的,不过path.format(pathObject) 中也是四个配置属性,就有点容易搞混。

  1. path.parse('/home/user/dir/file.txt'
  2. // returns 
  3. // { 
  4. //    root : "/"
  5. //    dir : "/home/user/dir"
  6. //    base : "file.txt"
  7. //    ext : ".txt"
  8. //    name : "file" 
  9. // }  

获取相对路径

接口:path.relative(from, to)

描述:从from路径,到to路径的相对路径。

边界:

  • 如果from、to指向同个路径,那么,返回空字符串。
  • 如果from、to中任一者为空,那么,返回当前工作路径。

上例子:

  1. var path = require('path'); 
  2.  
  3. var p1 = path.relative('/data/orandea/test/aaa''/data/orandea/impl/bbb'); 
  4. console.log(p1);  // 输出 "../../impl/bbb" 
  5.  
  6. var p2 = path.relative('/data/demo''/data/demo'); 
  7. console.log(p2);  // 输出 "" 
  8.  
  9. var p3 = path.relative('/data/demo'''); 
  10. console.log(p3);  // 输出 "../../Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path"  

平台相关接口/属性

以下属性、接口,都跟平台的具体实现相关。也就是说,同样的属性、接口,在不同平台上的表现不同。

  • path.posix:path相关属性、接口的linux实现。
  • path.win32:path相关属性、接口的win32实现。
  • path.sep:路径分隔符。在linux上是/,在windows上是``。
  • path.delimiter:path设置的分割符。linux上是:,windows上是;。

注意,当使用 path.win32 相关接口时,参数同样可以使用/做分隔符,但接口返回值的分割符只会是``。

直接来例子更直观。

  1. > path.win32.join('/tmp''fuck'
  2. '\\tmp\\fuck' 
  3. > path.win32.sep 
  4. '\\' 
  5. > path.win32.join('\tmp''demo'
  6. '\\tmp\\demo' 
  7. > path.win32.join('/tmp''demo'
  8. '\\tmp\\demo'  

path.delimiter

linux系统例子:

  1. console.log(process.env.PATH) 
  2. // '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin' 
  3.  
  4. process.env.PATH.split(path.delimiter) 
  5. // returns ['/usr/bin''/bin''/usr/sbin''/sbin''/usr/local/bin' 

windows系统例子:

  1. console.log(process.env.PATH) 
  2. // 'C:\Windows\system32;C:\Windows;C:\Program Files\node\' 
  3.  
  4. process.env.PATH.split(path.delimiter) 
  5. // returns ['C:\\Windows\\system32''C:\\Windows''C:\\Program Files\\node\\' 
责任编辑:庞桂玉 来源: segmentfault
相关推荐

2011-06-21 10:00:21

预处理指令

2021-04-29 06:14:49

CSS 文字动画Motion Path

2017-03-29 13:36:56

linux环境变量设置方法

2021-04-14 07:08:14

Nodejs错误处理

2021-09-24 09:30:05

os.path模块Python

2016-05-24 10:40:32

NodeJS总结

2021-03-02 09:34:41

Nodejs14前端代码

2016-09-19 10:01:08

NodeJSWeb

2021-02-16 10:55:02

Nodejs模块

2020-12-15 08:15:34

SVG元素路径

2013-05-20 17:21:34

2009-12-11 15:06:37

Linux系统

2017-11-21 14:14:04

PHPnode.js图片访问

2020-08-31 08:25:06

Python时间模块开发

2009-09-18 16:41:46

Linq to sql

2009-08-27 10:14:04

LINQ基础概念

2012-08-09 09:11:32

PHP超时

2019-08-28 16:18:39

JavaScriptJS前端

2010-03-03 13:39:41

Python os模块

2011-03-10 15:34:21

网络管理
点赞
收藏

51CTO技术栈公众号