Bazel

最新推荐文章于 2024-05-12 10:02:00 发布
最新推荐文章于 2024-05-12 10:02:00 发布
阅读量2.6k 收藏 8
点赞数 2
分类专栏： Go
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ayqy42602/article/details/108378427
版权

bazel：是一个可以快速构建和测试任意规模软件的编译工具，能够用来编译大部分语言。Bazel使用分布式缓存和增量构建方法，使得编译更加快速。

Bazel 主要文件
使用 Bazel 管理的项目一般包含以下几种 Bazel 相关的文件：WORKSPACE，BUILD(.bazel)，.bzl 和 .bazelrc 等。其中 WORKSPACE 和 .bazelrc 放置于项目的根目录下，BUILD.bazel 放项目中的每个文件夹中（包括根目录）， .bzl 文件可以根据用户喜好自由放置，一般可放在项目根目录下的某个专用文件夹（比如 build）中。

WORKSPACE

1.定义项目根目录和项目名。
2.加载 Bazel 工具和 rules 集。
3.管理项目外部依赖库。

# 加载bazel标准库中的函数http_archive
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# 调用http_archive下载rules_go
http_archive(
    name = "io_bazel_rules_go",
    # 下面两项需要根据官方的最近版本来修改
    urls = ["https://github.com/bazelbuild/rules_go/releases/download/0.16.1/rules_go-0.16.1.tar.gz"],
    sha256 = "f87fa87475ea107b3c69196f39c82b7bbf58fe27c62a338684c20ca17d1d8613",
)

# 获取gazelle
http_archive(
    name = "bazel_gazelle",
    # 同样需要根据官方最新版本修改
    urls = ["https://github.com/bazelbuild/bazel-gazelle/releases/download/0.15.0/bazel-gazelle-0.15.0.tar.gz"],
    sha256 = "6e875ab4b6bf64a38c352887760f21203ab054676d9c1b274963907e0768740d",
)

# 从rules_go中加载go_rules_dependencies,go_register_toolchains
load("@io_bazel_rules_go//go:def.bzl", "go_rules_dependencies", "go_register_toolchains")

# 加载rules_go依赖
go_rules_dependencies()

# 加载rules_go工具
go_register_toolchains()

# 从gazelle中加载gazelle_dependencies
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")

# 加载gazelle依赖
gazelle_dependencies()

BUILD.(bazel)
该文件主要针对其所在文件夹进行依赖解析（label）和目标定义（bazel target）。拿 go 来说，构建目标可以是 go_binary、go_test、go_library 等。

Bazel 的之前版本用的文件名是 BUILD ，但是在一些大小写不区分的系统上，它很容易跟 build 文件混淆，因此后来改为了显式的 BUILD.bazel 。如果项目中同时存在两者，Bazel 更倾向于使用后者。对于所有的新项目，都推荐使用显式的 BUILD.bazel。

为了引用一个依赖，Bazel 使用 label 语法对所有的包进行唯一标识，其格式如下：

@workerspace_name//path/of/package:target

比如，go 中常用的一个日志库 logrus 的 label 为：

@com_github_sirupsen_logrus//:go_default_library

如果是本项目中的包路径，可以将 // 之前的 workspace 名字省去。

自定义 rule (*.bzl)
如果你的项目有一些复杂构造逻辑、或者一些需要复用的构造逻辑，那么可以将这些逻辑以函数形式保存在 .bzl 文件，供 WORKSPACE 或者 BUILD 文件调用。其语法跟 Python 类似：

def third_party_http_deps():
    http_archive(
        name = "xxxx",
        ...
    )

    http_archive(
        name = "yyyy",
        ...
    )

配置项 .bazelrc
其中 rc 后缀的命名方式是个计算机中经典的小习俗，感兴趣可以看看 StackOverflow 这个回答。简单的说，该文件用来配置对应的命令运行时的一些参数。常见的如 .vimrc，.bashrc 等。

