ノードのパスモジュールについて説明する記事

path モジュールは、ファイル/ディレクトリ パスを処理するための、nodejs の組み込みモジュールです。ツールボックスとみなすことができ、使用できる多くのメソッドを提供します。すべてパス処理に関連します。同時に、パス モジュールは、Webpack を構成するときなど、フロントエンド開発で頻繁に表示されます。この記事では、このモジュールでよく使用されるメソッドをいくつか紹介します。一緒に学びましょう。 [関連チュートリアルの推奨事項: nodejs ビデオ チュートリアル 、プログラミング教育 ]

• nodejs のすべてのモジュール (組み込み、カスタム) は次のとおりであることに注意してください。 required require を使用してインポートします。通常、インポート位置はファイルの先頭になります。
#

const path = require('path');

#API

basename (パスのベース名を取得)

path.basename (path [,ext])
• path: ファイル/ディレクトリ パス
  • ext: (オプション) .js .css などのファイル拡張子
  • 戻り値: path path 最後の部分
注:
• path が文字列でない場合、または指定された ext パラメータが文字列でない場合は、TypeError がスローされます
  • ext パラメータがある場合、ext 接尾辞名がファイル名と一致すると、返されるファイル名はファイル接尾辞を省略します。
  • パスの末尾にディレクトリ区切り文字がある場合、それは無視されます

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 がスローされます
  • パスの末尾にディレクトリ区切り文字がある場合は無視されます

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: ファイル/ディレクトリ パス
  • 戻り値: 最後の「.」出現箇所からのパス拡張子。パスの最後の部分の文字列の末尾までの文字。拡張子がない場合は、空が返されます
注:
• パスが文字列でない場合は、 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: ファイルのサフィックス名
  #注:
• if 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'
  //   }

形式 (シリアル化パス)

path.format(pathObj) シリアル化パス パス。path.parse()の反対です。

• pathObj: パス オブジェクト
  • Return値: シリアル化された文字列パス (obj => string)
注:

• pathObject がオブジェクトではない場合、TypeError がスローされます
  • pathObject の属性は優先順位に注意する必要があります。
  • dir 属性が存在する場合、root 属性は無視されます。
    • base 属性が存在する場合、name および ext属性は無視されます
isAbsolute (絶対パスかどうか)

path.isAbsolute(path)

• #path: ファイル/ディレクトリ パス

  戻り値: true/false
  • #注:
#パスが文字列でない場合、TypeError がスローされます
• #指定されたパス文字列の長さが 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(&#39;fs&#39;)
  
  fs.readFileSync(&#39;./ext/test1.js&#39;,(err,data)=> {
      console.log(&#39;ok&#39;)
  })

  会正常打印出 ok

  • \Stone\node\node 目录下 执行 node fs_module\test.js

  <!--当前启动脚本的执行命令所在目录 \Stone\node\node-->
  const fs = require(&#39;fs&#39;)
  
  fs.readFile(&#39;./ext/test1.js&#39;,(err,data)=> {
      console.log(&#39;ok&#39;)
  })

  运行会报错 no such file or directory, open './ext/test1.js'

  这到底是为啥嘞，原因就是 './' 和 '../' 的路径表示意义需要分情况，当结合 require() 使用的时候相对于当前执行文件，如果不结合 require() 使用的情况下会相对于当前启动脚本的目录，因此只有在 require() 时才使用相对路径(./, ../) 的写法，其他地方一律使用绝对路径，这点一定要注意。

  结语

  关于nodejs path 模块，我们今天就说到这里了，虽然 api 不是很多，但是 path 模块在前端的使用频率还是非常高的，所以觉得很值得学习了解一下的。由于认知有限，本文若有不准确之处还望路过的各位兄台及时指正，吃瓜，吃瓜。

  更多node相关知识，请访问：nodejs 教程！

以上がノードのパスモジュールについて説明する記事の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。