Funktionen mit lokalem Gültigkeitsbereich und Rückgabecodes entwerfen

In Bash sind Variablen standardmäßig global. Eine innerhalb einer Funktion gesetzte Variable wird in den Gültigkeitsbereich des Aufrufers übernommen, sofern Sie sie nicht ausdrücklich mit local deklarieren. Das ist eine häufige Ursache für schwer erkennbare Fehler in Shell-Skripten.

• Funktionen ohne local können Variablen des Aufrufers unbemerkt überschreiben.
• local-Variablen werden zerstört, sobald die Funktion zurückkehrt.
• Saubere Gültigkeitsbereiche machen Funktionen isoliert wiederverwendbar und testbar.

In dieser Lektion lernen Sie, in sich geschlossene Funktionen zu schreiben: Sie verwenden local-Variablen, übermitteln Ergebnisse mithilfe von Exit-Codes und printf und verlassen sich niemals auf impliziten globalen Zustand.

Hier ist ein konkretes Beispiel für ein Leck bei einer globalen Variablen. Die Funktion set_name setzt eine Variable namens result und überschreibt dabei unbemerkt die eigene Variable result des Aufrufers.

Führen Sie dieses Skript aus und beobachten Sie die unerwartete Ausgabe – die result-Variable des Aufrufers ist nach dem Funktionsaufruf verschwunden.

Das eingebaute Kommando local beschränkt den Gültigkeitsbereich einer Variablen auf die umschließende Funktion und alle von ihr aufgerufenen Funktionen. Außerhalb der Funktion ist die Variable entweder nicht gesetzt oder behält ihren vorherigen Wert.

• local varname – deklariert die Variable, ohne ihr einen Wert zuzuweisen.
• local varname="value" – deklariert die Variable und weist ihr in einem Schritt einen Wert zu.
• local -i count=0 – deklariert eine lokale Variable vom Typ Integer.
• local -r PI=3.14159 – deklariert eine lokale schreibgeschützte Konstante.

Bewährte Vorgehensweise: Deklarieren Sie jede Variable innerhalb einer Funktion als local, sofern sie nicht absichtlich global sein soll.

Bash-Funktionen können keine Zeichenketten mit return zurückgeben – return setzt lediglich einen Integer-Exit-Status (0–255). Üblicherweise gilt:

• return 0 – Erfolg
• return 1 (oder ein beliebiger Wert ungleich null) – Fehler

Der Aufrufer liest den Exit-Status unmittelbar nach dem Aufruf über $? aus oder verwendet die Funktion direkt als Bedingung in einem if. Exit-Codes sind die idiomatische Möglichkeit, Erfolg oder Fehler einer Funktion zu signalisieren.

Wenn eine Funktion ein Zeichenketten-Ergebnis zurückgeben muss, besteht das Standardmuster darin, es auf stdout auszugeben und mit einer Command Substitution $() abzufangen. printf wird gegenüber echo bevorzugt, weil:

• printf standardmäßig keinen abschließenden Zeilenumbruch anhängt (außer Sie fügen \n ein).
• Das Verhalten von printf konsistent und durch POSIX definiert ist; echo sich je nach Shell unterschiedlich verhält.
• Die Command Substitution abschließende Zeilenumbrüche entfernt, sodass printf '%s' "$value" präzise ist.

Eine gut entworfene Funktion kann gleichzeitig ein Ergebnis ausgeben (bei Erfolg) und einen Fehler signalisieren (über den Exit-Code). Der Aufrufer entscheidet anhand des Exit-Codes, was zu tun ist, bevor er der Ausgabe vertraut.

Das folgende Muster wird in echten Bash-Bibliotheken häufig verwendet:

• Bei Erfolg: Das Ergebnis mit printf ausgeben und return 0 verwenden.
• Bei einem Fehler: Eine Diagnose nach stderr (nicht stdout) schreiben und return 1 verwenden.
• Wenn Fehler nach stderr geschrieben werden, bleibt stdout für Pipes frei von zusätzlichen Ausgaben.

Rekursion zeigt besonders deutlich, warum local unverzichtbar ist. Jeder rekursive Aufruf erhält auf dem Call-Stack eine eigene, unabhängige Kopie jeder local-Variablen. Ohne local würde jeder Aufruf dieselbe globale Variable überschreiben und falsche Ergebnisse liefern.

Die folgende Fakultätsfunktion ist sicher, weil n und sub in jedem Stack-Frame lokal sind.

