Program hello world yang ringkas menggunakan Bazel dan Go lang

Selepas menulis siaran tentang "Membina dengan Go dalam monorepo menggunakan Bazel, Gazelle dan bzlmod" dan berkongsi dengan beberapa rakan sekerja, saya melihat minat yang semakin meningkat dalam pembangunan monorepo. Saya mengetahui bahawa tidak ramai orang yang masih cukup berpengalaman untuk memahami faedah yang boleh dibawanya. Jadi saya memutuskan untuk menukar ini kepada siri bermula dengan siaran ini pada program hello world Simple menggunakan Bazel dan Go lang

Dalam siaran ini, saya akan cuba mengupas beberapa konsep asas Bazel bersama-sama dengan coretan kod untuk membuat seseorang bangun dan pergi dalam masa yang singkat.

Apa itu Bazel?

Mengikut dokumentasi rasmi

Bazel ialah alat binaan dan ujian sumber terbuka yang serupa dengan Make, Maven dan Gradle. Ia menggunakan bahasa binaan peringkat tinggi yang boleh dibaca manusia. Bazel menyokong projek dalam pelbagai bahasa dan membina output untuk berbilang platform. Bazel menyokong pangkalan kod yang besar merentas berbilang repositori dan sejumlah besar pengguna.

Ia telah digunakan di Google selama beberapa dekad dan diuji secara menyeluruh. Anda boleh membaca lebih lanjut tentang cara saya menyedari perkara ini pada siaran yang dipautkan di atas.

---

Langkah 1: Menyediakan repositori

Untuk tujuan siri ini saya telah mencipta repositori di github.com/nixclix/basil yang akan berkembang dari semasa ke semasa. Pada masa menulis siaran ini, komitmen terkini ialah https://github.com/nixclix/basil/tree/d8af2aea6fb8b692f735f9959429df9fcd28422b

Jadi, teruskan buat repo git baharu pada mana-mana pembekal yang anda mahu pilih

Untuk .gitignore, saya amat mengesyorkan menambah perkara berikut supaya tidak memasukkan fail yang tidak diperlukan dalam komit anda

# 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

---

Langkah 2: Menambah beberapa boilerplate Bazel

Memulakan Bazel 6.3 anda tidak perlu mempunyai fail WORKSPACE lagi. Jadi, kita akan mulakan dengan mencipta yang berikut pada akar repo

MODUL.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")

Di sinilah kami menetapkan versi go yang ingin kami gunakan serta versi gazelle dan rules_go.

Kami akan menggunakan Gazelle untuk pengurusan fail BINA. Gazelle menjadikan penjanaan fail binaan agak mudah. Anda boleh membaca lebih lanjut mengenainya di sini

BINA.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",
)

Ini sepatutnya berada di akar repo. Ini mengarahkan gazelle pada sumber fail mod go dan proses lain untuk dijalankan

Seterusnya kami mencipta 3 lagi fail dengan kandungan masing-masing. Jangan risau tentang apa yang mereka lakukan sekarang.

.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

Baiklah, pada ketika ini anda sepatutnya mempunyai semua yang diperlukan untuk memastikan beberapa asas berfungsi. Sekarang jika anda menjalankan binaan bazel //... pada akarnya, bazel sepatutnya boleh merentasi repo dan membina sebarang pakej yang ditemuinya. Bazel menyimpan output pakej daripada binaan terdahulu, jadi sebarang binaan seterusnya dari sini hendaklah sangat pantas.

Seterusnya, mari kita mulakan program hello world yang sebenarnya.

Langkah 3: Menulis pakej helloworld

Untuk organisasi asas kod, kami akan menulis semua kod Go dalam direktori yang dipanggil /packages. Dengan cara ini sebarang rujukan di bahagian lain kod boleh merujuknya sebagai //pakej/...

Mari kita buat direktori dalam direktori pakej yang dipanggil helloworld dan tambahkan yang berikut

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")

BINA.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",
)

Program go adalah agak mudah. Kami mempunyai fungsi utama ringkas yang mudah mencetak mesej hello world.

Sedikit yang kami minati ialah fail BUILD.bazel. Mari kita pergi ke blok demi blok ini dan cuba fahami maksudnya.

Barisan pertama memuatkan makro go_binary dan go_library daripada rules_go . Anda akan mendapati ini digunakan kemudian dalam kod.

Dalam baris 10 kami mentakrifkan perpustakaan yang dipanggil helloworld_lib dan menentukan sumber perpustakaan sebagai helloworld.go. Jika pakej ini perlu saya jadikan boleh diimport, maka anda juga boleh menentukan laluan yang akan tersedia iaitu basil/packages/helloworld_lib. Kemudian datang keterlihatan dan di sini kami menyatakan bahawa perpustakaan adalah peribadi hanya boleh dilihat dalam pakej ini. Dalam siaran akan datang, kami mungkin melihat cara menukar parameter ini untuk menggunakan kebergantungan daripada pakej lain.

Dalam baris 3 kami kemudian menggunakan makro go_binary daripada rules_go untuk menjana binari untuk program kami. Di sini kami menentukan perpustakaan yang telah kami takrifkan sebelum ini dalam parameter benam. Keterlihatan pakej terpakai pada binari juga.

---

Langkah 4: Bina dan Jalankan

Dan itu sahaja. Voila! Anda boleh menjalankan binari dengan membinanya terlebih dahulu menggunakan binaan bazel //packages/helloworld diikuti dengan bazel run //packages/helloworld

Jika anda menyukai siaran ini dan ingin mendapatkan siaran masa depan yang membinanya sebagai sebahagian daripada siri ini, sila langgan dan kongsi siaran ini.

Atas ialah kandungan terperinci Program hello world yang ringkas menggunakan Bazel dan Go lang. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!