Nodejs基礎：路徑處理模塊path總結

時間 2019-11-11

標籤 nodejs 基礎路徑處理模塊 path 總結简体版

原文原文鏈接

本文摘錄自《Nodejs學習筆記》，更多章節及更新，請訪問 github主頁地址。歡迎加羣交流，羣號 197339705。javascript

模塊概覽

在nodejs中，path是個使用頻率很高，但卻讓人又愛又恨的模塊。部分由於文檔說的不夠清晰，部分由於接口的平臺差別性。html

將path的接口按照用途歸類，仔細琢磨琢磨，也就沒那麼費解了。java

獲取路徑/文件名/擴展名

獲取路徑：path.dirname(filepath)node
獲取文件名：path.basename(filepath)linux
獲取擴展名：path.extname(filepath)git

獲取所在路徑

例子以下：github

var path = require('path');
var filepath = '/tmp/demo/js/test.js';

// 輸出：/tmp/demo/js
console.log( path.dirname(filepath) );

獲取文件名

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

但大部分時候，咱們能夠用它來做爲簡易的「獲取文件名「的方法。windows

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

若是隻想獲取文件名，單不包括文件擴展呢？能夠用上第二個參數。api

// 輸出：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.normalize(filepath) 的node源碼以下：傳送門

文件路徑分解/組合

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