如何使用 Bazel 构建 Go 项目

发表于 2年以前 | 总阅读数：500 次

# 1. Bazel产生的背景

1、开源成为当前软件开发的主旋律。哪怕你是商业软件，也逃离不了社区的包围。如何方便地获取依赖，并做到平滑升级很重要。如果构建工具能够很方便地获取源代码，那就太好了。

2、混合多语言编程成为一种选择。每种语言都有自己适用的场景，但是构建多语言的软件系统非常具有挑战性。例如，Python社区很喜欢搭配C/C++，高性能计算扔个Ｃ/C++，Python提供编程接口。如果构建工具能够无缝支持多语言构建，真的很方便。

3、代码复用。我只想复用第三方的一个头文件，而不是整个系统。拒绝拷贝是优秀程序员的基本素养，如果构建工具能帮我方便地获取到所依赖的组件，剔除不必要的依赖，那就太完美了。

4、增量构建。当只修改了一行代码，构建系统能够准确计算需要构建的依赖目标，而不是全构建；否则生命都浪费在编译上了。

5、云构建。大型软件公司，复用计算资源，可以带来巨大的收益。

# 2. 什么是Bazel

Bazel是一个支持多语言、跨平台的构建工具。Bazel支持任意大小的构建目标，并支持跨多个仓库的构建，是Google主推的一种构建工具。

bazel优点很多，主要有

构建快。支持增量编译。对依赖关系进行了优化，从而支持并发执行。
可构建多种语言。bazel可用来构建Java C++ Android ios等很多语言和框架，并支持mac windows linux等不同平台
可伸缩。可处理任意大小的代码库，可处理多个库，也可以处理单个库
可扩展。使用bazel扩展语言可支持新语言和新平台。

快(Fast)

Bazel的构建过程很快，它集合了之前构建系统的加速的一些常见做法。包括：

1、增量编译。只重新编译必须的部分，即通过依赖分析，只编译修改过的部分及其影响的路径。

2、并行编译。将没有依赖的部分进行并行执行，可以通过--jobs来指定并行流的个数，一般可以是你机器CPU的个数。遇到大项目马力全开时，Bazel能把你机器的CPU各个核都吃满。

3、分布式/本地缓存。Bazel将构建过程视为函数式的，只要输入给定，那么输出就是一定的。而不会随着构建环境的不同而改变（当然这需要做一些限制），这样就可以分布式的缓存/复用不同模块，这点对于超大项目的速度提升极为明显。

可伸缩(scalable)

Bazel号称无论什么量级的项目都可以应对，无论是超大型单体项目monorepo、还是超多库的分布式项目multirepo。Bazel还可以很方便的集成CD/CI ，并在云端利用分布式环境进行构建。

它使用沙箱机制进行编译，即将所有编译依赖隔绝在一个沙箱中，比如编译golang项目时，不会依赖你本机的GOPATH，从而做到同样源码、跨环境编译、输出相同，即构建的确定性。

跨语言(multi-language)

如果一个项目不同模块使用不同的语言，利用Bazel可以使用一致的风格来管理项目外部依赖和内部依赖。典型的项目如 Ray。该项目使用C++构建Ray的核心调度组件、通过Python/Java来提供多语言的API，并将上述所有模块用单个repo进行管理。如此组织使其项目整合相当困难，但Bazel在此处理的游刃有余，大家可以去该repo一探究竟。

可扩展(extensible)

Bazel使用的语法是基于Python裁剪而成的一门语言：Startlark。其表达能力强大，往小了说，可以使用户自定义一些rules（类似一般语言中的函数）对构建逻辑进行复用；往大了说，可以支持第三方编写适配新的语言或平台的rules集，比如rules go。 Bazel并不原生支持构建golang工程，但通过引入rules go ，就能以比较一致的风格来管理golang工程。

# 3. Bazel中的主要文件

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

WORKSPACE

1、定义项目根目录和项目名。

2、加载 Bazel 工具和 rules 集。

3、管理项目外部依赖库。

BUILD.bazel

