Nodejs path模块


这是一篇读Nodejs API的读书笔记(抄书笔记)
path模块

小总结:
ext 扩展名
base 文件全名
dir 路径名(不包括文件名)
delimiter 分隔符
root 你懂的
----------------------------------------
path 路径 用win32、posix
path.basename(path[, ext]) 
返回最后一部分如index.html, ext为扩展名,加了后就不返回扩展名
path.delimiter 是分割符 ; 或 : 用split分割
path.sep  路径分隔符 win: \, POSIX: /
path.dirname(path)  返回目录名,不包括当前
path.extname(path) 返回文件扩展名
path.format(pathObject) 把dir、root、base、name、ext组合,有优先级
path.isAbsolute(path)  判断是否为绝对路径
path.join([...paths])  组合路径
path.normalize(path)  规范化路径
path.parse(path) 和format 相反  返回对象dir、root、base、name、ext
path.relative(from, to)  from到to的相对路径,无参数有区别
path.resolve([...paths])  把片段路径解析为绝对路径,无参数返回当前

path(路径)

path是nodejs的模块,提供了一些工具函数,用于处理文件与目录的路径
使用方法

const path = require('path')

path模块在windows与POSIX环境下的不同

path模块的默认操作会因为node运行环境的不同而变化
在POSIX上

path.basename('C:\\temp\\myfile.html');
// 返回: 'C:\\temp\\myfile.html'

在 Windows 上:

path.basename('C:\\temp\\myfile.html');
// 返回: 'myfile.html'

处理windows文件路径

path.win32.basename('C:\\temp\\myfile.html');
// 返回: 'myfile.html'

处理POSIX文件路径

path.posix.basename('/tmp/myfile.html');
// 返回: 'myfile.html'

POSIX是UNIX的一套可移植性标准

path.basename(path[, ext])

  • path <string>
  • ext <string> 可选
  • 返回 <string>
    path.basename() 方法返回一个 path 的最后一部分,类似于 Unix 中的 basename 命令。
path.basename('/foo/bar/baz/asdf/quux.html')
// 返回: 'quux.html'
path.basename('/foo/bar/baz/asdf/quux.html', '.html')
// 返回: 'quux'

path.delimiter

path.delimiter是分隔符,windows上是;,POSIX是:
在windows上:

console.log(process.env.PATH)
// 输出: 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'
process.env.PATH.split(path.delimiter)
// 返回: ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']

在POSIX上:

console.log(process.env.PATH)
// 输出: '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'
process.env.PATH.split(path.delimiter)
// 返回: ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']
```![在windows上给路径分割了数组](http://upload-images.jianshu.io/upload_images/2155778-6fc1dbe9cd8917cf.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

path.dirname(path)

  • path <string> 不是字符串就报错

path.dirname() 方法返回一个 path 的目录名,类似于 Unix 中的 dirname 命令。

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

path.extname(path)

  • path <string> 非字符串报错
  • return <string>
    返回path的扩展名,有.就返回.,没有就返回空

path.format(pathObject)

  • pathObject <object>
    • dir <string>
    • root <string>
    • base <string>
    • name <string>
    • ext <string>
  • return <string>
    path.format()方法会从一个对象返回一个路径字符串。 与 path.parse()
    相反。
    当 pathObject 提供的属性有组合时,有些属性的优先级比其他的高:
    在 POSIX 上:
// 如果提供了 `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'

在 Windows 上:

path.format({
  dir : "C:\\path\\dir",
  base : "file.txt"
});
// 返回: 'C:\\path\\dir\\file.txt'

path.isAbsolute(path)

  • path <string>
  • return <boolean>
    path.isAbsolute() 方法会判定 path 是否为一个绝对路径。
    如果给定的 path 是一个长度为零的字符串,则返回 false。
    例如,在 POSIX 上:
path.isAbsolute('/foo/bar') // true
path.isAbsolute('/baz/..')  // true
path.isAbsolute('qux/')     // false
path.isAbsolute('.')        // false

在 Windows 上:

path.isAbsolute('//server')    // true
path.isAbsolute('\\\\server')  // true
path.isAbsolute('C:/foo/..')   // true
path.isAbsolute('C:\\foo\\..') // true
path.isAbsolute('bar\\baz')    // false
path.isAbsolute('bar/baz')     // false
path.isAbsolute('.')           // false

path.join([...paths])

  • ...paths 一个路径片段的序列
    path.join() 方法使用平台特定的分隔符把全部给定的 path 片段连接到一起,并规范化生成的路径。
    长度为零的 path 片段会被忽略。 如果连接后的路径字符串是一个长度为零的字符串,则返回 '.',表示当前工作目录。
path.join('/foo', 'bar', 'baz/asdf', 'quux', '..')
// 返回: '/foo/bar/baz/asdf'  这里的`..`表示上一层
path.join('foo', {}, 'bar')
// 抛出 TypeError: path.join 的参数必须为字符串

path.normalize(path)

path.normalize() 方法会规范化给定的 path,并解析 '..' 和 '.' 片段。
当发现多个连续的路径分隔符时(如 POSIX 上的 / 与 Windows 上的 \),它们会被单一的路径分隔符替换。 末尾的多个分隔符会被保留。
例如,在 POSIX 上:

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

在 Windows 上:

path.normalize('C:\\temp\\\\foo\\bar\\..\\');
// 返回: 'C:\\temp\\foo\\'

path.parse(path) 和format 相反

path.parse() 方法返回一个对象,对象的属性表示 path 的元素。
返回的对象有以下属性:

  • dir <string>
  • root <string>
  • base <string>
  • name <string>
  • ext <string>
    例如,在 POSIX 上:
path.parse('/home/user/dir/file.txt')
// 返回:
// {
//    root : "/",
//    dir : "/home/user/dir",
//    base : "file.txt",
//    ext : ".txt",
//    name : "file"
// }  

在 Windows 上:

path.parse('C:\\path\\dir\\file.txt')
// 返回:
// {
//    root : "C:\\",
//    dir : "C:\\path\\dir",
//    base : "file.txt",
//    ext : ".txt",
//    name : "file"
// }

path.posix (开头讲的)

path.posix 属性提供了 path 方法针对 POSIX 的实现。

path.relative(from, to)

path.relative() 方法返回从 from 到 to 的相对路径。 如果 from 和 to 各自解析到同一路径(调用 path.resolve()),则返回一个长度为零的字符串。
如果 from 或 to 传入了一个长度为零的字符串,则当前工作目录会被用于代替长度为零的字符串。
在 POSIX 上:

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

在 Windows 上:

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

to为0就到当前,from为0就直接到to


path.resolve([...paths])

path.resolve() 方法会把一个路径或路径片段的序列解析为一个绝对路径。
则 path.resolve() 会返回当前工作目录的绝对路径。
如果没有传入 path 片段,则 path.resolve() 会返回当前工作目录的绝对路径。


path.sep

提供了平台特定的路径片段分隔符:
Windows 上是 , POSIX 上是`/
在 POSIX 上:

'foo/bar/baz'.split(path.sep)
// 返回: ['foo', 'bar', 'baz']

在 Windows 上:

'foo\\bar\\baz'.split(path.sep)
// 返回: ['foo', 'bar', 'baz']

path.win32

path.win32 属性提供了 path 方法针对 Windows 的实现。
注意:在 Windows 上,斜杠字符(/)和反斜杠字符(\)都可作为路径分隔符; 但返回值中只用到反斜杠(\)。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容