Jak organizować duże projekty Node.js.


82

Jakie są dobre sposoby organizowania dużych projektów Node.js?

Na przykład aplikacja korzystająca z Express.js i socket.io? Obejmuje to zarówno strukturę logiczną aplikacji, jak i system plików.

Obecnie wsuwam mnóstwo kodu do jednego głównego pliku js i umieszczam kod w gigantycznym globalnym obiekcie i wydaje mi się to niegrzeczne.


2
Masz czas na przeczytanie książki ?
— Straseus

Może będę musiał kupić tę książkę, dzięki!
— Thomas Hunter II

Google "Moduły JavaScript" lub "Modular JavaScript" :-)
— Sri

1
Przeczytałem książkę zasugerowaną przez Straseusa i zawiera ona wiele dobrych rad i analiz, ale obawiam się, że niewiele dobrze przekłada się na tworzenie struktury aplikacji Node.js za pomocą express. Odpowiedź PuerkitoBio poniżej prowadzi do kilku sugestii dotyczących dobrej struktury początkowej plików; W razie potrzeby planuję rozbudować tę strukturę.
— Aaron

Odpowiedzi:


97

Przykład dla początkujących

Podoba mi się oryginał sprawdzony z @ david-ellis i powinieneś go dokładnie przestudiować, aby go zrozumieć, ponieważ jest dobry. Wolałbym jednak, aby było to bardziej uproszczone dla początkujących, którzy chcą zobaczyć prosty przykład. Oto, co chciałbym, żeby ktoś mi pokazał.

Podajmy typowy scenariusz, w którym używasz ekspresu i masz wiele tras wymienionych w pliku app.js. Jego zawartość wyglądałaby mniej więcej tak:

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...

Możesz sobie wyobrazić, że jeśli masz 50 tras, ten plik może wymknąć się spod kontroli. Byłoby miło usunąć część tego bałaganu z pliku app.js.

To co byś zrobił, to utworzenie folderu „controllers” w swojej aplikacji, aby Twoja struktura wyglądała teraz następująco:

app.js
/controllers

Utwórz plik w „/ controllers” o nazwie „index.js”, a następnie umieść następujący kod.

/controllers/index.js

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

Wytnij i wklej listę tras z pliku „app.js” i umieść je w pliku „/controllers/index.js”.

W pliku app.js usuń trasy i zamiast ich wykonaj następujące czynności.

app.js

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

Teraz, jeśli chciałbyś, aby twój plik "/controllers/index.js" również został podzielony, dodajmy jeszcze jeden przykład, abyś mógł zobaczyć, jak Node.js naprawdę działa jak rosyjska lalka w sposobie organizacji jego kodu.

W „/ controllers” dodaj jeszcze jeden plik „accounts.js” i umieść w nim następujący plik.

/controllers/account.js

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

Teraz w pliku „/controllers/index.js” umieść odniesienie do „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);
}

Jak możesz sobie wyobrazić, możesz dalej dzielić rzeczy na mniejsze i mniejsze części i umieszczać więcej folderów w folderach i odwoływać się do „wymagania”, jeśli chcesz. Możesz użyć tej samej koncepcji dla „/ lib” lub plików bibliotek. „node_modules” już to robi.

To tylko jeden z wielu powodów, dla których program node.js jest bardzo przyjemny.

Przykład routingu Manageable Express 4

Oto kolejny post, na który odpowiedziałem, dotyczący tras ekspresowych 4, który się z tym wiąże.

Odpocznij z zagnieżdżonym routerem Express.js


IMHO było lepiej przed aktualizacją, można uniknąć konieczności nadawania nazwy każdemu kontrolerowi, implementując mechanizm aliasingu, w którym jedna trasa kieruje do drugiej, pomaga to również w przypadku kanonicznych adresów URL
— Timo Huovinen

Nie przejmuj się kanonicznymi adresami URL, to była refleksja. Przez kanoniczny adres URL miałem na myśli dodanie kanonicznego <link>do czegoś, na przykład /example/pathgdy użytkownik wchodzi /example/path/w pasek adresu (lub na odwrót).
— Timo Huovinen

