如何使用节点的fs.mkdirSync创建完整路径?

时间:2015-07-27 05:49:03

标签: node.js fs

我试图创建一个完整的路径,如果它不存在。

代码如下所示:

var fs = require('fs');
if (!fs.existsSync(newDest)) fs.mkdirSync(newDest); 

只要只有一个子目录(像' dir1'这样的newDest),这段代码就可以正常运行,但是当存在类似(' dir1 / dir2')的目录路径时,它会失败同 错误:ENOENT,没有此类文件或目录

我希望能够根据需要使用尽可能少的代码行创建完整路径。

我读到fs上有一个递归选项并尝试过这样的

var fs = require('fs');
if (!fs.existsSync(newDest)) fs.mkdirSync(newDest,'0777', true);

我觉得递归创建一个不存在的目录应该很简单。我是否遗漏了某些内容,或者我是否需要解析路径并检查每个目录并创建它(如果它还不存在?)

我对Node很陌生。也许我使用旧版本的FS?

22 个答案:

答案 0 :(得分:193)

修改

NodeJS版本10为mkdirmkdirSync添加了本机支持,以recursive: true选项递归创建目录,如下所示:

fs.mkdirSync(targetDir, { recursive: true });

如果你更喜欢fs Promises API,你可以写

fs.promises.mkdir(targetDir, { recursive: true });

原始答案

