mitmario.dev

Projektstruktur

Node.js Sandbox 4 Min Lesezeit 3 BeispieleLektion 1 von 7

Soll sich an der Regel für alte Bücher später eine Kleinigkeit ändern, suchst du erst einmal, wo sie überhaupt steht. Mit einer Verabredung darüber, was wohin gehört, fällt diese Suche weg, und so eine Verabredung ist schnell getroffen.

Routen, Logik und Datenzugriff

Alles in einer Datei
import express from "express";
import { DatabaseSync } from "node:sqlite";

const db = new DatabaseSync("bibliothek.db");

// Damit die Datei fuer sich laeuft: drei Buecher, jedes Mal frisch.
db.exec("DROP TABLE IF EXISTS buecher");
db.exec("CREATE TABLE buecher (id INTEGER PRIMARY KEY, titel TEXT, jahr INTEGER)");
db.exec(
  "INSERT INTO buecher (titel, jahr) VALUES " +
    "('Sicher ausliefern', 2009), " +
    "('Die lange Nacht des Debuggens', 2022), " +
    "('Nachtschicht mit Node', 2023)"
);

const app = express();

app.get("/", (req, res) => {
  res.type("html").send(
    '<h1>Bibliothek</h1><p><a href="/api/buecher">/api/buecher</a></p>'
  );
});

app.get("/api/buecher", (req, res) => {
  const q = typeof req.query.q === "string" ? req.query.q.trim() : "";

  if (q.length > 100) {
    return res.status(400).json({ fehler: { code: "ungueltig", meldung: "Der Suchbegriff ist zu lang." } });
  }

  const zeilen = q
    ? db.prepare("SELECT id, titel, jahr FROM buecher WHERE titel LIKE '%' || ? || '%' ORDER BY id").all(q)
    : db.prepare("SELECT id, titel, jahr FROM buecher ORDER BY id").all();

  // Und hier faengt es an: die Regel, was ein Buch fuer den Aufrufer
  // ist, steht mitten in einer Route und nirgends sonst. Das Jahr steht
  // fest, damit das Beispiel jedes Jahr dasselbe zeigt; im Betrieb
  // stuende hier new Date().getFullYear().
  const jetzt = 2026;
  const buecher = zeilen.map((buch) => ({
    ...buch,
    alt: jetzt - buch.jahr > 10,
  }));

  res.json({ anzahl: buecher.length, daten: buecher });
});

app.listen(3000);

Diese Route ist nicht schlecht geschrieben. Sie macht nur drei Dinge auf einmal, und keins davon lässt sich einzeln anfassen. Sie nimmt eine Anfrage entgegen und antwortet, sie entscheidet, wann ein Buch als alt gilt, und sie spricht SQL.

Im Reiter Browser steht ein Link, und dahinter liegt das JSON. alt ist bei dem Buch von 2009 wahr und bei den beiden jüngeren falsch. Um diese eine Zeile geht es gleich. Das Jahr steht im Beispiel fest, damit jedes Jahr dasselbe herauskommt. Die drei db.exec-Zeilen legen nur die Tabelle an, damit die Datei für sich läuft. Die Route auf / liefert nur den Link.

Die Aufteilung in Schichten (englisch layers) folgt diesen drei Aufgaben.

SchichtWeiß etwas vonWeiß nichts von
RoutenHTTP, Statuscodes, req und resSQL
Logikden Regeln deiner AnwendungHTTP und SQL
Datenzugriffder DatenbankHTTP und den Regeln

Wichtiger als die Namen ist die Richtung. Oben ruft unten auf, nie umgekehrt. Importiert eine Datei im Datenzugriff etwas aus routen/, ist das immer ein Fehler.

Die Logik ist die Schicht, die man testen kann

Dieselbe Anwendung in drei Schichten
import express from "express";
import { buecherRouter } from "./routen/buecher.js";

// Der Server haengt nur noch den Router ein und startet.
const app = express();
app.use("/api/buecher", buecherRouter);
app.listen(3000);

