mitmario.dev

Synthese: gemerkte Einstellungen

JavaScript Im Browser 4 Min Lesezeit 3 BeispieleLektion 4 von 5

Die Lautstärke von gestern soll auch heute noch stimmen. Auch wenn die Anwendung inzwischen eine Einstellung mehr kennt, auch wenn jemand den Speicher kaputt gemacht hat, und ohne dass bei jedem Tastendruck geschrieben wird. Dafür gibt es ein Muster, in dem alles aus diesem Abschnitt zusammenkommt.

Ein Objekt, zwei Funktionen

Ein Objekt, zwei Funktionen
const SCHLUESSEL = "musik:wiedergabe";
const STANDARD = { lautstaerke: 5, wiederholen: false };

function laden() {
  const roh = localStorage.getItem(SCHLUESSEL);
  if (roh === null) {
    return { ...STANDARD };
  }
  try {
    return { ...STANDARD, ...JSON.parse(roh) };
  } catch (fehler) {
    return { ...STANDARD };
  }
}

function speichern() {
  localStorage.setItem(SCHLUESSEL, JSON.stringify(zustand));
}

// Der Zustand ist ein einziges Objekt. Der Rest des Codes
// arbeitet nur damit und sieht den Speicher nie.
let zustand = laden();

const anzeige = document.getElementById("anzeige");

function anzeigen() {
  anzeige.textContent = `Lautstärke: ${zustand.lautstaerke}`;
  console.log("Zustand:", JSON.stringify(zustand));
}

document.getElementById("lauter").addEventListener("click", () => {
  zustand.lautstaerke = Math.min(10, zustand.lautstaerke + 1);
  anzeigen();
  speichern();
});

document.getElementById("leiser").addEventListener("click", () => {
  zustand.lautstaerke = Math.max(0, zustand.lautstaerke - 1);
  anzeigen();
  speichern();
});

anzeigen();

Der Aufbau ist immer derselbe.

  • Ein einziges Objekt hält den gesamten Zustand.
  • Eine Funktion liest ihn beim Start aus dem Speicher.
  • Eine Funktion schreibt ihn weg.
  • Der ganze Rest des Codes arbeitet nur mit dem Objekt und fasst den Speicher nie an.

Der letzte Punkt ist der wichtige. Steht ein localStorage.setItem mitten in einem Klick-Handler, ist die Umwandlung an dieser einen Stelle geregelt, und an der nächsten Stelle wird sie wieder geregelt, nur ein bisschen anders. Mit zwei Funktionen gibt es genau einen Ort, an dem entschieden wird, wie gespeichert wird, und einen, an dem der Ärger abgefangen wird.

Nach zwei Klicks auf „Lauter“ im ersten Beispiel antwortet localStorage.getItem("musik:wiedergabe") in der Eingabezeile der Console mit "{\"lautstaerke\":7,\"wiederholen\":false}". Das ist ein Text, in dem jedes innere Anführungszeichen einen Backslash davor bekommt. Machst du den Eintrag danach mit localStorage.setItem("musik:wiedergabe", "{kaputt") absichtlich kaputt, kommt die Seite nach „Seite neu laden“ bei Lautstärke: 5 wieder hoch, ohne Fehler und ohne leere Anzeige. Das catch in laden hat den Unsinn geschluckt und den Standardzustand zurückgegeben. Ein laden, das direkt JSON.parse zurückgibt, hätte an dieser Stelle die ganze Anwendung angehalten, und zwar bevor der erste Button verdrahtet ist.

Der Standardzustand liegt darunter

Der Standardzustand liegt darunter
const STANDARD = { thema: "hell", groesse: 16, kompakt: false };

// So sah der gespeicherte Zustand vor drei Versionen aus.
// Die Eigenschaft kompakt gab es damals noch nicht.
localStorage.setItem("einstellungen:alt", JSON.stringify({ thema: "dunkel", groesse: 20 }));

const gelesen = JSON.parse(localStorage.getItem("einstellungen:alt"));

console.log("Nur gelesen:", JSON.stringify(gelesen));
console.log("kompakt fehlt:", gelesen.kompakt);

// Der Standardzustand darunter, das Gelesene darüber.
const zustand = { ...STANDARD, ...gelesen };

console.log("Mit Standard:", JSON.stringify(zustand));
console.log("kompakt ist jetzt da:", zustand.kompakt);

// Andersherum gewinnt der Standard.
console.log("Verkehrt herum:", JSON.stringify({ ...gelesen, ...STANDARD }));

Beim Lesen reicht es nicht, einfach das Gespeicherte zu nehmen, denn der gespeicherte Stand ist womöglich alt.

Angenommen, die Anwendung hat vor drei Versionen eine Einstellung dazubekommen. Wer damals gespeichert hat, hat sie nicht mit abgelegt, und beim Lesen fehlt sie. Ab da rechnet der Code mit undefined, und zwar ausgerechnet bei den Leuten, die schon lange dabei sind.

