node之path模組

• 2020 年 12 月 24 日
• 筆記
• javascript, path

路徑概念介紹

概念

所謂路徑，就是定位一個文件所在的位置時，所必須經過 的目錄的層級結構的集合.

絕對路徑與相對路徑

• windows 下的相對與絕對路徑

  資料原文

  完全限定路徑(絕對路徑)與相對路徑

  對於操作文件的 Windows API 函數，文件名通常可以相對於當前目錄，而一些 API 需要一個完全限定的路徑。如果文件名不是用下列內容之一開頭的，則該文件名是相對路徑(相對於當前工作目錄):

  • 任何格式的通用命名約定(UNC)名稱: 總是以兩個反斜杠字元(“\”)開頭

  • 帶冒號與反斜杠的磁碟指示符，例如「C:\」或「d:\」

  • 一個反斜杠，例如，「\directory」或「\file.txt」,這也屬於絕對路徑

  如果文件名僅以磁碟指示符開頭，後面不帶冒號加反斜杠的組合，則它將被解釋為該磁碟驅動器上當前目錄的相對路徑。
  注意，當前目錄可能是根目錄，也可能不是根目錄，這取決於最近在該磁碟上進行「更改目錄(cd)」操作時將其設置為什麼。這種格式的例子如下:

  • 「C: tmp.txt」指的是一個在驅動器 C 上的當前目錄中,名為「tmp」的文件
  • 「C: tempdir \ tmp.txt」指的是 C 驅動器上當前目錄的子目錄中的一個文件

  程式碼示例:(DOS)

  cd "C:\windows"
  
  node C:test.js ::執行C:\windows\test.js
  node D:test.js ::執行D:\test.js
  

  如果一個路徑包含「雙點」，亦即，路徑的一個組件是兩個連續的點,它也被稱為相對路徑;。這個特殊的說明符用於表示當前目錄之上的目錄，也稱為「父目錄」。這種格式的例子如下:

  • 「. . \ tmp.txt”指定一個名為 tmp.txt 的文件，該文件位於當前目錄的父目錄中。

  • 「. . \ . . \ tmp.txt「指定當前目錄之上兩個目錄的文件。

  • 「. . \ tempdir \ tmp.txt”指定一個名為 tmp.txt 的文件，它位於一個名為 tempdir 的目錄中，該目錄是當前目錄的對等目錄

  相對路徑可以組合這兩種示例類型使用，例如「C:..\tmp.txt」 , 這是有效的,因為,儘管系統持續跟蹤記錄當前驅動器的當前目錄 . 它還跟蹤所有驅動器(如果你的系統有不止一個)中的當前目錄, 不管當前驅動器是被設置為哪一個.

  DOS 舉例：

  cd /d "D:\test1\test2\test3" ::系統追蹤記錄D盤及D盤當前目錄為D:\test1\test2\test3
  cd /d "C:\windows\Boot" ::系統追蹤記錄C盤及C盤當前目錄為C:\windows\Boot
  cd /d "E:\video" ::系統追蹤記錄E盤及E盤當前目錄為E:\video
  
  node D:..\test.js ::執行D:\test1\test2\test.js
  node C:..\test.js ::執行C:\windows\test.js
  ::注意-所謂追蹤和記錄多個盤的當前目錄,指的是在同一個cmd會話之中記錄,多個cmd會話之間是不共享的
  

Windows 與 POSIX 的對比

• 什麼是 POSIX

  可移植作業系統介面(Portable Operating System Interface，縮寫為 POSIX):

  1. 是 IEEE 為要在各種 UNIX 作業系統上運行軟體，而定義 API 的一系列互相關聯的標準的總稱，其正式稱呼為 IEEE Std 1003，而國際標準名稱為 ISO/IEC 9945

  2. 它基本上是 Portable Operating System Interface（可移植作業系統介面）的縮寫，而 X 則表明其對 Unix API 的傳承

  3. Linux 基本上逐步實現了 POSIX 兼容，但並沒有參加正式的 POSIX 認證。

  簡單來看，POSIX 就是 UNIX 與類 UNIX 系統.

• POSIX 與 windows 上路徑的區別

  • 路徑分隔符

    windows 下使用的是「\」作為分隔符，而 linux 則反其道而行之使用”/”作為分隔符.所以在 windows 環境中獲取路徑常見 C:\windows\system 的形式，而 linux 常見 /user/share 的形式

  • 絕對路徑

    • windows: 以盤符開始,如 C:\a.txt
    • linux: 以根目錄/開始, 如/user/share

• 更多參考

path 模組對 windows 與 POSIX 路徑的處理方案

• windows 路徑的注意事項

  因為 windows 使用反斜杠\作為路徑分隔符, 而 js 中的反斜杠被用來對特殊字元進行轉義. 因此,直接的 windows 文件路徑字元串是不能直接在 node 程式中使用的.舉例如下:

  let path = require("path");
  let raw = 「C:\Windows\node\」;
  
  console.log(path.basename(rawPath));
  // 輸出:
  // Windows
  // ode
  // 原因: \node 中的 \n 被解析為一個換行符
  

不過不需要擔心,我們只需要在 js 源程式碼中注意不要這麼草率地直接使用這種字面量即可.像是從另一個文件讀取內容這種操作,在讀取過程中,node 會自動對其中的反斜杠進行轉義,不需要我們來操心.如下例:

