使用 Bazel 和 Go lang 的简单 hello world 程序

使用 bazel 和 go lang 的简单 hello world 程序

在写了“使用 bazel、gazelle 和 bzlmod 在 monorepo 中使用 go 进行构建”的文章并与一些同事分享后，我发现人们对 monorepo 开发越来越感兴趣。我了解到，没有多少人仍然有足够的经验来了解它可以带来的好处。所以我决定将其转换为一个系列，从这篇关于使用 bazel 和 go lang 的简单 hello world 程序的文章开始

在这篇文章中，我将尝试介绍 bazel 的一些极其基本的概念以及代码片段，以便让人们立即上手。

巴泽尔是什么？

根据官方文档

bazel 是一个类似于 make、maven 和 gradle 的开源构建和测试工具。它使用人类可读的高级构建语言。 bazel 支持多种语言的项目并为多个平台构建输出。 bazel 支持跨多个存储库的大型代码库和大量用户。

它已经在 google 使用了数十年，并且经过了彻底的实战测试。您可以在上面链接的帖子中详细了解我如何意识到这一点。

第 1 步：设置存储库

出于本系列的目的，我在 github.com/nixclix/basil 创建了一个存储库，该存储库将随着时间的推移而不断发展。在撰写本文时，最新提交为 https://github.com/nixclix/basil/tree/d8af2aea6fb8b692f735f9959429df9fcd28422b

所以，继续在您想要选择的任何提供商上创建一个新的 git 存储库

对于 .gitignore，我强烈建议添加以下内容，以免在提交中包含不必要的文件

# 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

第 2 步：添加一些 bazel 样板

从 bazel 6.3 开始，您不再需要 workspace 文件。因此，我们将从在存储库的根目录创建以下内容开始

模块.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")

这里是我们设置要使用的 go 版本以及瞪羚和rules_go 版本的地方。

我们将使用 gazelle 进行 build 文件管理。 gazelle 使得生成构建文件变得非常方便。您可以在这里阅读更多相关信息

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

这应该位于存储库的根目录。这会指示瞪羚了解 go mod 文件的来源以及其他要运行的进程

接下来我们再创建 3 个包含各自内容的文件。现在不用担心这些的作用。

.bazelignore

runfiles/
bzlmod/

.bazelrc

# enable bzlmod for every bazel command
common --enable_bzlmod

.bazel版本

7.3.1

好吧，至此您应该具备了进行一些基础工作所需的一切。现在，如果您在根目录运行 bazel build //... ，bazel 应该能够遍历存储库并构建它发现的任何包。 bazel 缓存早期构建的包输出，因此从这里开始的任何后续构建都应该非常快。

接下来，让我们开始破解实际的 hello world 程序。

第三步：编写helloworld包

对于代码的基本组织，我们将在名为 /packages 的目录中编写所有 go 代码。这样，代码其他部分中的任何引用都可以将其引用为 //packages/...

让我们在packages目录中创建一个名为helloworld的目录并添加以下内容

helloworld.go

package main

import (
    "fmt"
)

func main() {
    fmt.println("hello world!")
}

build.bazel

load("@rules_go//go:def.bzl", "go_binary", "go_library")

go_binary(
    name = "helloworld",
    embed = [":helloworld_lib"],
    importpath = "basil/packages/helloworld",
    visibility = ["//visibility:private"],
)

go_library(
    name = "helloworld_lib",
    srcs = ["helloworld.go"],
    importpath = "basil/packages/helloworld_lib",
    visibility = ["//visibility:private"],
)

go 程序相当简单。我们有一个简单的 main 函数，可以简单地打印一条 hello world 消息。

我们感兴趣的是 build.bazel 文件。让我们逐块地看一下这个并尝试理解它的含义。

第一行从rules_go加载go_binary和go_library宏。您会发现这些在稍后的代码中被使用。

在第 10 行中，我们定义了一个名为 helloworld_lib 的库，并将该库的源指定为 helloworld.go。如果这个包需要我导入，那么您还可以指定它的可用路径，即 basil/packages/helloworld_lib。然后是可见性，在这里我们指定该库是私有的，仅在此包中可见。在以后的文章中，我们可能会研究如何更改这些参数以使用其他包的依赖项。

在第 3 行中，我们使用 rules_go 中的 go_binary 宏为我们的程序生成二进制文件。这里我们指定之前在 embed 参数中定义的库。包可见性也适用于二进制文件。

第 4 步：构建并运行

就是这样。瞧！您可以通过首先使用 bazel build //packages/helloworld 构建它，然后使用 bazel run //packages/helloworld

来运行二进制文件

如果您喜欢这篇文章，并且希望获得以此为基础的未来帖子作为该系列的一部分，请订阅并分享这篇文章。

以上就是使用 Bazel 和 Go lang 的简单 hello world 程序的详细内容，更多请关注其它相关文章！