webpack及node.js基础必会--path模块的常见操作

前言

在没有相关经验的同学，在学习webpack和使用node时，经常会遇到__dirname path.resolve 等，这时往往会一脸懵逼这些都是什么，干嘛的，为什么这些资料和书都完全不提，难道就我不知道 -。-

其实path模块是很常见很通用的。这里我就简单总结一些在项目中经常会用到的方法，帮助大家尽快掌握。

1, 获取规范化的路径/路径/文件名/扩展名

获取规范化的路径：path.normaliz(filepath)
获取路径：path.dirname(filepath)
获取文件名：path.basename(filepath)
获取扩展名：path.extname(filepath)

1.1获取规范化的路径格式

path.normalize() 方法会规范化给定的 path，并解析 '..' 和 '.' 片段。
当发现多个连续的路径分隔符时（如 POSIX 上的 / 与 Windows 上的 \ 或 /），它们会被单个的路径分隔符（POSIX 上是 /，Windows 上是 \）替换。末尾的多个分隔符会被保留。
如果 path 是一个长度为零的字符串，则返回 '.'，表示当前工作目录。

path.normalize('C:\\temp\\\\foo\\bar\\..\\');
// 返回: 'C:\\temp\\foo\\'

var myPath = path.normalize(__dirname + '/test/a//b//../c/helloWorld.js');
console.log(myPath); //windows: E:\workspace\NodeJS\app\fs\test\a\c\helloWorld.js

PS：

Windows系统下，'/'和'\'均可以表示路径，但是在网络链接里只能用'/'表示路径。
如果 path 不是一个字符串，则抛出 TypeError。

1.2 获取所在路径

例子如下：

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

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

var myPath = path.dirname(__dirname + '/test/util/helloWorld.js');
console.log(myPath);

//Users/cayley/Documents/webpack-demo/test/util

__dirname是node.js中的一个全局变量，用来获取当前模块文件所在目录的完整绝对路径

1.3 获取文件名

严格意义上来说，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') );

1.4 获取文件扩展名

简单的例子如下：

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 ''

2, 路径组合

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

2.1 path.join([...paths])

path.join() 方法使用平台特定的分隔符把全部给定的 path 片段连接到一起，并规范化生成的路径。长度为零的 path 片段会被忽略。如果连接后的路径字符串是一个长度为零的字符串，则返回 '.'，表示当前工作目录。

参数说明： ...paths <string> 一个路径片段的序列。返回:

把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.join('/foo', 'bar', 'baz/asdf', 'quux', '.');          //  返回 /foo/bar/baz/asdf/quux, "."和"/"没什么影响
path.join('/foo', './bar', 'baz/asdf', '.', 'quux');        //  返回 /foo/bar/baz/asdf/quux
path.join('/foo', './bar', './baz/asdf', 'quux', '..');     //  返回 /foo/bar/baz/asdf
path.join('/foo', 'bar', 'baz/asdf', '.', '.');             //  返回 /foo/bar/baz/asdf
path.join('/foo', 'bar', 'baz/asdf', 'quux');               //  返回 /foo/bar/baz/asdf/quux
path.join('/foo', 'bar', 'baz/asdf', '..', '..');           //  返回 /foo/bar

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

智能解析绝对路径 path.resolve() 方法会把一个路径或路径片段的序列解析为一个绝对路径。层级关系是从左到右的.

规则：
1\. 给定的路径的序列是从右往左被处理的，后面每个 path 被依次解析，直到构造完成一个绝对路径。
2\. 如果处理完全部给定的 path 片段后还未生成一个绝对路径，则当前工作目录会被用上。
3\. 生成的路径是规范化后的，且末尾的斜杠会被删除，除非路径被解析为根目录。
4\. 长度为零的 path 片段会被忽略。
5\. 如果没有传入 path 片段，则 path.resolve() 会返回当前工作目录的绝对路径。
6\. path.resolve将以/开始的路径片段作为根目录，在此之前的路径将会被丢弃，就像是在terminal中使用cd命令一样。而path.join只是简单的将该路径片段进行拼接

比如 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') );

更多例子：

// 当前工作目录与当前文件路径(F:/1/2/task6/test/dist)有区别
path.resolve();                               //  F:/1/2/task6/test 当前工作目录的绝对路径
path.resolve('./a');                          //  F:/1/2/task6/test/a 
path.resolve('../a');                         //  F:/1/2/task6/a
path.resolve('.');                            //  F:/1/2/task6/test 
path.resolve('..');                           //  F:/1/2/task6
path.resolve('/'));                           //  F:/
path.resolve('./a','../c/d');                 //  F:/1/2/task6/test/c/d
path.resolve('./a','./c/d');                  //  F:/1/2/task6/test/a/c/d
path.resolve('/a','../c/d');                  //  F:c/d
path.resolve('/a','./c/d');                   //  F:/a/c/d
path.resolve('./a','/b','./c/d');             //  F:/b/c/d
path.resolve('a','b','c/d');                  //  F:/1/2/task6/test/a/b/c/d
path.resolve('./a','./b','c/d');              //  F:/1/2/task6/test/a/b/c/d
path.resolve('./a','/b','c/d');               //  F:/b/c/d
path.resolve('./a/b','..','c/d');             //  F:/1/2/task6/test/a/c/d
path.resolve('./a','..','c/d');               //  F:/1/2/task6/test/c/d

3, 获取相对路径

接口：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"

参考及感谢

Node入门教程(8)第六章：path 模块详解