Node.js, restify und richtiges Routing

Question

Ich bin immer noch meinen Kopf um Knoten, aber ich habe eine sehr einfache Frage. Ich sehe eine Menge von Knotenbeispielen, bei denen Leute ihre Routen und ihre gesamte Logik in einer einzigen app.js-Datei deklarieren (oder sie manchmal in Unterdateien aufteilen).

Meine Frage ist im Grunde: ist es besser, alle Ihre Routen Deklarationen in der App oder Bootstrap eine generische Route, die auf Ihre Dateistruktur zuordnet. Dies mag wie eine primitive Frage erscheinen, aber mein Ziel ist es zu erfassen, was innerhalb von Knoten am effizientesten ist.

Ich baue gerade einen API-Handler mit Restify, aber ich habe eine andere App, die Express verwendet (diese Frage wird wahrscheinlich beide Fragen beantworten).

In meiner Route kann ich entweder eine einzelne Route Bootstrap wie so erklärt:

app.all('/api/:package/:controller', function(request, response) { 
    var controller = require(
     '../' + request.params.package + '/api/' + request.params.controller 
    ); 
    controller.index(request, response); 
    response.end(); 
}); 

Dieser übernimmt grundsätzlich alle Anrufe aus der API und zielt auf die richtigen api-Controller. Alternativ kann ich jede Route einzeln deklarieren oder vielleicht sogar eine Schleife schreiben, die jeden meiner Controller durchläuft und sie auf init deklariert. Also:

for (var i in packages.controllers) { 
    app.all('api/' + package + '/' + controllers[i].name, function(request, response) { 
     var controller = require(
      '../' + request.params.package + '/api/' + request.params.controller 
     ); 
     controller.index(request, response); 
    } 
} 

packages.controllers ist ein Array aller möglichen Steuerungen. Beachten Sie, dass der obige Code nicht korrekt ist. Ich habe eine HMVC-Ordnerstruktur, daher ist der Code ein wenig komplizierter als der obige Code. Aber Sie verstehen es.

Ich frage mich, was die Konsequenzen von beiden sind und ob es wirklich wichtig ist?

Danke!

Answer 1

Die explodierende app.js-Datei veranlasste einige von uns, eine kleine Referenz-App zu erstellen, um eine Standard-Express-App-Struktur zu kodieren. Es ist keine Hexerei, sondern eine Reihe von Konventionen, die die Dinge organisierter machen.

Sie können es hier finden: https://github.com/EAAppFoundry/tableau

Wir Liebe Vorschläge würden/Anfragen ziehen, wenn es etwas, was wir falsch verstanden oder fehlt.

Answer 2

Ich würde nicht eine einzige app.js überhaupt empfehlen. Sie werden mit einer Datei mit mehr als 5.000 Zeilen enden, was ein Albtraum ist, der beibehalten werden muss.

Das größte Problem, das ich mit Ihrem Snippet sehe, ist, dass, obwohl require() zwischengespeichert wird, es eine synchrone EA-Anfrage durchführen muss. Es ist nur eine schlechte Angewohnheit, hineinzugehen.

Ähnlich wie Don empfiehlt, hatte ich das Glück, Routen in Module zu teilen, die eine einzelne Funktion exportieren, die eine Instanz der App akzeptiert. Sie können daran denken als „Dekoration“, um die App-Instanz:

// app.js 
var app = express.createServer(); 
app.configure(function(){ //... }); 

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

// foo.js 
exports = module.exports = function(app){ 

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

}; 

Answer 3

Ich glaube nicht, dass es mit Looping durch den Verzeichnisbaum ein wirkliches Problem sein soll und die Routen zu erzeugen. Es wird jedoch schwierig sein, routenbasierte Middleware und andere Routing-Funktionen (wie etwa Variablen in den Routen) auf eine nette Weise zu definieren.

Ich habe eine Bibliothek geschrieben, die ich benutze, um meine Routen deklarativ und mit minimalen Wiederholungen zu definieren, die Sie interessieren könnten. Sie ist von Rails findigem Routing inspiriert und ist ziemlich flexibel - die Idee besteht darin, einen Hash von Routen und Unterrouten zu erstellen; Es gibt auch Möglichkeiten, Gruppen von Routen, Middleware und Variablen zu definieren.

https://github.com/cheesun/express-declarative-routing

Obwohl es nicht automatisch die Routen auf die Verzeichnisstruktur auf Basis erzeugen ist, denke ich, dass ein cooles Feature sein würde und empfangen Sie es in die Bibliothek hinzufügen.