Nodejs基本：途径处置惩罚模块path总结

2024年5月7日 154次阅读 来源: 程序猿小卡_casper

本文摘录自《Nodejs进修笔记》，更多章节及更新，请接见 github主页地点。迎接加群交换，群号 197339705。

模块概览

在nodejs中，path是个运用频次很高，但却让人又爱又恨的模块。部份由于文档说的不够清楚，部份由于接口的平台差异性。

将path的接口依据用处归类，细致揣摩揣摩，也就没那末费解了。

猎取途径/文件名/扩大名

  • 猎取途径：path.dirname(filepath)

  • 猎取文件名：path.basename(filepath)

  • 猎取扩大名：path.extname(filepath)

猎取地点途径

例子以下：

var path = require('path');
var filepath = '/tmp/demo/js/test.js';

// 输出：/tmp/demo/js
console.log( path.dirname(filepath) );

猎取文件名

严厉意义上来讲，path.basename(filepath) 只是输出途径的末了一部份，并不会推断是不是文件名。

但大部份时刻，我们能够用它来作为浅易的“猎取文件名“的要领。

var path = require('path');

// 输出：test.js
console.log( path.basename('/tmp/demo/js/test.js') );

// 输出：test
console.log( path.basename('/tmp/demo/js/test/') );

// 输出：test
console.log( path.basename('/tmp/demo/js/test') );

假如只想猎取文件名，单不包含文件扩大呢？能够用上第二个参数。

// 输出：test
console.log( path.basename('/tmp/demo/js/test.js', '.js') );

猎取文件扩大名

简朴的例子以下：

var path = require('path');
var filepath = '/tmp/demo/js/test.js';

// 输出：.js
console.log( path.extname(filepath) );

更细致的划定规矩是以下：（假定 path.basename(filepath) === B ）

  • 从B的末了一个.最先截取，直到末了一个字符。

  • 假如B中不存在.，或许B的第一个字符就是.，那末返回空字符串。

直接看官方文档的例子

path.extname('index.html')
// returns '.html'

path.extname('index.coffee.md')
// returns '.md'

path.extname('index.')
// returns '.'

path.extname('index')
// returns ''

path.extname('.index')
// returns ''

途径组合

  • path.join([…paths])

  • path.resolve([…paths])

path.join([…paths])

把paths拼起来，然后再normalize一下。这句话横竖我本身看着也是稀里糊涂，能够参考下面的伪代码定义。

例子以下：

var path = require('path');

// 输出 '/foo/bar/baz/asdf'
path.join('/foo', 'bar', 'baz/asdf', 'quux', '..');

path定义的伪代码以下：

module.exports.join = function(){
  var paths = Array.prototye.slice.call(arguments, 0);
  return this.normalize( paths.join('/') );
};

path.resolve([…paths])

这个接口的申明有点烦琐。你能够设想如今你在shell下面，从左到右运转一遍cd path敕令，终究猎取的绝对途径/文件名，就是这个接口所返回的效果了。

比方 path.resolve('/foo/bar', './baz') 能够算作下面敕令的效果

cd /foo/bar
cd ./baz

更多对照例子以下：

var path = require('path');

// 假定当前事情途径是 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path

// 输出 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path
console.log( path.resolve('') )

// 输出 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path
console.log( path.resolve('.') )

// 输出 /foo/bar/baz
console.log( path.resolve('/foo/bar', './baz') );

// 输出 /foo/bar/baz
console.log( path.resolve('/foo/bar', './baz/') );

// 输出 /tmp/file
console.log( path.resolve('/foo/bar', '/tmp/file/') );

// 输出 /Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path/www/js/mod.js
console.log( path.resolve('www', 'js/upload', '../mod.js') );

途径剖析

path.parse(path)

path.normalize(filepath)

从官方文档的形貌来看，path.normalize(filepath) 应该是比较简朴的一个API，不过用起来老是以为没底。

为何呢？API申明过于简单了，包含以下：

  • 假如途径为空，返回.，相当于当前的事情途径。

  • 将对途径中反复的途径分隔符（比方linux下的/)合并为一个。

  • 对途径中的.、..举行处置惩罚。（类似于shell里的cd ..）

  • 假如途径末了有/，那末保存该/。

觉得stackoverflow上一个兄弟对这个API的诠释更着实，原文链接。

In other words, path.normalize is “What is the shortest path I can take that will take me to the same place as the input”

代码示例以下。发起读者把代码拷贝出来运转下，看下实际效果。

var path = require('path');
var filepath = '/tmp/demo/js/test.js';

var index = 0;

var compare = function(desc, callback){
  console.log('[用例%d]：%s', ++index, desc);
  callback();
  console.log('\n');
};

compare('途径为空', function(){
  // 输出 .
  console.log( path.normalize('') );
});

