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

1
เอกสารประกอบ: nodejs.org/api/modules.html#modules_folders_as_modules
Xeoncross

คำตอบ:


515

เมื่อต้องการได้รับเส้นทางของโฟลเดอร์มันจะค้นหาไฟล์ 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'ทำให้ทุกอย่างในไดเรกทอรีนั้นพร้อมใช้งาน
เทรเวอร์เบิร์นแฮม

22
requireเป็นฟังก์ชั่นซิงโครนัสจึงไม่ได้รับประโยชน์จากการโทรกลับ ฉันจะใช้ fs.readdirSync แทน
Rafał Sobota

4
ขอบคุณพบปัญหาเดียวกันนี้ในวันนี้และคิดว่า "ทำไมจึงไม่มีความต้องการ ('./ เส้นทาง / *')?
Richard Clayton

3
@RobertMartin มันมีประโยชน์เมื่อคุณไม่จำเป็นต้องจัดการกับสิ่งที่ส่งออก; เช่นหากฉันต้องการส่งตัวอย่างแอป Express ไปยังชุดไฟล์ที่จะผูกเส้นทาง
Richard Clayton

2
@TrevorBurnham หากต้องการเพิ่มไฟล์หลัก (เช่น index.js) ไฟล์ของไดเรกทอรีสามารถเปลี่ยนแปลงได้package.jsonในไดเรกทอรีนี้ เช่นเดียวกับ:{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
แนะนำ globbing เนื่องจากการควบคุมโดยรวมที่คุณมีมากกว่าชุดของเกณฑ์ filespec ที่คุณสามารถระบุได้
stephenwil

6
glob? glob-savior-of-the-nodejs-raceคุณหมายถึง คำตอบที่ดีที่สุด
deepelement

3
ใช้ map () เพื่อบันทึกลิงก์: const route = glob.sync ('./ route / ** / *. js'). map (file => ต้องการ (path.resolve (ไฟล์)))
lexa-b

71

บนพื้นฐานของวิธีการแก้ปัญหาของ @ 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ไดเรกทอรีนี้จากที่อื่น ๆ


5
ฉันรู้ว่ามันอายุมากกว่าหนึ่งปี แต่คุณสามารถใช้ไฟล์ JSON ได้เช่นกันดังนั้นบางทีสิ่งที่/\.js(on)?$/ดีกว่านี้ ยังไม่!== nullซ้ำซ้อนหรือไม่

59

อีกทางเลือกหนึ่งคือใช้แพ็คเกจrequire-dirซึ่งให้คุณทำสิ่งต่อไปนี้ รองรับการเรียกซ้ำด้วยเช่นกัน

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

3
+1 สำหรับrequire-dirเนื่องจากจะแยกไฟล์การเรียก (ดัชนี) และค่าเริ่มต้นไปยังไดเรกทอรีปัจจุบันโดยอัตโนมัติ สมบูรณ์
เชื้อเพลิงชีวภาพ

2
ใน npm มีแพ็กเกจที่คล้ายกันอีกสองสามรายการ: require-all, require-directory, require-dir และอื่น ๆ ดูเหมือนว่าไฟล์ที่ดาวน์โหลดมากที่สุดจะเป็นที่ต้องการอย่างน้อยในเดือนกรกฎาคม 2015
Mnebuerquo

require-dir ได้รับการดาวน์โหลดมากที่สุดแล้ว (แต่ก็ไม่รองรับการยกเว้นไฟล์ในขณะที่เขียน)
Sean Anderson

สามปีหลังจากความคิดเห็นของฌอนด้านบนrequire-dirเพิ่มfilterตัวเลือก
givemesnacks

7

ฉันมีโฟลเดอร์ / ฟิลด์ที่เต็มไปด้วยไฟล์ที่มีคลาสเดียวแต่ละรายการเช่น:

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

วางในฟิลด์ / 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ไม่มีตัวเลือกในการกรองไฟล์ / dirs และไม่มี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

หนึ่งโมดูลที่ฉันใช้สำหรับกรณีการใช้งานที่แน่นอนนี้คือต้องการทั้งหมดต้องทั้งหมด

มันต้องเรียกซ้ำไฟล์ทั้งหมดในไดเรกทอรีที่กำหนดและไดเรกทอรีย่อยตราบเท่าที่พวกเขาไม่ตรงกับ 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

สามารถใช้: https://www.npmjs.com/package/require-file-directory

  • ต้องการไฟล์ที่เลือกด้วยชื่อเท่านั้นหรือไฟล์ทั้งหมด
  • ไม่จำเป็นต้องมีเส้นทางที่ไม่มีฝีเท้า
  • ง่ายต่อการเข้าใจและใช้งาน

2
ยินดีต้อนรับสู่ SO โปรดอ่านวิธีการตอบสำหรับการให้คำตอบที่มีคุณภาพนี้
อีก

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"):

ในไดเรกทอรีแอป / lib

example.js:

module.exports = function (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.