mitmario.dev

Code aufteilen

JavaScript Im Browser 4 Min Lesezeit 3 BeispieleLektion 2 von 8

Eine Funktion in vier zu zerlegen ist der leichte Teil. Schwieriger ist die Frage, wo man schneidet. Dafür gibt es ein Schnittmuster, das fast immer passt, und es steckt schon in diesem Kurs, auch wenn es nie einen Namen bekommen hat.

Die drei Schichten

Fast jede Oberfläche besteht aus denselben drei Teilen. In Lektion 16.6 hießen sie holen, umformen, zeichnen. Hier geht es um dieselbe Teilung mit allgemeineren Namen.

  • Daten. Woher die Sachen kommen und in welcher Form sie im Programm liegen, also eine Liste im Code, eine Antwort aus dem Netz oder ein Eintrag aus dem Speicher.
  • Logik. Was daraus gerechnet wird, also Rabatte, Summen, Filter, Sortierung, Prüfregeln.
  • Darstellung. Was davon auf dem Bildschirm landet, also Elemente bauen, Texte setzen, Klassen tauschen.
Alles in einer Funktion
const angebote = [
  { titel: "Kurze Tour", preisInCent: 4900, minuten: 180 },
  { titel: "Halbtagstour", preisInCent: 6900, minuten: 240 },
  { titel: "Tagestour", preisInCent: 12900, minuten: 420 },
];

function zeigeAngebote(istMitglied) {
  const liste = document.getElementById("liste");
  liste.replaceChildren();

  for (const angebot of angebote) {
    let rabatt = 0;
    if (istMitglied) {
      rabatt = 10;
    }
    if (angebot.minuten >= 300) {
      rabatt = rabatt + 5;
    }

    const endpreisInCent = Math.round(
      angebot.preisInCent * (1 - rabatt / 100)
    );

    const zeile = document.createElement("li");
    zeile.classList.add("zeile");
    zeile.textContent =
      angebot.titel +
      ": " +
      (endpreisInCent / 100).toFixed(2).replace(".", ",") +
      " € (" +
      rabatt +
      " % Rabatt)";
    liste.append(zeile);
  }
}

zeigeAngebote(true);

Im ersten Beispiel liegen alle drei in einer Schleife übereinander. Die Funktion holt sich das Element, rechnet den Rabatt aus, formatiert einen Betrag und baut nebenbei ein li. Knapp dreißig Zeilen, die vier Dinge tun.

So sieht viel Code aus, und er funktioniert. Unangenehm wird er erst beim ersten Wunsch wie „Die Rabatte sollen auch in die Rechnungs-Mail.“ Dann brauchst du die Rechnung ohne die Seite, und die steht mitten in einer Funktion, die ein li baut.

Die Probe dafür ist eine Zeile. Tippst du im ersten Beispiel typeof rabattInProzent in die Eingabezeile der Console, kommt "undefined" zurück. Die Rabattregel steht in dieser Datei und rechnet richtig. Trotzdem gibt es sie nicht, denn sie hat keinen Namen, unter dem man sie rufen könnte.

Dieselbe Aufgabe, getrennt

Dieselbe Aufgabe in drei Schichten
// 1. Daten
const ANGEBOTE = [
  { titel: "Kurze Tour", preisInCent: 4900, minuten: 180 },
  { titel: "Halbtagstour", preisInCent: 6900, minuten: 240 },
  { titel: "Tagestour", preisInCent: 12900, minuten: 420 },
];

// 2. Logik. Kennt keine Elemente, kein document, keine Klassen.
function rabattInProzent(minuten, istMitglied) {
  let rabatt = 0;
  if (istMitglied) {
    rabatt = rabatt + 10;
  }
  if (minuten >= 300) {
    rabatt = rabatt + 5;
  }
  return rabatt;
}

function endpreisInCent(preisInCent, rabatt) {
  return Math.round(preisInCent * (1 - rabatt / 100));
}

function euroText(cent) {
  return (cent / 100).toFixed(2).replace(".", ",") + " €";
}

function zeileText(angebot, istMitglied) {
  const rabatt = rabattInProzent(angebot.minuten, istMitglied);
  const betragInCent = endpreisInCent(angebot.preisInCent, rabatt);
  return `${angebot.titel}: ${euroText(betragInCent)} (${rabatt} % Rabatt)`;
}

// 3. Darstellung. Kennt die Regeln nicht, nur die Texte.
function zeichnen(angebote, istMitglied) {
  const liste = document.getElementById("liste");
  liste.replaceChildren();

  for (const angebot of angebote) {
    const zeile = document.createElement("li");
    zeile.classList.add("zeile");
    zeile.textContent = zeileText(angebot, istMitglied);
    liste.append(zeile);
  }
}

zeichnen(ANGEBOTE, true);

Derselbe Bildschirminhalt, nur in Schichten. Oben stehen die Daten, dann vier Funktionen, die rechnen, und ganz unten eine, die zeichnet.

Aufschlussreich ist, was die einzelnen Teile nicht wissen. In rabattInProzent kommt kein document vor, keine Klasse, kein Element. In zeichnen kommt keine Zahl und keine Regel vor, nur zeileText. Du kannst also die Rabattregel ändern, ohne die Darstellung anzufassen, und umgekehrt.

