我的编程空间,编程开发者的网络收藏夹
学习永远不晚

详解如何使用Bazel构建Golang程序

短信预约 -IT技能 免费直播动态提醒
省份

北京

  • 北京
  • 上海
  • 天津
  • 重庆
  • 河北
  • 山东
  • 辽宁
  • 黑龙江
  • 吉林
  • 甘肃
  • 青海
  • 河南
  • 江苏
  • 湖北
  • 湖南
  • 江西
  • 浙江
  • 广东
  • 云南
  • 福建
  • 海南
  • 山西
  • 四川
  • 陕西
  • 贵州
  • 安徽
  • 广西
  • 内蒙
  • 西藏
  • 新疆
  • 宁夏
  • 兵团
手机号立即预约

请填写图片验证码后获取短信验证码

看不清楚,换张图片

免费获取短信验证码

详解如何使用Bazel构建Golang程序

使用Bazel构建Golang程序

在这篇简短的文章中,我们将介绍如何将 Golang 与 Bazel 构建系统结合使用。

具体来说,我们将讨论三个场景:

  • 从头开始一个 Golang 项目;
  • 将一个现有的 Golang 项目转换为 Bazel 构建;
  • 以及将一个第三方 Golang 项目引入到您的 Bazel 构建系统。

从头开始一个 Golang 项目

让我们从将 Go 与 Bazel 结合使用的基础知识开始。

为此,我们需要从 github.com/bazelbuild/… 获取 Go 语言的官方构建规则。

在配置部分,您会发现:我们需要将以下这段 Starlark 语言代码,放入名为 WORKSPACE 的配置文件里面:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "io_bazel_rules_go",
    sha256 = "8e968b5fcea1d2d64071872b12737bbb5514524ee5f0a4f54f5920266c261acb",
    urls = [
        "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.28.0/rules_go-v0.28.0.zip",
        "https://github.com/bazelbuild/rules_go/releases/download/v0.28.0/rules_go-v0.28.0.zip",
    ],
)
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
go_rules_dependencies()
go_register_toolchains(version = "1.16.5")

让我们逐步了解这段代码所做的事情。

首先,我们使用load指令来加载并提取新功能,以在 Bazel 文件当中能够使用该功能。我们调用了两次load指令,第一次用于导入下载 HTTP 代码库的能力,第二次则是从刚下载的代码库中加载特定于 Go 的命令。

对于导入本身,我们需要提供一个导入名称。通常的命名方案是:逆反域名,后面跟命名空间和项目名称;并需将/.全部都转换为下划线_。例如:github.com/user/project变成com_github_user_projectio_bazel_rules_go这个项目由于是Bazel官方项目中的一部分,所以它使用的是bazel.io而不是github.com

如果您并不熟悉 Bazel,那么,您需要了解到:实际的构建配置是通过BUILD文件完成的。我们可以将 Go 视为任何其他语言,并使用遵循相同结构的规则:go_binarygo_librarygo_test。我在我的 Github 上准备了一个最小化的例子:github.com/HappyCerber…。您会注意到,我们需要从导入的io_bazel_rules_go代码库中加载这些规则,以使其在BUILD文件中可用。

将现有项目转换为 Bazel 构建

现在我们知道,从头全新开始是很容易。但是,如果您已经有一个 Golang 项目,并且需要将其转换为 使用 Bazel 构建怎么办?为此,我们需要使用 Bazel 官方项目中提供的另一个工具 Gazelle ( github.com/bazelbuild/… )。

为了演示,我将使用一个第三方项目 ( github.com/aler9/rtsp-… ),我目前正在为即将到来的系统设计课程修改该项目。

首先,我们需要创建一个WORKSPACE文件,并从 Gazelle 代码库的设置部分复制粘贴代码。

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "io_bazel_rules_go",
    sha256 = "8e968b5fcea1d2d64071872b12737bbb5514524ee5f0a4f54f5920266c261acb",
    urls = [
        "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.28.0/rules_go-v0.28.0.zip",
        "https://github.com/bazelbuild/rules_go/releases/download/v0.28.0/rules_go-v0.28.0.zip",
    ],
)
http_archive(
    name = "bazel_gazelle",
    sha256 = "62ca106be173579c0a167deb23358fdfe71ffa1e4cfdddf5582af26520f1c66f",
    urls = [
        "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.23.0/bazel-gazelle-v0.23.0.tar.gz",
        "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.23.0/bazel-gazelle-v0.23.0.tar.gz",
    ],
)
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
go_rules_dependencies()
go_register_toolchains(version = "1.16.5")
gazelle_dependencies()

