node的path模塊是什么及怎么使用

這篇“node的path模塊是什么及怎么使用”文章的知識(shí)點(diǎn)大部分人都不太理解，所以小編給大家總結(jié)了以下內(nèi)容，內(nèi)容詳細(xì)，步驟清晰，具有一定的借鑒價(jià)值，希望大家閱讀完這篇文章能有所收獲，下面我們一起來(lái)看看這篇“node的path模塊是什么及怎么使用”文章吧。

path 模塊是 nodejs 中用于處理文件/目錄路徑的一個(gè)內(nèi)置模塊，可以看作是一個(gè)工具箱，提供諸多方法供我們使用，當(dāng)然都是和路徑處理有關(guān)的。同時(shí)在前端開(kāi)發(fā)中 path 模塊出現(xiàn)的頻率也是比較高的，比如配置 webpack 的時(shí)候等。本文是對(duì)該模塊中一些常用的方法進(jìn)行介紹，走，一起學(xué)習(xí)下吧。

• 需要注意下，nodejs 中所有的模塊（內(nèi)置，自定義）都需要使用 requier 進(jìn)行導(dǎo)入，一般導(dǎo)入位置在文件頂部。

const path = require('path');

API

basename （獲取路徑基礎(chǔ)名）

• path.basename(path[,ext])

• path：文件/目錄路徑

• ext：（可選）文件擴(kuò)展名 例如 .js .css 等

• 返回值：path 路徑的最后一部分

• 注意：

• 如果 path 不是字符串或者給定的 ext 參數(shù)不是字符串，則拋出 TypeError

• 如果有 ext 參數(shù)，當(dāng) ext 后綴名與文件名匹配上時(shí)返回的文件名會(huì)省略文件后綴

• 如果 path 尾部有目錄分隔符則會(huì)被忽略

const path = require("path");

path.basename('./ext/test.js') //test.js
path.basename('./ext/test.js','.js') //test (當(dāng)后綴名與文件名匹配上時(shí)返回的文件名會(huì)省略文件后綴)
path.basename('./ext/test.js','.html') //test.js (沒(méi)有匹配上時(shí)返回文件全名)
path.basename('./ext/foo/') // foo (尾部目錄分隔符被忽略)

dirname （獲取路徑目錄名）

• path.dirname(path)

• path：文件/目錄路徑

• 返回值：path 路徑的目錄名

• 注意：

• 如果 path 不是字符串，則拋出 TypeError

• 如果 path 尾部有目錄分隔符則會(huì)被忽略

const path = require("path");

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

extname （獲取路徑擴(kuò)展名）

• path.extname(path)

• path：文件/目錄路徑

• 返回值：path 路徑的擴(kuò)展名，從最后一次出現(xiàn) '.' 字符到 path 最后一部分的字符串結(jié)束,無(wú)擴(kuò)展名則返回空

• 注意：

• 如果 path 不是字符串，則拋出 TypeError

const path = require("path");

path.extname('foo/bar/baz/test.js'); // .js
path.extname('foo/bar/baz');// '' (無(wú)擴(kuò)展名返回 '')
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 )

• root：根目錄

• dir： 文件所在的文件夾

• base：完整文件 ( index.js )

• name：文件名

• ext: 文件后綴名

• path：文件/目錄路徑

• 返回值：帶有屬性(dir,root,base,name,ext)的對(duì)象

• 注意：

• 如果 path 不是字符串，則拋出 TypeError

• 如果尾部有目錄分隔符則會(huì)被忽略

• 一圖勝千言

┌──────────────────┬────────────┐
│          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') //當(dāng)路徑為相對(duì)路徑 ./ 或../時(shí) 解析結(jié)果中root(代表根目錄,絕對(duì)路徑才有值)為 ''
// {
//     root: '',
//     dir: './foo/bar/baz',
//     base: 'index.js',
//     ext: '.js',
//     name: 'index'
//   }

format （序列化路徑）

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

• pathObj：path對(duì)象

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

• 注意：

• 當(dāng) dir 屬性存在則忽略 root 屬性

• 當(dāng) base 屬性存在則會(huì)忽略 name 和 ext 屬性

• 如果 pathObject 不是對(duì)象，則拋出 TypeError

• pathObject 中的屬性需要注意優(yōu)先級(jí)：

isAbsolute （是否是絕對(duì)路徑）

• path.isAbsolute(path)

• path：文件/目錄路徑

• 返回值：true/false

• 注意：

  參考 前端面試題詳細(xì)解答

• 如果 path 不是字符串，則拋出 TypeError

• 如果給定的 path 字符串長(zhǎng)度為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：路徑片段

• 返回值：使用平臺(tái)特定的分隔符作為定界符將所有給定的 path 片段連接在一起規(guī)范化后生成的路徑

• 注意：

• 如果 paths 不是字符串片段，則拋出 TypeError

• 零長(zhǎng)度的 path 片段會(huì)被忽略