Der Code ist dabei länger geworden. Das ist der Preis. Er ist niedriger, als er aussieht, denn die zusätzlichen Zeilen sind Funktionsköpfe und keine zusätzliche Arbeit.

Warum die Logik nichts vom DOM wissen darf

Die Logik prüfen, ohne eine Seite zu bauen
function rabattInProzent(minuten, istMitglied) {
  let rabatt = 0;
  if (istMitglied) {
    rabatt = rabatt + 10;
  }
  if (minuten >= 300) {
    rabatt = rabatt + 5;
  }
  return rabatt;
}

// Kein Element, kein Klick, kein Warten. Nur Eingabe und
// Ergebnis, und so nimmt dieser Kurs die meisten deiner
// Funktionen ab.
const faelle = [
  { minuten: 120, mitglied: false, erwartet: 0 },
  { minuten: 120, mitglied: true, erwartet: 10 },
  { minuten: 300, mitglied: false, erwartet: 5 },
  { minuten: 420, mitglied: true, erwartet: 15 },
  { minuten: 299, mitglied: true, erwartet: 10 },
];

for (const fall of faelle) {
  const ergebnis = rabattInProzent(fall.minuten, fall.mitglied);
  const stimmt = ergebnis === fall.erwartet;
  console.log(
    stimmt ? "ok" : "FALSCH",
    `${fall.minuten} min, Mitglied: ${fall.mitglied}`,
    "ergibt",
    ergebnis
  );
}

Eine Funktion, die nur Werte hinein und Werte heraus reicht, lässt sich mit Beispielen abklopfen. Fünf Eingaben, fünf Ergebnisse, und nach drei Sekunden weißt du, ob die Regel stimmt.

So werden in diesem Kurs die meisten Aufgaben geprüft. Die Funktion wird mit festen Argumenten aufgerufen, und verglichen wird, was zurückkommt. Das geht nur, weil die Funktion nichts von der Seite verlangt. Bei einer Funktion, die mittendrin ein li baut, müsste erst ein Dokument bereitstehen. Dann müsste man das Element suchen und den Text wieder herauslesen, nur um zu erfahren, ob 15 Prozent richtig gerechnet wurden.

Der letzte Fall im Beispiel ist der aufschlussreichste, 299 Minuten. Grenzfälle sind die Stellen, an denen sich > und >= unterscheiden, und für sie schreibt man solche Listen überhaupt.

Im zweiten oder dritten Beispiel ergibt rabattInProzent(299, false) in der Eingabezeile der Console 0, und rabattInProzent(300, false) ergibt 5. Eine Minute Unterschied, und die Regel kippt. rabattInProzent(300, true) ergibt 15, weil sich beide Gründe addieren.

Im ersten Beispiel lässt sich dieselbe Frage gar nicht stellen, und darin liegt der Unterschied zwischen den zwei Fassungen. Auf der einen Seite stehen drei getippte Zeilen. Auf der anderen steht eine Seite, die erst aufgebaut und auf den richtigen Stand geklickt werden muss, und danach liest man den Text aus ihrem li in der Hoffnung, die richtige Zeile erwischt zu haben.

Mit Modulen und ohne

Mit Modulen ist der Schnitt sichtbar. Es gibt daten.js, rabatte.js und ansicht.js, und jede Datei gibt nach außen, was die anderen brauchen. Was ein Modul ist, stand in Lektion 18.4.

Ohne Module ändert sich nichts am Prinzip, nur an der Sichtbarkeit. Die Schichten stehen dann in derselben Datei untereinander, oben die Daten, in der Mitte die Logik, unten die Darstellung. Das ist die Reihenfolge aus der letzten Lektion, dieselbe Idee eine Etage tiefer.

Ich fange immer so an. Eine Datei mit klaren Blöcken lässt sich in fünf Minuten in Module zerlegen, sobald es nötig wird. Ein Durcheinander in drei Dateien ist dagegen ein Durcheinander in drei Dateien.

Woran man eine zu große Datei erkennt

Musst du beim Suchen scrollen, ist die Datei zu groß. Dasselbe gilt, wenn du eine Funktion zweimal öffnest, weil beim zweiten Mal nicht mehr klar ist, wo sie steht. Es gibt Faustzahlen dafür, und keine davon hilft. Zweihundert übersichtliche Zeilen sind besser als achtzig verschachtelte.

Zu früh geteilt

Wer die Sache einmal verstanden hat, teilt leicht zu früh. Zwanzig Dateien mit je zwölf Zeilen sind nicht übersichtlicher als eine mit zweihundert, nur anders unübersichtlich. Im Zusammenhang sieht man nichts mehr, und beim Lesen springt man zwischen den Dateien hin und her.

Wo die Grenze liegt, ist Erfahrung und keine Zahl. Ich teile erst, wenn es weh tut. Und wer zum dritten Mal an derselben Stelle sucht, weiß dann auch, wo der Schnitt hingehört.

In der Aufgabe werden Rechnung und Text aus einer Funktion herausgenommen, die bisher alles selbst macht.

Zum Mitnehmen

Daten, Logik und Darstellung gehören in getrennte Teile. Eine Rechnung, die nichts vom DOM weiß, lässt sich mit festen Werten prüfen, ohne dass es eine Seite gibt.

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.