您会注意到,上述代码也导入了上一节中所提到的规则。

现在,要真正运行 Gazelle,我们需要将以下代码添加到我们的主BUILD文件中:

load("@bazel_gazelle//:def.bzl", "gazelle")
# gazelle:prefix github.com/aler9/rtsp-simple-server 
gazelle(name = "gazelle")

gazelle:prefix注释后面的路径是整个项目所使用的 Go 导入路径。例如,main.go中有以下包的导入:

import (
    "os"
    "github.com/aler9/rtsp-simple-server/internal/core"
)

至此,我们终于可以真正运行Gazelle,让它BUILD为我们的项目生成文件了。

bazel run //:gazelle

之后,我们应该BUILD自动生成项目的所有文件:

git status
On branch main
Your branch is up to date with 'origin/main'.
Untracked files:
  (use "git add <file>..." to include in what will be committed)
 BUILD
 WORKSPACE
 bazel-bin
 bazel-out
 bazel-test
 bazel-testlogs
 internal/aac/BUILD.bazel
 internal/conf/BUILD.bazel
 internal/confenv/BUILD.bazel
 internal/confwatcher/BUILD.bazel
 internal/core/BUILD.bazel
 internal/externalcmd/BUILD.bazel
 internal/h264/BUILD.bazel
 internal/hls/BUILD.bazel
 internal/logger/BUILD.bazel
 internal/rlimit/BUILD.bazel
 internal/rtcpsenderset/BUILD.bazel
 internal/rtmp/BUILD.bazel
nothing added to commit but untracked files present (use "git add" to track)

但是,如果您尝试使用bazel build //...命令构建项目,实际上您会看到许多关于未定义代码库的错误。这是因为我们仍然缺少项目依赖项的定义。然而,Gazelle 连这件事也可以为我们办好(to_macro参数是可选的):

bazel run //:gazelle -- update-repos -from_file=go.mod -to_macro=deps.bzl%go_dependencies

此命令将生成一个文件名为deps.bzl的新文件(如果我们在WORKSPACE中有使用repository_macro指令定义过,那么我们省略该to_macro指令),加载该文件,以导入构建项目所需的所有代码库。