对于 Bazel 来说，如果某些构建动作都需要某个参数，就可以将其写在此配置中，从而省去每次敲命令都重复输入该参数。举个 Go 的例子：由于国情在此，构建、测试和运行时可能都需要 GOPROXY，则可以配置如下：

# set GOPROXY
test --action_env=GOPROXY=https://goproxy.io
build --action_env=GOPROXY=https://goproxy.io
run --action_env=GOPROXY=https://goproxy.io

Bazel 构建 golang 项目

在有了上面 Bazel 的基础知识后，构建 golang 项目还需要了解两个概念：rules_go 和 bazel gazelle。
rules_go
rules_go 是一个 Bazel 的扩展包，Bazel 可以编译 Go。它由一系列的 rule 构成，包括 go_libray\go_binary\go_test，支持 vendor、交叉编译；可以方便集成 protobuf 、cgo 、gogo、nogo等工具。

它会在 Bazel 的沙箱中进行编译，不依赖本地 GOROOT/GOPATH，而是自动下载对应 Go 版本，从而可以在不同平台上进行一致性的编译。

bazel gazelle
Gazelle 是一个自动生成 Bazel 编译文件工具，包括给 WORKSPACE 添加外部依赖、扫描源文件依赖自动生成 BUILD.bazel 文件等。Gazelle 原生支持 Go 和 protobuf，当然可以通过扩展来支持其他语言和规则。Gazelle 可以使用 bazel 命令结合 gazelle rule 运行，也可以下载使用单独的 Gazelle 的命令行工具。

  1. 自动添加外部依赖
    用 bazel run //:gazelle update-repos repo-uri 可以从 go.mod 导入对应依赖包。
    比如想要往项目中增加 Kafka 的 segmentio 的 go client 包，只需要在项目根目录下执行命令： bazel run //:gazelle update-repos github.com/segmentio/kafka-g
    Gazelle 便会自动增加一条依赖到 WORKSPACE 文件：
go_repository(
    name = "com_github_segmentio_kafka_go",
    importpath = "github.com/segmentio/kafka-go",
    sum = "h1:Mv9AcnCgU14/cU6Vd0wuRdG1FBO0HzXQLnjBduDLy70=",
    version = "v0.3.4",
)
  1. 自动生成构建文件
    Gazelle 能够自动生成每个目录下的 BUILD.bazel 文件，只需要简单的两步：
    (1)在项目根目录的 BUILD.bazel 中配置加载并配置 Gazelle：
    load("@bazel_gazelle//:def.bzl", "gazelle")
    # gazelle:prefix your/project/url    
    gazelle(name = "gazelle")

需要注意的是 # 后面的内容对于 Bazel 而言是注释，对于 Gazelle 来说却是一种语法，会被 Gazelle 运行时所使用。当然 Gazelle 除了可以通过 bazel rule 运行，也可以单独在命令行中执行。

(2)在根目录下执行 bazel run //:gazelle

一些实践
Bazel 有一些比较实用的实践，比如使用 http_archive 下载确定版本的外部依赖包、使用 stamp 变量注入、打包和发布等等。可以多去一些有很好的 Bazel 构建项目实践的开源项目中去看看：

github.com/kubernetes/test-infra（go 语言项目最佳实践，比较全面的 bazel 深度使用）
github.com/kubernetes/repo-infra（go 语言项目最佳实践，配置和脚本非常精妙）

1. 创建工作空间WORKSPACE和BUILD.bazel:
在使用bazel的时候，需要先创建一个WORKSPACE文件在你的项目根目录，表示这是bazel的工作空间，后续所有的配置都是基于这个目录来的。
要在当前 project 的根目录下创建 WORKSPACE 和 BUILD.bazel 文件。其中 WORKSPACE 文件用于设置加载 Bazel 环境（包括rules）和相关依赖。
创建一个WORKSPACE文件 添加以下内容：

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "io_bazel_rules_go",
    urls = [
        "https://storage.googleapis.com/bazel-mirror/github.com/bazelbuild/rules_go/releases/download/0.19.0/rules_go-0.19.0.tar.gz",
        "https://github.com/bazelbuild/rules_go/releases/download/0.19.0/rules_go-0.19.0.tar.gz",
    ],
    sha256 = "9fb16af4d4836c8222142e54c9efa0bb5fc562ffc893ce2abeac3e25daead144",
)

