Как включить обработчики маршрутов в несколько файлов в Express? - PullRequest
190 голосов
/ 19 мая 2011

В моем приложении NodeJS express у меня есть app.js, у которого есть несколько общих маршрутов. Затем в файле wf.js я хотел бы определить еще несколько маршрутов.

Как мне получить app.js для распознавания других обработчиков маршрутов, определенных в файле wf.js?

Простое требование , похоже, не работает.

Ответы [ 12 ]

349 голосов
/ 19 мая 2011

Если вы хотите поместить маршруты в отдельный файл , например routes.js, вы можете создать файл routes.js следующим образом:

module.exports = function(app){

    app.get('/login', function(req, res){
        res.render('login', {
            title: 'Express Login'
        });
    });

    //other routes..
}

И тогда вы можете потребовать его от app.js, передавая app объект таким образом:

require('./routes')(app);

Посмотрите также на эти примеры

https://github.com/visionmedia/express/tree/master/examples/route-separation

93 голосов
/ 20 мая 2011

Опираясь на пример @ShadowCloud, я смог динамически включить все маршруты в подкаталог.

route / index.js

var fs = require('fs');

module.exports = function(app){
    fs.readdirSync(__dirname).forEach(function(file) {
        if (file == "index.js") return;
        var name = file.substr(0, file.indexOf('.'));
        require('./' + name)(app);
    });
}

Тогдаразмещение файлов маршрутов в каталоге маршрутов следующим образом:

rout / test1.js

module.exports = function(app){

    app.get('/test1/', function(req, res){
        //...
    });

    //other routes..
}

Повторение этого столько раз, сколько мне нужно, а затем, наконец, в app.js размещение

require('./routes')(app);
83 голосов
/ 18 мая 2016

Несмотря на то, что этот старый вопрос я наткнулся здесь в поисках решения аналогичной проблемы. Попробовав некоторые решения здесь, я в конечном итоге пошел в другом направлении и подумал, что добавлю свое решение для всех, кто окажется здесь.

В Express 4.x вы можете получить экземпляр объекта маршрутизатора и импортировать другой файл, который содержит больше маршрутов. Вы даже можете сделать это рекурсивно, чтобы ваши маршруты импортировали другие маршруты, позволяя вам создавать простые для поддержки URL-пути. Например, если у меня уже есть отдельный файл маршрута для моей конечной точки / tests, и я хочу добавить новый набор маршрутов для / tests / automatic, я могу разбить эти / автоматизированные маршруты в другой файл для сохранить мой файл / test небольшим и легким в управлении. Это также позволяет логически группировать маршруты по URL-пути, что может быть очень удобно.

Содержание ./app.js:

var express = require('express'),
    app = express();

var testRoutes = require('./routes/tests');

// Import my test routes into the path '/test'
app.use('/tests', testRoutes);

Содержание ./routes/tests.js

var express = require('express'),
    router = express.Router();

var automatedRoutes = require('./testRoutes/automated');

router
  // Add a binding to handle '/test'
  .get('/', function(){
    // render the /tests view
  })

  // Import my automated routes into the path '/tests/automated'
  // This works because we're already within the '/tests' route so we're simply appending more routes to the '/tests' endpoint
  .use('/automated', automatedRoutes);

module.exports = router;

Содержание ./routes/testRoutes/automated.js:

var express = require('express'),
    router = express.Router();

router
   // Add a binding for '/tests/automated/'
  .get('/', function(){
    // render the /tests/automated view
  })

module.exports = router;
18 голосов
/ 12 августа 2012

И, опираясь на предыдущий ответ, эта версия маршрутов / index.js будет игнорировать любые файлы, не заканчивающиеся на .js (и сам по себе)

var fs = require('fs');

module.exports = function(app) {
    fs.readdirSync(__dirname).forEach(function(file) {
        if (file === "index.js" || file.substr(file.lastIndexOf('.') + 1) !== 'js')
            return;
        var name = file.substr(0, file.indexOf('.'));
        require('./' + name)(app);
    });
}
17 голосов
/ 14 февраля 2014

Полная рекурсивная маршрутизация всех .js файлов в папке /routes, поместите это в app.js.

// Initialize ALL routes including subfolders
var fs = require('fs');
var path = require('path');

