情報アイランド

「情報を制する者は世界を制す」をモットーに様々な情報を提供することを目指すブログです。現在はプログラミング関連情報が多めですが、投資関連情報も取り扱っていきたいです。

Node.jsでフォルダを再帰的に作成する

フォルダを再帰的に作成するには非同期的に作成する方法と同期的に作成する方法の2つがあります。

非同期的な作成

フォルダを非同期的に再帰的に作成するにはmkdirpモジュールのmkdirp関数やfs-extraモジュールのfsExtra.mkdirp関数を使用します。

var mkdirp = require('mkdirp');

mkdirp('xxx', function (err) {
});
var fsExtra = require('fs-extra');

fsExtra.mkdirp('xxx', function (err) {
});

第1引数にフォルダのパスを指定します。

第2引数にコールバック関数を指定します。この関数の第1引数はエラーオブジェクトです。

同期的な作成

フォルダを同期的に再帰的に作成するにはmkdirpモジュールのmkdirp.sync関数やfs-extraモジュールのfsExtra.mkdirpSync関数を使用します。

mkdirp.sync('xxx');
fsExtra.mkdirpSync('xxx');

第1引数にフォルダのパスを指定します。

使い分け

原則的にはmkdirp関数やfsExtra.mkdirp関数を使用するべきであり、特に理由がないならmkdirp.sync関数やfsExtra.mkdirpSync関数は使用するべきではありません。

これは、フォルダへのアクセスは非常に時間の掛かる処理であるためです。フォルダへのアクセスを同期的に行うとアクセスが完了するまでプログラムは待機状態となり、他の処理を行うことができません。長い時間プログラムが待機状態になると様々な問題を引き起こす可能性があります(このような現象をスターベーションと言います)。

サンプルコード1

mkdirp関数の使用例です。

3つ目のコマンドライン引数として与えられたフォルダを非同期的に再帰的に作成します。

mkdirp.js

var mkdirp = require('mkdirp');

if (process.argv.length < 3) {
    console.error('lack argument.');
    process.exit(1);
}

mkdirp(process.argv[2], function (err) {
    if (err) {
        console.error(err);
        process.exit(1);
    }
    else {
        console.log('finished!!');
    }
});

使用パッケージ

  • mkdirp
    npm install mkdirpでインストールします。

実行結果

現在のフォルダにはtmpという名称のフォルダは存在していません。

C:\work\node>dir tmp
 Volume in drive C is TI31035600A
 Volume Serial Number is 1CBD-3C48

 Directory of C:\work\node

File Not Found

tmp\tmp2\tmp3を3つ目のコマンドライン引数に指定してコードを実行するとフォルダが再帰的に作成されます。

C:\work\node>node mkdirp.js tmp\tmp2\tmp3
finished!!

C:\work\node>dir tmp\tmp2\tmp3
 Volume in drive C is TI31035600A
 Volume Serial Number is 1CBD-3C48

 Directory of C:\work\node\tmp\tmp2\tmp3

2016/10/18  10:24    <DIR>          .
2016/10/18  10:24    <DIR>          ..
               0 File(s)              0 bytes
               2 Dir(s)  30,116,642,816 bytes free

ファイルを指定した場合にはエラーが発生します。

C:\work\node>node mkdirp.js mkdirp.js
{ Error: EEXIST: file already exists, mkdir 'C:\work\node\mkdirp.js'
    at Error (native)
  errno: -4075,
  code: 'EEXIST',
  syscall: 'mkdir',
  path: 'C:\\work\\node\\mkdirp.js' }

関連

pizyumi
プログラミング歴19年のベテランプログラマー。業務システム全般何でも作れます。現在はWeb系の技術を勉強中。
スポンサーリンク

-Node.js