compare('途径末端是不是带/', function(){
  // 输出 /tmp/demo/js/upload
  console.log( path.normalize('/tmp/demo/js/upload') );

  // /tmp/demo/js/upload/
  console.log( path.normalize('/tmp/demo/js/upload/') );
});

compare('反复的/', function(){
  // 输出 /tmp/demo/js
  console.log( path.normalize('/tmp/demo//js') );
});

compare('途径带..', function(){
  // 输出 /tmp/demo/js
  console.log( path.normalize('/tmp/demo/js/upload/..') );
});

compare('相对途径', function(){
  // 输出 demo/js/upload/
  console.log( path.normalize('./demo/js/upload/') );

  // 输出 demo/js/upload/
  console.log( path.normalize('demo/js/upload/') );
});

compare('不经常使用边境', function(){
  // 输出 ..
  console.log( path.normalize('./..') );

  // 输出 ..
  console.log( path.normalize('..') );

  // 输出 ../
  console.log( path.normalize('../') );

  // 输出 /
  console.log( path.normalize('/../') );
  
  // 输出 /
  console.log( path.normalize('/..') );
});

感兴趣的能够看下 path.normalize(filepath) 的node源码以下：传送门

文件途径剖析/组合

  • path.format(pathObject)：将pathObject的root、dir、base、name、ext属性，依据肯定的划定规矩，组合成一个文件途径。

  • path.parse(filepath)：path.format()要领的反向操纵。

我们先来看看官网对相干属性的申明。

首先是linux下

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
"  /    home/user/dir / file  .txt "
└──────┴──────────────┴──────┴─────┘
(all spaces in the "" line should be ignored -- they are purely for formatting)

然后是windows下

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
" C:\      path\dir   \ file  .txt "
└──────┴──────────────┴──────┴─────┘
(all spaces in the "" line should be ignored -- they are purely for formatting)

path.format(pathObject)

浏览相干API文档申明后发明，path.format(pathObject)中，pathObject的设置属性是能够进一步精简的。

依据接口的形貌来看，以下二者是等价的。

  • root vs dir：二者能够相互替代，区分在于，途径拼接时，root后不会自动加/，而dir会。

  • base vs name+ext：二者能够相互替代。

var path = require('path');

var p1 = path.format({
  root: '/tmp/', 
  base: 'hello.js'
});
console.log( p1 ); // 输出 /tmp/hello.js

var p2 = path.format({
  dir: '/tmp', 
  name: 'hello',
  ext: '.js'
});
console.log( p2 );  // 输出 /tmp/hello.js

path.parse(filepath)

path.format(pathObject) 的反向操纵，直接上官网例子。

四个属性，关于运用者是挺方便的，不过path.format(pathObject) 中也是四个设置属性，就有点轻易搞混。

path.parse('/home/user/dir/file.txt')
// returns
// {
//    root : "/",
//    dir : "/home/user/dir",
//    base : "file.txt",
//    ext : ".txt",
//    name : "file"
// }

猎取相对途径

接口：path.relative(from, to)

形貌：从from途径，到to途径的相对途径。

边境：

  • 假如from、to指向同个途径，那末，返回空字符串。

  • 假如from、to中任一者为空，那末，返回当前事情途径。

上例子：

var path = require('path');

var p1 = path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb');
console.log(p1);  // 输出 "../../impl/bbb"

var p2 = path.relative('/data/demo', '/data/demo');
console.log(p2);  // 输出 ""

var p3 = path.relative('/data/demo', '');
console.log(p3);  // 输出 "../../Users/a/Documents/git-code/nodejs-learning-guide/examples/2016.11.08-node-path"

平台相干接口/属性

以下属性、接口，都跟平台的详细完成相干。也就是说，一样的属性、接口，在差别平台上的表现差别。

  • path.posix：path相干属性、接口的linux完成。

  • path.win32：path相干属性、接口的win32完成。

  • path.sep：途径分隔符。在linux上是/，在windows上是“。

  • path.delimiter：path设置的支解符。linux上是:，windows上是;。

注重，当运用 path.win32 相干接口时，参数一样能够运用/做分隔符，但接口返回值的支解符只会是“。

直接来例子更直观。

> path.win32.join('/tmp', 'fuck')
'\\tmp\\fuck'
> path.win32.sep
'\\'
> path.win32.join('\tmp', 'demo')
'\\tmp\\demo'
> path.win32.join('/tmp', 'demo')
'\\tmp\\demo'

path.delimiter

linux体系例子：

console.log(process.env.PATH)
// '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'

process.env.PATH.split(path.delimiter)
// returns ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']

windows体系例子：

console.log(process.env.PATH)
// 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'

process.env.PATH.split(path.delimiter)
// returns ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']

相干链接

官方文档：https://nodejs.org/api/path.h…

    原文作者：程序猿小卡_casper
    原文地址: https://segmentfault.com/a/1190000007471775
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