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


Answers:


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-nativeindex.js在根目录中有一个require./lib/mongodb,一个目录;./lib/mongodb/index.js'使该目录中的其他所有内容都可用。
Trevor Burnham

22
require是一个同步函数,因此回调没有任何好处。我会改用fs.readdirSync。
拉斐尔·索博塔

4
谢谢,今天遇到了同样的问题,并以为“为什么没有require('./ routes / *')?”。
理查德·克莱顿

3
@RobertMartin不需要导出的任何内容时很有用;例如,如果我只想将Express应用程序实例传递给一组将绑定路线的文件。
理查德·克莱顿

2
@TrevorBurnham要添加,可以package.json在此目录中更改目录的主文件(即index.js)文件。像这样:{main: './lib/my-custom-main-file.js'}

187

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

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

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

12
每个人都应该使用这个答案;)
Jamie Hutber

2
最佳答案!比所有其他选项都更容易,尤其是对于具有需要包含文件的递归子文件夹而言。
ngDeveloper

1
由于您可以对可以指定的文件规范标准集进行整体控制,因此建议进行globing。
stephenwil

6
glob?你是说glob-savior-of-the-nodejs-race。最佳答案。
deepelement '17

3
使用map()来保存链接:const route = glob.sync('./ routes / ** / *。js')。map(file => require(path.resolve(file)));
lexa-b

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
我知道这已经有一年多了,但是实际上您也可以要求使用JSON文件,因此可能/\.js(on)?$/会更好。也不是!== null多余的吗?

59

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

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

3
+1,require-dir因为它会自动排除调用文件(索引),并且默认为当前目录。完善。
biofractal 2015年

2
在npm中,还有一些其他类似的软件包:require-all,require-directory,require-dir等。至少在2015
必需品。– Mnebuerquo

require-dir现在是下载次数最多的文件(但值得注意的是,在撰写本文时,它不支持文件排除)
Sean Anderson

在肖恩发表上述评论的三年后,require-dir添加了一个filter选项。
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

另一种选择是将最流行的软件包中的require-dir-all组合功能。

最受欢迎的require-dir选项没有用于过滤文件/目录的选项,并且没有map功能(请参见下文),但是使用了一些小技巧来查找模块的当前路径。

其次,它require-all具有regexp过滤和预处理功能,但缺少相对路径,因此您需要使用__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-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
});

如您所见,这可以节省大量时间,并使应用程序的路由完全易于编写,维护和理解。它支持所有表示支持的http动词以及特殊.all()方法。


3

我一直用于此确切用例的一个模块是require-all

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

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


2

我正在使用节点模块复制到模块来创建一个文件,以要求基于NodeJS的系统中的所有文件。

我们的实用程序文件的代码如下所示:

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

如果在目录示例(“ app / lib / *。js”)中包含* .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');
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.