mitmario.dev

Ändern und löschen

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

Ein Buch bekommt eine zweite Auflage, ein anderes fliegt aus dem Bestand. Für beides gibt es eigene Methoden, beim Ändern sogar zwei, PUT und PATCH. Nimmst du die falsche, gehen Daten verloren.

PUT ersetzt, PATCH ändert

PUT ersetzt, PATCH ändert
import express from "express";

const app = express();
app.use(express.json());

app.get("/", (req, res) =>
  res.type("text/plain").send(
    `curl -s -X PATCH -H "Content-Type: application/json" -d '{"titel":"Nur der Titel"}' http://localhost:3000/buch\n` +
      `curl -s -X PUT   -H "Content-Type: application/json" -d '{"titel":"Nur der Titel"}' http://localhost:3000/buch\n`
  )
);

let buch = { id: 1, titel: "Node in der Praxis", jahr: 2020, verlag: "Selbstverlag" };

// PUT ersetzt den Eintrag durch das, was ankommt. Die Kennung bleibt.
app.put("/buch", (req, res) => {
  buch = { id: buch.id, titel: req.body.titel, jahr: req.body.jahr, verlag: req.body.verlag };
  res.json(buch);
});

// PATCH aendert nur die Felder, die mitgeschickt wurden. Die Kennung
// gehoert nicht dazu, deshalb die Liste.
app.patch("/buch", (req, res) => {
  for (const feld of ["titel", "jahr", "verlag"]) {
    if (req.body[feld] !== undefined) {
      buch[feld] = req.body[feld];
    }
  }

  res.json(buch);
});

app.listen(3000);

Auf der Seite im Reiter Browser stehen beide Befehle. Erst ändert PATCH den Titel und lässt den Rest stehen. Danach ersetzt PUT den ganzen Eintrag, und vom Buch bleibt nur der Titel.

Nach dem PUT ist das Feld verlag weg, obwohl niemand es gelöscht hat. So ist PUT gemeint. Es heißt „der Eintrag unter dieser Adresse sieht ab jetzt so aus“, und was nicht mitgeschickt wurde, gehört nicht mehr dazu. PATCH heißt dagegen „ändere daran diese Felder“ und lässt den Rest in Ruhe.

Aus dieser Verwechslung kommt eine typische Panne. Eine Seite zeigt drei von sieben Feldern, schickt die drei mit fetch per PUT und löscht damit ganz nebenbei die anderen vier, die sie gar nicht angezeigt hat. Im Browser sieht alles richtig aus, denn die angezeigten Felder stimmen ja.

Einmal oder zweimal geschickt

Einmal oder zweimal geschickt
import express from "express";

const app = express();
app.use(express.json());

const buecher = [{ id: 1, titel: "Node in der Praxis", jahr: 2020 }];
let naechsteId = 2;

app.get("/buecher", (req, res) => res.json({ anzahl: buecher.length }));

// Wiederholbar: das Ergebnis haengt nur davon ab, was ankommt.
app.put("/buecher/1", (req, res) => {
  buecher[0] = { id: 1, titel: req.body.titel, jahr: req.body.jahr };
  res.json(buecher[0]);
});

// Nicht idempotent: das Ergebnis haengt davon ab, wie oft es ankommt.
app.post("/buecher", (req, res) => {
  const buch = { id: naechsteId++, titel: req.body.titel, jahr: req.body.jahr };
  buecher.push(buch);
  res.status(201).location(`/buecher/${buch.id}`).json(buch);
});

app.listen(3000);

Auf der Seite steht die Anzahl, und nach jedem Befehl holst du sie mit einem Neuladen frisch. Zweimal PUT mit demselben Rumpf lässt denselben Zustand zurück wie einmal. Zweimal POST legt zwei Bücher an.

Eine Methode heißt idempotent, wenn sie zweimal ausgeführt denselben Zustand hinterlässt wie einmal. GET, PUT und DELETE sind es, POST ist es nicht. PATCH zählt sein eigener Standard (RFC 5789) auch nicht dazu. Eine Änderung wie „ein Exemplar mehr“ ergibt beim zweiten Mal nämlich etwas anderes. Ein PATCH wie im ersten Beispiel, das Felder auf feste Werte setzt, lässt sich trotzdem gefahrlos wiederholen.

Reißt eine Verbindung ab, weiß der Aufrufer nicht, ob seine Anfrage angekommen ist. Bei einer idempotenten Methode schickt er sie einfach noch einmal, und schlimmstenfalls war der zweite Versuch umsonst, weil der erste doch schon angekommen war. Bei POST muss er raten, und daraus entstehen doppelte Bestellungen.

Die richtigen Codes

Für die drei Fälle gibt es feste Gewohnheiten, auch wenn kein Standard sie vorschreibt.

  • 200 mit dem geänderten Eintrag nach PUT und PATCH. Der Aufrufer sieht sofort, was dabei herausgekommen ist, und nach einem PATCH stehen darin auch die Felder, die er nicht geschickt hat.
  • 204 nach DELETE. Der Code heißt „hat geklappt, es kommt kein Rumpf“, und nach dem Löschen gibt es nichts mehr zu zeigen. Ein res.status(204).json(...) wäre ein Widerspruch in sich.
  • 404, wenn es die Kennung nicht gibt, bei allen drei Methoden. Ändern kann man nur, was da ist. Ein PUT dürfte nach dem Standard auch anlegen, die Routen in diesem Kurs antworten trotzdem mit 404.

Das zweite DELETE

Das zweite DELETE
import express from "express";

const app = express();

const notizen = [{ id: 1, text: "Steuer abgeben" }];

app.get("/", (req, res) =>
  res.type("text/plain").send("curl -si -X DELETE http://localhost:3000/notizen/1\n")
);

app.delete("/notizen/:id", (req, res) => {
  const platz = notizen.findIndex((notiz) => notiz.id === Number(req.params.id));

  if (platz === -1) {
    return res.status(404).json({ fehler: "nicht gefunden" });
  }

  notizen.splice(platz, 1);

  // 204 heisst: hat geklappt, und ich habe dir nichts zu sagen. Ein
  // Rumpf waere hier nicht erlaubt, res.end() beendet ohne Rumpf.
  res.status(204).end();
});

app.listen(3000);

Der Befehl steht auf der Seite im Reiter Browser. Beim ersten Mal kommt ein 204, beim zweiten ein 404.

Beim zweiten DELETE auf denselben Eintrag gehen die Meinungen auseinander, im Netz findest du beide Antworten. 404, weil es ihn nicht mehr gibt, oder 204, weil der gewünschte Zustand ja eingetreten ist.

Ich antworte in diesem Kurs mit 404, weil DELETE /notizen/1 und GET /notizen/1 nach demselben Ding fragen. Es wäre seltsam, wenn auf die eine Anfrage „gibt es nicht“ kommt und auf die andere „alles in Ordnung“. So erfährt es auch ein Aufrufer, der sich bei der Kennung vertippt hat.

Idempotent bleibt DELETE trotzdem, denn es geht um denselben Zustand danach und nicht um dieselbe Antwort. Nach dem zweiten Aufruf ist der Eintrag genauso weg wie nach dem ersten.

Zum Bücherserver der Aufgabe kommen PUT, PATCH und DELETE auf /buecher/:id dazu.

Zum Mitnehmen

Ein PUT schreibt den ganzen Eintrag neu, und was es nicht mitschickt, fehlt danach. Ein PATCH ändert nur die genannten Felder. PUT und DELETE lassen sich nach einem Abbruch gefahrlos wiederholen, ein zweites POST legt einen zweiten Eintrag an.

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.