function recursiveRoutes(folderName) {
    fs.readdirSync(folderName).forEach(function(file) {

        var fullName = path.join(folderName, file);
        var stat = fs.lstatSync(fullName);

        if (stat.isDirectory()) {
            recursiveRoutes(fullName);
        } else if (file.toLowerCase().indexOf('.js')) {
            require('./' + fullName)(app);
            console.log("require('" + fullName + "')");
        }
    });
}
recursiveRoutes('routes'); // Initialize it

в /routes вы ставите whatevername.js и инициализируете свои маршруты следующим образом:

module.exports = function(app) {
    app.get('/', function(req, res) {
        res.render('index', { title: 'index' });
    });

    app.get('/contactus', function(req, res) {
        res.render('contactus', { title: 'contactus' });
    });
}
6 голосов
/ 01 июля 2018

Я пытаюсь обновить этот ответ "express": "^ 4.16.3". Этот ответ аналогичен ShortRound1911.

server.js

const express = require('express');
const mongoose = require('mongoose');
const bodyParser = require('body-parser');
const db = require('./src/config/db');
const routes = require('./src/routes');
const port = 3001;

const app = new express();

//...use body-parser
app.use(bodyParser.urlencoded({ extended: true }));

//...fire connection
mongoose.connect(db.url, (err, database) => {
  if (err) return console.log(err);

  //...fire the routes
  app.use('/', routes);

  app.listen(port, () => {
    console.log('we are live on ' + port);
  });
});

/ SRC / маршруты / index.js

const express = require('express');
const app = express();

const siswaRoute = require('./siswa_route');

app.get('/', (req, res) => {
  res.json({item: 'Welcome ini separated page...'});
})
.use('/siswa', siswaRoute);

module.exports = app;

/ SRC / маршруты / siswa_route.js

const express = require('express');
const app = express();

app.get('/', (req, res) => {
  res.json({item: 'Siswa page...'});
});

module.exports = app;

Надеюсь, это кому-нибудь поможет. Удачного кодирования!

5 голосов
/ 28 июля 2015

Я знаю, что это старый вопрос, но я пытался выяснить что-то подобное для себя, и это место, в котором я оказался, поэтому я хотел найти свое решение аналогичной проблемы на случай, если кто-то другой имеет такую ​​же проблемы у меня Есть замечательный модуль узла, который называется consign , который выполняет большую часть работы с файловой системой, которую мы здесь видим (т. Е. - без чтения readdirSync). Например:

У меня есть спокойное API-приложение, которое я пытаюсь создать, и я хочу поместить все запросы, которые идут в '/ api / *', для аутентификации, и я хочу сохранить все свои маршруты, которые идут в api, в их собственный каталог (давайте просто назовем его «API»). В основной части приложения:

app.use('/api', [authenticationMiddlewareFunction], require('./routes/api'));

Внутри каталога маршрутов у меня есть каталог с именем "api" и файл с именем api.js. В api.js у меня просто есть:

var express = require('express');
var router = express.Router();
var consign = require('consign');

// get all routes inside the api directory and attach them to the api router
// all of these routes should be behind authorization
consign({cwd: 'routes'})
  .include('api')
  .into(router);

module.exports = router;

Все работало как положено. Надеюсь, это кому-нибудь поможет.

5 голосов
/ 04 ноября 2014

Если вы хотите, чтобы отдельный файл .js лучше организовывал ваши маршруты, просто создайте переменную в файле app.js, указывающую его местоположение в файловой системе:

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

тогда

app.get('/wf', wf.foo );

где .foo - некоторая функция, объявленная в вашем файле wf.js. например,

// wf.js file 
exports.foo = function(req,res){

          console.log(` request object is ${req}, response object is ${res} `);

}
5 голосов
/ 14 июня 2013

Один твик ко всем ответам:

var routes = fs.readdirSync('routes')
      .filter(function(v){
         return (/.js$/).test(v);
      });

Просто используйте регулярное выражение для фильтрации путем тестирования каждого файла в массиве.Он не рекурсивный, но отфильтровывает папки, которые не заканчиваются на .js

1 голос
/ 12 декабря 2016

Я написал небольшой плагин для этого! надоело писать один и тот же код снова и снова.

https://www.npmjs.com/package/js-file-req

Надеюсь, это поможет.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...