如果目录不存在,则以递归方式创建目录! (零依赖

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

function mkDirByPathSync(targetDir, { isRelativeToScript = false } = {}) {
  const sep = path.sep;
  const initDir = path.isAbsolute(targetDir) ? sep : '';
  const baseDir = isRelativeToScript ? __dirname : '.';

  return targetDir.split(sep).reduce((parentDir, childDir) => {
    const curDir = path.resolve(baseDir, parentDir, childDir);
    try {
      fs.mkdirSync(curDir);
    } catch (err) {
      if (err.code === 'EEXIST') { // curDir already exists!
        return curDir;
      }

      // To avoid `EISDIR` error on Mac and `EACCES`-->`ENOENT` and `EPERM` on Windows.
      if (err.code === 'ENOENT') { // Throw the original parentDir error on curDir `ENOENT` failure.
        throw new Error(`EACCES: permission denied, mkdir '${parentDir}'`);
      }

      const caughtErr = ['EACCES', 'EPERM', 'EISDIR'].indexOf(err.code) > -1;
      if (!caughtErr || caughtErr && curDir === path.resolve(targetDir)) {
        throw err; // Throw if it's just the last created dir.
      }
    }

    return curDir;
  }, initDir);
}

用法

// Default, make directories relative to current working directory.
mkDirByPathSync('path/to/dir');

// Make directories relative to the current script.
mkDirByPathSync('path/to/dir', {isRelativeToScript: true});

// Make directories with an absolute path.
mkDirByPathSync('/path/to/dir');

演示

Try It!

说明

  • [更新] 此解决方案可处理特定于平台的错误,例如Mac的EISDIR和Windows的EPERMEACCES。感谢@PediT。,@ JohnQin,@ deed02392,@ robyoder和@Almenon的所有报道评论。
  • 此解决方案可处理相对绝对路径。感谢@john评论。
  • 在相对路径的情况下,将在当前工作目录中创建(解析)目标目录。要相对于当前脚本目录解析它们,请传递{isRelativeToScript: true}
  • 使用path.seppath.resolve(),而不仅仅是/串联,以避免跨平台问题。
  • 使用fs.mkdirSync并在处理竞争条件时抛出错误try/catch:另一个进程可能会在调用fs.existsSync()fs.mkdirSync()之间添加文件并导致例外。
    • 实现这一目标的另一种方法是检查文件是否存在然后创建它,即if (!fs.existsSync(curDir) fs.mkdirSync(curDir);。但这是一种反模式,使代码容易受到竞争条件的影响。感谢@GershomMaes关于目录存在检查的评论。
  • 需要节点v6 以及更新版本以支持解构。 (如果您在使用旧的Node版本实现此解决方案时遇到问题,请给我留言)

答案 1 :(得分:73)

更强大的答案是使用mkdirp

    public class DocumentAPIController : ApiController
    {
    }

然后继续将文件写入完整路径:

var mkdirp = require('mkdirp');

mkdirp('/path/to/dir', function (err) {
    if (err) console.error(err)
    else console.log('dir created')
});

答案 2 :(得分:49)

一种选择是使用shelljs module

npm install shelljs

var shell = require('shelljs');
shell.mkdir('-p', fullPath);

从该页面开始:

  

可用选项:

     

p:完整路径(如有必要,将创建中间目录)

正如其他人所说,还有其他更集中的模块。但是,在mkdirp之外,它还有大量其他有用的shell操作(比如grep等......),它适用于windows和* nix

答案 3 :(得分:46)

fs-extra添加了本机fs模块中未包含的文件系统方法。这是对fs的替代。

安装fs-extra

$ npm install --save fs-extra

const fs = require("fs-extra");
// Make sure the output directory is there.
fs.ensureDirSync(newDest);

有同步和异步选项。

https://github.com/jprichardson/node-fs-extra/blob/master/docs/ensureDir.md

答案 4 :(得分:29)

使用reduce我们可以验证每个路径是否存在并在必要时创建它,这样我觉得它更容易理解。编辑,感谢@Arvin,我们应该使用path.sep来获取适当的特定于平台的路径段分隔符。

void m (int num, int nums[])
{
    num = 100;
    nums[0] = 1000;
}

答案 5 :(得分:26)

此功能已在10.12.0版中添加到node.js中,因此就像将选项{recursive: true}作为第二个参数传递给fs.mkdir()调用一样容易。 参见example in the official docs

不需要外部模块或您自己的实现。

答案 6 :(得分:5)

我知道这是一个老问题,但是nodejs v10.12现在通过将recursive选项设置为true来本地支持此问题。 fs.mkdir

// Creates /tmp/a/apple, regardless of whether `/tmp` and /tmp/a exist.
fs.mkdir('/tmp/a/apple', { recursive: true }, (err) => {
  if (err) throw err;
});

答案 7 :(得分:2)

现在使用NodeJS> = 10,您可以使用fs.mkdirSync(path, { recursive: true }) fs.mkdirSync

答案 8 :(得分:2)

您可以使用下一个功能

const recursiveUpload =(路径:字符串)=> {     const path = path.split(“ /”)

const fullPath = paths.reduce((accumulator, current) => {
  fs.mkdirSync(accumulator)
  return `${accumulator}/${current}`
  })

  fs.mkdirSync(fullPath)

  return fullPath
}

它的作用是什么

  1. 创建paths变量,该变量将每个路径本身存储为数组的元素。
  2. 在数组中每个元素的末尾添加“ /”。
  3. 制造周期:
    1. 从数组元素的连接创建一个目录,该数组元素的索引从0到当前迭代。基本上,它是递归的。

希望有帮助!

顺便说一句,在Node v10.12.0中,可以通过将其作为附加参数来使用递归路径创建。

fs.mkdir('/tmp/a/apple', { recursive: true }, (err) => { if (err) throw err; });

https://nodejs.org/api/fs.html#fs_fs_mkdirsync_path_options

答案 9 :(得分:2)

Windows示例(没有额外的依赖关系和错误处理)

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

let dir = "C:\\temp\\dir1\\dir2\\dir3";

function createDirRecursively(dir) {
    if (!fs.existsSync(dir)) {        
        createDirRecursively(path.join(dir, ".."));
        fs.mkdirSync(dir);
    }
}

createDirRecursively(dir); //creates dir1\dir2\dir3 in C:\temp

答案 10 :(得分:1)

您可以简单地递归检查路径中是否存在文件夹,并在检查文件夹是否不存在时对其进行设置。 (没有外部库

function checkAndCreateDestinationPath (fileDestination) {
    const dirPath = fileDestination.split('/');
    dirPath.forEach((element, index) => {
        if(!fs.existsSync(dirPath.slice(0, index + 1).join('/'))){
            fs.mkdirSync(dirPath.slice(0, index + 1).join('/')); 
        }
    });
}

答案 11 :(得分:1)

答案太多了,但是这里有一个没有递归的解决方案,可以通过拆分路径然后从左到右将其重新建立起来

function mkdirRecursiveSync(path) {
    let paths = path.split(path.delimiter);
    let fullPath = '';
    paths.forEach((path) => {

        if (fullPath === '') {
            fullPath = path;
        } else {
            fullPath = fullPath + '/' + path;
        }

        if (!fs.existsSync(fullPath)) {
            fs.mkdirSync(fullPath);
        }
    });
};

对于那些担心Windows与Linux兼容性的人,只需用双反斜杠替换正斜杠' \'在上面的两个出现但是TBH我们谈论的是节点fs而不是windows命令行,前者非常宽容,上面的代码只能在Windows上工作,而且更像是一个完整的跨平台解决方案。

答案 12 :(得分:1)

const fs = require('fs');

try {
    fs.mkdirSync(path, { recursive: true });
} catch (error) {
    // this make script keep running, even when folder already exist
    console.log(error);
}

答案 13 :(得分:0)

我以这种方式解决了这个问题-与其他递归答案类似,但是对我来说,这更容易理解和阅读。

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

function mkdirRecurse(inputPath) {
  if (fs.existsSync(inputPath)) {
    return;
  }
  const basePath = path.dirname(inputPath);
  if (fs.existsSync(basePath)) {
    fs.mkdirSync(inputPath);
  }
  mkdirRecurse(basePath);
}

答案 14 :(得分:0)

我在使用fs.mkdir的递归选项时遇到问题,所以我做了一个执行以下操作的函数:

  1. 创建所有目录的列表,从最终目标目录开始,一直到根父目录。
  2. 为mkdir函数创建所需目录的新列表
  3. 制作所需的每个目录,包括最终目录

    function createDirectoryIfNotExistsRecursive(dirname) {
        return new Promise((resolve, reject) => {
           const fs = require('fs');
    
           var slash = '/';
    
           // backward slashes for windows
           if(require('os').platform() === 'win32') {
              slash = '\\';
           }
           // initialize directories with final directory
           var directories_backwards = [dirname];
           var minimize_dir = dirname;
           while (minimize_dir = minimize_dir.substring(0, minimize_dir.lastIndexOf(slash))) {
              directories_backwards.push(minimize_dir);
           }
    
           var directories_needed = [];
    
           //stop on first directory found
           for(const d in directories_backwards) {
              if(!(fs.existsSync(directories_backwards[d]))) {
                 directories_needed.push(directories_backwards[d]);
              } else {
                 break;
              }
           }
    
           //no directories missing
           if(!directories_needed.length) {
              return resolve();
           }
    
           // make all directories in ascending order
           var directories_forwards = directories_needed.reverse();
    
           for(const d in directories_forwards) {
              fs.mkdirSync(directories_forwards[d]);
           }
    
           return resolve();
        });
     }
    

答案 15 :(得分:0)

像这样干净:)

DialWriteTimeout

答案 16 :(得分:0)

基于mouneer's零依赖关系答案,这是一个稍微更初学者友好的Typescript变体,作为一个模块:

import * as fs from 'fs';
import * as path from 'path';

/**
* Recursively creates directories until `targetDir` is valid.
* @param targetDir target directory path to be created recursively.
* @param isRelative is the provided `targetDir` a relative path?
*/
export function mkdirRecursiveSync(targetDir: string, isRelative = false) {
    const sep = path.sep;
    const initDir = path.isAbsolute(targetDir) ? sep : '';
    const baseDir = isRelative ? __dirname : '.';

    targetDir.split(sep).reduce((prevDirPath, dirToCreate) => {
        const curDirPathToCreate = path.resolve(baseDir, prevDirPath, dirToCreate);
        try {
            fs.mkdirSync(curDirPathToCreate);
        } catch (err) {
            if (err.code !== 'EEXIST') {
                throw err;
            }
            // caught EEXIST error if curDirPathToCreate already existed (not a problem for us).
        }

        return curDirPathToCreate; // becomes prevDirPath on next call to reduce
    }, initDir);
}

答案 17 :(得分:0)

这种方法怎么样:

if (!fs.existsSync(pathToFile)) {
            var dirName = "";
            var filePathSplit = pathToFile.split('/');
            for (var index = 0; index < filePathSplit.length; index++) {
                dirName += filePathSplit[index]+'/';
                if (!fs.existsSync(dirName))
                    fs.mkdirSync(dirName);
            }
        }

这适用于相对路径。

答案 18 :(得分:0)

这是我对{j} mkdirp的命令版本。

function mkdirSyncP(location) {
    let normalizedPath = path.normalize(location);
    let parsedPathObj = path.parse(normalizedPath);
    let curDir = parsedPathObj.root;
    let folders = parsedPathObj.dir.split(path.sep);
    folders.push(parsedPathObj.base);
    for(let part of folders) {
        curDir = path.join(curDir, part);
        if (!fs.existsSync(curDir)) {
            fs.mkdirSync(curDir);
        }
    }
}

答案 19 :(得分:0)

以递归方式创建目录的异步方法:

import fs from 'fs'

const mkdirRecursive = function(path, callback) {
  let controlledPaths = []
  let paths = path.split(
    '/' // Put each path in an array
  ).filter(
    p => p != '.' // Skip root path indicator (.)
  ).reduce((memo, item) => {
    // Previous item prepended to each item so we preserve realpaths
    const prevItem = memo.length > 0 ? memo.join('/').replace(/\.\//g, '')+'/' : ''
    controlledPaths.push('./'+prevItem+item)
    return [...memo, './'+prevItem+item]
  }, []).map(dir => {
    fs.mkdir(dir, err => {
      if (err && err.code != 'EEXIST') throw err
      // Delete created directory (or skipped) from controlledPath
      controlledPaths.splice(controlledPaths.indexOf(dir), 1)
      if (controlledPaths.length === 0) {
        return callback()
      }
    })
  })
}

// Usage
mkdirRecursive('./photos/recent', () => {
  console.log('Directories created succesfully!')
})

答案 20 :(得分:-1)

此版本在Windows上比在最上面的答案上更好,因为它可以同时理解/path.sep,因此正斜杠在Windows上可以正常工作。支持绝对和相对路径(相对于process.cwd)。

/**
 * Creates a folder and if necessary, parent folders also. Returns true
 * if any folders were created. Understands both '/' and path.sep as 
 * path separators. Doesn't try to create folders that already exist,
 * which could cause a permissions error. Gracefully handles the race 
 * condition if two processes are creating a folder. Throws on error.
 * @param targetDir Name of folder to create
 */
export function mkdirSyncRecursive(targetDir) {
  if (!fs.existsSync(targetDir)) {
    for (var i = targetDir.length-2; i >= 0; i--) {
      if (targetDir.charAt(i) == '/' || targetDir.charAt(i) == path.sep) {
        mkdirSyncRecursive(targetDir.slice(0, i));
        break;
      }
    }
    try {
      fs.mkdirSync(targetDir);
      return true;
    } catch (err) {
      if (err.code !== 'EEXIST') throw err;
    }
  }
  return false;
}

答案 21 :(得分:-1)

在Windows上,Exec可能会很乱。有一个更“nodie”的解决方案。从根本上说,您有一个递归调用来查看目录是否存在并潜入子级(如果存在)或创建它。这是一个函数,它将创建子节点并在完成时调用函数:

fs = require('fs');
makedirs = function(path, func) {
 var pth = path.replace(/['\\]+/g, '/');
 var els = pth.split('/');
 var all = "";
 (function insertOne() {
   var el = els.splice(0, 1)[0];
   if (!fs.existsSync(all + el)) {
    fs.mkdirSync(all + el);
   }
   all += el + "/";
   if (els.length == 0) {
    func();
   } else {
     insertOne();
   }
   })();

}