一文聊聊node中的path模塊

node.js極速入門課程：進入學習

path 模塊是 nodejs 中用于處理文件/目錄路徑的一個內置模塊，可以看作是一個工具箱，提供諸多方法供我們使用，當然都是和路徑處理有關的。同時在前端開發中 path 模塊出現的頻率也是比較高的，比如配置 webpack 的時候等。本文是對該模塊中一些常用的方法進行介紹，走，一起學習下吧。【相關教程推薦：nodejs視頻教程、編程教學】

• 需要注意下，nodejs 中所有的模塊（內置，自定義）都需要使用 requier 進行導入，一般導入位置在文件頂部。

const path = require('path');

API

basename （獲取路徑基礎名）

• path.basename(path[,ext])
  • path：文件/目錄路徑
  • ext：（可選）文件擴展名 例如 .js .css 等
  • 返回值：path 路徑的最后一部分
• 注意：
  • 如果 path 不是字符串或者給定的 ext 參數不是字符串，則拋出 TypeError
  • 如果有 ext 參數，當 ext 后綴名與文件名匹配上時返回的文件名會省略文件后綴
  • 如果 path 尾部有目錄分隔符則會被忽略

const path = require("path");  path.basename('./ext/test.js') //test.js path.basename('./ext/test.js','.js') //test (當后綴名與文件名匹配上時返回的文件名會省略文件后綴) path.basename('./ext/test.js','.html') //test.js (沒有匹配上時返回文件全名) path.basename('./ext/foo/') // foo (尾部目錄分隔符被忽略)

dirname （獲取路徑目錄名）

• path.dirname(path)
  • path：文件/目錄路徑
  • 返回值：path 路徑的目錄名
• 注意：
  • 如果 path 不是字符串，則拋出 TypeError
  • 如果 path 尾部有目錄分隔符則會被忽略

const path = require("path");  path.dirname('./foo/bar/baz'); //./foo/bar (相對路徑/絕對路徑均可) path.dirname('/foo/bar/baz/'); // /foo/bar (尾部目錄分隔符被忽略) path.dirname('/foo/bar/baz/test.js'); // /foo/bar/baz

extname （獲取路徑擴展名）

• path.extname(path)
  • path：文件/目錄路徑
  • 返回值：path 路徑的擴展名，從最后一次出現 '.' 字符到 path 最后一部分的字符串結束,無擴展名則返回空
• 注意：
  • 如果 path 不是字符串，則拋出 TypeError

const path = require("path");  path.extname('foo/bar/baz/test.js'); // .js path.extname('foo/bar/baz');// '' (無擴展名返回 '') path.extname('foo/bar/baz/.'); // '' path.extname('foo/bar/baz/test.'); // '.' path.extname('foo/bar/baz/.test'); // '' path.extname('foo/bar/baz/.test.js'); // '.js'

parse （解析路徑）

• path.parse(path) ( str => obj )
  • path：文件/目錄路徑
  • 返回值：帶有屬性(dir,root,base,name,ext)的對象
    • root：根目錄
    • dir： 文件所在的文件夾
    • base：完整文件 ( index.js )
    • name：文件名
    • ext: 文件后綴名
• 注意：
  • 如果 path 不是字符串，則拋出 TypeError
  • 如果尾部有目錄分隔符則會被忽略
• 一圖勝千言

┌──────────────────┬────────────┐ │          dir     │    base    │ ├──────┬           ├──────┬─────┤ │ root │           │ name │ ext │ "  /    foo/bar/baz/ index  .js "

const path = require("path");  path.parse('/foo/bar/baz/index.js') // { //     root: '/', //     dir: '/foo/bar/baz', //     base: 'index.js', //     ext: '.js', //     name: 'index' //   }  path.parse('/foo/bar/baz') //尾部目錄分隔符省略 // { //     root: '/', //     dir: '/foo/bar', //     base: 'baz', //     ext: '', //     name: 'baz' //   }  path.parse('./foo/bar/baz/index.js') //當路徑為相對路徑 ./ 或../時 解析結果中root(代表根目錄,絕對路徑才有值)為 '' // { //     root: '', //     dir: './foo/bar/baz', //     base: 'index.js', //     ext: '.js', //     name: 'index' //   }

