Node.js中路徑處理模組path詳解

NO IMAGE

前言

在node.js中,提供了一個path某塊,在這個模組中,提供了許多使用的,可被用來處理與轉換路徑的方法與屬性,將path的介面按照用途歸類,仔細琢磨琢磨,也就沒那麼費解了。下面我們就來詳細介紹下關於Node.js中的路徑處理模組path。

獲取路徑/檔名/副檔名

     獲取路徑:path.dirname(filepath)

     獲取檔名:path.basename(filepath)

     獲取副檔名:path.extname(filepath)

獲取所在路徑

例子如下:


var path = require('path');
var filepath = '/tmp/demo/js/test.js';
// 輸出:/tmp/demo/js
console.log( path.dirname(filepath) );

獲取檔名

嚴格意義上來說,path.basename(filepath) 只是輸出路徑的最後一部分,並不會判斷是否檔名。

但大部分時候,我們可以用它來作為簡易的“獲取檔名“的方法。


var path = require('path');
// 輸出:test.js
console.log( path.basename('/tmp/demo/js/test.js') );
// 輸出:test
console.log( path.basename('/tmp/demo/js/test/') );
// 輸出:test
console.log( path.basename('/tmp/demo/js/test') );

如果只想獲取檔名,單不包括檔案擴充套件呢?可以用上第二個引數。


// 輸出:test
console.log( path.basename('/tmp/demo/js/test.js', '.js') );

獲取副檔名

簡單的例子如下:


var path = require('path');
var filepath = '/tmp/demo/js/test.js';
// 輸出:.js
console.log( path.extname(filepath) );

更詳細的規則是如下:(假設 path.basename(filepath) === B

     從B的最後一個.開始擷取,直到最後一個字元。

    如果B中不存在.,或者B的第一個字元就是.,那麼返回空字串。

直接看官方文件的例子


path.extname('index.html')
// returns '.html'
path.extname('index.coffee.md')
// returns '.md'
path.extname('index.')
// returns '.'
path.extname('index')
// returns ''
path.extname('.index')
// returns ''

路徑組合


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

path.join([…paths])

把paths拼起來,然後再normalize一下。這句話反正我自己看著也是莫名其妙,可以參考下面的虛擬碼定義。

例子如下:


var path = require('path');
// 輸出 '/foo/bar/baz/asdf'
path.join('/foo', 'bar', 'baz/asdf', 'quux', '..');

path定義的虛擬碼如下:


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

path.resolve([…paths])

這個介面的說明有點囉嗦。你可以想象現在你在shell下面,從左到右執行一遍cd path命令,最終獲取的絕對路徑/檔名,就是這個介面所返回的結果了。

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


cd /foo/bar
cd ./baz

更多對比例子如下:


var path = require('path');
// 假設當前工作路徑是 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path
// 輸出 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path
console.log( path.resolve('') )
// 輸出 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path
console.log( path.resolve('.') )
// 輸出 /foo/bar/baz
console.log( path.resolve('/foo/bar', './baz') );
// 輸出 /foo/bar/baz
console.log( path.resolve('/foo/bar', './baz/') );
// 輸出 /tmp/file
console.log( path.resolve('/foo/bar', '/tmp/file/') );
// 輸出 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path/www/js/mod.js
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"

程式碼示例如下。建議讀者把程式碼拷貝出來執行下,看下實際效果。


var path = require('path');
var filepath = '/tmp/demo/js/test.js';
var index = 0;
var compare = function(desc, callback){
console.log('[用例%d]:%s',   index, desc);
callback();
console.log('\n');
};
compare('路徑為空', function(){
// 輸出 .
console.log( path.normalize('') );
});
compare('路徑結尾是否帶/', function(){
// 輸出 /tmp/demo/js/upload
console.log( path.normalize('/tmp/demo/js/upload') );
// /tmp/demo/js/upload/
console.log( path.normalize('/tmp/demo/js/upload/') );
});
compare('重複的/', function(){
// 輸出 /tmp/demo/js
console.log( path.normalize('/tmp/demo//js') );
});
compare('路徑帶..', function(){
// 輸出 /tmp/demo/js
console.log( path.normalize('/tmp/demo/js/upload/..') );
});
compare('相對路徑', function(){
// 輸出 demo/js/upload/
console.log( path.normalize('./demo/js/upload/') );
// 輸出 demo/js/upload/
console.log( path.normalize('demo/js/upload/') );
});
compare('不常用邊界', function(){
// 輸出 ..
console.log( path.normalize('./..') );
// 輸出 ..
console.log( path.normalize('..') );
// 輸出 ../
console.log( path.normalize('../') );
// 輸出 /
console.log( path.normalize('/../') );
// 輸出 /
console.log( path.normalize('/..') );
});

檔案路徑分解/組合

path.format(pathObject) :將pathObject的root、dir、base、name、ext屬性,按照一定的規則,組合成一個檔案路徑。

path.parse(filepath) path.format()方法的反向操作。

我們先來看看官網對相關屬性的說明。

首先是linux下


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

然後是windows下


┌─────────────────────┬────────────┐
│   dir  │ base │
├──────┬    ├──────┬─────┤
│ root │    │ name │ ext │
" C:\  path\dir \ file .txt "
└──────┴──────────────┴──────┴─────┘
(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:兩者可以互相替換。


var path = require('path');
var p1 = path.format({
root: '/tmp/', 
base: 'hello.js'
});
console.log( p1 ); // 輸出 /tmp/hello.js
var p2 = path.format({
dir: '/tmp', 
name: 'hello',
ext: '.js'
});
console.log( p2 ); // 輸出 /tmp/hello.js

path.parse(filepath)

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

四個屬性,對於使用者是挺便利的,不過path.format(pathObject) 中也是四個配置屬性,就有點容易搞混。


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

獲取相對路徑

介面:path.relative(from, to)

描述:從from路徑,到to路徑的相對路徑。

邊界:

     如果from、to指向同個路徑,那麼,返回空字串。

     如果from、to中任一者為空,那麼,返回當前工作路徑。

上例子:


var path = require('path');
var p1 = path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb');
console.log(p1); // 輸出 "../../impl/bbb"
var p2 = path.relative('/data/demo', '/data/demo');
console.log(p2); // 輸出 ""
var p3 = path.relative('/data/demo', '');
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 相關介面時,引數同樣可以使用/做分隔符,但介面返回值的分割符只會是“。

直接來例子更直觀。


> path.win32.join('/tmp', 'fuck')
'\\tmp\\fuck'
> path.win32.sep
'\\'
> path.win32.join('\tmp', 'demo')
'\\tmp\\demo'
> path.win32.join('/tmp', 'demo')
'\\tmp\\demo'

path.delimiter

linux系統例子:


console.log(process.env.PATH)
// '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'
process.env.PATH.split(path.delimiter)
// returns ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']

windows系統例子:


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

總結

以上就是這篇文章的全部內容了,希望本文的內容對大家學習或者使用node.js能有所幫助,如果有疑問大家可以留言交流,謝謝大家對指令碼之家的支援。

您可能感興趣的文章:

解決Nodejs全域性安裝模組後找不到命令的問題NodeJs在Linux下使用的各種問題解決解決Linux無法正常安裝與解除安裝Node.js的方法npm全域性模組解除安裝及預設安裝目錄修改方法完美解決linux下node.js全域性模組找不到的情況