技術文章 » 一文聊聊node中的path模組

一文聊聊node中的path模組

2022-12-14 22:00:58

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

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\barpath.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 模組在前端的使用頻率還是非常高的，所以覺得很值得學習瞭解一下的。由於認知有限，本文若有不準確之處還望路過的各位兄臺及時指正，吃瓜，吃瓜。

更多node相關知識，請存取：！

以上就是一文聊聊node中的path模組的詳細內容，更多請關注TW511.COM其它相關文章！