Der Ausweg ist eine Zeile mit den drei Punkten aus Lektion 7.6. Erst kommt der vollständige Standardzustand, dann das Gelesene darüber. Was gelesen wurde, gewinnt, und was fehlt, kommt aus dem Standard.

Die Reihenfolge entscheidet. Andersherum gewinnt der Standard, und die gespeicherten Einstellungen verschwinden bei jedem Start. Im zweiten Beispiel stehen beide Fassungen untereinander.

Nicht bei jedem Tastendruck

Nicht bei jedem Tastendruck
const zaehler = document.getElementById("zaehler");
let sofortZahl = 0;
let spaeterZahl = 0;
let timer = null;

function zeigen() {
  zaehler.textContent = `Schreibvorgänge: sofort ${sofortZahl}, verzögert ${spaeterZahl}`;
}

document.getElementById("sofort").addEventListener("input", (ereignis) => {
  localStorage.setItem("entwurf:sofort", ereignis.target.value);
  sofortZahl = sofortZahl + 1;
  zeigen();
});

document.getElementById("spaeter").addEventListener("input", (ereignis) => {
  // Jeder neue Tastendruck wirft den vorigen Termin weg.
  clearTimeout(timer);
  timer = setTimeout(() => {
    localStorage.setItem("entwurf:spaeter", ereignis.target.value);
    spaeterZahl = spaeterZahl + 1;
    zeigen();
  }, 400);
});

zeigen();

Bei einem Button ist es egal, denn ein Klick heißt ein Speichervorgang. Bei einem Textfeld nicht. Ein input-Ereignis feuert bei jedem Zeichen, und wenn du dort direkt speicherst, schreibst du bei einem Satz sechzig Mal in den Speicher.

Abhilfe schafft verzögertes Speichern, das Entprellen (debounce). setTimeout kam in Lektion 15.1, und clearTimeout stand dort in einem Satz. Es sagt einen Termin ab, der noch nicht dran war.

Beim Aufruf wird ein Termin auf ein paar hundert Millisekunden gesetzt. Kommt vorher ein weiterer Aufruf, wird der alte Termin mit clearTimeout weggeworfen und ein neuer gesetzt. Gespeichert wird also erst, wenn eine Weile nichts mehr passiert ist.

Im dritten Beispiel stehen beide Zähler nebeneinander. Wenn du in jedes Feld zügig ein Wort tippst, steht hinter „sofort“ die Zahl der Buchstaben und hinter „verzögert“ eine Eins.

An den Zählern siehst du nicht, warum dort nur eine Eins steht, im Reiter „Debug“ aber schon. Dafür tippst du während einer Aufzeichnung im Reiter „Browser“ in beide Felder dasselbe Wort mit fünf Buchstaben. Im Protokoll stehen dann für das obere Feld fünfmal dieselben vier Zeilen, setItem, sofortZahl + 1, zeigen() und darin die Zeile, die den Zähler schreibt. Für das untere Feld stehen dort fünfmal nur die zwei Zeilen clearTimeout(timer) und timer = setTimeout(...). Die Nummer, die als Änderung daneben steht, ist jedes Mal eine andere, denn jeder Tastendruck wirft den alten Termin weg und bucht einen neuen. Erst danach kommt ein einziges Mal die Zeile mit dem setItem. Auf der Seite selbst siehst du davon nichts.

Der Preis ist ein kleines Zeitfenster, in dem der letzte Stand noch nicht im Speicher liegt. Für Einstellungen ist das egal. Was auf keinen Fall verloren gehen darf, wird zusätzlich gespeichert, wenn jemand das Feld verlässt.

Was beim Zurücksetzen passieren muss

Bleibt das Zurücksetzen, und das ist schnell nur halb gebaut. Zurücksetzen heißt drei Dinge.

  • Der Eintrag im Speicher wird gelöscht.
  • Das Zustandsobjekt bekommt wieder die Standardwerte.
  • Die Anzeige wird neu gezeichnet.

Wer nur den Speicher leert, hat im Arbeitsspeicher einen Zustand, der nicht mehr zu dem passt, was gespeichert ist. Beim nächsten Klick wird er zurückgeschrieben, und das Zurücksetzen war umsonst. Wer nur das Objekt zurücksetzt, findet die alten Werte beim nächsten Laden wieder vor.

In der Aufgabe baust du die drei Funktionen einer Einstellungsleiste, die den Neustart übersteht.

Zum Mitnehmen

Ein Objekt hält den Zustand, laden legt das Gelesene über den Standardzustand, und speichern schreibt verzögert. Zurücksetzen räumt Speicher, Objekt und Anzeige zugleich auf.

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.

Was in dieser Lektion steckt

  • Artikel mit 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe im Editor, direkt im Browser geprüft

    Öffnet sich mit dem Basis Konto.