nodejs 5.2.0文档自翻译——Path模块

模块方法概览

• Path
  • path.basename(p[, ext])
  • path.delimiter
  • path.dirname(p)
  • path.extname(p)
  • path.format(pathObject)
  • path.isAbsolute(path)
  • path.join([path1][, path2][, ...])
  • path.normalize(p)
  • path.parse(pathString)
  • path.posix
  • path.relative(from, to)
  • path.resolve([from ...], to)
  • path.sep
  • path.win32

Path模块

这个模块包含传递和转换文件路径的公共程序。几乎所有的方法只会在字符串转化的时候执行。 文件系统不会尝试去确认路径是否合法。

通过 require('path')来使用这个模块。 以下是该模块提供的方法：

path.basename(p[, ext])

返回路径的最后一部分。就像Unix中的basename命令那样。

例子：

path.basename('/foo/bar/baz/asdf/quux.html')
// returns
'quux.html'

path.basename('/foo/bar/baz/asdf/quux.html', '.html')
// returns
'quux'

path.delimiter

平台特定的路径分隔符， ';'或者 ':' 。

在UNIX或者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\\']

译者多嘴一句：不要把精力过多的放在细节上，如果你不太明白某个属性或方法是怎么回事，don't worry，一切都会随着时间而变得好起来。

path.dirname(p)

返回一个路径所对应的文件夹名。就像你在Unix下使用dirname命令那样。

例子：

path.dirname('/foo/bar/baz/asdf/quux')
// returns
'/foo/bar/baz/asdf'

path.extname(p)

返回路径的扩展名，从最后一个'.'字符到路径最后一个部分的字符串的结尾。如果在路径的最后一部分中没有'.'字符或者以'.'字符开头，那么则会返回一个空字符串。

例子：

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.format(pathObject)

从一个对象中返回一个路径字符串, 与之相对应的方法请参考path.parse。

例子：

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

path.isAbsolute(path)

确认传进来的path参数是否是一个绝对路径。一个绝对路径将总是解析到相同的位置，并无视工作文件夹。

Posix下的例子：

path.isAbsolute('/foo/bar') // true
path.isAbsolute('/baz/..')  // true
path.isAbsolute('qux/')     // false
path.isAbsolute('.')        // false

Windows下的例子：

path.isAbsolute('//server')  // true
path.isAbsolute('C:/foo/..') // true
path.isAbsolute('bar\\baz')  // false
path.isAbsolute('.')         // false

注意： 如果被当作参数传递的路径字符串是一个长度为0的字符串，与path模块下其他的方法不同，他会按照原样使用并返回false。

path.join([path1][, path2][, ...])

把所有的参数结合在一起并标准化。

参数必须是字符串。在v0.8下,不是字符串的参数会被忽略.在v0.10或更高版本，会抛出一个异常。

例子：

path.join('/foo', 'bar', 'baz/asdf', 'quux', '..')
// returns
'/foo/bar/baz/asdf'

path.join('foo', {}, 'bar')
// throws exception
TypeError: Arguments to path.join must be strings

Note: join方法的参数中如果有长度为0的字符串，与path模块下其他的函数不同，这些参数将会被忽略。如果没有给join方法传递任何参数那么会返回'.', 代表目前的工作目录。

path.normalize(p)

标准化一个路径字符串， 特别是'..'和'.'的部分。

当发现多个斜杠时，他们将会替换成一个单斜杠； 当一个路径结尾有一个斜杠，它将会被保留。在windows下会使用反斜线。

例子：

path.normalize('/foo/bar//baz/asdf/quux/..')
// returns
'/foo/bar/baz/asdf'

注意： 如果将一个空字符串当作参数传递那么会返回一个'.'，代表当前的工作目录。

path.parse(pathString)

将一个路径字符串当作对象返回。

在UNIX或LINUX下的例子：

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

在windows下的例子：

path.parse('C:\\path\\dir\\index.html')
// returns
{
    root : "C:\\",
    dir : "C:\\path\\dir",
    base : "index.html",
    ext : ".html",
    name : "index"
}

path.posix

提供一个访问path前缀的方法但是一般会由于posix兼容方式二相互影响。（译者水平有限，这句翻译不准）

path.relative(from, to)

有时候我们有两个绝对路径， 我们需要从一个路径向另外一个路径派生他们之间有关系的路径。 这个方法实际上是path.resolve的相反方法，比如：

path.resolve(from, path.relative(from, to)) == path.resolve(to)

例子：

path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb')
// returns
'..\\..\\impl\\bbb'

path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')
// returns
'../../impl/bbb'

提示：如果relative方法的的参数是空字符串那么当前的工作目录会去替代那个空字符串。如果提供了两个相同的参数，那么该方法会返回一个空字符串。

path.resolve([from ...], to)

将 to 分解成一个绝对路径。

如果 to 不是一个绝对路径那么from将会被优先考虑， 直到找到一个绝对路径。如果用完了所有的from依然没有找到绝对路径，就会使用当前的工作目录。结果路径会被标准化， 尾部斜杠会被移除除非路径分解到根目录。from如果有空字符串将会被忽略。

如果不太理解，可以试着将其看成cmd中的一系列cd命令。

path.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile')

类似于：

cd foo/bar
cd /tmp/file/
cd ..
cd a/../subfile
pwd

不同点在于路径不需要存在，也可以是一个文件。

例子：

path.resolve('/foo/bar', './baz')
// returns
'/foo/bar/baz'

path.resolve('/foo/bar', '/tmp/file/')
// returns
'/tmp/file'

path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')
// if currently in /home/myself/node, it returns
'/home/myself/node/wwwroot/static_files/gif/image.gif'

例子： 如果将空字符串作为参数，他会被自动替换成当前工作目录。

path.sep

平台特定的文件分隔符。 '\\' 或者 '/'。

LINUX或UNIX下的例子：

'foo/bar/baz'.split(path.sep)
// returns
['foo', 'bar', 'baz']

windows下的例子：

'foo\\bar\\baz'.split(path.sep)
// returns
['foo', 'bar', 'baz']

path.win32

提供访问path前缀的方法但是会在win32的兼容方式下相互影响。