bazel构建cpp项目

最近用到了bazel构建cpp，由于bazel构建不是官网文档有些细节不是很清楚，这里做个自己实践的记录。这里有关bazel构建过程都是在Ubuntu系统下做的实践，CentOS之前也做过同样的实验，出现了一些莫名错误。

这里bazel的软件包安装过程需要连接外网才能正确安装，建议先解决网络问题。

首先是安装bazel，这里给出bazel官网安装指南链接

https://bazel.build/install/ubuntu

基础的bazel命令及bazel构建基础sample请参考

官方：https://bazel.build/tutorials/cpp

官方示例项目:

git clone https://github.com/bazelbuild/examples

下面主要说明bazel构建依赖外部仓库

阶段1：依赖本地仓库（源码）

我们尝试将 Eigen3 源代码作为一个本地外部仓库，我们的项目将依赖这个仓库。实现这一点需要使用工作空间规则。Eigen3 并不是一个 Bazel仓库，因此使用 new_local_repository 规则 (如果外部依赖是一个 Bazel 仓库，则使用 local_repository 规则)。

下载 Eigen3 源代码 (例如 eigen-3.4.0.tar.gz) 并解压 (例如解压到 /home/username/app/eigen3)

目录结构如下：

local_deps
├── main
│   ├── BUILD
│   └── main.cc
├── eigen3
│   └── BUILD
└── WORKSPACE

在 eigen3/BUILD 文件中建立以下构建规则：

EIGEN3_HEADERS = glob([
    "Eigen/*",
])
EIGEN3_SOURCES = glob([
    "Eigen/**/src/**/*.h",
])
 
cc_library(
    name = "eigen3",
    hdrs = EIGEN3_HEADERS,
    srcs = EIGEN3_SOURCES,
    visibility = ["//visibility:public"],
)

函数 glob 可以帮助我们匹配满足路径格式的文件，其详细使用方法与路径格式的书写规则可见官方文档；cc_library 中参数 visibility = ["//visibility:public"] 表明该库对所有包可见。

在 WORKSPACE 文件建立规则中引入外部仓库 (假设 Eigen3 源代码解压到了 /home/username/app/eigen3 目录)：

new_local_repository(
    name = "eigen3",
    path = "/home/username/app/eigen3",
    build_file = "eigen3/BUILD",
)

参数 build_file 是相对于主仓库的路径或绝对路径，关于 new_local_repository 详细使用方法与参数说明可见new_local_repository官方文档。

在 main/BUILD 文件中建立以下构建规则：

cc_binary(
    name = "main",
    srcs = ["main.cc"],
    deps = ["@eigen3//:eigen3"],
)

注意标签 @eigen3//:eigen3 中 // 后直接加 : 是 build_file 参数指定文件中的规则。

在根目录 local-deps 下使用以下命令构建项目：

bazel build //main

效果如下图，这里是采用外部源码引入方式进行构建。

 

阶段2：依赖本地仓库（库）

可能更多情况下，我们所依赖的项目是使用外部仓库但是不含源文件，而是库文件，那么我们应该怎么使用bazel进行构建呢？

这里我们尝试使用谷歌的glog作为一个外部非源码的仓库进行构建。

下载glog源码 (例如 glog-v0.5.0.tar.gz)，进行编译，安装放在/home/username/app/glog-build-0.5.0

glog编译安装可详见（我这里采用cmake进行构建的）：

https://github.com/google/glog#building-glog-with-cmake

# download
git clone https://github.com/google/glog.git -b v0.5.0
cd glog
 
# build glog project
cmake -S . -B build -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=$HOME/app/glog-build-0.5.0
 
# compile
cmake --build build
 
# optional test
cmake --build build --target test
 
# install
cmake --build build --target install

目录结构如下：

local_dynamic_deps
├── main
│   ├── BUILD
│   └── main.cc
├── glog-build
│   └── glog_linux.BUILD
└── WORKSPACE

在 glog-build/glog_linux.BUILD 文件中建立以下构建规则，这里采用

cc_library(
    name = "glog-build",
    srcs = glob(
        [
             "lib/libglog.so.0", 
        ],
    ),
    hdrs = glob(
         [
              "include/glog/*.h",
         ]),
    includes = ["include",], # ["include"],
    linkstatic= 1,
    visibility = ["//visibility:public"],
)

这里采用cc_library进行外部构建（默认使用静态内部构建）引入，通过includes设置引入的头文件搜索路径，hdrs设置头文件，srcs设置库文件，这里为什么要设置为so.0呢？我们可以看一下glog库文件

