vcpkg+CMake跨平台构建方案详解

搭建基于vcpkg和CMake的跨平台构建流水线的核心在于利用vcpkg管理依赖，CMake组织构建流程，从而实现代码在不同操作系统和编译器上的自动化编译和测试。1. 安装配置vcpkg：克隆仓库并运行引导脚本，设置VCPKG_ROOT环境变量，可选地将vcpkg加入PATH；2. 创建CMakeLists.txt：指定最低版本、项目名称、引入vcpkg工具链、查找并链接所需库；3. 使用vcpkg安装依赖：根据平台架构执行如vcpkg install boost:x64-windows或x64-linux等命令；4. 配置构建流水线：通过CI/CD工具安装vcpkg与CMake，使用CMake生成构建系统并进行编译；5. 解决跨平台依赖问题：通过vcpkg的triplet机制选择对应平台依赖；6. 优化构建速度：使用缓存、Ninja构建系统、并行编译及增量编译；7. 处理私有仓库：设置VCPKG_OVERLAY_PORTS指向自定义port目录以优先加载内部库。

搭建基于vcpkg和CMake的跨平台构建流水线，核心在于利用vcpkg管理依赖，CMake组织构建流程，从而实现代码在不同操作系统和编译器上的自动化编译和测试。

首先，我们需要一个可靠的依赖管理方案和一套标准化的构建流程。vcpkg解决了依赖管理的问题，CMake则提供了跨平台的构建能力。将两者结合，能显著简化跨平台构建的复杂性。

为什么选择vcpkg和CMake？

vcpkg简化了第三方库的获取和管理。它能够自动下载、构建和安装依赖项，并能轻松管理不同版本的库。CMake则是一个强大的构建系统生成器，它可以生成各种构建系统（如Makefile、Ninja、Visual Studio项目等）的配置文件，使得项目可以在不同的平台上使用相同的构建流程。

搭建步骤

1. 安装和配置vcpkg:

   • 从GitHub克隆vcpkg仓库：git clone https://github.com/microsoft/vcpkg
   • 运行vcpkg的引导脚本：.\vcpkg\bootstrap-vcpkg.bat (Windows) 或 ./vcpkg/bootstrap-vcpkg.sh (Linux/macOS)
   • 设置环境变量VCPKG_ROOT指向vcpkg的安装目录。
   • (可选) 将vcpkg添加到PATH环境变量，方便直接使用vcpkg命令。

2. 创建CMakeLists.txt:

   • 在项目根目录下创建CMakeLists.txt文件。
   • 设置CMake最低版本要求：cmake_minimum_required(VERSION 3.15)
   • 项目名称：project(MyProject)
   • 引入vcpkg工具链文件：set(CMAKE_TOOLCHAIN_FILE ${VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake)
   • 查找需要的库：find_package(Boost REQUIRED) (例如，查找Boost库)
   • 添加可执行文件或库：add_executable(MyProject main.cpp)
   • 链接需要的库：target_link_libraries(MyProject Boost::boost)

3. 使用vcpkg安装依赖:

   • 使用vcpkg install 安装需要的依赖。例如，vcpkg install boost:x64-windows (Windows 64位) 或 vcpkg install boost:x64-linux (Linux 64位)。
   • 指定平台和架构非常重要，确保安装的库与目标平台兼容。

4. 配置构建流水线:

   • 可以使用各种CI/CD工具（如GitHub Actions、GitLab CI、Azure DevOps等）配置构建流水线。
   • 在流水线中，首先安装vcpkg和CMake。
   • 然后，使用CMake生成构建系统：cmake -B build -S .
   • 最后，使用生成的构建系统进行编译：cmake --build build

如何解决跨平台依赖问题？

不同平台可能需要不同版本的依赖库，或者依赖库的名称有所差异。vcpkg通过triplet的概念来解决这个问题。Triplet定义了目标平台、架构和编译器。例如，x64-windows, x64-linux, x64-osx都是不同的triplet。

在构建流水线中，可以根据不同的平台选择不同的triplet进行安装。例如，在GitHub Actions中，可以使用if语句来判断当前运行的平台，然后选择合适的triplet：

steps:
  - name: Install dependencies (Windows)
    if: runner.os == 'Windows'
    run: vcpkg install boost:x64-windows

  - name: Install dependencies (Linux)
    if: runner.os == 'Linux'
    run: vcpkg install boost:x64-linux

如何优化构建速度？

构建速度是影响开发效率的关键因素。以下是一些优化构建速度的技巧：

• 使用缓存: CI/CD工具通常提供缓存机制，可以将vcpkg安装的依赖缓存起来，避免每次构建都重新下载和编译。
• 使用Ninja构建系统: Ninja是一个小而快的构建系统，通常比Makefile构建速度更快。可以在CMake中指定使用Ninja：cmake -B build -S . -GNinja
• 并行编译: 使用多线程进行并行编译可以显著提高构建速度。可以在CMake构建命令中指定线程数：cmake --build build -j
• 增量编译: CMake支持增量编译，只编译修改过的文件。确保CMake配置正确，以便充分利用增量编译的优势。

如何处理vcpkg的私有仓库？

有时候，我们需要使用私有的vcpkg仓库，例如包含公司内部的库。这可以通过配置VCPKG_OVERLAY_PORTS环境变量来实现。

VCPKG_OVERLAY_PORTS指向包含自定义port文件的目录。vcpkg会优先搜索这些目录，然后再搜索官方的vcpkg仓库。

例如，假设我们有一个私有仓库位于/path/to/my-vcpkg-ports，可以在构建流水线中设置环境变量：

env:
  VCPKG_OVERLAY_PORTS: /path/to/my-vcpkg-ports

然后在私有仓库中创建相应的port文件，例如ports/mylib/portfile.cmake。