同步检查Node.js中是否存在文件/目录

Question

如何使用node.js同步检查文件或目录是否存在？

Answer 1

多年来,这个问题的答案发生了变化.在目前的答案是在此间举行的顶部,然后用按时间顺序多年的各种答案:

目前的答案

你可以使用fs.existsSync():

const fs = require("fs"); // Or `import fs from "fs";` with ESM
if (fs.existsSync(path)) {
    // Do something
}

它被弃用了几年,但不再是.来自文档:

请注意,fs.exists()不推荐使用,但fs.existsSync()不是.(用于fs.exists()接受与其他Node.js回调不一致的参数的回调参数.fs.existsSync()不使用回调.)

您已经特别要求进行同步检查,但是如果您可以使用异步检查(通常最好使用I/O),请使用fs.promises.access(因为async不推荐使用).

历史答案

以下是按时间顺序排列的历史答案:

• 2010年的原始答案
  (fs.access/ exists或async/ stat)
• 2012年9月更新
  (statSync/ lstat)
• 2015年2月更新
  (注意即将弃用lstatSync/ exists,因此我们可能会回到existsSync/ exists或existsSync/ stat)
• 2015年12月更新
  (还有statSync/ lstat,但请注意,如果文件/目录不存在,则表示错误; 如果您需要检查存在而不打开,lstatSync建议使用文档fs.access(path, fs.F_OK, function(){}))
• 2016年12月更新
  fs.accessSync(path, fs.F_OK)仍然已弃用,但fs.stat不再弃用.所以你现在可以安全地使用它.

2010年的原始答案:

您可以使用fs.access或fs.exists()(文档链接),它为您提供一个fs.existsSync()对象.通常,如果函数的同步版本可用,则它将与statSync最终的异步版本具有相同的名称.所以,lstatSync是的同步版本fs.Stats; Sync是等的同步版本statSync等.

stat 告诉你两者是否存在,如果存在,是否是文件或目录(或在某些文件系统,符号链接,块设备,字符设备等),例如,如果你需要知道它是否存在,是目录:

try {
    await fs.promises.access("somefile");
    // The check succeeded
} catch (error) {
    // The check failed
}

......同样如果它是一个文件,那就是lstatSync; 如果它是一个块设备,那么lstat等等等.注意lstatSync; 如果条目根本不存在则抛出错误.

如果您不关心条目是什么,只想知道它是否存在,您可以使用isFile(或最新的isBlockDevice),如user618408所述:

fs.access("somefile", error => {
    if (!error) {
        // The check succeeded
    } else {
        // The check failed
    }
});

它不需要a try/catch,但是没有给出关于这是什么的信息,只是它就在那里. path.existsSync很久以前就被弃用了.

旁注:您已明确询问如何同步检查,因此我使用了fs.existsSync上述功能的版本.但只要有可能,使用I/O,最好避免同步调用.从CPU的角度来看,调用I/O子系统需要很长时间.注意调用是否容易,try/catch而不是path.existsSync:

var fs = require('fs');
try {
    // Query the entry
    stats = fs.lstatSync('/the/path');

    // Is it a directory?
    if (stats.isDirectory()) {
        // Yes it is
    }
}
catch (e) {
    // ...
}

但是如果你需要同步版本,它就在那里.

2012年9月更新

几年前的答案现在有点过时了.当前的方法是xyzSync用于对文件/目录存在进行同步检查(当然还有 lstat异步检查),而不是lstatSync下面的版本.

例:

var path = require('path');
if (path.existsSync("/the/path")) { // or fs.existsSync
    // ...
}

2015年2月更新

在这里,我们在2015年,Node文档现在说fs.existsSync(和fs.exists)"将被弃用".(因为节点的人认为在打开它之前检查是否存在某些东西是愚蠢的,它是什么;但这不是检查某些东西是否存在的唯一原因!)

所以我们可能会回到各种path方法......当然,除非这种情况再次发生变化.

2015年12月更新

不知道它有多久,但也有fs.existsSync/fs.exists.至少截至2016年10月,stat文档建议使用fs.access(path, fs.F_OK, ...)进行存在检查("fs.accessSync(path, fs.F_OK)建议检查文件是否存在而不进行操作,").但请注意,访问不可用被视为错误,因此如果您希望可以访问该文件,这可能是最好的:

// Is it a directory?
lstat('/the/path', function(err, stats) {
    if (!err && stats.isDirectory()) {
        // Yes it is
    }
});

2016年12月更新

你可以使用fs.stat:

var fs = require('fs');

if (fs.existsSync(path)) {
    // Do something
}

// Or

fs.exists(path, function(exists) {
    if (exists) {
        // Do something
    }
});

它被弃用了几年,但不再是.来自文档:

