Clean Code in Go: Prinzipien und Beispiele für Anfänger — Teil 1

Clean Code ist nicht nur ein trendiger Begriff, sondern die Grundlage professioneller Programmierung. Wenn Sie Go (Golang) lernen und Programme schreiben möchten, die leicht zu lesen, zu warten und zu erweitern sind, dann werden die Clean Code-Prinzipien Ihr bestes Werkzeug sein. In diesem Artikel zerlegen wir die grundlegenden Konzepte von Clean Code in Go, die auch für Anfänger geeignet sind.

Warum ist Clean Code in Go wichtig?

Go wurde ursprünglich als Sprache für die Erstellung einfacher und effizienter Lösungen entwickelt. Ohne die Einhaltung der Clean Code-Regeln kann jedoch selbst ein einfaches Projekt zu "Spaghetti-Code" werden. Clean Code hilft dabei:

• Die Anzahl der Fehler während der Programmierung zu reduzieren;
• Die Teamarbeit zu vereinfachen;
• Die Zeit für die Einarbeitung neuer Entwickler zu verkürzen;
• Die Lesbarkeit und Wartbarkeit des Codes zu verbessern.

Prinzip 1: Korrekte Benennung

Namen von Variablen, Funktionen und Paketen sollten ihren Zweck widerspiegeln. In Go ist es üblich, kurze Namen zu verwenden, aber das bedeutet nicht, dass sie bedeutungslos sein sollten.

Schlechtes Beispiel:

func f(a int, b int) int {    r := a + b    return r}

Gutes Beispiel (Clean Code):

func AddNumbers(first int, second int) int {    result := first + second    return result}

Beachten Sie: Der Funktionsname AddNumbers sagt Ihnen sofort, was sie tut. Die Variablen first, second, result werfen ebenfalls keine Fragen auf. Dies ist besonders wichtig für Go für Anfänger, da klare Namen das Codeverständnis beschleunigen.

Prinzip 2: Minimierung des Gültigkeitsbereichs

In Golang gibt es das Konzept von exportierten (mit einem Großbuchstaben beginnend) und nicht exportierten (mit einem Kleinbuchstaben beginnend) Bezeichnern. Nutzen Sie dies, um interne Implementierungsdetails zu verbergen.

Beispiel:

package calculator

// Exported functiontype Calculator struct {    result int}

func (c *Calculator) Add(value int) {    c.result += value}

func (c *Calculator) GetResult() int {    return c.result}

// Unexported function — hidden from the outside worldfunc (c *Calculator) reset() {    c.result = 0}

Hier ist reset für andere Pakete unzugänglich, was den internen Zustand des Objekts schützt. Dies ist eines der wichtigsten Clean Code-Prinzipien — die Kapselung.

Prinzip 3: Funktionen sollten klein sein

Eine Funktion — eine Aufgabe. Wenn eine Funktion mehr als eine Sache tut, sollte sie in mehrere aufgeteilt werden. Dies verbessert die Lesbarkeit und vereinfacht das Testen.

Schlechtes Beispiel:

func ProcessUser(name string, age int) string {    if age < 18 {        return "Access denied"    }    result := "Hello, " + name    return result}

Gutes Beispiel (Clean Code):

func IsAdult(age int) bool {    return age >= 18}

func GreetUser(name string) string {    return "Hello, " + name}

func ProcessUser(name string, age int) string {    if !IsAdult(age) {        return "Access denied"    }    return GreetUser(name)}

Jetzt ist jede Funktion für ihren eigenen Teil verantwortlich. Dies erleichtert das Lernen und die Codewartung.

Prinzip 4: Fehlerbehandlung

In Go gibt es keine Ausnahmen — Fehler werden als Werte zurückgegeben. Clean Code erfordert eine explizite Fehlerbehandlung, nicht deren Ignorieren.

Schlechtes Beispiel:

func ReadFile(path string) string {    data, _ := os.ReadFile(path)    return string(data)}

Gutes Beispiel: