Comment organiser de grandes Node.js projets

Débutants Exemple

J'aime à l'origine contrôlées de @david-ellis et vous devez l'étudier en profondeur pour comprendre que c'est une bonne idée. Cependant, j'aurais aimé plus simplifié pour les débutants qui veulent voir un simple exemple. Voici ce que j'aurais aimé avoir vu quelqu'un me montrer.

Donnons un scénario typique où vous utilisez express et que vous avez beaucoup de routes figurant sur votre app.js fichier. Son contenu devrait ressembler à quelque chose comme ceci:

app.js

//... startup code omitted above

app.get('/', function(req, res) {
  res.render('index', { title : 'home' });
});
app.get('/contactus', function(req, res) {
  res.render('contactus', { title : 'contact us' });
});
app.get('/anotherpage', function(req, res) {
  res.render('anotherpage', { title : 'another page' });
});
//and so on...

Vous pouvez imaginer si vous avez 50 itinéraires, ce fichier peut être tout à fait hors de la main. Il serait bon de supprimer certains de ces interruptions de la app.js fichier.

Ce que vous voulez faire est de créer un "contrôleurs" dans le dossier de votre application de sorte que votre structure serait maintenant ressembler à ceci:

app.js
/controllers

Créer un fichier dans "/controllers" nommé "index.js" puis placez le code suivant.

/controllers/index.js

module.exports.set = function(app) {
   //copy your routes listed in your app.js directly into here
}

Couper et coller votre itinéraire inscriptions à partir de votre "app.js" fichier et le placer dans le "/controllers/index.js" fichier.

Sur votre app.js fichier, supprimez votre parcours et à la place de faire le suivant.

app.js

//remove your routes and replace with this code
var controllers = require('./controllers');
controllers.set(app);

Maintenant, si vous voulez avoir votre "/controllers/index.js" fichier peut également être scindée, nous allons ajouter un exemple de plus de sorte que vous pouvez voir comment Node.js vraiment agit comme une Poupée russe dans la façon dont son code peut être organisé.

Dans "/controllers" ajouter un fichier "accounts.js" et placer celui-ci en son sein.

/controllers/account.js

module.exports.set = function(app) {
    //put more app route listings here
}

Maintenant dans votre "/controllers/index.js fichier, mettre une référence à "account.js"

/controllers/index.js

var account = require('./account.js');

module.exports.set = function(app) {
   //your routes here

   //let "account.js" set other routes
   account.set(app);
}

Comme vous pouvez l'imaginer, vous pouvez garder la rupture des choses en plus petits et de plus petites pièces et mettre plus de dossiers dans des dossiers et de la référence à "exiger" si vous le souhaitez. Vous pouvez utiliser la même notion de "/lib" ou les fichiers de bibliothèque. "node_modules" est déjà cela.

Qui est juste une des nombreuses raisons node.js est très agréable à programmer avec.

Gérable Express 4 exemple de Routage

Voici un autre post, j'ai répondu à propos d'express 4 voies qui se rapporte à cela.

Reste avec Express.js imbriquée routeur

J'ai écrit un blog post sur ce sujet il y a quelques jours, et bien que l'article est en français, j'ai mis en place un Dépôt GitHub (en anglais) pour montrer un exemple de fonctionnement de la structure que j'utilise.

Évidemment, il n'y a pas de réponse définitive à cette question, mais il est intéressant de voir ce que les autres font, et je suis preneuse d'autres avis sur le sujet (qui était aussi le discuté ici, où vous pouvez voir un résumé de ce que je propose).

Ses Articles ne sont plus en ligne, mais Eric Satterwhite de nœud de la série a recommandé une structure comme indiqué ci-dessous.

# Project 
. 
|-- packages/
|   |-- project-core
|   |   |-- lib/
|   |   |-- commands/
|   |   |-- startup/
|   |   |-- conf/
|   |   |-- test/
|   |   |-- package.json
|   |   |-- README.md
|   |   |-- events.js
|   |   |-- .npmignore
|   |   `-- index.js
|-- package.json
`-- index.js

Avec le packages/ dossier tournant dans votre source pour la modularité.

Si vous n'avez pas l'esprit, vous pouvez toujours en apprendre tapuscrit et aller pour https://nestjs.com/

Si vous voulez coller avec JS, je recommande fortement d'utiliser de l'oignon de l'architecture.
La meilleure pratique est de garder séparés logique d'entreprise, les contrôleurs, même les bibliothèques (ils doivent être enveloppé à l'intérieur de certaines classes /helpers) - juste au cas où, si vous devez migrer vers une autre bibliothèque (différents CSV analyseur etc.).

Avec des oignons, de l'architecture, vous n'avez pas de soins à partir de laquelle les demandes vient, il n'y aura pas beaucoup de changements, afin d'ajouter encore quelques courtier de message.

Aussi essayer celui-ci https://en.wikipedia.org/wiki/Domain-driven_design

ESLint peuvent aider à la bonne organisation du projet.