node.jsはフォルダー内のすべてのファイルを必要としますか?


330

node.jsのフォルダー内のすべてのファイルを要求するにはどうすればよいですか?

次のようなものが必要です:

files.forEach(function (v,k){
  // require routes
  require('./routes/'+v);
}};

4
var routes = require('auto-load')('routes');新しいauto-loadモジュール [私はそれを作成するのを手伝った]。
Francisco Presencia、2015年

回答:


515

requireがフォルダのパスを与えられると、そのフォルダでindex.jsファイルを探します。存在する場合はそれを使用し、存在しない場合は失敗します。

index.jsファイルを作成してすべての「モジュール」を割り当て、それを単に要求することはおそらく(フォルダーを制御できる場合)おそらく最も理にかなっています。

yourfile.js

var routes = require("./routes");

index.js

exports.something = require("./routes/something.js");
exports.others = require("./routes/others.js");

ファイル名がわからない場合は、何らかのローダーを作成する必要があります。

ローダーの実例:

var normalizedPath = require("path").join(__dirname, "routes");

require("fs").readdirSync(normalizedPath).forEach(function(file) {
  require("./routes/" + file);
});

// Continue application logic here

152
いくつかの明確化を追加するにrequireは:フォルダーのパスを指定すると、そのフォルダー内でが検索されindex.jsます。存在する場合はそれを使用し、存在しない場合は失敗します。参照してくださいgithub.com/christkv/node-mongodb-nativeこの現実世界の例:ありますindex.js必要がルートディレクトリに./lib/mongodb、ディレクトリを。./lib/mongodb/index.js'そのディレクトリ内の他のすべてを使用可能にします。
Trevor Burnham、

22
requireは同期関数であるため、コールバックによるメリットはありません。代わりにfs.readdirSyncを使用します。
ラファウSobotaの

4
ありがとう、今日同じ問題に遭遇し、「なぜrequire( './ routes / *')がないのか?」と考えました。
Richard Clayton

3
@RobertMartinこれは、エクスポートされたものへのハンドルが必要ない場合に役立ちます。たとえば、ルートをバインドする一連のファイルにExpressアプリインスタンスを渡したいだけの場合です。
Richard Clayton

2
@TrevorBurnham追加するには、ディレクトリのメインファイル(つまり、index.js)ファイルをpackage.jsonこのディレクトリで変更できます。このように:{main: './lib/my-custom-main-file.js'}
抗毒性

187

そのタスクを実行するには、グロブを使用することをお勧めします。

var glob = require( 'glob' )
  , path = require( 'path' );

glob.sync( './routes/**/*.js' ).forEach( function( file ) {
  require( path.resolve( file ) );
});

12
誰もがこの答えを使用する必要があります;)
Jamie Hutber

2
ベストアンサー!他のすべてのオプションよりも簡単です。特に、含める必要のあるファイルがある再帰的な子フォルダーの場合。
ngDeveloper 2015

1
指定できる一連のfilespec基準を全体的に制御できるため、グロビングをお勧めします。
スティーブンヴィル、2015

6
glob?つまりglob-savior-of-the-nodejs-race。ベストアンサー。
deepelement 2017

3
保存リンクにはmap()を使用します。const routes = glob.sync( './ routes / ** / *。js')。map(file => require(path.resolve(file)));
lexa-b 2018

71

@tbranyenのソリューションにindex.js基づいて、の一部として現在のフォルダーの下に任意のJavaScriptをロードするファイルを作成しますexports

// Load `*.js` under current directory as properties
//  i.e., `User.js` will become `exports['User']` or `exports.User`
require('fs').readdirSync(__dirname + '/').forEach(function(file) {
  if (file.match(/\.js$/) !== null && file !== 'index.js') {
    var name = file.replace('.js', '');
    exports[name] = require('./' + file);
  }
});

次にrequire、他のどこからでもこのディレクトリを使用できます。


5
私はこれが1年以上前のものであることを知っていますが、実際にはJSONファイルも必要とする可能性があるため、おそらく/\.js(on)?$/より良いものになるでしょう。また、!== null冗長ではありませんか?

59

別のオプションは、パッケージrequire-dirを使用して、次のことを実行することです。再帰もサポートしています。

var requireDir = require('require-dir');
var dir = requireDir('./path/to/dir');

3
+1 require-dirは、呼び出しファイル(インデックス)を自動的に除外し、デフォルトで現在のディレクトリを使用するためです。完璧です。
バイオフラクタル2015年