发现libglog.so.0.5.0的soname为libglog.so.0，这里不再赘述了，详细的解释再我另一篇里面有详细介绍。传送门：Linux程序cmake编译链接动态库版本号的问题_笑傲江湖的小白的博客-CSDN博客

 在 WORKSPACE 文件建立规则中引入外部仓库 (假设 glog 安装到了 /home/username/app/glog-build-0.5.0 目录)：

new_local_repository(
    name = "glog-build",
    path = "/home/username/app/glog-build-0.5.0",
    build_file = "glog-build/glog_linux.BUILD",
)

参数 build_file 是相对于主仓库的路径或绝对路径，关于 new_local_repository 详细使用方法与参数说明可见new_local_repository官方文档。

在 main/BUILD 文件中建立以下构建规则，引入glog-build规则依赖

cc_binary(
    name = "hello-glog",
    srcs = ["main.cc"],
	deps = ["@glog-build//:glog-build"]
)

注意标签 @glog-build//:glog-build 中 // 后直接加 : 是 build_file 参数指定文件中的规则。注意这里我们使用的name为 hello-glog

main.cc的源代码，打印最简单的一条INFO日志级别的log

#include <glog/logging.h>
 
int main(int argc, char* argv[]) {
    // Initialize Google’s logging library.
 
    google::InitGoogleLogging(argv[0]);
    FLAGS_stderrthreshold=google::INFO;
    // ...
    LOG(INFO) << "Found " << "num_cookies" << " cookies";
}

在根目录 local-dynamic-deps下使用以下命令构建项目：

bazel build //main:hello-glog

效果如下图，这里是采用外部编译动态库引入方式进行构建。

 

 

至此我们就完成了本地外部依赖库的构建。

 阶段3：依赖远程仓库

依赖远程仓库是Bazel 自动去获取特定版本的远程仓库。使用 http_archive 函数实现远程仓库的获取，注意该函数需要事先通过 load 导入。

这里我们使用eigen3来说明，这里通过版本前缀来保证获取指定的版本软件包。

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 
EIGEN_COMMIT = "12e8d57108c50d8a63605c6eb0144c838c128337"
EIGEN_SHA256 = "f689246e342c3955af48d26ce74ac34d21b579a00675c341721a735937919b02"
 
http_archive(
    name = "eigen3",
    build_file = "//eigen3:BUILD",
    sha256 = EIGEN_SHA256,
    strip_prefix = "eigen-{commit}".format(commit = EIGEN_COMMIT),
    urls = [
                
"https://storage.googleapis.com/mirror.tensorflow.org/gitlab.com/libeigen/eigen/-/archive/{commit}/eigen-{commit}.tar.gz".format(commit = EIGEN_COMMIT),
        "https://gitlab.com/libeigen/eigen/-/archive/{commit}/eigen-{commit}.tar.gz".format(commit = EIGEN_COMMIT),
    ],
)

项目结构为：

googletest-demo
├── hello_test
│   ├── BUILD
│   └── hello_test.cc
└── WORKSPACE

在hello_test/BUILD中构建规则。

cc_test(
  name = "hello_test",
  size = "small",
  srcs = ["hello_test.cc"],
  deps = ["@com_google_googletest//:gtest_main"],
)

这里可以看到hello_test依赖了gtest中的gtest_main规则。

hello_test.cc的源文件内容：

#include <gtest/gtest.h>
 
// Demonstrate some basic assertions.
TEST(HelloTest, BasicAssertions) {
  // Expect two strings not to be equal.
  EXPECT_STRNE("hello", "world");
  // Expect equality.
  EXPECT_EQ(7 * 6, 42);
}

在 WORKSPACE 文件建立规则中引入外部仓库 ，这里默认会下载到$HOME缓存的.cache下面的externel中，这里使用strip_prefix来设置跳过冗长的前缀名。

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 
http_archive(
  name = "com_google_googletest",
  urls = ["https://github.com/google/googletest/archive/609281088cfefc76f9d0ce82e1ff6c30cc3591e5.zip"],
  strip_prefix = "googletest-609281088cfefc76f9d0ce82e1ff6c30cc3591e5",
)

在根目录 googletest-demo下使用以下命令构建项目：

bazel test --test_output=all //hello_test:hello_test

效果如下图：

 至此常用的几种外部依赖构建都已梳理完毕！

之前在centOS7下测试gtest同样的示例出现错误。

这里也贴一下吧，希望有知道怎么解决的大佬告知一下如何解决。