Abschnitt 6 · Lektion 5
Funktionen aufteilen
Irgendwann ändert jemand etwas an einer langen Funktion. Steht derselbe Rechenweg darin zweimal, wird oft nur eine der beiden Stellen geändert. Das Ergebnis ist dann falsch, ohne dass eine Meldung kommt. Besser zerlegst du die Funktion in kleinere, bevor so etwas passiert.
Drei Arbeiten in einem Block
<?php
declare(strict_types=1);
$zettel = [
["tag" => "Montag", "stunden" => 6, "satz" => 4500],
["tag" => "Dienstag", "stunden" => 3, "satz" => 4500],
["tag" => "Samstag", "stunden" => 4, "satz" => 6000],
];
function baueAbrechnung(array $zettel, string $name): string
{
$zeilen = [];
foreach ($zettel as $eintrag) {
$wert = $eintrag["stunden"] * $eintrag["satz"];
$zeilen[] = $eintrag["tag"] . ": " . $eintrag["stunden"] . " Stunden zu "
. number_format($eintrag["satz"] / 100, 2, ",", ".") . " = "
. number_format($wert / 100, 2, ",", ".");
}
$summe = 0;
foreach ($zettel as $eintrag) {
$summe += $eintrag["stunden"] * 4500;
}
$zeilen[] = "Stundenzettel " . $name . ": " . count($zettel) . " Tage, "
. number_format($summe / 100, 2, ",", ".") . " Euro";
return implode("\n", $zeilen);
}
echo baueAbrechnung($zettel, "Tom"), "\n"; baueAbrechnung() rechnet je Tag den Wert aus, baut daraus Text und addiert eine Summe. Das sind
drei verschiedene Dinge in einem Block, und beim Lesen musst du alle drei gleichzeitig im Kopf
haben.
Die drei Tageszeilen stimmen und ergeben zusammen 645,00 Euro. In der letzten Zeile steht trotzdem
585,00 Euro. Der Rechenweg steht zweimal in der Funktion, und nur an der ersten Stelle kommt der
Satz aus dem Zettel. Die Summenschleife rechnet weiter mit festen 4500 Cent, und für die vier
Stunden am Samstag zu 60 Euro fehlen dann 60 Euro. Eine Meldung gibt es dazu nicht.
Zwei Anzeichen für eine zu große Funktion sind zuverlässig:
- Der Name braucht ein „und“. Ehrlich hieße die Funktion
rechneUndFormatiereUndSummiere(). Findest du einen Namen nur mit einem „und“, hast du in Wahrheit mehrere Funktionen. - Du musst beim Lesen zurückblättern. In der Zeile mit
$summewillst du wissen, wie der Wert weiter oben berechnet wurde, und scrollst nach oben. Bei einer Funktion, die auf einen Bildschirm passt, kommt das nicht vor.
Vier kurze statt einer langen
<?php
declare(strict_types=1);
$zettel = [
["tag" => "Montag", "stunden" => 6, "satz" => 4500],
["tag" => "Dienstag", "stunden" => 3, "satz" => 4500],
["tag" => "Samstag", "stunden" => 4, "satz" => 6000],
];
function tagesWert(array $eintrag): int
{
return $eintrag["stunden"] * $eintrag["satz"];
}
function zeileFuerTag(array $eintrag): string
{
return $eintrag["tag"] . ": " . $eintrag["stunden"] . " Stunden zu "
. number_format($eintrag["satz"] / 100, 2, ",", ".") . " = "
. number_format(tagesWert($eintrag) / 100, 2, ",", ".");
}
function wochenSumme(array $zettel): int
{
$summe = 0;
foreach ($zettel as $eintrag) {
$summe += tagesWert($eintrag);
}
return $summe;
}
function baueAbrechnung(array $zettel, string $name): string
{
$zeilen = [];
foreach ($zettel as $eintrag) {
$zeilen[] = zeileFuerTag($eintrag);
}
$zeilen[] = "Stundenzettel " . $name . ": " . count($zettel) . " Tage, "
. number_format(wochenSumme($zettel) / 100, 2, ",", ".") . " Euro";
return implode("\n", $zeilen);
}
echo baueAbrechnung($zettel, "Tom"), "\n"; Die Tageszeilen sind dieselben, und die Summe stimmt jetzt, 645,00 Euro. Jede der drei neuen
Funktionen hat einen Zweck, und der steht in ihrem Namen. tagesWert() rechnet, zeileFuerTag()
formatiert, wochenSumme() addiert. baueAbrechnung() gibt es weiterhin, aber sie setzt nur noch
die Teile zusammen.
Der Rechenweg stunden * satz steht nur noch an einer Stelle, und beide anderen Funktionen
holen ihn sich von dort. Zwei Stellen können auseinanderlaufen. Eine nicht.
In Abschnitt 17 besteht ein Test darin, eine Funktion mit bekannten Werten aufzurufen und ihr
Ergebnis zu vergleichen. tagesWert() lässt sich so prüfen. Bei der langen Fassung ginge das nur
mit der ganzen Abrechnung als Text. Stimmt daran etwas nicht, weißt du nicht, welcher der drei Teile
schuld ist.
Zuerst das, was dagegen spricht
<?php
declare(strict_types=1);
// Verschachtelt:
function pruefeTief(string $name, int $alter): string
{
if ($name !== "") {
if ($alter > 0) {
if ($alter < 130) {
return "in Ordnung";
} else {
return "Alter zu hoch";
}
} else {
return "Alter fehlt";
}
} else {
return "Name fehlt";
}
}
// Mit fruehen Rueckgaben:
function pruefeFlach(string $name, int $alter): string
{
if ($name === "") {
return "Name fehlt";
}
if ($alter <= 0) {
return "Alter fehlt";
}
if ($alter >= 130) {
return "Alter zu hoch";
}
return "in Ordnung";
}
echo pruefeTief("Mia", 34), " / ", pruefeFlach("Mia", 34), "\n";
echo pruefeTief("", 34), " / ", pruefeFlach("", 34), "\n";
echo pruefeTief("Ben", 0), " / ", pruefeFlach("Ben", 0), "\n";
echo pruefeTief("Tom", 200), " / ", pruefeFlach("Tom", 200), "\n"; Beide Funktionen liefern dieselben vier Antworten. Die erste schachtelt vier Ebenen tief, die zweite ist flach.
Der Trick heißt frühe Rückgabe (englisch early return). Am Anfang steht alles, was gegen ein
Ergebnis spricht, und jeder dieser Fälle geht per return sofort wieder raus. Was danach kommt, ist
der Normalfall. Und der braucht keine Einrückung mehr.
Dabei ändert sich auch die Reihenfolge, in der du liest. In der tiefen Fassung steht der Normalfall ganz innen, vier Ebenen weit rechts. In der flachen steht er zuletzt und ganz links.
Nebenbei fallen die else-Blöcke weg. Nach einem return braucht es kein else, denn die Funktion
ist an dieser Stelle ohnehin schon vorbei.
Kleine Bausteine lassen sich anders zusammensetzen
<?php
declare(strict_types=1);
function tagesWert(array $eintrag): int
{
return $eintrag["stunden"] * $eintrag["satz"];
}
$zettel = [
["tag" => "Montag", "stunden" => 6, "satz" => 4500],
["tag" => "Dienstag", "stunden" => 3, "satz" => 4500],
["tag" => "Samstag", "stunden" => 4, "satz" => 6000],
];
$werte = [];
foreach ($zettel as $eintrag) {
$werte[] = tagesWert($eintrag);
}
echo "Bester Tag: ", number_format(max($werte) / 100, 2, ",", "."), " Euro\n";
echo "Zusammen: ", number_format(array_sum($werte) / 100, 2, ",", "."), " Euro\n";
echo "Im Schnitt: ", number_format(array_sum($werte) / count($werte) / 100, 2, ",", "."), " Euro\n"; Hier steht dieselbe tagesWert() wie vorher. Dahinter beantwortet sie drei Fragen, an die die lange
Fassung nur über Umwege herankam, nämlich welcher Tag am meisten gebracht hat, was zusammen
herauskommt und was der Schnitt ist.
Die lange Fassung konnte nur eine fertige Abrechnung als Text liefern. Wolltest du nur die Summe,
hättest du die Abrechnung bauen und die letzte Zeile wieder auseinandernehmen müssen. Mit
tagesWert() kommst du direkt an die Summe, weil sie ihr Ergebnis zurückgibt. Hätte sie es
ausgegeben, stünde es an einer einzigen Stelle im Programm und nirgends sonst.
In der Aufgabe wird aus einer langen Rechnungsfunktion eine kurze mit drei Helfern.
Zum Mitnehmen
Eine Funktion ist zu groß, wenn ihr ehrlicher Name ein „und“ braucht oder man beim Lesen zurückblättern muss. Kleine Funktionen mit einem Zweck lassen sich neu zusammensetzen, ein Rechenweg steht dann nur an einer Stelle, und frühe Rückgaben halten sie flach.
Jetzt du
Basis Konto, kostenlosZu 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 4 Beispielen zum Ausprobieren
Steht hier, ohne Konto lesbar.
-
Aufgabe, dein Code läuft auf einem Server
Öffnet sich mit dem Basis Konto.