C++ `build2`：基于模块的现代 C++ 构建系统探索

好的，各位观众老爷，欢迎来到“C++ build2：模块化C++航海指南”讲座现场！今天咱们不讲玄学，只讲如何用build2这个现代C++构建系统，让你的代码“模块化”起飞，告别“编译即爆炸”的噩梦。

开场白：C++构建的那些痛

话说C++构建系统，那绝对是个让人头疼的话题。Makefile写到头秃，CMake配置到崩溃，Autotools更是仿佛来自上古时代。更别提各种依赖管理，简直是乱成一锅粥。

想象一下，你写了一个超赞的库，想分享给世界，结果别人拿到手，发现光是配置编译环境就得花三天三夜，这谁顶得住啊？

所以，我们需要一个更现代、更智能、更友好的C++构建系统，它不仅能帮我们管理依赖，还能让我们轻松地构建模块化的代码。这就是build2登场的原因。

Build2：C++ 构建界的救星？

Build2，顾名思义，就是第二代构建系统（当然，这只是我猜的）。它主要解决以下问题：

• 依赖地狱： 自动下载、构建、管理依赖。再也不用手动安装一堆库了。
• 模块化： 鼓励模块化设计，让你的代码更清晰、更易维护。
• 跨平台： 支持Windows、Linux、macOS等主流平台。
• 可扩展： 可以通过自定义构建步骤和规则来满足特殊需求。
• 性能： 旨在提供快速、高效的构建体验。

简而言之，build2试图让你专注于代码，而不是浪费时间在构建配置上。

Build2基础：从Hello World开始

让我们先来一个最简单的例子，看看build2的基本结构。

1. 安装Build2：

   这个因平台而异，请参考官方文档：https://build2.org/ 通常，Linux可以通过包管理器安装，Windows需要下载预编译包，macOS可以使用 Homebrew。

2. 创建项目目录：

   mkdir hello_world
   cd hello_world

3. 创建buildfile：

   这是build2的核心配置文件，类似于Makefile或CMakeLists.txt。

   # buildfile
   
   project(hello_world)
   
   executable(hello_world) : hello_world.cxx

   这个buildfile做了什么？

   • project(hello_world): 定义项目名称为hello_world。
   • executable(hello_world) : hello_world.cxx: 定义一个可执行文件，名为hello_world，源代码是hello_world.cxx。

4. 创建hello_world.cxx：

   // hello_world.cxx
   
   #include <iostream>
   
   int main() {
      std::cout << "Hello, world!" << std::endl;
      return 0;
   }

5. 构建和运行：

   b
   ./bin/hello_world

   b命令是build2的构建命令。它会读取buildfile，编译源代码，并生成可执行文件。

   运行结果：

   Hello, world!

   恭喜你，完成了第一个build2项目！

模块化：Build2的灵魂

Build2鼓励模块化开发，这让大型项目更易于管理。让我们来创建一个稍微复杂点的例子，包含一个库和一个可执行文件。

1. 创建项目目录：

   mkdir my_project
   cd my_project

2. 创建目录结构：

   my_project/
   ├── lib/
   │   └── hello/
   │       ├── hello.cxx
   │       └── buildfile
   └── app/
      ├── main.cxx
      └── buildfile
   └── buildfile

   • lib/hello/: 包含一个名为hello的库。
   • app/: 包含一个使用hello库的可执行文件。
   • 根目录的buildfile：顶级构建文件，用于定义整个项目。

3. 编写lib/hello/hello.cxx：

   // lib/hello/hello.cxx
   
   #include "hello.hxx"
   #include <iostream>
   
   void hello::say_hello(const std::string& name) {
      std::cout << "Hello, " << name << "!" << std::endl;
   }

4. 编写lib/hello/hello.hxx：

   // lib/hello/hello.hxx
   
   #ifndef HELLO_HXX
   #define HELLO_HXX
   
   #include <string>
   
   namespace hello {
      void say_hello(const std::string& name);
   }
   
   #endif

5. 编写lib/hello/buildfile：

   # lib/hello/buildfile
   
   library(hello) : hello.cxx

   这个buildfile定义了一个名为hello的静态库。

6. 编写app/main.cxx：

   // app/main.cxx
   
   #include "hello/hello.hxx"
   
   int main() {
      hello::say_hello("World");
      return 0;
   }

7. 编写app/buildfile：

   # app/buildfile
   
   executable(my_app) : main.cxx
   {
      depends: ../lib/hello
   }

   这个buildfile定义了一个名为my_app的可执行文件，并且依赖于../lib/hello库。

8. 编写根目录的buildfile：

   # buildfile
   
   project(my_project)
   
   subproject(lib/hello)
   subproject(app)

   这个buildfile定义了项目名称，并包含了两个子项目：lib/hello和app。

9. 构建和运行：

   b
   ./bin/my_app

   运行结果：

   Hello, World!

   在这个例子中，我们将代码分成了两个模块：hello库和my_app可执行文件。app模块依赖于hello模块。这种模块化的结构使得代码更易于理解和维护。

