在nodejs中,path是个使用频率很高,但却让人又爱又恨的模块。部分因为文档说的不够清晰,部分因为接口的平台差异性。
将path的接口按照用途归类,仔细琢磨琢磨,也就没那么费解了。
获取路径:path.dirname(filepath)
获取文件名:path.basename(filepath)
获取扩展名:path.extname(filepath)
例子如下:
严格意义上来说,path.basename(filepath) 只是输出路径的最后一部分,并不会判断是否文件名。
但大部分时候,我们可以用它来作为简易的“获取文件名“的方法。
如果只想获取文件名,单不包括文件扩展呢?可以用上第二个参数。
简单的例子如下:
更详细的规则是如下:(假设 path.basename(filepath) === b )
从b的最后一个<code>.</code>开始截取,直到最后一个字符。
如果b中不存在<code>.</code>,或者b的第一个字符就是<code>.</code>,那么返回空字符串。
path.join([...paths])
path.resolve([...paths])
把<code>paths</code>拼起来,然后再normalize一下。这句话反正我自己看着也是莫名其妙,可以参考下面的伪代码定义。
path定义的伪代码如下:
这个接口的说明有点啰嗦。你可以想象现在你在shell下面,从左到右运行一遍<code>cd path</code>命令,最终获取的绝对路径/文件名,就是这个接口所返回的结果了。
比如 <code>path.resolve('/foo/bar', './baz')</code> 可以看成下面命令的结果
更多对比例子如下:
path.parse(path)
从官方文档的描述来看,path.normalize(filepath) 应该是比较简单的一个api,不过用起来总是觉得没底。
为什么呢?api说明过于简略了,包括如下:
如果路径为空,返回<code>.</code>,相当于当前的工作路径。
将对路径中重复的路径分隔符(比如linux下的<code>/</code>)合并为一个。
对路径中的<code>.</code>、<code>..</code>进行处理。(类似于shell里的<code>cd ..</code>)
如果路径最后有<code>/</code>,那么保留该<code>/</code>。
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"
代码示例如下。建议读者把代码拷贝出来运行下,看下实际效果。
path.format(pathobject):将pathobject的root、dir、base、name、ext属性,按照一定的规则,组合成一个文件路径。
path.parse(filepath):path.format()方法的反向操作。
我们先来看看官网对相关属性的说明。
首先是linux下
然后是windows下
阅读相关api文档说明后发现,path.format(pathobject)中,pathobject的配置属性是可以进一步精简的。
根据接口的描述来看,以下两者是等价的。
<code>root</code> vs <code>dir</code>:两者可以互相替换,区别在于,路径拼接时,<code>root</code>后不会自动加<code>/</code>,而<code>dir</code>会。
<code>base</code> vs <code>name+ext</code>:两者可以互相替换。
path.format(pathobject) 的反向操作,直接上官网例子。
四个属性,对于使用者是挺便利的,不过path.format(pathobject) 中也是四个配置属性,就有点容易搞混。
接口:path.relative(from, to)
描述:从<code>from</code>路径,到<code>to</code>路径的相对路径。
边界:
如果<code>from</code>、<code>to</code>指向同个路径,那么,返回空字符串。
如果<code>from</code>、<code>to</code>中任一者为空,那么,返回当前工作路径。
上例子:
以下属性、接口,都跟平台的具体实现相关。也就是说,同样的属性、接口,在不同平台上的表现不同。
path.posix:path相关属性、接口的linux实现。
path.win32:path相关属性、接口的win32实现。
path.sep:路径分隔符。在linux上是<code>/</code>,在windows上是<code>\</code>。
path.delimiter:path设置的分割符。linux上是<code>:</code>,windows上是<code>;</code>。
注意,当使用 path.win32 相关接口时,参数同样可以使用<code>/</code>做分隔符,但接口返回值的分割符只会是<code>\</code>。
直接来例子更直观。
linux系统例子:
windows系统例子: