Einfaches Hallo-Welt-Programm mit Bazel und Go lang

Nachdem ich den Beitrag zum Thema „Building with Go in a monorepo using Bazel, Gazelle and bzlmod“ geschrieben und mit einigen Kollegen geteilt hatte, sah ich ein wachsendes Interesse an der Monorepo-Entwicklung. Ich habe gelernt, dass nicht viele Menschen noch genug Erfahrung hatten, um die Vorteile zu verstehen, die es mit sich bringen könnte. Deshalb habe ich beschlossen, dies in eine Serie umzuwandeln, beginnend mit diesem Beitrag über das Simple Hello World-Programm mit Bazel und Go Lang

In diesem Beitrag werde ich versuchen, einige äußerst grundlegende Konzepte von Bazel zusammen mit Codeausschnitten zu behandeln, damit jemand im Handumdrehen loslegen kann.

Was ist Bazel?

Laut offizieller Dokumentation

Bazel ist ein Open-Source-Build- und Testtool, das Make, Maven und Gradle ähnelt. Es verwendet eine für Menschen lesbare High-Level-Build-Sprache. Bazel unterstützt Projekte in mehreren Sprachen und erstellt Ausgaben für mehrere Plattformen. Bazel unterstützt große Codebasen über mehrere Repositorys hinweg und eine große Anzahl von Benutzern.

Es ist seit Jahrzehnten bei Google im Einsatz und wurde gründlich kampferprobt. Mehr darüber, wie ich darauf aufmerksam geworden bin, könnt ihr im oben verlinkten Beitrag lesen.

---

Schritt 1: Repository einrichten

Für diese Serie habe ich unter github.com/nixclix/basil ein Repository erstellt, das sich im Laufe der Zeit weiterentwickeln wird. Zum Zeitpunkt des Schreibens dieses Beitrags ist der neueste Commit https://github.com/nixclix/basil/tree/d8af2aea6fb8b692f735f9959429df9fcd28422b

Erstellen Sie also ein neues Git-Repo bei einem beliebigen Anbieter Ihrer Wahl

Für die .gitignore-Datei empfehle ich dringend, Folgendes hinzuzufügen, um keine unnötigen Dateien in Ihre Commits aufzunehmen

# If you prefer the allow list template instead of the deny list, see community template:
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
#
bazel-*
/.ijwb
/.clwb
/.idea
/.project
*.swp
/.bazelrc.user

# macOS-specific excludes
.DS_Store

# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/

# Go workspace file
go.work
go.work.sum

# env file
.env

---

Schritt 2: Etwas Bazel-Käse hinzufügen

Ab Bazel 6.3 benötigen Sie keine WORKSPACE-Datei mehr. Wir beginnen also damit, Folgendes im Stammverzeichnis des Repos zu erstellen

MODULE.bazel

"""Building go applications in a monorepo environment"""

module(name = "basil", version = "0.0.0")
http_file = use_repo_rule(
    "@bazel_tools//tools/build_defs/repo:http.bzl", "http_file"
)
http_archive = use_repo_rule(
    "@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive"
)

# https://github.com/bazelbuild/rules_go/blob/master/docs/go/core/bzlmod.md
bazel_dep(name = "rules_go", version = "0.50.1")
bazel_dep(name = "gazelle", version = "0.39.1")

GO_VERSION = "1.23.2"

go_sdk = use_extension("@rules_go//go:extensions.bzl", "go_sdk")
go_sdk.download(version = GO_VERSION)

go_deps = use_extension("@gazelle//:extensions.bzl", "go_deps")
go_deps.from_file(go_mod = "//:go.mod")

Hier legen wir die Go-Version fest, die wir verwenden möchten, sowie die Gazelle- und Rules_Go-Version.

Wir werden Gazelle für die BUILD-Dateiverwaltung verwenden. Gazelle macht das Generieren einer Build-Datei sehr bequem. Mehr darüber können Sie hier lesen

BUILD.bazel

load("@gazelle//:def.bzl", "gazelle")

gazelle(name = "gazelle")

gazelle(
    name = "gazelle-update-repos",
    args = [
        "-from_file=go.mod",
        "-to_macro=deps.bzl%go_dependencies",
        "-prune",
    ],
    command = "update-repos",
)

Dies sollte sich im Stammverzeichnis des Repos befinden. Dadurch wird Gazelle über die Quelle der Go-Mod-Datei und andere auszuführende Prozesse informiert

Als nächstes erstellen wir 3 weitere Dateien mit den jeweiligen Inhalten. Machen Sie sich vorerst keine Sorgen darüber, was diese bewirken.