Wiesz, jako programista naturalne jest, że chce tego typu zorganizowanej hierarchii, ale w praktyce nie nadaje się to dobrze podczas otwierania pliku lub czytania zameldowania. Otrzymasz dużą liczbę plików „index.js”, z którymi praca szybko staje się uciążliwa.
— Abhinav Gujjar

Rok później cenny dla mnie post. Właśnie uruchamiam node.js do wykorzystania w weekendowym projekcie.
— masfenix

@JasonSebring Jest tyle informacji, a ja jestem nowy! Jestem teraz bardzo zagubiony. Jako student magisterski z matematyki robię dużo matlab / R / mathematica, ALE ostatnim razem, gdy dotknąłem frameworka web / desktop, powróciłem do .net 2.0 dni.
— masfenix

10

Napisałem post na blogu na ten temat kilka dni temu i chociaż artykuł jest po francusku, założyłem repozytorium GitHub (w języku angielskim), aby pokazać działający przykład struktury, której używam.

Oczywiście nie ma ostatecznej odpowiedzi na to pytanie, ale ciekawie jest zobaczyć, co robią inni, a ja mam uszy na inne opinie na ten temat (o czym również tutaj dyskutowano , gdzie można zobaczyć podsumowanie tego, co sugeruję) .


Dzięki za ten link, to była dobra lektura (z pomocą Tłumacza Google) i jestem pewien, że postąpię zgodnie z Twoimi sugestiami dotyczącymi organizacji projektu, nad którym obecnie pracuję.
— Aaron

Czy możesz naprawić link?
— Yevhenii Herasymchuk

2

Podobnie jak w przypadku innego wpisu na blogu, napisałem jeden dotyczący organizowania Expressaplikacji. To metoda, której używam od około półtora roku. Zasadniczo organizuj aplikacje wokół jednostek danych lub innych podstawowych elementów. Umieść logikę dla każdego z tych elementów w ich własnych katalogach. Próbowałem dużo pożyczyć od Pythona.

http://rycole.com/2013/01/28/organizing-nodejs-express.html


1

Jego artykuły nie są już dostępne online, ale seria węzłów Erica Satterwhite'a zalecała strukturę wymienioną poniżej.

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

Dzięki temu, że packages/folder staje się źródłem modułowości.


0

Jeśli jesteś początkującym w tej dziedzinie, proponuję przyjrzeć się istniejącym projektom, które są kochane przez programistów. Niektórzy z nich są:

  • Sails.js - 18 tys. Gwiazdek . Możesz zobaczyć, jak zorganizowali strukturę aplikacji pod linkiem, który podałem. Świetna strona internetowa ma wyjaśnienie każdego folderu w strukturze.

  • Generator Express.js - 800 gwiazdek. Istnieje świetny i prosty szablon do rozpoczęcia pracy z Express.js. Tutaj możesz zauważyć, jak dzielą trasy z aplikacji.

Nawiasem mówiąc, wielu programistów już wcześniej zajmowało się Twoją sprawą i możesz po prostu ją rozwidlić i zaktualizować.

  • Kioska . Zobacz, jak dzielą wydarzenia na różne pliki w events/folderze.

  • Ballons.io 2.3k gwiazdy. Niestety mają cały serwer gniazda w jednym pliku, ale całej struktury aplikacji można poznać za pomocą node.js i socket.io


0

Jeśli nie masz nic przeciwko, zawsze możesz nauczyć się maszynopisu i przejść do https://nestjs.com/

Jeśli chcesz pozostać przy JS, zdecydowanie polecam użycie architektury cebulowej. Najlepszą praktyką jest zachowanie oddzielnej logiki biznesowej, kontrolerów, a nawet bibliotek (powinny być opakowane w niektóre klasy / pomocniki) - na wszelki wypadek, jeśli będziesz musiał migrować do innej biblioteki (inny parser CSV itp.).

Dzięki architekturze cebulowej nie obchodzi Cię, skąd pochodzą żądania, nie będzie wielu zmian, aby dodać nawet brokera wiadomości.

Spróbuj także tego https://en.wikipedia.org/wiki/Domain-driven_design

ESLint może pomóc w prawidłowej organizacji projektu.

Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.