存在于根目录以及源文件所在目录，用来标记源文件编译以及依赖情况，一般是自动生成。拿 go 来说，构建目标可以是 go_binary、go_test、go_library等。

自定义 rule (*.bzl)

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

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

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

配置项 .bazelrc

对于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

# 3. 使用Bazel部署go应用

1、安装Bazel

mac中直接通过brew安装

$ brew install Bazel

centos中的安装可参考 centos7安装bazel：https://blog.csdn.net/xavier_muse/article/details/93203093

2、安装gazelle

$ go get github.com/bazelbuild/bazel-gazelle/cmd/gazelle

手动通过Bazel部署go应用

创建go的运行文件

package main

import "fmt"

func main() {
    fmt.Println("hello world")
}

创建WORKSPACE文件

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

# download rules_go
http_archive(
    name = "io_bazel_rules_go",
    sha256 = "8663604808d2738dc615a2c3eb70eba54a9a982089dd09f6ffe5d0e75771bc4f",
    urls = [
        "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.23.6/rules_go-v0.23.6.tar.gz",
        "https://github.com/bazelbuild/rules_go/releases/download/v0.23.6/rules_go-v0.23.6.tar.gz",
    ],
)

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

go_rules_dependencies()

go_register_toolchains()

# download gazelle
http_archive(
    name = "bazel_gazelle",
    sha256 = "cdb02a887a7187ea4d5a27452311a75ed8637379a1287d8eeb952138ea485f7d",
    urls = [
        "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.21.1/bazel-gazelle-v0.21.1.tar.gz",
        "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.21.1/bazel-gazelle-v0.21.1.tar.gz",
    ],
)

# load gazelle
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies", "go_repository")

gazelle_dependencies()

创建BUILD.bazel文件

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

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

查看目录

test
├── BUILD.bazel
├── WORKSPACE
└── main.go

运行

$ bazel run //:test
DEBUG: /root/.cache/bazel/_bazel_root/1bc6a4d389355f502b77b0dd6dd1fdb4/external/bazel_tools/tools/cpp/lib_cc_configure.bzl:118:5: 
Auto-Configuration Warning: CC with -fuse-ld=gold returned 0, but its -v output didn't contain 'gold', falling back to the default linker.
INFO: Analyzed target //:test (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //:test up-to-date:
  bazel-bin/linux_amd64_stripped/test
INFO: Elapsed time: 0.254s, Critical Path: 0.00s
INFO: 0 processes.
INFO: Build completed successfully, 1 total action
INFO: Build completed successfully, 1 total action
hello world

成功输出hello world

使用gazelle自动生成BUILD.bazel文件

在实际的项目中，里面的BUILD.bazel我们肯定是使用工具自动生成的，来看下如何自动生成的

创建t1和t2两个文件夹，写入两个文件

package main

import "fmt"

func main() {
    fmt.Println("hello t1")
}

在项目的根目录的BUILD.bazel中配置加载并配置Gazelle

load("@bazel_gazelle//:def.bzl", "gazelle")
# gazelle:prefix test  
gazelle(name = "gazelle")

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

查看下目录

test
├── BUILD.bazel
├── WORKSPACE
├── main.go
├── t1
│   └── main.go
└── t2
    └── main.go

在根目录下面执行bazel run //:gazelle

test
├── BUILD.bazel
├── main.go
├── t1
│   ├── BUILD.bazel
│   └── main.go
├── t2
│   ├── BUILD.bazel
│   └── main.go
└── WORKSPACE

发现对应的目录下面已经生成了我们需要的BUILD.bazel文件

在根目录下,运行下

$ bazel run t1:t1
INFO: Analyzed target //t1:t1 (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //t1:t1 up-to-date:
  bazel-bin/t1/t1_/t1
INFO: Elapsed time: 0.486s, Critical Path: 0.33s
INFO: 3 processes: 1 internal, 2 darwin-sandbox.
INFO: Build completed successfully, 3 total actions
INFO: Build completed successfully, 3 total actions
hello t1