.bazelignore

runfiles/
bzlmod/

.bazelrc

# Enable Bzlmod for every Bazel command
common --enable_bzlmod

.bazelversion

# If you prefer the allow list template instead of the deny list, see community template:
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
#
bazel-*
/.ijwb
/.clwb
/.idea
/.project
*.swp
/.bazelrc.user

# macOS-specific excludes
.DS_Store

# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/

# Go workspace file
go.work
go.work.sum

# env file
.env

Okay, zu diesem Zeitpunkt sollten Sie alles haben, was Sie brauchen, um einige Grundlagen zum Laufen zu bringen. Wenn Sie nun bazel build //... im Stammverzeichnis ausführen, sollte bazel in der Lage sein, das Repo zu durchlaufen und alle erkannten Pakete zu erstellen. Bazel speichert Paketausgaben früherer Builds zwischen, daher sollte jeder nachfolgende Build von hier an extrem schnell sein.

Als Nächstes fangen wir mit dem eigentlichen „Hallo Welt“-Programm an.

Schritt 3: Schreiben eines Helloworld-Pakets

Für die grundlegende Organisation des Codes schreiben wir den gesamten Go-Code in ein Verzeichnis namens /packages. Auf diese Weise können alle Referenzen in anderen Teilen des Codes darauf verweisen als //packages/...

Lassen Sie uns im Paketverzeichnis ein Verzeichnis namens helloworld erstellen und Folgendes hinzufügen

helloworld.go

"""Building go applications in a monorepo environment"""

module(name = "basil", version = "0.0.0")
http_file = use_repo_rule(
    "@bazel_tools//tools/build_defs/repo:http.bzl", "http_file"
)
http_archive = use_repo_rule(
    "@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive"
)

# https://github.com/bazelbuild/rules_go/blob/master/docs/go/core/bzlmod.md
bazel_dep(name = "rules_go", version = "0.50.1")
bazel_dep(name = "gazelle", version = "0.39.1")

GO_VERSION = "1.23.2"

go_sdk = use_extension("@rules_go//go:extensions.bzl", "go_sdk")
go_sdk.download(version = GO_VERSION)

go_deps = use_extension("@gazelle//:extensions.bzl", "go_deps")
go_deps.from_file(go_mod = "//:go.mod")

BUILD.bazel

load("@gazelle//:def.bzl", "gazelle")

gazelle(name = "gazelle")

gazelle(
    name = "gazelle-update-repos",
    args = [
        "-from_file=go.mod",
        "-to_macro=deps.bzl%go_dependencies",
        "-prune",
    ],
    command = "update-repos",
)

Das Go-Programm ist ziemlich einfach. Wir haben eine einfache Hauptfunktion, die einfach eine „Hallo Welt“-Nachricht ausgibt.

Der Teil, der uns interessiert, ist die Datei BUILD.bazel. Gehen wir das Block für Block durch und versuchen zu verstehen, was es bedeutet.

Die erste Zeile lädt die Makros go_binary und go_library aus Rules_go . Sie werden später im Code feststellen, dass diese verwendet werden.

In Zeile 10 definieren wir eine Bibliothek namens helloworld_lib und geben die Quellen der Bibliothek als helloworld.go an. Wenn dieses Paket importierbar gemacht werden muss, können Sie auch den Pfad angeben, unter dem es verfügbar sein wird: basil/packages/helloworld_lib. Dann kommt die Sichtbarkeit und hier geben wir an, dass die Bibliothek privat ist und nur innerhalb dieses Pakets sichtbar ist. In zukünftigen Beiträgen werden wir möglicherweise untersuchen, wie diese Parameter geändert werden können, um Abhängigkeiten von anderen Paketen zu verwenden.

In Zeile 3 verwenden wir dann das Makro go_binary von Rules_go, um eine Binärdatei für unser Programm zu generieren. Hier geben wir die Bibliothek an, die wir zuvor im Embed-Parameter definiert haben. Die Paketsichtbarkeit gilt auch für Binärdateien.

---

Schritt 4: Erstellen und ausführen

Und das ist es. Voila! Sie können die Binärdatei ausführen, indem Sie sie zunächst mit bazel build //packages/helloworld erstellen, gefolgt von bazel run //packages/helloworld

Wenn Ihnen dieser Beitrag gefällt und Sie gerne zukünftige darauf aufbauende Beiträge als Teil der Serie erhalten möchten, abonnieren Sie diesen Beitrag und teilen Sie ihn.

Das obige ist der detaillierte Inhalt vonEinfaches Hallo-Welt-Programm mit Bazel und Go lang. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!