nodejs — path 模塊

前言

path 模塊是 nodejs 中用於處理文件/目錄路徑的一個內置模塊，能夠看做是一個工具箱，提供諸多方法供咱們使用，固然都是和路徑處理有關的。同時在前端開發中 path 模塊出現的頻率也是比較高的，好比配置 webpack 的時候等。本文是對該模塊中一些經常使用的方法進行介紹，走，一塊兒學習下吧。

• 須要注意下，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') // '\foo\bar\index.js'
path.join('./bar','baz' ,'/','../','',index.js') // 'bar\index.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//..//'); // temp\foo\
path.normalize('C:////temp\\\\/\\/\\/foo/bar') // C:\temp\foo\bar
path.normalize('..////foo//\bar/baz/') // ..\fooar\baz\ (轉義字符出現)
path.normalize('temp//foo/\bar') // temp\fooar (轉義字符出現)

複製代碼

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

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

const path = require("path");

//當前工做目錄爲 \Stone\node\node\path_module
path.relative('/foo/bar/baz','/foo/bar/dir/file.js') // ..\dir\file.js
path.relative('/foo/bar/baz','/foo/bar/baz') // ''
path.relative('/foo/bar/baz/files.js','') // ..\..\..\..\Stone\node\node\path_module
path.relative('','/foo/bar/baz/files.js') // ..\..\..\..\foo\bar\baz\files.js
path.relative('','./foo/bar/baz/files.js') // foo\bar\baz\files.js
複製代碼

這裏針對 from 或 to 任何一方爲空,則使用當前工做目錄代替其空路徑。稍做說明下， 例如當前工做目錄爲 \Stone\node\node\path_module,則能夠看到 path.relative('/foo/bar/baz/files.js','') 的輸出結果爲..\..\..\..\Stone\node\node\path_module，此時 to 爲 \Stone\node\node\path_module， 要輸出 to 相對於 from 的相對路徑，則 from 須要先 ../ 的形式 一層一層退出，來檢索與 to 的公共父級目錄，直到遇到公共父級目錄或者到根目錄中止，而後cd 進 to 目錄。這是針對另外一方爲絕對路徑，若是另外一方爲相對路徑，則直接就是當前另外一方路徑。

resolve（將路徑或路徑片斷的序列解析爲絕對路徑）

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

const path = require("path");

//當前工做目錄爲 \Stone\node\node\path_module
path.resolve('/foo/bar', './baz'); // '/foo/bar/baz'
path.resolve('/foo/bar','', '/tmp/file/'); //'/tmp/file'
path.resolve('root', 'foo/baz/', '../fun/bar') // '\Stone\node\node\path_module\root\foo\fun\bar'
path.resolve() // '\Stone\node\node\path_module'

複製代碼

path.resolve 方法解析路徑片斷的時候會從右往左的順序依次解析，直到構造出一個絕對路徑，不然會將當前工做目錄加在路徑開頭。因此，經過 resolve 解析生成的路徑必定是絕對路徑。這個方法使用的很是多，應該特眼熟，對，前端咱們配置 webpack 的時候會高頻率用到，而且每每還會結合 __dirname 使用。

__dirname，__filename

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

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

<!--當前執行文件的完整路徑爲\Stone\node\node\path_module\test.js-->
const path = require("path");

console.log(__dirname); // \Stone\node\node\path_module
console.log(__filename); // \Stone\node\node\path_module\test.js
複製代碼

而後咱們在 \Stone\node\node 目錄下運行 node path_module\test.js，會發現輸出結果同上， 因此這就是說明 __dirname 和 __filename 始終跟當前執行文件有關，跟啓動腳本所在目錄無關。

./ ../

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

• fs_module 目錄下 執行 node test.js

<!--當前啓動腳本的執行命令所在目錄 \Stone\node\node\fs_module\test.js-->
const fs = require('fs')

fs.readFileSync('./ext/test1.js',(err,data)=> {
    console.log('ok')
})
複製代碼

會正常打印出 ok

• \Stone\node\node 目錄下 執行 node fs_module\test.js

<!--當前啓動腳本的執行命令所在目錄 \Stone\node\node-->
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 模塊在前端的使用頻率仍是很是高的，因此以爲很值得學習瞭解一下的。因爲認知有限，本文如有不許確之處還望路過的各位兄臺及時指正，吃瓜，吃瓜。