请注意,fs.access不推荐使用,但fs.access()不是.(用于fs.existsSync()接受与其他Node.js回调不一致的参数的回调参数.fs.exists()不使用回调.)

Answer 2

查看源代码,有一个同步版本path.exists- path.existsSync.看起来它在文档中被遗漏了.

更新:

path.exists而path.existsSync现在不推荐使用.请使用fs.exists和fs.existsSync.

2016年更新:

fs.exists并且fs.existsSync也被弃用了.请改用fs.stat()或fs.access().

Answer 3

使用当前推荐的(截至2015年)API(根据Node文档),这就是我所做的:

var fs = require('fs');

function fileExists(filePath)
{
    try
    {
        return fs.statSync(filePath).isFile();
    }
    catch (err)
    {
        return false;
    }
}

针对@broadband在评论中提出的EPERM问题,这提出了一个很好的观点.在许多情况下,fileExists()可能不是一个考虑这个问题的好方法,因为fileExists()实际上不能保证布尔返回.您可能确定该文件存在或不存在,但您可能还会收到权限错误.权限错误并不一定意味着文件存在,因为您可能缺少包含要检查的文件的目录的权限.当然,在检查文件存在时,您可能会遇到其他错误.

所以我上面的代码实际上是doFileExistAndDoIHaveAccessToIt(),但你的问题可能是doFileNotExistAndCouldICreateIt(),这将是完全不同的逻辑(需要考虑EPERM错误等).

虽然fs.existsSync回答直接解决了这里提出的问题,但通常不会是你想要的(你不只是想知道路径上是否存在"某事"),你可能会关心"事物"是否存在存在的是文件或目录).

最重要的是,如果您正在检查文件是否存在,那么您可能正在这样做,因为您打算根据结果采取某些操作,并且该逻辑(检查和/或后续操作)应该适应这个想法在该路径中找到的东西可能是文件或目录,并且您在检查过程中可能会遇到EPERM或其他错误.

Answer 4

另一个更新

需要回答这个问题,我自己,我抬起头节点文档,看来你应该不使用fs.exists来,改用fs.open和使用输出错误,如果一个文件不存在检测:

来自文档:

fs.exists()是一种时代错误,只是出于历史原因而存在.几乎没有理由在你自己的代码中使用它.

特别是,在打开文件之前检查文件是否存在是一种反模式,使您容易受到竞争条件的影响:另一个进程可能会在调用fs.exists()和fs.open()之间删除该文件.只需打开文件并在错误处理时处理错误.

http://nodejs.org/api/fs.html#fs_fs_exists_path_callback

Answer 5

const fs = require('fs');

检查如下函数，

if(fs.existsSync(<path_that_need_to_be_checked>)){
  // enter the code to excecute after the folder is there.
}
else{
  // Below code to create the folder, if its not there
  fs.mkdir('<folder_name>', cb function);
}

Answer 6

我使用下面的函数来测试文件是否存在.它还捕获了其他例外情况.因此,如果存在权限问题,例如chmod ugo-rwx filename或在Windows Right Click -> Properties -> Security -> Advanced -> Permission entries: empty list ..函数中返回异常应该如此.该文件存在,但我们无权访问它.忽略这种例外是错误的.

function fileExists(path) {

  try  {
    return fs.statSync(path).isFile();
  }
  catch (e) {

    if (e.code == 'ENOENT') { // no such file or directory. File really does not exist
      console.log("File does not exist.");
      return false;
    }

    console.log("Exception fs.statSync (" + path + "): " + e);
    throw e; // something else went wrong, we don't have rights, ...
  }
}

案例文件中不存在异常输出,nodejs错误文档:

{
  [Error: ENOENT: no such file or directory, stat 'X:\\delsdfsdf.txt']
  errno: -4058,
  code: 'ENOENT',
  syscall: 'stat',
  path: 'X:\\delsdfsdf.txt'
}

如果我们没有文件权限但存在,则例外:

{
  [Error: EPERM: operation not permitted, stat 'X:\file.txt']
  errno: -4048,
  code: 'EPERM',
  syscall: 'stat',
  path: 'X:\\file.txt'
}

Answer 7

不建议使用fs.exists（），不要使用它 https://nodejs.org/api/fs.html#fs_fs_exists_path_callback

您可以实现此处使用的核心nodejs方式：https : //github.com/nodejs/node-v0.x-archive/blob/master/lib/module.js#L86

function statPath(path) {
  try {
    return fs.statSync(path);
  } catch (ex) {}
  return false;
}

这将返回stats对象，然后一旦获得s​​tats对象，您可以尝试

var exist = statPath('/path/to/your/file.js');
if(exist && exist.isFile()) {
  // do something
}