node.js需要文件夹中的所有文件吗?

时间:2011-03-19 21:09:23

标签: javascript node.js directory require

如何在node.js中的文件夹中要求所有文件?

需要类似的东西:

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

14 个答案:

答案 0 :(得分:476)

当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

答案 1 :(得分:141)

我建议使用glob来完成该任务。

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

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

答案 2 :(得分:69)

基于@tbranyen的解决方案,我创建了一个index.js文件,它在当前文件夹下加载任意javascripts,作为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这个目录。

答案 3 :(得分:52)

另一种选择是使用包require-dir,让您执行以下操作。它也支持递归。

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

答案 4 :(得分:7)

我有一个文件夹/字段,每个文件都有一个类,例如:

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()

答案 5 :(得分:5)

另一个选项not recommended结合了大多数热门软件包的功能。

最受欢迎的map没有筛选文件/目录的选项,也没有require-all功能(见下文),但使用小技巧查找模块的当前路径。< / p>

第二个受欢迎程度__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`. ,您可以进行一些预处理,例如创建对象和传递配置值(假设模块低于导出构造函数):

{{1}}

答案 6 :(得分:3)

我在这个确切用例中使用的一个模块是require-all

它递归地要求给定目录及其子目录中的所有文件,只要它们与excludeDirs属性不匹配。

它还允许指定文件过滤器以及如何从文件名派生返回的哈希的键。

答案 7 :(得分:2)

我知道这个问题已有5年多了,而且给出的答案都很好,但是我想要一些更强大的表达,所以我为npm创建了express-map2包。我只是简单地命名express-map,但雅虎的已经有了一个包含该名称的包,所以我不得不重命名我的包。

<强> 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
});

正如您所看到的,这节省了大量时间,并使您的应用程序的路由变得简单,无法编写,维护和理解。它支持所有表达支持的http动词,以及特殊的.all()方法。

答案 8 :(得分:2)

需要routes文件夹中的所有文件,并作为中间件应用。无需外部模块。

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

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

答案 9 :(得分:1)

我使用node modules copy-to module创建一个文件来要求基于NodeJS的系统中的所有文件。

our utility file的代码如下所示:

/**
 * 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

答案 10 :(得分:1)

可以使用:https://www.npmjs.com/package/require-file-directory

  • 要求选定的文件只包含名称或所有文件。
  • 不需要absoulute路径。
  • 易于理解和使用。

答案 11 :(得分:1)

扩展this 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 installed的项目内部,运行node example.js

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

答案 12 :(得分:1)

使用此功能,您可能需要一个完整的目录。

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);

答案 13 :(得分:-2)

如果在目录示例中包含* .js的所有文件(“app / lib / * .js”):

在目录app / lib

example.js:

module.exports = function (example) { }

示例-2.js:

module.exports = function (example2) { }

在目录app create index.js

index.js:

module.exports = require('./app/lib');