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

前言

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

取得路徑/檔案名稱/副檔名

     取得路徑：path.dirname(filepath)

    

取得所在路徑

範例如下：

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

   

取得檔案名稱

嚴格意義上來說，path.basename(取得檔案名稱

嚴格意義上來說，path.basename()

但大部分時候，我們可以用它來作為簡易的「取得檔案名稱「的方法。

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) );

      從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])

   

這句話反正我自己看著也是莫名其妙，可以參考下面的偽代碼定義。

範例如下：

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('/') );
};

   

囉

.resolve()這個介面的說明。你可以想像現在你在shell下面，從左到右執行一遍cd path指令，最後取得的絕對路徑/檔名，就是這個介面所回傳的結果了。

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

cd /foo/bar
cd ./baz

   

更多對比例子，path.normalize(filepath) 應該是個比較簡單的API，但用上總覺得沒底。

為什麼呢？ API說明過於簡略了，包括如下：

      如果路徑為空，返回.，相當於目前的工作路徑。

      將路徑中重複的路徑分隔符號（例如linux下的/)合併為一。

      路徑中的.、..處理。 （類似shell裡的cd ..）

      如果路徑最後有/，保留該/。

感覺stackoverflow上一個兄弟對這個API的解釋比較實在，原文連結。

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)

   

程式碼範例如下。建議讀者把程式碼拷貝出來運行下，看下實際效果。

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下

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('/..') );
});

   

然後是windows下

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

，path.format(pathObject)中，pathObject的配置屬性是可以進一步精簡的。

根據介面的描述來看，以下兩者是等價的。

     root vs dir：兩者可以互相替換，差別在於，路徑拼接時，root後不會自動加/，dir會。

     base vs name+ext：兩者可以互相取代。

┌─────────────────────┬────────────┐
│   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) 中也是四個配置屬性，就有點容易搞混。

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.relative(from, to)

描述：從from路徑，到to路徑的相對路徑。

邊界：

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

     如果from、to中任一者為空，那麼，請回到目前工作路徑。

上範例：

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

   

平台相關介面/屬性

以下屬性、介面，都跟平台的特定實作相關。也就是說，同樣的屬性、接口，在不同平台上的表現不同。

    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\\']