Go-Service-Arbeit
Konventionen, die einen mehrschichtigen Go-Service unter Nebenläufigkeit und Multi-Tenancy korrekt halten. Lies zuerst das umgebende Paket – ein lokales Muster, das konsistent angewendet wird, hat Vorrang vor allem hier.
Bevor du Code schreibst
Überprüfe die Toolchain. go.mod entscheidet, welche Standardbibliothek und
Sprachfeatures verfügbar sind, und Services im selben Workspace befinden sich
häufig auf unterschiedlichen Versionen. Ein Loop-Variable-Capture ist ein
echter Bug unter Go 1.22 und kein Problem darüber; errors.Join, slices und
maps benötigen 1.21. Lies die Version, anstatt die neueste anzunehmen.
Finde dann die Schicht, die die Entscheidung besitzt, die du gerade ändern willst. Handler übersetzen Transport in Domäne und sonst nichts. Services treffen die Entscheidung. Repositories führen die Abfrage aus. Eine Validierung, die im Handler hinzugefügt wird, ist für jeden anderen Aufrufer des Service unsichtbar.
Kontext
Der Kontext gehört zur Anfrage und stirbt mit ihr.
- Übergib
ctxals ersten Parameter, bis zum Datenbankaufruf. Eine Funktion, die keinen Kontext entgegennimmt, kann nicht abgebrochen werden und kann keine Deadline tragen. - Speichere niemals ein
context.Contextin einem Struct-Feld. - Gib einen Anforderungskontext niemals an eine Goroutine weiter, die den Handler überlebt. Abgekoppelte Hintergrundarbeit benötigt einen eigenen Kontext mit eigenem Timeout und die benötigten Werte müssen explizit kopiert werden, bevor der Handler zurückkehrt.
- Gleiches gilt für jedes aus der Anfrage abgeleitete Handle – eine Transaktion, eine Verbindung, ein anforderungsspezifischer Datenbankzugriff. Die Verwendung nach der Rückkehr des Handlers ist ein Use-After-Free mit einer freundlicheren Fehlermeldung.
Fehler
- Wickle mit
%wund füge hinzu, was der Aufrufer nicht bereits weiß: die Kennung, die Operation.fmt.Errorf("Lade Bestellung %d: %w", id, err). Füge den Funktionsnamen nicht als Präfix hinzu; ein Stapel davon liest sich wie Rauschen. - Vergleiche mit
errors.Isunderrors.As. Ein direkter==-Vergleich bricht, sobald jemand den Fehler verpackt. - Übersetze in einen Transportstatus an genau einer Stelle, an der Handler-Grenze. Ein Repository, das einen HTTP-Code zurückgibt, hat zwei Schichten undicht gemacht.
sql.ErrNoRowsist ein Domänenergebnis, kein Fehler. Bilde es am Rand des Repository auf das „nicht gefunden“ der Domäne ab, sodass der Service niemalsdatabase/sqlimportiert.- Verwerfe niemals einen Fehler, um den Compiler zufriedenzustellen. Wenn er
wirklich ignorierbar ist, weise ihn mit
_zu und kommentiere, warum.
Transaktionen
Öffne die Transaktion auf der Schicht, die die Invariante besitzt – normalerweise der Service, niemals das Repository, weil ein Repository, das seine eigene Transaktion öffnet, nicht in eine größere zusammengesetzt werden kann. Gib das Transaktions-Handle nach unten weiter.
Führe Commit und Rollback auf jedem Pfad aus, einschließlich Panic. Der
Rollback nach einem erfolgreichen Commit muss harmlos sein; das macht
defer tx.Rollback() sicher.
Führe kein I/O innerhalb einer Transaktion durch, das nicht atomar mit ihr sein muss. Ein HTTP-Aufruf an einen Zahlungsanbieter innerhalb einer offenen Transaktion hält Datenbanksperren für die Dauer eines Ausfalls eines anderen.
Mandantenfähigkeit
Wenn der Service mandantenfähig ist, wird die Mandantenkennung im Code durchgesetzt, nicht in der Datenbank. Jede Repository-Abfrage – Lesen und Schreiben – trägt das Mandanten-Prädikat. Eine Abfrage, die nur nach dem Primärschlüssel filtert, gibt freudig die Zeile eines anderen Mandanten zurück. Leite die Kennung von dem im Code bereits verwendeten Anforderungskontext-Zugriff ab und prüfe, welcher Zugriff korrekt ist: Ein Service, der im Namen eines Untermandanten handelt, hat normalerweise zwei, und der offensichtliche ist oft der falsche.
Goroutinen
Jede Goroutine benötigt eine bekannte Lebensdauer und einen bekannten
Eigentümer. Bevor du go schreibst, beantworte: Wer wartet auf sie, wie
hört sie auf und wohin geht ihr Fehler? Eine Goroutine, deren Fehler
verworfen wird, ist ein stiller Fehler.
Verwende errgroup, wenn der Aufrufer wartet. Verwende ein explizites
sync.WaitGroup plus einen gesammelten Fehlerkanal, wenn es nicht passt.
Ein bloßes go f() in der Anforderungsbearbeitung ist fast immer ein
Fehler.
Tests
Tabellengesteuert, ein t.Run pro Fall, benannt nach dem Verhalten, nicht
nach der Eingabe. Jeder Fall gibt seine Eingabe, seine Erwartung und nichts
weiter an; Setup, das von jedem Fall gemeinsam genutzt wird, gehört oberhalb
der Tabelle.
Übergib immer ein Timeout, wenn du sie ausführst:
go test -count=1 -timeout 60s ./...
-count=1 deaktiviert den Ergebniscache, der sonst ein Bestehen für Code
meldet, den du gerade geändert hast. Das Timeout ist wichtiger, als es
aussieht: Ein festgefahrener Test ohne Timeout verbraucht Speicher, bis die
Maschine stehen bleibt.
Teste das exportierte Verhalten des Pakets. Ein Test, der in nicht exportierte Interna eindringt, fixiert die Implementierung und schlägt bei jedem ehrlichen Refactoring fehl.
Wenn ein Test flaky ist, meldet er meistens einen echten Race-Condition.
Führe ihn unter -race aus, bevor du etwas anderes annimmst, und behebe ihn
niemals durch Hinzufügen eines Sleeps.
Bevor du es als erledigt betrachtest
Führe den engsten Test aus, der die Änderung abdeckt, und erweitere dann,
wenn sich ein gemeinsamer Vertrag geändert hat. Führe golangci-lint run im
Service aus, nicht über ein Make-Ziel, das den Exit-Code verschlucken kann.
Melde Fehler mit ihrer Ausgabe, anstatt den Test abzuschwächen.