load("@io_bazel_rules_go//go:deps.bzl", "go_rules_dependencies", "go_register_toolchains")

go_rules_dependencies()
go_register_toolchains()

这里面的内容不需要手写啊，你去https://github.com/bazelbuild/rules_go/releases 复制过来就好了。

然后创建一个BUILD.bazel文件，添加一下内容：

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

go_binary(
    name = "go_default_library",
    srcs = ["main.go"],
    importpath = "test",
    visibility = ["//visibility:private"],
)

2. 编写main.go
配置了上面的东西之后，我们在项目目录下创建一个main.go的文件，内容如下：

package main

import "fmt"

func main() {
	fmt.Println("hello go!!!!")
}

当前的目录结构：
在这里插入图片描述
非常简单，只有3个文件，然后我们看下怎么用bazel来运行这个go程序。

在项目的根目录下执行一下命令：

bazel run //:go_default_library

如果你是第一次跑的话可能会需要一点时间：
在这里插入图片描述

3. 使用gazelle自动生成BUILD.bazel文件
上面看到了，我们需要手写BUILD.bazel？那如果大项目包很多的话，不是要写到吐血？下面就来说下，怎么用gazelle这个工具来自动给每个包生成一个BUILD.bazel的文件。

需要添加gazelle这个工具到我们的WORKSPACE文件中。

# 加载bazel标准库中的函数 http_archive
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
# 调用http_archive下载rules_go
http_archive(
    name = "io_bazel_rules_go",
    # 下面两项需要根据官方的最近版本来修改
    urls = ["https://github.com/bazelbuild/rules_go/releases/download/0.16.1/rules_go-0.16.1.tar.gz"],
    sha256 = "f87fa87475ea107b3c69196f39c82b7bbf58fe27c62a338684c20ca17d1d8613",
)
# 获取gazelle
http_archive(
    name = "bazel_gazelle",
    # 同样需要根据官方最新版本修改
    urls = ["https://github.com/bazelbuild/bazel-gazelle/releases/download/0.15.0/bazel-gazelle-0.15.0.tar.gz"],
    sha256 = "6e875ab4b6bf64a38c352887760f21203ab054676d9c1b274963907e0768740d",
)
# 从rules_go中加载go_rules_dependencies,go_register_toolchains
load("@io_bazel_rules_go//go:def.bzl", "go_rules_dependencies", "go_register_toolchains")
# 加载rules_go依赖
go_rules_dependencies()
# 加载rules_go工具
go_register_toolchains()
# 从gazelle中加载gazelle_dependencies
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
# 加载gazelle依赖
gazelle_dependencies()

然后修改跟目录下的BUILD.bazel文件内容如下：

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

# gazelle:prefix your_project_name
gazelle(name = "gazelle")

然后运行以下命令：

bazel run //:gazelle

构建
1.使用gazelle生成build文件
2.使用生成的build文件构建项目代码

使用gazelle自动生成build文件
bazel run //:gazelle

#使用生成的build文件构建
#构建根目录下所有target
bazel build //...
#构建特定taget
bazel build //path/of/target:target_name

Golang项目bazel指北:
https://zhuanlan.zhihu.com/p/52155083
使用bazel编译go项目
https://juejin.im/post/6844903892757528590
使用 Bazel 构建 Golang 项目
https://blog.didiyun.com/index.php/2019/03/27/bazel-golang/
Bazel 构建 golang 项目
https://zhuanlan.zhihu.com/p/95998597

