乐趣区

关于node.js:细说nodejs的path模块

jiezi

前言

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 任何一方为空, 则应用当前工作目录代替其空门路
    • 参考 nodejs 进阶视频解说：进入学习
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 模块在前端的应用频率还是十分高的，所以感觉很值得学习理解一下的。因为认知无限，本文若有不精确之处还望路过的各位兄台及时斧正，吃瓜，吃瓜。

退出移动版