DE
RU
EN
ES
ZH
FR
PT
AR
HI
Monorepository mit Go: Effiziente Code-Organisation
In der modernen Softwareentwicklung ist die Wahl der Strategie zur Code-Verwaltung einer der Schlüsselfaktoren, der die Teamproduktivität und die Skalierbarkeit des Projekts beeinflusst. Ein Monorepository (Monorepo) ist ein Ansatz, bei dem der Code aller Dienste, Bibliotheken und Werkzeuge in einem einzigen Repository gespeichert wird. In Kombination mit der Sprache Go, die von Grund auf für große Projekte konzipiert wurde, wird das Monorepository zu einem leistungsstarken Werkzeug.
In diesem Artikel werden wir uns ansehen, wie man ein Monorepository in Go richtig organisiert: von der grundlegenden Verzeichnisstruktur bis zur Abhängigkeitsverwaltung mit Go Workspace. Sie erfahren, wie Sie typische Fehler vermeiden und eine Architektur aufbauen, die mit Ihrem Projekt mitwächst.
Warum sind Monorepository und Go das ideale Paar?
Go (Golang) ist bekannt für seine Einfachheit und Effizienz. Bei der Arbeit mit Microservices oder großen Bibliotheken stellt sich jedoch die Frage: Wie organisiert man den Code, damit er wartbar und refaktorisierbar bleibt?
Vorteile eines Monorepositorys für Go:
- Einheitliche Abhängigkeitsversionen: Alle Dienste verwenden dieselben Bibliotheksversionen, was Konflikte ausschließt.
- Vereinfachte Refaktorisierung: Eine API-Änderung in einer Bibliothek wirkt sich sofort auf alle Konsumenten aus.
- Commit-Integrität: Änderungen in verschiedenen Teilen des Projekts können in einem einzigen Commit zusammengefasst werden, was das Zurücksetzen vereinfacht.
- Standardisierung: Einheitliche Regeln für Linting, Tests und CI/CD für das gesamte Projekt.
Gleichzeitig bietet Go integrierte Werkzeuge – Module (go mod) und Workspace (go work) – die sich ideal für die Arbeit mit einem Monorepository eignen.
Grundlegende Struktur eines Go-Monorepositorys
Die richtige Verzeichnisstruktur ist die Grundlage eines erfolgreichen Monorepositorys. Betrachten wir die empfohlene Organisation am Beispiel eines Projekts mit mehreren Microservices und einer gemeinsamen Bibliothek.
myproject/├── apps/│ ├── api-gateway/│ │ ├── cmd/│ │ │ └── main.go│ │ ├── internal/│ │ ├── go.mod│ │ └── go.sum│ ├── user-service/│ │ ├── cmd/│ │ └── internal/│ └── order-service/│ ├── cmd/│ └── internal/├── libs/│ ├── common/│ │ ├── logger/│ │ ├── config/│ │ ├── go.mod│ │ └── go.sum│ └── db/│ ├── models/│ ├── migrations/│ ├── go.mod│ └── go.sum├── scripts/│ ├── build.sh│ └── deploy.sh├── go.work├── Makefile├── .golangci.yml└── README.mdErläuterungen zur Struktur:
apps/– enthält ausführbare Anwendungen (Microservices, CLI-Tools). Jeder Dienst ist ein separates Go-Modul mit seiner eigenengo.mod.libs/– Allzweckbibliotheken, die zwischen den Diensten wiederverwendet werden.scripts/– Hilfsskripte für Build, Tests und Deployment.go.work– Die Workspace-Datei, die alle Module in einem einzigen Entwicklungsbereich zusammenfasst.
Wichtig: Legen Sie Code nicht direkt im Repository-Stammverzeichnis ab. Verwenden Sie Unterverzeichnisse zur Gruppierung nach funktionalem Zweck.
Abhängigkeitsverwaltung mit Go Workspace
Seit Go Version 1.18 gibt es Unterstützung für Workspace (Arbeitsbereich). Dies ist eine Schlüsselfunktion für Monorepositorys, die es ermöglicht, mehrere Module gleichzeitig zu entwickeln, ohne sie in einer entfernten Registry veröffentlichen zu müssen.
Erstellen eines Workspace:
# Workspace im Projektstammverzeichnis initialisierengo work init ./apps/api-gateway ./apps/user-service ./libs/common
# Neues Modul hinzufügengo work use ./apps/order-service
# Aktuellen Workspace anzeigengo work edit -jsonInhalt der Datei go.work
Blogs
Buchempfehlungen
Lesen Sie auch