raw.txt:

C:\Windows\node

test.js

let path = require("path");
let fs = require("fs");

let raw = fs.readFileSync("./raw.txt", "utf-8"); //文件讀取時,會將C:\Windows\node自動轉義為C:\\Windows\\node
console.log(path.basename(raw)); //node

• path 模組對 windows 與 POSIX 的解決方案

  path 提供了 path.win32 與 path.posix 兩個屬性來分別解決 windows 與 posix 類型的路徑.

  let path = require("path");
  
  console.log("path:\n");
  console.log(Object.keys(path).length);
  console.log(Object.keys(path));
  
  console.log("path.win32:\n");
  console.log(Object.keys(path.win32).length);
  console.log(Object.keys(path.win32));
  
  console.log("path.posix:\n");
  console.log(Object.keys(path.posix).length);
  console.log(Object.keys(path.posix));
  
  // 輸出:
  // path:
  // 16
  // [
  //   'resolve',    'normalize',
  //   'isAbsolute', 'join',
  //   'relative',   'toNamespacedPath',
  //   'dirname',    'basename',
  //   'extname',    'format',
  //   'parse',      'sep',
  //   'delimiter',  'win32',
  //   'posix',      '_makeLong'
  // ]
  // path.win32:
  // 16
  // [
  //   'resolve',    'normalize',
  //   'isAbsolute', 'join',
  //   'relative',   'toNamespacedPath',
  //   'dirname',    'basename',
  //   'extname',    'format',
  //   'parse',      'sep',
  //   'delimiter',  'win32',
  //   'posix',      '_makeLong'
  // ]
  // path.posix:
  // 16
  // [
  //   'resolve',    'normalize',
  //   'isAbsolute', 'join',
  //   'relative',   'toNamespacedPath',
  //   'dirname',    'basename',
  //   'extname',    'format',
  //   'parse',      'sep',
  //   'delimiter',  'win32',
  //   'posix',      '_makeLong'
  // ]
  

  三個對象都擁有完全一樣的屬性與方法.path 中的主要方法都有對應的 win32 和 posix 版本來分別處理兩種不同的路徑風格.

路徑組件獲取

說明: 路徑組件的獲取函數(方法),都只是基於最基本的字元匹配模式的操作,不會對.或..進行解析和運算.

path.basename

語法

path.basename(path[, ext])

• 返回 path 的最後一部分

• 尾部的分隔符會被忽略

• 傳入可選參數 ext(擴展名),可在結果中過濾掉擴展名

  • ext 參數區分大小寫(.html 與.HTML 為不同擴展名)

  • 這與 windows 無視文件擴展名大小寫的行為不同.

  • 其實質可以視為:

    path.basename(path).replace(ext,"")

  path.basename("/目錄1/目錄2/文件.html");
  // 返回: '文件.html'
  path.basename("/目錄1/目錄2/文件.html", ".html");
  // 返回: '文件'
  path.basename("/目錄1/目錄2/文件.HTML", ".html");
  // 返回: '文件.HTML'
  

path.dirname

語法

path.dirname(path)

• 返回 path 的目錄名
• 尾部的目錄分隔符(path.sep)會被忽略

path.dirname('/目錄1/目錄2/目錄3');
// 返回: '/目錄1/目錄2'

說明: 路徑組件的獲取函數(方法),都只是基於最基本的字元匹配模式的操作,不會對.或..進行解析和運算.
舉例如下:

let path = require("path");

let p1 = "c:\\windows\\node\\test\\..\\";
console.log(path.basename(p1)); //輸出 ..

let p2 = "c:\\windows\\node\\..\\test\\test.md";
console.log(path.dirname(p2)); //輸出 c:\windows\node\..\test

path.delimiter

這是一個屬性值，返回平台特定的路徑定界符

• windows: 分號;
• posix: 冒號:

path.extname

這是一個屬性值,返迴路徑中的擴展名

擴展名:

• path 的最後一部分中從最後一次出現 . （句點）字元直到字元串結束
• path 最後一部分中沒有.，或者 path 的基本名稱(basename)除了第一個字元以外沒有.，則返回空字元
  串

path.sep

這是一個屬性值,平台特定的路徑片段(組件)分隔符

• Windows: 反斜杠\
• POSIX: 正斜杠/

路徑處理函數

說明: 路徑處理函數,不同於路徑組件的獲取函數,會對路徑中的.及..進行解析,也就是基於相對路徑語法進行路徑運算.

path 模組的內容:

• 錯誤處理: ERR_INVALID_ARG_TYPE
• 關鍵字元的 unicode 碼點常量: require 自 internal/constants
• 字元串類型驗證: validateString
• 工具函數
  • 路徑分隔符判斷: isPathSeparato
  • POSIX 分隔符判斷: isPosixPathSeparator
  • windows 盤符判斷: isWindowsDeviceRoot
  • 相對路徑解析(解析.或..): normalizeString
  • path 對象格式化為字元串: _format
• windows 平台系列處理函數封裝: win32 對象
• POSIX 平台系列處理函數封裝： posix 對象

主要函數的調用關係

win32 與 posix 對象

• 各自包含一整套特定於對應平台的路徑獲取與路徑處理函數
• 各自包含指向對方的引用

示例圖：