Come posso richiedere tutti i file in una cartella in node.js?
bisogno di qualcosa come:
files.forEach(function (v,k){
// require routes
require('./routes/'+v);
}};
Come posso richiedere tutti i file in una cartella in node.js?
bisogno di qualcosa come:
files.forEach(function (v,k){
// require routes
require('./routes/'+v);
}};
Risposte:
Quando viene richiesto il percorso di una cartella, verrà richiesto un file index.js in quella cartella; se ce n'è uno, lo usa e, in caso contrario, fallisce.
Probabilmente avrebbe molto senso (se si ha il controllo sulla cartella) creare un file index.js e quindi assegnare tutti i "moduli" e quindi semplicemente richiederlo.
yourfile.js
var routes = require("./routes");
index.js
exports.something = require("./routes/something.js");
exports.others = require("./routes/others.js");
Se non conosci i nomi dei file, dovresti scrivere una specie di caricatore.
Esempio di funzionamento di un caricatore:
var normalizedPath = require("path").join(__dirname, "routes");
require("fs").readdirSync(normalizedPath).forEach(function(file) {
require("./routes/" + file);
});
// Continue application logic here
require
viene dato il percorso di una cartella, cercherà un index.js
in quella cartella; se ce n'è uno, lo usa e, in caso contrario, fallisce. Vedi github.com/christkv/node-mongodb-native per un esempio del mondo reale di questo: c'è un index.js
nella directory root che richiede ./lib/mongodb
, una directory; ./lib/mongodb/index.js'
rende tutto il resto in quella directory disponibile.
require
è una funzione sincrona, quindi non ci sono vantaggi dal callback. Vorrei usare fs.readdirSync invece.
package.json
in questa directory. In questo modo:{main: './lib/my-custom-main-file.js'}
Raccomando di usare glob per svolgere questo compito.
var glob = require( 'glob' )
, path = require( 'path' );
glob.sync( './routes/**/*.js' ).forEach( function( file ) {
require( path.resolve( file ) );
});
glob
? intendi glob-savior-of-the-nodejs-race
. Migliore risposta.
Basandomi sulla soluzione di @ tbranyen, creo un index.js
file che carica javascript arbitrari nella cartella corrente come parte di 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);
}
});
Quindi è possibile require
questa directory da qualsiasi altra parte.
Un'altra opzione è quella di utilizzare il pacchetto request-dir che ti consente di fare quanto segue. Supporta anche la ricorsione.
var requireDir = require('require-dir');
var dir = requireDir('./path/to/dir');
require-dir
perché esclude automaticamente il file chiamante (indice) e imposta automaticamente la directory corrente. Perfetto.
require-dir
aggiunto filter
un'opzione.
Ho una cartella / campi pieni di file con una singola classe ciascuno, es:
fields/Text.js -> Test class
fields/Checkbox.js -> Checkbox class
Rilascialo in fields / index.js per esportare ogni classe:
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);
Questo rende i moduli più simili a come sarebbero in Python:
var text = new Fields.Text()
var checkbox = new Fields.Checkbox()
Un'altra opzione è richiedere-dir-all combinando le funzionalità dei pacchetti più popolari.
I più popolari require-dir
non hanno opzioni per filtrare i file / dirs e non hanno map
funzioni (vedi sotto), ma usano piccoli accorgimenti per trovare il percorso corrente del modulo.
In secondo luogo per popolarità require-all
ha il filtro regexp e la preelaborazione, ma manca di percorso relativo, quindi è necessario utilizzare __dirname
(questo ha pro e contro) come:
var libs = require('require-all')(__dirname + '/lib');
Menzionato qui require-index
è abbastanza minimalista.
Con map
te puoi fare un po 'di preelaborazione, come creare oggetti e passare valori di configurazione (supponendo che i moduli sotto esportatori siano costruttori):
// 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`.
So che questa domanda ha più di 5 anni e le risposte fornite sono buone, ma volevo qualcosa di un po 'più potente per Express, quindi ho creato il express-map2
pacchetto per npm. Stavo per nominarlo semplicemente express-map
, tuttavia le persone di Yahoo hanno già un pacchetto con quel nome, quindi ho dovuto rinominare il mio pacchetto.
1. utilizzo di base:
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.
});
utilizzo del controller:
//single function
module.exports = function(req,res){
};
//export an object with multiple functions.
module.exports = {
foo: function(req,res){
},
bar: function(req,res){
}
};
2. utilizzo avanzato, con prefissi:
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
});
Come puoi vedere, questo fa risparmiare un sacco di tempo e rende il routing della tua applicazione estremamente semplice da scrivere, gestire e comprendere. supporta tutti i verbi http che esprimono i supporti, nonché il .all()
metodo speciale .
Un modulo che ho usato per questo esatto caso d'uso è obbligatorio .
Richiede in modo ricorsivo tutti i file in una determinata directory e le sue sottodirectory purché non corrispondano alla excludeDirs
proprietà.
Consente inoltre di specificare un filtro file e come derivare le chiavi dell'hash restituito dai nomi dei file.
Sto usando i moduli di copia-modulo dei moduli del nodo per creare un singolo file per richiedere tutti i file nel nostro sistema basato su NodeJS.
Il codice per il nostro file di utilità è simile al seguente:
/**
* Module dependencies.
*/
var copy = require('copy-to');
copy(require('./module1'))
.and(require('./module2'))
.and(require('./module3'))
.to(module.exports);
In tutti i file, la maggior parte delle funzioni sono scritte come esportazioni, in questo modo:
exports.function1 = function () { // function contents };
exports.function2 = function () { // function contents };
exports.function3 = function () { // function contents };
Quindi, per usare qualsiasi funzione da un file, basta chiamare:
var utility = require('./utility');
var response = utility.function2(); // or whatever the name of the function is
Espandendo su questa glob
soluzione. Fare questo se si desidera importare tutti i moduli da una directory in index.js
e quindi importarlo index.js
in un'altra parte dell'applicazione. Si noti che i letterali dei modelli non sono supportati dal motore di evidenziazione utilizzato da StackOverflow, quindi il codice potrebbe apparire strano qui.
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;
Esempio completo
Struttura di directory
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';
Dall'interno del progetto con glob
installato , eseguinode example.js
$ node example.js
foo ran
bar run
keepit ran unexpected
foo ran
bar run
keepit ran unexpected
Può usare: https://www.npmjs.com/package/require-file-directory
Richiedi tutti i file dalla routes
cartella e applica come middleware. Non sono necessari moduli esterni.
// require
const path = require("path");
const { readdirSync } = require("fs");
// apply as middleware
readdirSync("./routes").map((r) => app.use("/api", require("./routes/" + r)));
Utilizzando questa funzione è possibile richiedere un'intera directory.
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);
Se includi tutti i file di * .js nell'esempio di directory ("app / lib / *. Js"):
example.js:
module.exports = function (example) { }
Esempio-2.js:
module.exports = function (example2) { }
index.js:
module.exports = require('./app/lib');
var routes = require('auto-load')('routes');
con il nuovoauto-load
modulo [ho contribuito a crearlo].