format （序列化路徑）

• path.format(pathObj) 序列化 path 路徑,與 path.parse() 剛好相反

  • pathObj：path對象
  • 返回值：序列化后的字符串路徑 ( obj => string )

• 注意：

  • 如果 pathObject 不是對象，則拋出 TypeError
  • pathObject 中的屬性需要注意優先級：
    • 當 dir 屬性存在則忽略 root 屬性
    • 當 base 屬性存在則會忽略 name 和 ext 屬性

isAbsolute （是否是絕對路徑）

• path.isAbsolute(path)

  • path：文件/目錄路徑
  • 返回值：true/false

• 注意：

  • 如果 path 不是字符串，則拋出 TypeError
  • 如果給定的 path 字符串長度為0，則返回 false

  參考 前端面試題詳細解答

const path = require("path");  path.isAbsolute('//foo'); // true path.isAbsolute('\\foo'); // 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.isAbsolute('');  // false

join（拼接路徑片段）

• path.join([…paths])
  • paths：路徑片段
  • 返回值：使用平臺特定的分隔符作為定界符將所有給定的 path 片段連接在一起規范化后生成的路徑
• 注意：
  • 如果 paths 不是字符串片段，則拋出 TypeError
  • 零長度的 path 片段會被忽略
  • 如果連接后的路徑字符長度為0，則返回 '.'，表示當前工作目錄
  • 目錄分隔符有平臺差異,windows 返回為 ' '

const path = require("path");  path.join('') // '.' path.join('./') // '.'path.join('../') // '..'path.join('/foo/','bar','baz','../','index.js') // 'foobarindex.js'path.join('./bar','baz' ,'/','../','',index.js') // 'barindex.js' path.join('foo', {}, 'bar'); // 'TypeError: Path must be a string. Received {}'

normalize（規范化路徑）

• path.normalize(path)
  • path: 文件/目錄路徑
  • 返回值：規范后的路徑字符串
• 注意：
  • 如果 path 不是字符串片段，則拋出 TypeError
  • 尾部的分隔符會保留
  • 如果 path字符串長度為0，則返回 '.'，表示當前工作目錄
  • 路徑中的目錄分隔符均會被替換成平臺特定的目錄分隔符,windows 系統 會將 '/' 或'' 均替換成 ''
  • 路徑中連續的多個分隔符會被規范化為一個
  • 路徑中最好不要出現單個 ' ',因為當和字母在一起的時候會被當做轉義符

const path = require("path");  path.normalize('') // '.'path.normalize('temp//foo//bar//..//'); // tempfoopath.normalize('C:////temp\\/\/\/foo/bar') // C:tempfoobarpath.normalize('..////foo//bar/baz/') // ..fooarbaz (轉義字符出現)path.normalize('temp//foo/bar') // tempfooar (轉義字符出現)

relative（獲取 from 到 to 的相對路徑）

• path.relative(from,to)
  • from，to: 文件/目錄路徑
  • 返回值：from 到 to 的相對路徑（to 相對于 form 的相對路徑）
• 注意：
  • 如果 from 和 to 指向相同路徑相同 則返回 ''
  • 如果 from 或 to 任何一方為空,則使用當前工作目錄代替其空路徑

const path = require("path");  //當前工作目錄為 Stonenodenodepath_module path.relative('/foo/bar/baz','/foo/bar/dir/file.js') // ..dirfile.js path.relative('/foo/bar/baz','/foo/bar/baz') // '' path.relative('/foo/bar/baz/files.js','') // ........Stonenodenodepath_module path.relative('','/foo/bar/baz/files.js') // ........foobarbazfiles.js path.relative('','./foo/bar/baz/files.js') // foobarbazfiles.js

這里針對 from 或 to 任何一方為空,則使用當前工作目錄代替其空路徑。稍作說明下， 例如當前工作目錄為 Stonenodenodepath_module,則可以看到 path.relative('/foo/bar/baz/files.js','') 的輸出結果為........Stonenodenodepath_module，此時 to 為 Stonenodenodepath_module， 要輸出 to 相對于 from 的相對路徑，則 from 需要先 ../ 的形式 一層一層退出，來檢索與 to 的公共父級目錄，直到遇到公共父級目錄或者到根目錄停止，然后cd 進 to 目錄。這是針對另一方為絕對路徑，如果另一方為相對路徑，則直接就是當前另一方路徑。

