mitmario.dev

Platzhalter im Pfad

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

Wer mit node:http die Nummer aus /buecher/12 holen will, schreibt ein split, ein filter gegen die leeren Stücke, eine Längenprüfung und den Griff nach dem richtigen Element. Rund zehn Zeilen, nur um eine Zahl aus der Adresse zu bekommen.

Ein Doppelpunkt

Ein Platzhalter statt zehn Zeilen
import express from "express";

const app = express();

// In 8.5 waren dafuer split, filter und eine Laengenpruefung noetig.
app.get("/buecher/:id", (req, res) => {
  res.send(`Buch ${req.params.id}`);
});

app.listen(3000);

Ein Pfadstück, das mit einem Doppelpunkt anfängt, ist ein Platzhalter (englisch route parameter). Was der Aufrufer an dieser Stelle geschickt hat, steht danach in req.params unter diesem Namen.

Diese eine Zeile ersetzt die zehn. Sie ist so kurz, dass leicht untergeht, was sie noch alles mitbringt. Die Längenprüfung ist eingebaut, und die Kodierung ist aufgelöst (aus %20 wird ein Leerzeichen). Außerdem greift die Route nur, wenn wirklich genau ein Stück dort steht.

Im Reiter Browser steht /buecher/7. Gibst du eine andere Zahl in die Adresszeile ein, geht die Antwort mit. /buecher ohne Zahl ergibt die Fehlerseite von Express, denn die Route verlangt das Stück und macht es nicht optional.

Mehrere Platzhalter, und alle sind Text

Mehrere Platzhalter, und kein Schrägstrich darin
import express from "express";

const app = express();

app.get("/buecher/:id/seiten/:nr", (req, res) => {
  const { id, nr } = req.params;
  res.json({ id, nr, typ: typeof id });
});

app.get("/dateien/:name", (req, res) => res.send(`Datei ${req.params.name}`));

app.listen(3000);

Der Typ ist string, auch bei 42. Kommandozeilenargumente, Umgebungsvariablen und Query-Parameter kommen genauso als Text an. Wenn du mit der Kennung (englisch ID) eines Buchs rechnen willst, musst du sie erst umwandeln. Geprüft ist sie damit noch lange nicht. /buecher/abc passt auf /buecher/:id genauso gut wie /buecher/42, denn ein Platzhalter fragt nicht nach der Form.

Ein Platzhalter frisst außerdem keinen Schrägstrich. /dateien/:name passt auf /dateien/logo.png, aber nicht auf /dateien/bilder/logo.png. Das ist meistens richtig so, denn sonst würde eine einzelne Route ungewollt halbe Adressbereiche verschlucken. Für einen ganzen Rest-Pfad gibt es einen benannten Stern, /dateien/*rest. Seit Express 5 steht der Rest dann als Liste der Stücke in req.params, für /dateien/bilder/logo.png also ["bilder", "logo.png"].

Alle drei Fälle kannst du in der Adresszeile nachstellen. Geladen ist zuerst /buecher/42/seiten/7, mit "typ":"string". /dateien/logo.png antwortet mit dem Dateinamen, und /dateien/bilder/logo.png ergibt die Fehlerseite von Express.

Feste Pfade vor Platzhaltern

Auch hier gewinnt die erste passende Route von oben. Zusammen mit Platzhaltern wird daraus eine Falle.

neu muss vor dem Platzhalter stehen
import express from "express";

const app = express();

// Falsch herum: der Platzhalter steht oben und nimmt auch "neu" an.
app.get("/falsch/buecher/:id", (req, res) => res.send(`Buch ${req.params.id}`));
app.get("/falsch/buecher/neu", (req, res) => res.send("Formular"));

// Richtig herum: der feste Pfad zuerst.
app.get("/richtig/buecher/neu", (req, res) => res.send("Formular"));
app.get("/richtig/buecher/:id", (req, res) => res.send(`Buch ${req.params.id}`));

app.listen(3000);

Beide Reihenfolgen stehen in derselben Datei, einmal unter /falsch und einmal unter /richtig. Die Seite startet auf /falsch/buecher/neu, und dort kommt „Buch neu“. Unter /richtig/buecher/neu kommt das Formular. Es sind dieselben zwei Zeilen, nur vertauscht.

/buecher/neu soll ein Formular zeigen, /buecher/:id ein Buch. Aber neu ist ein gültiges Pfadstück und passt deshalb auf :id. Steht die Platzhalter-Route oben, gewinnt sie. Der Server sucht dann brav nach einem Buch mit der Kennung neu.

Das Tückische daran ist, dass nichts kaputtgeht. Es gibt keinen Fehler und keine Warnung. Die Anwendung liefert einfach die falsche Antwort, und zwar eine, die für sich genommen ganz plausibel aussieht und bei einem schnellen Blick in den Browser niemandem auffällt.

Je spezifischer eine Route, desto weiter oben gehört sie. Feste Pfade stehen vor Platzhaltern, und der Standardfall steht ganz unten. Sortieren könnte Express das auch selbst. Fastify etwa nimmt feste Pfade immer vor Platzhaltern, egal in welcher Reihenfolge sie angelegt wurden. Ich nehme trotzdem lieber eine Liste, die von oben nach unten gilt, als eine Sortierregel, die ich nicht sehe.

Neben einer fertigen Route für einzelne Bücher fehlen in der Aufgabe noch zwei.

Zum Mitnehmen

Ein Platzhalter wie :id nimmt genau ein Pfadstück auf und legt es als Text in req.params. Weil er auf jedes Stück passt, gehören feste Pfade wie /buecher/neu über ihn.

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.