mitmario.dev

Daten lesen

Node.js Sandbox 3 Min Lesezeit 3 BeispieleLektion 2 von 8

Eine Bücherliste ohne Bücher und ein Buch mit einer Kennung, die es nicht gibt, sehen auf den ersten Blick gleich aus. In beiden Fällen ist nichts da. Für ein Programm, das die API abfragt, ist das trotzdem ein großer Unterschied, denn die leere Liste ist ein Ergebnis und das fehlende Buch keins. Antwortet die API auf beides gleich, muss der Aufrufer raten. Deshalb bekommen die beiden Fälle bei der Sammlung /buecher und beim Einzelstück /buecher/2 verschiedene Statuscodes.

Leer ist nicht dasselbe wie nicht vorhanden

Leer ist nicht dasselbe wie nicht vorhanden
import express from "express";

const app = express();

const buecher = [];
const regale = [{ id: 1, name: "Wohnzimmer" }];

// Die Sammlung gibt es, sie ist nur leer. Das ist ein gueltiges Ergebnis.
app.get("/buecher", (req, res) => {
  res.json({ anzahl: buecher.length, daten: buecher });
});

// Das Einzelstueck gibt es nicht. Das ist kein gueltiges Ergebnis.
app.get("/regale/:id", (req, res) => {
  const regal = regale.find((eintrag) => eintrag.id === Number(req.params.id));

  if (regal === undefined) {
    return res.status(404).json({ fehler: "nicht gefunden" });
  }

  res.json(regal);
});

app.listen(3000);

Im Reiter Browser steht die Liste. /buecher ist leer und antwortet trotzdem mit 200, /regale/99 gibt es gar nicht und antwortet mit 404.

Eine leere Sammlung ist 200 mit einer leeren Liste. Die Sammlung gibt es ja, sie hat im Moment nur nichts drin. Es sind eben noch keine Bücher erfasst. Das ist eine ganz normale Antwort.

Beim Einzelstück ist es umgekehrt. Unter /regale/99 liegt gar kein Regal, auch kein leeres, und deshalb ist hier 404 richtig.

Bekommst du für eine leere Liste einen 404, musst du diesen Fall wie einen Fehler behandeln, obwohl nichts kaputt ist. Nach ein paar solchen Stellen behandelt man 404 grundsätzlich als „egal, weitermachen“. Und dann geht der echte Fehler unter.

Nacktes Array oder ein Objekt drumherum

Eine Liste kann als nacktes Array zurückkommen oder in einem Objekt mit weiteren Angaben daneben. Was eine API hier wählt, bauen alle ihre Aufrufer ein. Danach bleibt es so.

Nacktes Array oder ein Objekt drumherum
import express from "express";

const app = express();

const buecher = [
  { id: 1, titel: "Node in der Praxis" },
  { id: 2, titel: "JavaScript von vorn" },
];

// Der eine Weg: die Liste ohne alles drumherum.
app.get("/nackt", (req, res) => res.json(buecher));

// Der andere: ein Objekt, in dem noch Platz ist.
app.get("/umhuellt", (req, res) => {
  res.json({ anzahl: buecher.length, daten: buecher });
});

// Ein halbes Jahr spaeter wird die Liste in Seiten aufgeteilt. Nur einer
// der beiden Wege vertraegt das, ohne jeden Aufrufer zu brechen.
app.get("/umhuellt-spaeter", (req, res) => {
  res.json({ anzahl: buecher.length, seite: 1, seiten: 1, daten: buecher });
});

app.listen(3000);

Die drei Formen liegen unter /nackt, /umhuellt und /umhuellt-spaeter.

Die erste Route gibt die Liste heraus, wie sie ist. Kurz, direkt, gut zu lesen. Die zweite packt sie in ein Objekt und schreibt die Anzahl daneben.

Die dritte Route teilt die Liste in Seiten auf und schreibt die Nummer der Seite dazu. So etwas kommt irgendwann, genauso wie ein Hinweis, dass gefiltert wurde. In das Objekt passt das hinein, und wer nur daten ausliest, merkt nichts davon. Beim nackten Array gibt es dafür keinen Platz. Die Antwort müsste umgebaut werden, und alle, die sie schon auswerten, müssten mit umbauen. Ich nehme in diesem Kurs die zweite Form.

Richtig sind beide, nur eben eine je API. Liefern manche Routen ein Array und andere ein Objekt, kostet das jeden Aufrufer bei jeder Route eine Nachfrage.

Filtern über die Adresse

In Lektion 8.6 wurden Query-Parameter noch mit URL von Hand zerlegt. Express legt sie dir fertig als req.query hin.

Filtern über die Adresse
import express from "express";

const app = express();

const buecher = [
  { id: 1, titel: "Node in der Praxis", jahr: 2020 },
  { id: 2, titel: "JavaScript von vorn", jahr: 2019 },
  { id: 3, titel: "Nachtschicht mit Node", jahr: 2023 },
];

app.get("/buecher", (req, res) => {
  let gefunden = buecher;

  // req.query.q ist Text, wie jeder Wert aus der Adresse. Fuer eine
  // Suche passt das, verglichen wird Text mit Text.
  if (req.query.q !== undefined) {
    const suche = req.query.q.toLowerCase();
    gefunden = gefunden.filter((buch) => buch.titel.toLowerCase().includes(suche));
  }

  res.json({ anzahl: gefunden.length, daten: gefunden.map((buch) => buch.titel) });
});

app.listen(3000);

?q=node findet beide Bücher mit „Node“ im Titel. Mit ?q=python in der Adresszeile kommt keines, ohne den Parameter kommen alle drei.

Der Wert ist Text, auch wenn eine Zahl darin steht. Für die Suche passt das, dort wird Text mit Text verglichen. Bei ?jahr=2019 kommt dagegen "2019" an und nicht 2019, und mit === ist das nie gleich der Zahl im Bestand. Dafür gibt es Number().

Der Filter ist freiwillig. Ohne ?q= kommt die ganze Liste, und deshalb prüft die Route den Parameter mit !== undefined, bevor sie ihn benutzt. Eine Route, die ohne Parameter gar nichts liefert, hat den Filter zur Pflicht gemacht, ohne es zu sagen.

anzahl zählt das Ergebnis und nicht den Bestand. Wer filtert und trotzdem die Gesamtzahl meldet, liefert eine Zahl, die zur mitgelieferten Liste nicht passt. Das fällt niemandem sofort auf und kostet später eine Stunde Suche.

Ein Filter, der nichts findet

?q=python findet nichts und antwortet trotzdem mit 200. Es ist dieselbe Sammlung wie vorher, nur ist nach dem Filtern nichts übrig. Ein 404 wäre hier genauso falsch wie bei der leeren Liste.

Vier Bücher liegen in der Aufgabe im Speicher, ohne dass eine Route sie herausgibt.

Zum Mitnehmen

Ob etwas leer ist oder fehlt, sagt der Statuscode. Die Sammlung antwortet mit 200 und leerer Liste, ein Einzelstück, das es nicht gibt, mit 404. Die Liste steht in einem Objekt mit anzahl und daten, und anzahl zählt, was nach dem Filtern übrig ist.

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.