Die Command Substitution $() wird in einer Subshell ausgeführt. Variablenzuweisungen darin sind für die übergeordnete Shell nicht sichtbar. Wenn eine Funktion ohne Subshell in eine vom Aufrufer bereitgestellte Variable schreiben soll, verwenden Sie eine Namensreferenz (local -n), die ab Bash 4.3 verfügbar ist.

• local -n ref="$1" macht ref zu einem Alias für die Variable, deren Name in $1 gespeichert ist.
• Eine Zuweisung an ref innerhalb der Funktion ändert die Variable des Aufrufers direkt.
• Dadurch wird eine Subshell vermieden, während die Implementierungsdetails weiterhin lokal bleiben.

In realen Bash-Projekten werden wiederverwendbare Funktionen in Bibliotheksdateien aufgeteilt, die von Skripten mit source (oder dem Punkt-Operator .) eingebunden werden. Regeln für ein gutes Bibliotheksdesign:

• Jede Variable innerhalb einer Bibliotheksfunktion muss local sein.
• Bibliotheksfunktionen verwenden niemals exit – sie verwenden return, damit der Aufrufer weiter ausgeführt wird.
• Verwenden Sie ein einheitliches Namespace-Präfix (z. B. str_, log_), um Namenskollisionen zu vermeiden.
• Schützen Sie sich mit einer Sentinel-Variable gegen das mehrfache Einbinden.

Im Folgenden sehen Sie eine minimale Bibliothek für Zeichenketten-Hilfsfunktionen, die diesen Konventionen folgt.

Funktionen, die Argumente erhalten, sollten diese frühzeitig validieren und bei ungültigen Eingaben einen spezifischen Exit-Code zurückgeben. Dieses Muster wird als Guard Clause bezeichnet – Fehler werden frühzeitig und eindeutig behandelt.

• Prüfen Sie die Anzahl der Argumente mit $#.
• Validieren Sie Typen oder Formate, bevor Sie mit der eigentlichen Arbeit beginnen.
• Geben Sie Diagnosemeldungen ausschließlich nach stderr aus, niemals nach stdout.
• Verwenden Sie unterschiedliche Exit-Codes ungleich null (z. B. 1 = falsche Argumente, 2 = Datei nicht gefunden), damit Aufrufer auf verschiedene Fehlerursachen unterschiedlich reagieren können.

Hier ist ein vollständiges, eigenständiges Skript, das alle Konzepte dieser Lektion im Zusammenspiel demonstriert:

• local-Variablen in jeder Funktion.
• Exit-Codes zur Signalisierung von Erfolg und Fehler.
• printf zur Übermittlung von Zeichenketten-Ergebnissen.
• Fehler nach stderr, Ergebnisse nach stdout.
• Guard Clauses zur Validierung von Argumenten.

Untersuchen Sie den Ablauf: parse_version extrahiert Daten, version_ge vergleicht sie, und main verwendet beide Funktionen auf saubere Weise.

Betrachten Sie die folgende Bash-Funktion. Wie lässt sich ihr Zeichenketten-Ergebnis im Aufrufer korrekt abfangen, und welche Aussage über die Variable tmp ist richtig?

transform() {
    local tmp="${1,,}"   # lowercase
    printf '%s' "$tmp"
    return 0
}

In dieser Lektion haben Sie gelernt, wie Sie saubere, kombinierbare und sichere Bash-Funktionen schreiben:

• Verwenden Sie innerhalb von Funktionen immer local für Variablen, um den Gültigkeitsbereich des Aufrufers nicht zu verunreinigen.
• Verwenden Sie Exit-Codes (return 0/1/N), um Erfolg oder Fehler zu signalisieren – sie lassen sich natürlich mit if, && und || kombinieren.
• Verwenden Sie printf für die Ausgabe nach stdout, um Zeichenketten-Ergebnisse zu übermitteln; fangen Sie sie im Aufrufer mit $() ab.
• Schreiben Sie Fehler nach stderr (>&2), damit stdout für Datenfluss und Weiterleitungen sauber bleibt.
• Verwenden Sie local -n (Namensreferenzen), wenn Sie ohne den Aufwand einer Subshell in eine vom Aufrufer bereitgestellte Variable schreiben müssen.
• Guard Clauses (Argumente frühzeitig validieren und bei ungültigen Eingaben sofort zurückkehren) machen Funktionen robust und selbsterklärend.
• Bibliotheksdateien sollten mit source eingebunden werden, Namespace-Präfixe verwenden, niemals exit aufrufen und gegen mehrfaches Einbinden geschützt sein.

Wer diese Muster beherrscht, schreibt nicht nur fragile Einwegskripte, sondern professionelle und wartbare Bash-Codebasen.