resolve（將路徑或路徑片段的序列解析為絕對路徑）

• path.resolve([…paths])
  • paths: 路徑或路徑片段的序列
  • 返回值：路徑或路徑片段序列解析為絕對路徑。（將路徑片段解析后生成的絕對路徑）
• 注意：
  • 路徑片段如果給出則必須是字符串類型，否則類型錯誤
  • 給定的路徑序列從右到左進行處理，每個后續的 path 前置，直到構造出一個絕對路徑
  • 如果處理完所有給定的 path 片段之后還未生成絕對路徑，則再加上當前工作目錄
  • 生成的路徑均已規范化，并且除非將路徑解析為根目錄，否則將刪除尾部斜杠
  • 零長度的 path 片段會被忽略
  • 若沒有傳入 path 片段，則 path.resolve() 將返回當前工作目錄的絕對路徑

const path = require("path");  //當前工作目錄為 Stonenodenodepath_module path.resolve('/foo/bar', './baz'); // '/foo/bar/baz' path.resolve('/foo/bar','', '/tmp/file/'); //'/tmp/file' path.resolve('root', 'foo/baz/', '../fun/bar') // 'Stonenodenodepath_modulerootfoofunbar' path.resolve() // 'Stonenodenodepath_module'

path.resolve 方法解析路徑片段的時候會從右往左的順序依次解析，直到構造出一個絕對路徑，否則會將當前工作目錄加在路徑開頭。所以，通過 resolve 解析生成的路徑一定是絕對路徑。這個方法使用的非常多，應該特眼熟，對，前端我們配置 webpack 的時候會高頻率用到，并且往往還會結合 __dirname 使用。

__dirname，__filename

• __dirname：可以看作是 nodejs 中的全局變量，它始終表示當前執行文件所在目錄的完整目錄名（絕對路徑）
• __filename：可以看作是 nodejs 中的全局變量，它始終表示當前執行文件的完整文件名(完整絕對路)

我們先在 path_module 目錄下運行 node test.js 命令

<!--當前執行文件的完整路徑為Stonenodenodepath_moduletest.js--> const path = require("path");  console.log(__dirname); // Stonenodenodepath_module console.log(__filename); // Stonenodenodepath_moduletest.js

然后我們在 Stonenodenode 目錄下運行 node path_moduletest.js，會發現輸出結果同上， 所以這就是說明 __dirname 和 __filename 始終跟當前執行文件有關，跟啟動腳本所在目錄無關。

./ ../

./ 和 ../ 我們都知道是相對路徑的寫法，但是使用的過程中配合 require() 使用與否的結果是不同的。

• fs_module 目錄下 執行 node test.js

<!--當前啟動腳本的執行命令所在目錄 Stonenodenodefs_moduletest.js--> const fs = require('fs')  fs.readFileSync('./ext/test1.js',(err,data)=> {     console.log('ok') })

會正常打印出 ok

• Stonenodenode 目錄下 執行 node fs_moduletest.js

<!--當前啟動腳本的執行命令所在目錄 Stonenodenode--> const fs = require('fs')  fs.readFile('./ext/test1.js',(err,data)=> {     console.log('ok') })

運行會報錯 no such file or directory, open './ext/test1.js'

這到底是為啥嘞，原因就是 './' 和 '../' 的路徑表示意義需要分情況，當結合 require() 使用的時候相對于當前執行文件，如果不結合 require() 使用的情況下會相對于當前啟動腳本的目錄，因此只有在 require() 時才使用相對路徑(./, ../) 的寫法，其他地方一律使用絕對路徑，這點一定要注意。

結語

關于nodejs path 模塊，我們今天就說到這里了，雖然 api 不是很多，但是 path 模塊在前端的使用頻率還是非常高的，所以覺得很值得學習了解一下的。由于認知有限，本文若有不準確之處還望路過的各位兄臺及時指正，吃瓜，吃瓜。