2
npmには、require-all、require-directory、require-dirなどのいくつかの同様のパッケージがあります。ダウンロード数が最も多いのは、少なくとも2015
。– Mnebuerquo '25

require-dirが最もダウンロードされました(ただし、執筆時点ではファイルの除外はサポートされていません)
Sean Anderson

上記のショーンのコメントの3年後にrequire-dirfilterオプションを追加しました。
Givemesnacks

7

私はそれぞれ単一のクラスを持つファイルでいっぱいのフォルダ/ fieldsを持っています、例:

fields/Text.js -> Test class
fields/Checkbox.js -> Checkbox class

これをfields / index.jsにドロップして、各クラスをエクスポートします。

var collectExports, fs, path,
  __hasProp = {}.hasOwnProperty;

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

collectExports = function(file) {
  var func, include, _results;

  if (path.extname(file) === '.js' && file !== 'index.js') {
    include = require('./' + file);
    _results = [];
    for (func in include) {
      if (!__hasProp.call(include, func)) continue;
      _results.push(exports[func] = include[func]);
    }
    return _results;
  }
};

fs.readdirSync('./fields/').forEach(collectExports);

これにより、モジュールはPythonの場合と同様に機能します。

var text = new Fields.Text()
var checkbox = new Fields.Checkbox()

6

もう1つのオプションは、ほとんどの一般的なパッケージの機能を組み合わせたrequire-dir-allです。

最も人気のあるrequire-dirものには、ファイル/ディレクトリをフィルタリングするオプションがなく、map機能はありませんが(以下を参照)、モジュールの現在のパスを見つけるために小さなトリックを使用します。

2番目に人気require-allがあるのは、正規表現のフィルタリングと前処理ですが、相対パスがないため、次のように使用する必要があります__dirname(これには長所と短所があります)。

var libs = require('require-all')(__dirname + '/lib');

ここrequire-indexで言及されているのは非常にミニマルです。

ではmapあなたには、いくつかの前処理を行うことができ、のようなオブジェクトを作成し、(輸出コンストラクタ以下のモジュールを想定)設定値を渡します。

// Store config for each module in config object properties 
// with property names corresponding to module names 
var config = {
  module1: { value: 'config1' },
  module2: { value: 'config2' }
};

// Require all files in modules subdirectory 
var modules = require('require-dir-all')(
  'modules', // Directory to require 
  { // Options 
    // function to be post-processed over exported object for each require'd module 
    map: function(reqModule) {
      // create new object with corresponding config passed to constructor 
      reqModule.exports = new reqModule.exports( config[reqModule.name] );
    }
  }
);

// Now `modules` object holds not exported constructors, 
// but objects constructed using values provided in `config`.

5

私はこの質問が5年以上前であり、与えられた答えは良いことを知っていますが、私はExpressにもう少し強力なものが欲しかったのでexpress-map2、npm のパッケージを作成しました。私は単純に名前を付けるつもりでしexpress-map、yahoo の人々はすでにその名前のパッケージを持っているので、パッケージの名前を変更する必要がありました。

1.基本的な使い方:

app.js (or whatever you call it)

var app = require('express'); // 1. include express

app.set('controllers',__dirname+'/controllers/');// 2. set path to your controllers.

require('express-map2')(app); // 3. patch map() into express

app.map({
    'GET /':'test',
    'GET /foo':'middleware.foo,test',
    'GET /bar':'middleware.bar,test'// seperate your handlers with a comma. 
});

コントローラーの使用:

//single function
module.exports = function(req,res){

};

//export an object with multiple functions.
module.exports = {

    foo: function(req,res){

    },

    bar: function(req,res){

    }

};

2.プレフィックス付きの高度な使用法:

app.map('/api/v1/books',{
    'GET /': 'books.list', // GET /api/v1/books
    'GET /:id': 'books.loadOne', // GET /api/v1/books/5
    'DELETE /:id': 'books.delete', // DELETE /api/v1/books/5
    'PUT /:id': 'books.update', // PUT /api/v1/books/5
    'POST /': 'books.create' // POST /api/v1/books
});

ご覧のとおり、これにより時間を大幅に節約でき、アプリケーションのルーティングを作成、保守、および理解するのが非常に簡単になります。Expressがサポートするすべてのhttp動詞と、特別な.all()メソッドをサポートします。


3

この正確なユースケースで使用してきた1つのモジュールはrequire-allです。

