Node.js 路径和文件夹

1,034 阅读3分钟

在 Linux 和 macOS 上,路径可能类似于:

/users/joe/file.txt

在 Windows 上则有所不同,具有类似以下的结构:

C:\users\joe\file.txt

Node.js 路径模块

const path = require('path')

给定一个路径,可以使用以下方法从其中提取信息:

  • dirname: 获取文件的父文件夹。
  • basename: 获取文件名部分。
  • extname: 获取文件的扩展名。
const notes = '/users/joe/notes.txt'

path.dirname(notes) // /users/joe
path.basename(notes) // notes.txt
path.extname(notes) // .txt

可以通过为 basename 指定第二个参数来获取不带扩展名的文件名:

path.basename(notes, path.extname(notes)) //notes

使用路径

可以使用 path.join() 连接路径的两个或多个片段:

const name = 'joe'
path.join('/', 'users', name, 'notes.txt') //'/users/joe/notes.txt'

可以使用 path.resolve() 获得相对路径的绝对路径计算:

path.resolve('joe.txt') //'/Users/joe/joe.txt' 如果从主文件夹运行。

在此示例中,Node.js 只是简单地将 /joe.txt 附加到当前工作目录。 如果指定第二个文件夹参数,则 resolve 会使用第一个作为第二个的基础:

path.resolve('tmp', 'joe.txt') //'/Users/joe/tmp/joe.txt' 如果从主文件夹运行。

如果第一个参数以斜杠开头,则表示它是绝对路径:

path.resolve('/etc', 'joe.txt') //'/etc/joe.txt'

path.normalize() 是另一个有用的函数,当包含诸如 ... 或双斜杠之类的相对说明符时,其会尝试计算实际的路径:

path.normalize('/users/joe/..//test.txt') //'/users/test.txt'

Node.js 中使用文件夹

Node.js 的 fs 核心模块提供了许多便捷的方法用于处理文件夹。

创建新的文件夹

使用 fs.mkdir() 或 fs.mkdirSync() 可以创建新的文件夹。

const fs = require('fs')


const folderName = '/Users/joe/test'


try {
  if (!fs.existsSync(folderName)) {
    fs.mkdirSync(folderName)
  }
} catch (err) {
  console.error(err)
}

读取目录的内容

使用 fs.readdir() 或 fs.readdirSync() 可以读取目录的内容。

这段代码会读取文件夹的内容(全部的文件和子文件夹),并返回它们的相对路径:

const fs = require('fs')
const path = require('path')


const folderPath = '/Users/joe'


fs.readdirSync(folderPath)

可以获取完整的路径:

fs.readdirSync(folderPath).map(fileName => {
  return path.join(folderPath, fileName)
})

也可以过滤结果以仅返回文件(排除文件夹):

const isFile = fileName => {
  return fs.lstatSync(fileName).isFile()
}


fs.readdirSync(folderPath).map(fileName => {
  return path.join(folderPath, fileName)
})
.filter(isFile)

重命名文件夹

使用 fs.rename() 或 fs.renameSync() 可以重命名文件夹。 第一个参数是当前的路径,第二个参数是新的路径:

const fs = require('fs')


fs.rename('/Users/joe', '/Users/roger', err => {
  if (err) {
    console.error(err)
    return
  }
  //完成
})

fs.renameSync() 是同步的版本:

const fs = require('fs')


try {
  fs.renameSync('/Users/joe', '/Users/roger')
} catch (err) {
  console.error(err)
}

删除文件夹

使用 fs.rmdir() 或 fs.rmdirSync() 可以删除文件夹。

删除包含内容的文件夹可能会更复杂。

在这种情况下,最好安装 fs-extra 模块,该模块非常受欢迎且维护良好。 它是 fs 模块的直接替代品,在其之上提供了更多的功能。

在此示例中,需要的是 remove() 方法。

使用以下命令安装:

npm install fs-extra

并像这样使用它:

const fs = require('fs-extra')


const folder = '/Users/joe'


fs.remove(folder, err => {
  console.error(err)
})

也可以与 promise 一起使用:

fs.remove(folder)
  .then(() => {
    //完成
  })
  .catch(err => {
    console.error(err)
  })

或使用 async/await:

async function removeFolder(folder) {
  try {
    await fs.remove(folder)
    //完成
  } catch (err) {
    console.error(err)
  }
}


const folder = '/Users/joe'
removeFolder(folder)

参考

Node.js 文件路径

在 Node.js 中使用文件夹

Node.js 路径模块