y果子
关注
  • 2
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
带你深入AI（6）- 详解bazel
谢杨易的博客
04-27 2万+
1 Bazel简介bazel是Google开源的一套编译构建工具，广泛应用于Google内部，包括TensorFlow项目。修改TensorFlow内部源码，需要使用bazel来编译，故有必要了解下bazel。bazel优点很多，主要有 构建快。支持增量编译。对依赖关系进行了优化，从而支持并发执行。 可构建多种语言。bazel可用来构建Java C++ Android ios等很多语言和框架，并支持
bazel介绍以及其发展历史
m0_74043383的博客
09-02 1134
Bazel Google开源的，是一款与 Make、Maven 和 Gradle 类似的开源构建和测试工具。它使用人类可读的高级构建语言。Bazel 支持多种语言的项目，可为多个平台构建输出。Bazel支持任意大小的构建目标，并支持跨多个代码库和大量用户的大型代码库。是Google主推的一种构建工具。
推荐项目：Gazelle - 强大的BitTorrent追踪器Web框架
最新发布
gitblog_00081的博客
05-12 294
推荐项目：Gazelle - 强大的BitTorrent追踪器Web框架 项目地址:https://gitcode.com/WhatCD/Gazelle 项目介绍 Gazelle是一个专为私人BitTorrent追踪器设计的Web框架，其核心是音乐分享，但具备足够的灵活性以适应各种需求。该项目采用PHP、JavaScript和MySQL进行编写，旨在提供高效且可定制的文件共享体验。 项目技术分析 ...
【Bazel】Bazel 学习笔记
unonoi的博客
11-14 550
记录 Bazel 使用过程中的一些知识点。
bazel使用教程 转
TyearLin的专栏
07-15 1058
MediaPipe bazel
hello：bazel
m0_46900715的博客
11-11 1127
Bazel是什么： bazel是一个工程编译工具。 Bazel的特点： 它适合构建和测试拥有庞大代码库的项目，用（多种）需要编译的语言写的项目，在多平台上部署的项目，及有大量测试的工程的项目。 bazel可以成倍的提高构建速度，因为它只重新编译需要重新编译的文件，所以，对于没有发生变化的文件，它是不会对其进行重新编译的。当然为了能够让bazel很好的识别哪些文件是增量文件，在BUILD文件中，每个库，测试程序，二进制文件必须明确完整地指定直接依赖。当修改源代码文件后，Baze...
bazel源文件
11-23
**bazel源文件详解** Bazel是Google开源的一款构建工具，用于管理大型代码库的编译和测试。它提供了一种声明式构建语言，能够跨多种编程语言和操作系统工作，确保构建过程的一致性和可重复性。在描述中提到的"bazel...
bazel-3.7.2-windows-x86_64.exe.zip
02-13
标题中的“bazel-3.7.2-windows-x86_64.exe.zip”表明这是一个包含Bazel构建工具的Windows 64位版本的压缩文件，版本号为3.7.2。Bazel是由Google开发的一款开源的、跨平台的自动化构建和测试工具，它能够帮助开发者...
bazelbuild-example
04-03
标题 "bazelbuild-example" 暗示我们讨论的是一个使用 Bazel 构建工具的示例项目。Bazel 是谷歌开发的一款开源构建工具，它能够处理多种编程语言的项目，提供跨平台的构建和测试能力。这个示例很可能是为了帮助...
bazel-0.15.0.zip
04-27
`bazel-0.15.0.zip` 是一个包含Bazel构建工具的压缩包，该版本与TensorFlow 1.12.0兼容。Bazel是由Google开发的一款开源的自动化构建和测试工具，它允许开发者在多种语言和平台上管理大型代码库。在本文中，我们将...
node-http-archive:HTTP 存档 (HAR)
06-19
http-归档 通过安装 $ npm install http-archive 用法 var HAR = require ( 'http-archive' )
bazel-0.8.0
12-04
描述提到的"bazel-0.8.0-dist.zip"是一个包含Bazel源码的压缩文件，可能包含了编译Bazel所需的所有依赖和脚本。用户在国内下载可能较为困难，提示解压后执行"./compile"来编译安装。 **标签"Bazel"** Bazel是...
Bazel教程
热门推荐
YongqiangGao的专栏
08-19 5万+
Bazel的安装bazel支持的平台有Ubuntu linux、Mac OS X、Windows等，本教程基于Ubuntu14.04下的bazel，其它平台的安装参考官网安装教程。Ubuntu下bazel的安装可以用以下方式： - 传统的API库安装（推荐） - 二进制安装 - 源代码编译安装传统的API库安装： *1.安装JDK 8* 如果你的环境是Ubuntu15
bazel
郭云飞的专栏
09-20 8681
----什么是bazel---- Bazel可以快速地构建可靠的代码，谷歌的大多数软件都是由它来构建，因此，在谷歌的开发环境里，它主要负责处理代码构建相关问题：大规模数据构建问题，共享代码库问题，从源代码构建的软件的相关问题。
Tensorflow 离线安装跳坑总结
may0324的博客
12-01 3万+
TensorFlow作为目前最被看好的深度学习开源框架，又顶着Google爸爸的光环，使得很多CNN网络的部署都基于此框架。最近开始研究GAN（生成对抗网络），鉴于大部分源码都基于TensorFlow，theano，torch等Python框架，为了顺应时代潮流，开始学习Tensorflow，此篇记录了一下安装过程中的坑，供以后翻阅。 其实总体来说，Tensorflow作为Google荣誉出品的框
Bazel入门2：C++编译常见用例
elaine_bao的专栏
11-29 1万+
1. 在一个target中包含多个文件可以利用glob在单个target中包含多个文件，例如：cc_library( name = "build-all-the-files", srcs = glob(["*.cc"]) hdrs = glob(["*.h"]), )在这个target中，Bazel会编译BUILD文件所在目录下的所有.cc和.h文件（不包括子目录）。2.in
【编译工具】Bazel
liudongdong_jlu
08-28 587
Bazel builds software from source code organized in a directory called a workspace. Source files in the workspace are organized in a nested hierarchy of packages, where each package is a directory that contains a set of related source files and one BUILD .
bazel build //:go
Go中国
05-24 5653
作者简介 何 源古典互联网从业者2014年底加入英语流利说，目前主要负责 Platform Team。来流利说工作之前，在 the Plant 杭州工作。内容大纲1.程...
install bazel
02-26
Bazel是一个用于构建和测试软件的源构建工具。它支持多种编程语言，并提供了高效、可扩展和可靠的构建系统。 要安装Bazel，您可以按照以下步骤进行操作： 1. 首先，确保您的系统满足Bazel的要求。Bazel支持Linux、macOS和Windows操作系统。您可以在Bazel官方文档中找到详细的系统要求。 2. 下载Bazel安装包。您可以从Bazel官方网站（https://bazel.build/）下载适用于您操作系统的安装包。选择与您的操作系统和架构相对应的版本。 3. 安装Bazel。根据您的操作系统，执行相应的安装步骤。 - 在Linux上，您可以运行以下命令进行安装： ``` chmod +x <bazel-installer> sudo ./<bazel-installer> --user ``` - 在macOS上，您可以运行以下命令进行安装： ``` chmod +x <bazel-installer> ./<bazel-installer> --user ``` - 在Windows上，您可以运行安装程序并按照提示进行安装。 4. 验证安装。打开终端或命令提示符窗口，并运行以下命令来验证Bazel是否成功安装： ``` bazel version ``` 如果成功安装，您将看到Bazel的版本信息。 这是安装Bazel的基本步骤。您可以根据需要进一步配置和使用Bazel来构建和测试您的软件项目。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值