• 如果連接后的路徑字符長(zhǎng)度為0，則返回 '.'，表示當(dāng)前工作目錄

• 目錄分隔符有平臺(tái)差異,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（規(guī)范化路徑）

• path.normalize(path)

• path: 文件/目錄路徑

• 返回值：規(guī)范后的路徑字符串

• 注意：

• 如果 path 不是字符串片段，則拋出 TypeError

• 尾部的分隔符會(huì)保留

• 如果 path字符串長(zhǎng)度為0，則返回 '.'，表示當(dāng)前工作目錄

• 路徑中的目錄分隔符均會(huì)被替換成平臺(tái)特定的目錄分隔符,windows 系統(tǒng) 會(huì)將 '/' 或'' 均替換成 ''

• 路徑中連續(xù)的多個(gè)分隔符會(huì)被規(guī)范化為一個(gè)

• 路徑中最好不要出現(xiàn)單個(gè) ' \ ',因?yàn)楫?dāng)和字母在一起的時(shí)候會(huì)被當(dāng)做轉(zhuǎn)義符

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\ (轉(zhuǎn)義字符出現(xiàn))path.normalize('temp//foo/\bar') // temp\fooar (轉(zhuǎn)義字符出現(xiàn))

relative（獲取 from 到 to 的相對(duì)路徑）

• path.relative(from,to)

• from，to: 文件/目錄路徑

• 返回值：from 到 to 的相對(duì)路徑（to 相對(duì)于 form 的相對(duì)路徑）

• 注意：

• 如果 from 和 to 指向相同路徑相同 則返回 ''

• 如果 from 或 to 任何一方為空,則使用當(dāng)前工作目錄代替其空路徑

• 
  

const path = require("path");

//當(dāng)前工作目錄為 \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

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

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

• path.resolve([...paths])

• paths: 路徑或路徑片段的序列

• 返回值：路徑或路徑片段序列解析為絕對(duì)路徑。（將路徑片段解析后生成的絕對(duì)路徑）

• 注意：

• 路徑片段如果給出則必須是字符串類(lèi)型，否則類(lèi)型錯(cuò)誤

• 給定的路徑序列從右到左進(jìn)行處理，每個(gè)后續(xù)的 path 前置，直到構(gòu)造出一個(gè)絕對(duì)路徑

• 如果處理完所有給定的 path 片段之后還未生成絕對(duì)路徑，則再加上當(dāng)前工作目錄

• 生成的路徑均已規(guī)范化，并且除非將路徑解析為根目錄，否則將刪除尾部斜杠

• 零長(zhǎng)度的 path 片段會(huì)被忽略

• 若沒(méi)有傳入 path 片段，則 path.resolve() 將返回當(dāng)前工作目錄的絕對(duì)路徑

const path = require("path");

//當(dāng)前工作目錄為 \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 方法解析路徑片段的時(shí)候會(huì)從右往左的順序依次解析，直到構(gòu)造出一個(gè)絕對(duì)路徑，否則會(huì)將當(dāng)前工作目錄加在路徑開(kāi)頭。所以，通過(guò) resolve 解析生成的路徑一定是絕對(duì)路徑。這個(gè)方法使用的非常多，應(yīng)該特眼熟，對(duì)，前端我們配置 webpack 的時(shí)候會(huì)高頻率用到，并且往往還會(huì)結(jié)合 __dirname 使用。

__dirname，__filename

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

• __filename：可以看作是 nodejs 中的全局變量，它始終表示當(dāng)前執(zhí)行文件的完整文件名(完整絕對(duì)路)

我們先在 path_module 目錄下運(yùn)行 node test.js 命令

<!--當(dāng)前執(zhí)行文件的完整路徑為\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

然后我們?cè)?\Stone\node\node 目錄下運(yùn)行 node path_module\test.js，會(huì)發(fā)現(xiàn)輸出結(jié)果同上， 所以這就是說(shuō)明 __dirname 和 __filename 始終跟當(dāng)前執(zhí)行文件有關(guān)，跟啟動(dòng)腳本所在目錄無(wú)關(guān)。

./ ../

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

• fs_module 目錄下 執(zhí)行 node test.js

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

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

會(huì)正常打印出 ok

• \Stone\node\node 目錄下 執(zhí)行 node fs_module\test.js

<!--當(dāng)前啟動(dòng)腳本的執(zhí)行命令所在目錄 \Stone\node\node-->
const fs = require('fs')

fs.readFile('./ext/test1.js',(err,data)=> {
    console.log('ok')
})

運(yùn)行會(huì)報(bào)錯(cuò) no such file or directory, open './ext/test1.js'

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

以上就是關(guān)于“node的path模塊是什么及怎么使用”這篇文章的內(nèi)容，相信大家都有了一定的了解，希望小編分享的內(nèi)容對(duì)大家有幫助，若想了解更多相關(guān)的知識(shí)內(nèi)容，請(qǐng)關(guān)注億速云行業(yè)資訊頻道。