load("@bazel_gazelle//:deps.bzl", "go_repository")
def go_dependencies():
    go_repository(
        name = "com_github_alecthomas_template",
        importpath = "github.com/alecthomas/template",
        sum = "h1:JYp7IbQjafoB+tBA3gMyHYHrpOtNuDiK/uB5uXxq5wM=",
        version = "v0.0.0-20190718012654-fb15b899a751",
    )
    go_repository(
        name = "com_github_alecthomas_units",
        importpath = "github.com/alecthomas/units",
        sum = "h1:UQZhZ2O0vMHr2cI+DC1Mbh0TJxzA3RcLoMsFw+aXw7E=",
        version = "v0.0.0-20190924025748-f65c72e2690d",
    )
    go_repository(
        name = "com_github_aler9_gortsplib",
        importpath = "github.com/aler9/gortsplib",
        sum = "h1:Bf0hzdN1jUWsb5Mzezq1pd18EIBeKXxk5clIpHZJ1Lk=",
        version = "v0.0.0-20210724151831-dae5a1f04033",
    )
    go_repository(
...

在这个代码库里,我实际上遇到了一个小问题。构建仍然是失败的,因为它导入的org_golang_x_tools被错误地推断为依赖项(通过从deps.bzl中删除它来修复这个问题)。您可以在我的项目分支:github.com/HappyCerber…上看到rtsp-simple-server的最终结果。

您可以在后续继续使用 Gazelle 来管理依赖项,这也是您可以将代码库引入基于 Bazel 的项目而无需实际转换它的方法:

bazel run //:gazelle -- update-repos github.com/some/repo

密封测试(Hermetic tests)

您可能会遇到的最后一个问题是密封测试。如果您看到测试因访问被拒绝、文件未找到或操作不允许失败而失败,那是因为 Bazel 强制执行密封测试。这意味着每个测试都必须完全独立并且独立于任何其他测试。

对于单元测试,任何文件都需要作为测试的依赖项提供并通过运行文件机制访问(github.com/bazelbuild/…)。

环境变量中提供了每个测试的临时目录,您将使用TEST_TMPDIR而不是传统的os.TempDir()函数。

密封集成和系统测试需要从一开始就仔细设计,因此转换现有的此类测试可能很棘手。遗憾的是,我在这里没有放之四海而皆准的建议。

虽然将您的测试转换为密封测试可能很烦人,但这是一项值得的努力,它将为您带来更好的测试可重复性和更低的易碎性。

原文 翻译自:Golang With Bazel

以上就是详解如何使用Bazel构建Golang程序的详细内容,更多关于Bazel构建Golang程序的资料请关注编程网其它相关文章!

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

详解如何使用Bazel构建Golang程序

下载Word文档到电脑,方便收藏和打印~

下载Word文档

猜你喜欢

详解如何使用Bazel构建Golang程序

这篇文章主要为大家介绍了如何使用Bazel构建Golang程序实例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-01-28

怎么使用Bazel构建Golang程序

本篇内容介绍了“怎么使用Bazel构建Golang程序”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!从头开始一个 Golang 项目让我们从
2023-07-05

如何使用Golang快速构建出命令行应用程序

这篇文章主要介绍了如何使用Golang快速构建出命令行应用程序的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇如何使用Golang快速构建出命令行应用程序文章都会有所收获,下面我们一起来看看吧。urfave/cl
2023-07-05

多阶段构建Golang程序Docker镜像方法详解

现在基本都是采用容器化部署方式,打包出的镜像体积越小越好,和程序运行无关的东西越少越好。所以打包Golang程序Docker镜像时,最好的做法是只将编译好的Golang程序二进制文件打包进镜像即可。
容器Golang2024-11-30

如何使用Webpack构建多页面程序

这篇文章给大家分享的是有关如何使用Webpack构建多页面程序的内容。小编觉得挺实用的,因此分享给大家做个参考,一起跟随小编过来看看吧。原理将每个页面所在的文件夹都看作是一个单独的单页面程序目录,配置多个entry以及html-webpac
2023-06-14

如何使用 PHP 构建单页应用程序

使用 php 构建单页应用程序 (spa) 的步骤:创建 php 文件,并加载 vue.js。定义 vue 实例,并创建包含文本输入和输出文本的 html 界面。创建包含 vue 组件的 javascript 框架文件。将 javascri
如何使用 PHP 构建单页应用程序
2024-05-04

Golang使用gob实现结构体的序列化过程详解

Golangstruct类型数据序列化用于网络传输数据或在磁盘上写入数据。在分布式系统中,一端生成数据、然后序列化、压缩和发送;在另一端,接收数据、然后解压缩、反序列化和处理数据,整个过程必须快速有效
2023-03-08

使用Golang函数构建响应式Web应用程序

答案: 可以使用 golang 函数构建响应式 web 应用程序,提供动态内容和交互式界面。详细描述:创建 go 函数,定义一个 http 处理程序来响应请求。运行应用程序以启动 http 服务器。添加响应式内容,使用 html/templ
使用Golang函数构建响应式Web应用程序
2024-05-02

使用Golang快速构建出命令行应用程序

在日常开发中,大家对命令行工具(CLI)想必特别熟悉了,如果说你不知道命令工具,那你可能是个假开发。每天都会使用大量的命令行工具,例如最常用的Git、Go、Docker等,这篇文章主要介绍了使用Golang快速构建出命令行应用程序,需要的朋友可以参考下
2023-02-24

使用 Golang 构建基于浏览器的应用程序

使用 golang 构建基于浏览器的应用程序golang 结合 javascript 构建了动态的前端体验。安装 golang:访问 https://golang.org/doc/install。设置 golang 项目:创建一个名为 ma
使用 Golang 构建基于浏览器的应用程序
2024-04-08

如何构建Rails3应用程序

本篇内容主要讲解“如何构建Rails3应用程序”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“如何构建Rails3应用程序”吧!大改动、小变化Rails 3中变动的数量太多,无法在此全部列出。◆一
2023-06-17

如何使用 Golang 构建 RESTful API 并使用gRPC?

使用 Golang 构建 RESTful API 和 gRPC在本文中,我们将介绍如何在 Golang 中创建 RESTful API 和 gRPC 服务。我们将涵盖基本的设置过程、使用框架和提供一个实战案例。RESTful API1
如何使用 Golang 构建 RESTful API 并使用gRPC?
2024-05-15

如何使用 Golang 构建 RESTful API 并使用 ORM?

使用 golang 构建 restful api 并使用 orm 涉及以下步骤:使用 gin 创建 api。安装并使用 gorm 作为 orm。定义数据模型并应用数据库迁移。创建增删改查 api 路由。使用 gorm 进行数据库操作。部署
如何使用 Golang 构建 RESTful API 并使用 ORM?
2024-05-15

如何使用ChatGPT构建一个Web应用程序?

围绕ChatGPT的最大卖点之一是它可以成为一种有效的编程工具。其想法是这样的:您用自然语言描述需求,该聊天机器人生成满足该需求的代码。但是ChatGPT在这方面到底有多好呢?

使用适用于 Windows 的 fyne 包构建 golang 应用程序

php小编小新在这篇文章中为大家介绍如何使用适用于 Windows 的 fyne 包构建 golang 应用程序。Fyne 是一个用于构建原生应用程序的易于使用的跨平台 GUI 工具包。它提供了简单的 API 和丰富的组件,使开发人员能够快
使用适用于 Windows 的 fyne 包构建 golang 应用程序
2024-02-12

如何使用C++构建单页Web应用程序?

使用c++++构建spa涉及:1. 安装emscripten并配置编译器;2. 运行构建脚本编译代码;3. 创建包含wasm模块的html界面;4. 部署spa到web服务器。使用C++构建单页Web应用程序单页Web应用程序 (SPA)
如何使用C++构建单页Web应用程序?
2024-05-13

如何使用 Golang 构建 RESTful API 并使用缓存?

在使用 golang 构建 restful api 时集成缓存:使用 gin 创建 api;集成 redis 缓存;定义一个缓存层来管理缓存值;在 gin 处理函数中使用缓存层从 redis 获取和设置数据。如何在使用 Golang 构建
如何使用 Golang 构建 RESTful API 并使用缓存?
2024-05-15

编程热搜

  • Python 学习之路 - Python
    一、安装Python34Windows在Python官网(https://www.python.org/downloads/)下载安装包并安装。Python的默认安装路径是:C:\Python34配置环境变量:【右键计算机】--》【属性】-
    Python 学习之路 - Python
  • chatgpt的中文全称是什么
    chatgpt的中文全称是生成型预训练变换模型。ChatGPT是什么ChatGPT是美国人工智能研究实验室OpenAI开发的一种全新聊天机器人模型,它能够通过学习和理解人类的语言来进行对话,还能根据聊天的上下文进行互动,并协助人类完成一系列
    chatgpt的中文全称是什么
  • C/C++中extern函数使用详解
  • C/C++可变参数的使用
    可变参数的使用方法远远不止以下几种,不过在C,C++中使用可变参数时要小心,在使用printf()等函数时传入的参数个数一定不能比前面的格式化字符串中的’%’符号个数少,否则会产生访问越界,运气不好的话还会导致程序崩溃
    C/C++可变参数的使用
  • css样式文件该放在哪里
  • php中数组下标必须是连续的吗
  • Python 3 教程
    Python 3 教程 Python 的 3.0 版本,常被称为 Python 3000,或简称 Py3k。相对于 Python 的早期版本,这是一个较大的升级。为了不带入过多的累赘,Python 3.0 在设计的时候没有考虑向下兼容。 Python
    Python 3 教程
  • Python pip包管理
    一、前言    在Python中, 安装第三方模块是通过 setuptools 这个工具完成的。 Python有两个封装了 setuptools的包管理工具: easy_install  和  pip , 目前官方推荐使用 pip。    
    Python pip包管理
  • ubuntu如何重新编译内核
  • 改善Java代码之慎用java动态编译

目录