Build2 依赖管理：告别手动配置

Build2最强大的功能之一就是依赖管理。它可以自动下载、构建和管理第三方库。

1. 使用manifest文件：

   Build2使用manifest文件来声明项目的依赖。manifest文件通常位于项目的根目录。

   my_project/
   ├── lib/
   │   └── hello/
   │       ├── hello.cxx
   │       └── buildfile
   └── app/
      ├── main.cxx
      └── buildfile
   └── buildfile
   └── manifest

2. 声明依赖：

   假设我们要使用boost::format库，需要在manifest文件中添加以下内容：

   # manifest
   
   depends: boost >= 1.70.0

   这告诉build2，项目依赖于boost库，版本必须大于等于1.70.0。

3. 更新依赖：

   运行以下命令来更新依赖：

   bdep update

   Build2会自动下载并构建boost库。

4. 在代码中使用依赖：

   在app/main.cxx中，我们可以使用boost::format：

   // app/main.cxx
   
   #include "hello/hello.hxx"
   #include <boost/format.hpp>
   
   int main() {
      hello::say_hello("World");
      boost::format fmt("The answer is %1%.");
      fmt % 42;
      std::cout << fmt.str() << std::endl;
      return 0;
   }

5. 更新app/buildfile：

   为了让app模块知道boost库的存在，需要更新app/buildfile：

   # app/buildfile
   
   executable(my_app) : main.cxx
   {
      depends: ../lib/hello
      using: boost
   }

   using: boost告诉build2，my_app模块使用了boost库。

6. 重新构建：

   b
   ./bin/my_app

   运行结果：

   Hello, World!
   The answer is 42.

   Build2会自动将boost库链接到my_app可执行文件中。

Build2高级特性：自定义构建步骤

Build2允许你自定义构建步骤，以满足特殊需求。例如，你可以添加一个步骤来生成代码文档，或者运行静态分析工具。

1. 定义构建步骤：

   在buildfile中，可以使用custom关键字来定义自定义构建步骤。

   # buildfile
   
   project(my_project)
   
   subproject(lib/hello)
   subproject(app)
   
   custom(generate_docs) :
   {
      command: doxygen Doxyfile
      depends: Doxyfile
      always: true
   }

   • custom(generate_docs): 定义一个名为generate_docs的自定义构建步骤。
   • command: doxygen Doxyfile: 执行doxygen命令，使用Doxyfile作为配置文件。
   • depends: Doxyfile: generate_docs步骤依赖于Doxyfile文件。
   • always: true: 每次构建都执行generate_docs步骤。

2. 创建Doxyfile：

   # Doxyfile
   
   PROJECT_NAME           = MyProject
   INPUT                  = .
   OUTPUT_DIRECTORY       = docs
   GENERATE_HTML          = YES

3. 运行自定义构建步骤：

   b generate_docs

   这会执行generate_docs步骤，使用Doxygen生成代码文档。

Build2 实用技巧：提高效率

• 使用bdep sync： 可以将项目依赖同步到本地目录，方便离线开发。
• 利用b -jN： 使用多线程构建，N是线程数，加快编译速度。
• 探索build2-toolchain： 可以更精细的控制编译器、链接器等工具链的选项。

Build2的优缺点

特性	优点	缺点
依赖管理	自动下载、构建、管理依赖，避免手动配置的麻烦。	需要配置manifest文件，学习成本较高。
模块化	鼓励模块化设计，代码结构清晰，易于维护。	需要规划模块结构，可能增加项目初期设计复杂度。
跨平台	支持Windows、Linux、macOS等主流平台。	某些平台可能需要手动配置工具链。
可扩展	可以通过自定义构建步骤和规则来满足特殊需求。	需要学习build2的构建规则和API。
性能	旨在提供快速、高效的构建体验。（实际取决于项目规模和硬件配置）	对于非常小的项目，可能感觉不到明显优势。
学习曲线	相对于Makefile，CMake，初始学习曲线较陡峭，需要理解buildfile和manifest的语法。	生态不如CMake完善，一些第三方库可能没有现成的build2支持，需要自己编写构建脚本。

总结：Build2，未来可期

Build2是一个充满潜力的C++构建系统。它在依赖管理、模块化和可扩展性方面具有显著优势。虽然学习曲线略陡峭，但一旦掌握，它将极大地提高C++项目的开发效率和可维护性。

当然，任何构建系统都有其适用场景。对于小型项目，CMake可能更简单直接。但对于大型、复杂的项目，Build2的模块化和依赖管理功能将发挥更大的作用。

希望通过今天的讲座，大家能够对Build2有一个初步的了解。如果你正在寻找一个更现代、更智能的C++构建系统，不妨尝试一下Build2，也许它会给你带来惊喜。

彩蛋：Build2的小秘密

你知道吗？Build2是用C++自己编写的，这本身就证明了它的强大之处！

好了，今天的讲座就到这里。感谢各位的观看，祝大家编码愉快！ 记得点赞、收藏、分享哦！下次再见！