Der Code ist jetzt auf drei Schichten verteilt, und heraus kommt dasselbe JSON wie eben. server.js hängt nur noch den Router ein. In logik/ nimmt sucheBuecher(q) einen Text und gibt ein Array zurück. Mehr braucht sie nicht, also kannst du sie in einem Test aufrufen, ohne dass ein Server startet. So sahen auch die Funktionen aus, die du in Lektion 17.2 getestet hast.

In den Regeln sitzen die Fehler, die nur diese eine Anwendung haben kann. Ohne die Trennung kommt an sie nur heran, wer einen Server startet und eine Anfrage schickt.

req und res bleiben oben

Wenn res in die Logik rutscht
import { entferne, istVerliehen } from "./daten/buecher.js";
import { Konflikt } from "./fehler.js";

// Dieselbe Regel, ohne res: die Funktion gibt zurueck oder wirft.
export function sortiereAus(id) {
  if (istVerliehen(id)) {
    throw new Konflikt("Ein verliehenes Buch bleibt im Bestand.");
  }

  entferne(id);
}

// Die Route uebersetzt das in HTTP, und nur sie. Wirft sortiereAus,
// macht der Fehler-Handler aus Abschnitt 16 eine 409 daraus:
//
//   buecherRouter.delete("/:id", (req, res) => {
//     sortiereAus(Number(req.params.id));
//     res.status(204).end();
//   });

Dass ein verliehenes Buch im Bestand bleibt, ist eine Regel der Anwendung. Sie gilt auch für ein Aufräumskript, das nie eine Anfrage sieht, und gehört deshalb in die Logik. Die Länge des Suchbegriffs prüft dagegen die Route, denn diese Grenze gilt nur für das, was über HTTP hereinkommt. In falsch.js ist res in die Logik mitgewandert, weil es gerade zur Hand war. Mit ihm stehen jetzt die Statuscodes 409 und 204 in einer Datei, die von HTTP nichts wissen sollte.

In richtig.js kennt die Funktion nur die Kennung. Ist die Regel verletzt, wirft sie einen Fehler, hier einen Konflikt aus fehler.js. Was daraus für HTTP wird, entscheidet der Fehler-Handler aus Abschnitt 16, und für einen Konflikt ist das die 409.

Nach Zuständigkeit oder nach Technik

Ordner lassen sich auf zwei Arten schneiden. Nach Technik heißen sie routen/, logik/ und daten/, so wie oben. Nach Zuständigkeit heißen sie buecher/, nutzer/ und ausleihen/, und in jedem liegen Route, Logik und Datenzugriff nebeneinander.

Für ein kleines Projekt reicht die erste Art. Bei drei Themen und neun Dateien findest du alles auch so, und ein neues Thema ist dann einfach eine Datei mehr in jedem Ordner statt eines ganzen neuen Ordners. Das dreht sich, sobald ein Bereich groß wird und du beim Arbeiten dauernd zwischen drei Ordnern hin und her springst. Dann wandert er in einen eigenen Ordner mit allem darin, und der Rest bleibt, wie er ist.

Die Datei utils.js

Irgendwann entsteht eine Datei namens utils.js oder helpers.js, und ein halbes Jahr später stehen dreißig Funktionen darin, die nichts miteinander zu tun haben. Das liegt am Namen. Er sagt nicht, was drinsteht, also passt alles hinein.

Die Antwort stand schon in Lektion 2.6. Eine Datei bekommt einen Namen, der eine Aufgabe beschreibt. Findet sich keiner, sind es wahrscheinlich zwei Dateien. datum.js, geld.js und slug.js sind drei statt einer und trotzdem übersichtlicher.

Konfiguration bekommt eine eigene Datei, um die es in der nächsten Lektion geht. Tests liegen neben dem, was sie prüfen, oder in einem eigenen test/. Statische Dateien liegen in public/, wo express.static sie ausliefert.

Die Logik ziehst du in der Aufgabe aus einer alten server-alt.js heraus, in der sie dreimal zwischen req und res steht.

Zum Mitnehmen

Routen nehmen entgegen und antworten, die Logik rechnet und entscheidet, der Datenzugriff spricht SQL. Aufgerufen wird nur von oben nach unten, und req und res bleiben oben.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.

Was in dieser Lektion steckt

  • Artikel mit 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.