excludeDirsプロパティに一致しない限り、特定のディレクトリとそのサブディレクトリにあるすべてのファイルが再帰的に必要になります。

また、ファイルフィルターと、ファイル名から返されるハッシュのキーを取得する方法を指定することもできます。


2

ノードモジュールのコピー先モジュールを使用しています当社NodeJSベースのシステム内のすべてのファイルを必要とする1つのファイルを作成します。

ユーティリティファイルのコードは次のようになります。

/**
 * Module dependencies.
 */

var copy = require('copy-to');
copy(require('./module1'))
.and(require('./module2'))
.and(require('./module3'))
.to(module.exports);

すべてのファイルで、ほとんどの関数は次のようにエクスポートとして記述されます。

exports.function1 = function () { // function contents };
exports.function2 = function () { // function contents };
exports.function3 = function () { // function contents };

したがって、ファイルから関数を使用するには、次のコードを呼び出すだけです。

var utility = require('./utility');

var response = utility.function2(); // or whatever the name of the function is

2

この globソリューションを拡張します。ディレクトリからすべてのモジュールをindex.jsインポートしindex.jsて、アプリケーションの別の部分にインポートする場合は、これを行います。テンプレートリテラルは、stackoverflowで使用される強調表示エンジンでサポートされていないため、コードがここで奇妙に見える可能性があることに注意してください。

const glob = require("glob");

let allOfThem = {};
glob.sync(`${__dirname}/*.js`).forEach((file) => {
  /* see note about this in example below */
  allOfThem = { ...allOfThem, ...require(file) };
});
module.exports = allOfThem;

完全な例

ディレクトリ構造

globExample/example.js
globExample/foobars/index.js
globExample/foobars/unexpected.js
globExample/foobars/barit.js
globExample/foobars/fooit.js

globExample / example.js

const { foo, bar, keepit } = require('./foobars/index');
const longStyle = require('./foobars/index');

console.log(foo()); // foo ran
console.log(bar()); // bar ran
console.log(keepit()); // keepit ran unexpected

console.log(longStyle.foo()); // foo ran
console.log(longStyle.bar()); // bar ran
console.log(longStyle.keepit()); // keepit ran unexpected

globExample / foobars / index.js

const glob = require("glob");
/*
Note the following style also works with multiple exports per file (barit.js example)
but will overwrite if you have 2 exports with the same
name (unexpected.js and barit.js have a keepit function) in the files being imported. As a result, this method is best used when
your exporting one module per file and use the filename to easily identify what is in it.

Also Note: This ignores itself (index.js) by default to prevent infinite loop.
*/

let allOfThem = {};
glob.sync(`${__dirname}/*.js`).forEach((file) => {
  allOfThem = { ...allOfThem, ...require(file) };
});

module.exports = allOfThem;

globExample / foobars / unexpected.js

exports.keepit = () => 'keepit ran unexpected';

globExample / foobars / barit.js

exports.bar = () => 'bar run';

exports.keepit = () => 'keepit ran';

globExample / foobars / fooit.js

exports.foo = () => 'foo ran';

glob インストールされたプロジェクト内から、実行しますnode example.js

$ node example.js
foo ran
bar run
keepit ran unexpected
foo ran
bar run
keepit ran unexpected


1

routesフォルダーからすべてのファイルを要求し、ミドルウェアとして適用します。外部モジュールは必要ありません。

// require
const path = require("path");
const { readdirSync } = require("fs");

// apply as middleware
readdirSync("./routes").map((r) => app.use("/api", require("./routes/" + r)));

0

この関数を使用すると、ディレクトリ全体を要求できます。

const GetAllModules = ( dirname ) => {
    if ( dirname ) {
        let dirItems = require( "fs" ).readdirSync( dirname );
        return dirItems.reduce( ( acc, value, index ) => {
            if ( PATH.extname( value ) == ".js" && value.toLowerCase() != "index.js" ) {
                let moduleName = value.replace( /.js/g, '' );
                acc[ moduleName ] = require( `${dirname}/${moduleName}` );
            }
            return acc;
        }, {} );
    }
}

// calling this function.

let dirModules = GetAllModules(__dirname);

-2

* .jsのすべてのファイルをディレクトリの例( "app / lib / *。js")に含める場合:

app / libディレクトリ

example.js:

module.exports = function (example) { }

example-2.js:

module.exports = function (example2) { }

ディレクトリアプリでindex.jsを作成します

index.js:

module.exports = require('./app/lib');
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.