目录

1.简介

2.安装

3.常用命令

4.与项目集成

5.指定目标平台(triplet)

6.vcpkg目录文件夹介绍

7.vcpkg的工作原理

7.1.包索引:ports 系统(定义库的 “元信息”)

7.2.源码获取:从 “地址” 到 “本地缓存”

7.3.编译构建:按 “triplet” 定制目标

7.4.安装布局:按 “triplet” 隔离文件

7.5.项目集成:让构建系统 “找到” 库

8.常见问题

9.总结

官方资源矩阵


1.简介

        vcpkg 是微软开发的 C++ 包管理工具,旨在简化跨平台 C++ 库的获取、编译和集成过程。它解决了 C++ 开发中 “库版本不一致、编译配置复杂、跨平台适配难” 等痛点,支持 Windows、Linux、macOS 等主流系统,可与 CMake、Visual Studio 等工具无缝集成。

        为什么使用 vcpkg?

        核心功能

  1. 自动管理库依赖:安装库时自动下载并编译其依赖项(如安装openssl时自动处理zlib等依赖)。
  2. 跨平台一致性:同一套命令可在 Windows、Linux、macOS 上安装相同版本的库,保证开发环境一致。
  3. 灵活的目标配置:支持不同架构(x86/x64/arm)、编译类型(Debug/Release)、链接方式(静态 / 动态)。
  4. 与构建系统集成:无缝对接 CMake、MSBuild,无需手动设置库路径。

2.安装

1.Windows 安装

# 克隆仓库(需Git)
git clone https://github.com/microsoft/vcpkg
cd vcpkg

# 运行 bootstrap 脚本(生成vcpkg可执行文件)
.\bootstrap-vcpkg.bat

# 验证安装
.\vcpkg --version

2.Linux/macOS 安装

# 克隆仓库
git clone https://github.com/microsoft/vcpkg
cd vcpkg

# 运行bootstrap脚本
./bootstrap-vcpkg.sh

# 验证安装
./vcpkg --version

安装完成后,建议将vcpkg目录添加到系统PATH,方便全局调用。

3.常用命令

1.基本操作

命令 功能
vcpkg search <库名>

搜索库(如vcpkg search boost-asio),支持正则表达式

如:vcpkg search "boost.*asio"

vcpkg install <库名>:<triplet>

安装指定库(triplet指定平台,如x64-windows),如:

vcpkg install zlib:x64-windows-static

vcpkg remove <库名> 卸载库
vcpkg list

列出已安装的库,如:

vcpkg list --x-tree

vcpkg update 检查可更新的库
vcpkg upgrade

更新所有已安装的库,如:

vcpkg upgrade --no-dry-run

vcpkg export

导出二进制供分发,如:

vcpkg export boost --zip

2.关键概念:triplet

triplet是 vcpkg 用于指定目标平台、架构、链接方式的标识,格式为<arch>-<os>-<link>,常见值:

  • x64-windows:Windows x64,动态链接(默认)
  • x64-windows-static:Windows x64,静态链接
  • x64-linux:Linux x64
  • arm64-osx:macOS ARM64(M 系列芯片)

3.安装示例

# 安装Boost.Asio(Windows x64,动态链接)
vcpkg install boost-asio:x64-windows

# 安装OpenSSL(Linux x64,静态链接)
vcpkg install openssl:x64-linux-static

# 安装多个库(自动处理依赖)
vcpkg install fmt spdlog:x64-windows

4.与项目集成

1.CMake 项目(推荐)

CMakeLists.txt中通过CMAKE_TOOLCHAIN_FILE指定 vcpkg 的工具链:

# 假设vcpkg安装在C:\vcpkg
set(CMAKE_TOOLCHAIN_FILE "C:/vcpkg/scripts/buildsystems/vcpkg.cmake")
project(MyProject)

# 直接find_package使用已安装的库
find_package(Boost REQUIRED COMPONENTS asio)
add_executable(myapp main.cpp)
target_link_libraries(myapp PRIVATE Boost::asio)

编译时无需手动指定库路径,CMake 会自动通过 vcpkg 找到依赖。

也可以配置 CMake 时指定工具链文件:

在命令行中运行:

# 创建构建目录
mkdir build && cd build

# 配置 CMake,指定 vcpkg 工具链
cmake .. -DCMAKE_TOOLCHAIN_FILE=D:/vcpkg/scripts/buildsystems/vcpkg.cmake

# 编译
cmake --build . --config Release

Windows PowerShell:路径需用反斜杠或引号包裹:

cmake .. -DCMAKE_TOOLCHAIN_FILE="D:/vcpkg/scripts/buildsystems/vcpkg.cmake"

Linux/macOS

cmake .. -DCMAKE_TOOLCHAIN_FILE="D:/vcpkg/scripts/buildsystems/vcpkg.cmake"

2.Visual Studio 项目

通过 vcpkg 的 integrate install 命令后,VS 会自动添加 include 和 lib 路径到项目设置中。将工具链文件全局注册到 CMake,无需每次手动指定 -DCMAKE_TOOLCHAIN_FILE

# 将vcpkg集成到所有VS项目(管理员权限)
vcpkg integrate install

# 取消集成
vcpkg integrate remove

输出示例(Windows):
Applied user-wide integration for this vcpkg root.
All CMake projects can now use find_package() to find vcpkg libraries.

集成后,VS 会自动识别 vcpkg 安装的库,直接#include并链接即可。

mkdir build && cd build
cmake ..  # 自动使用 vcpkg 工具链
cmake --build .

3.手动配置

  • 在编译器选项中添加 -I<vcpkg根目录>/installed/<triplet>/include(头文件路径)。
  • 在链接器选项中添加 -L<vcpkg根目录>/installed/<triplet>/lib(库文件路径)。

4.清单模式(Manifest )模式(推荐用于项目依赖管理)

清单模式(vcpkg.json)是 vcpkg 推荐的项目依赖管理方式,可在 CMake 构建时自动安装项目所需的库,确保团队成员 / CI 环境使用相同版本的依赖。

1) 项目结构

my_project/
├── CMakeLists.txt
├── vcpkg.json       # vcpkg 依赖清单
└── src/
    └── main.cpp

2) 编写 vcpkg.json

声明项目依赖的库(如 fmtspdlog):

{
  "name": "my_project",
  "version": "1.0.0",
  "dependencies": [
    "fmt",                // 不指定版本,使用最新兼容版
    "spdlog:1.12.0"       // 指定版本
  ]
}

3) CMakeLists.txt 配置

与基础用法一致,通过 find_package 查找库:

cmake_minimum_required(VERSION 3.15)
project(my_project)

find_package(fmt CONFIG REQUIRED)
find_package(spdlog CONFIG REQUIRED)

add_executable(my_app src/main.cpp)
target_link_libraries(my_app PRIVATE fmt::fmt spdlog::spdlog)

4) 构建时自动安装依赖

配置 CMake 时,通过 -DVCPKG_MANIFEST_DIR 指定清单文件目录(通常是项目根目录),vcpkg 会自动安装 vcpkg.json 中声明的依赖:

mkdir build && cd build

# 局部集成:指定工具链文件 + 清单目录
cmake .. \
  -DCMAKE_TOOLCHAIN_FILE=/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake \
  -DVCPKG_MANIFEST_DIR=..  # 指向 vcpkg.json 所在目录

# 编译(依赖会自动安装)
cmake --build .

优势

  • 无需手动运行 vcpkg install,构建时自动安装缺失的依赖;
  • 生成 vcpkg.lock 文件锁定依赖版本,确保团队成员和 CI 环境使用完全一致的库版本。

5.指定目标平台(triplet)

vcpkg 支持多平台(如 x64-windows、x64-linux、arm64-osx),CMake 构建时可通过 -DVCPKG_TARGET_TRIPLET 指定目标平台,确保链接对应平台的库。

例如:构建 Windows x64 静态链接版本的库:

cmake .. \
  -DCMAKE_TOOLCHAIN_FILE=D:/vcpkg/scripts/buildsystems/vcpkg.cmake \
  -DVCPKG_TARGET_TRIPLET=x64-windows-static  # 静态链接 triplet

常用 triplet 参考:

  • x64-windows:Windows x64 动态链接(默认);
  • x64-windows-static:Windows x64 静态链接;
  • x64-linux:Linux x64;
  • x64-osx:macOS x64;
  • arm64-android:Android arm64。

6.vcpkg目录文件夹介绍

1.installed 目录

核心用途:存放 最终安装完成、可直接使用 的库文件,是开发者最常访问的目录。

包含头文件(include)、静态 / 动态库(lib/bin)、配置文件(share)等,按架构(如 x64-windows)和编译模式(Debug/Release)分类。

每个库会根据编译目标的架构(如 x64-windowsx86-linux)和配置(Debug/Release)存放在不同的子目录中。例如:

vcpkg根目录/
└── installed/
    └── x64-windows/        # 64位Windows架构
        ├── include/        # 头文件(.h/.hpp)
        ├── lib/            # 静态库(.lib/.a)和动态库导入库(.lib)
        ├── bin/            # 动态库(.dll)
        ├── debug/          # Debug模式下的库文件
        ├── share/          # CMake配置文件、pkgconfig文件等
        └── tools/          # 可执行工具(如某些库提供的命令行工具)

2.downloads 目录

核心用途:缓存从网络下载的 源码包、二进制包或依赖文件,避免重复下载。

文件多为压缩包(.tar.gz/.zip),命名含包名、版本号和哈希值,后续构建时直接从这里读取,无需重新联网获取。

3.ports 目录

核心用途:存放每个库的 构建规则与元数据(vcpkg 的 “包定义中心”)。

每个子目录对应一个库(如 zlibfmt),内含 portfile.cmake(构建脚本)、vcpkg.json(版本 / 依赖配置)等,定义了库的下载地址、编译参数、安装逻辑。

4.buildtrees 目录

核心用途:存放库的 编译过程临时文件,是 “构建工作台”。

每个库会生成独立子目录,包含源码解压后的文件、编译中间产物(.obj/.o)、CMake 缓存、日志等,构建完成后可删除(不影响已安装的库),重新构建时会重建。

5.packages 目录

核心用途:归档 编译完成的二进制包,是 “成品仓库”。

按 “包名 + 版本 + 架构” 分类(如 zlib_x64-windows_1.3.1),内含该库编译后的完整文件集(与 installed 目录结构一致),vcpkg install 本质是将这里的文件复制到 installed

6.scripts 目录

核心用途:vcpkg 自身的 工具脚本与集成配置 目录,是 “功能核心”。

包含构建系统集成脚本(如 buildsystems/vcpkg.cmake,供 CMake 项目使用)、命令行工具脚本、依赖解析脚本、平台适配脚本等,支撑 vcpkg 的安装、编译、集成功能。

7.vcpkg的工作原理

vcpkg 的核心目标是自动化 C++ 库的获取、编译、安装和项目集成,其工作原理可通过 “包索引→源码获取→编译构建→安装布局→项目集成” 五个核心环节解析:

7.1.包索引:ports 系统(定义库的 “元信息”)

vcpkg 通过 ports 目录 管理所有支持的库,每个库对应一个独立的子目录(如 ports/boost-asio),内含描述库信息的关键文件:

  • portfile.cmake:核心脚本,定义库的下载地址(Git 仓库、压缩包 URL)、校验信息(SHA512 哈希,确保源码完整性)、编译参数(CMake 选项、补丁文件)、依赖关系(如 boost-asio 依赖 boost-system)等。
  • vcpkg.json:库的元数据(名称、版本、许可证等),用于版本管理和依赖解析。
  • 补丁文件(可选):如 0001-fix-compile-error.patch,解决特定平台的编译问题(如 Windows/Linux 兼容性)。

当用户执行 vcpkg install <库名> 时,vcpkg 首先通过 ports 目录定位该库的 portfile.cmake,获取构建所需的全部信息。

7.2.源码获取:从 “地址” 到 “本地缓存”

根据 portfile.cmake 中的配置,vcpkg 执行以下步骤获取源码:

1) 解析下载地址:支持 Git 仓库(带分支 / 标签)、HTTP/HTTPS 压缩包(.tar.gz/.zip)等。

2) 校验完整性:下载后通过 portfile.cmake 中定义的 SHA512 哈希值校验源码,防止篡改或损坏。

3) 缓存源码:将源码解压 / 克隆到 vcpkg/downloads 目录,后续安装同一版本时直接复用,避免重复下载。

7.3.编译构建:按 “triplet” 定制目标

vcpkg 的核心能力之一是跨平台编译,通过 triplet(目标标识) 控制编译参数,确保库适配指定平台。

1) triplet 的作用

triplet 是一个字符串(如 x64-windowsarm64-linux-static),编码了三个关键信息:

  • 架构x64(64 位)、x86(32 位)、arm64(ARM 64 位)等;
  • 操作系统windowslinuxosx(macOS)等;
  • 链接方式:默认动态链接(如 x64-windows),-static 后缀表示静态链接(如 x64-linux-static)。

vcpkg 会根据 triplet 加载对应的配置文件(如 triplets/x64-windows.cmake),设置编译工具链(编译器路径、标准库)、宏定义(如 _WIN32__linux__)等。

2) 依赖递归编译

若库 A 依赖库 B,vcpkg 会:

  1. 先检查库 B 是否已安装(按当前 triplet);
  2. 若未安装,自动触发库 B 的编译流程(重复 “源码获取→编译” 步骤);
  3. 待库 B 安装完成后,再编译库 A,并在编译时自动链接库 B 的头文件和库文件。

3) 构建系统适配

vcpkg 支持多种构建系统(CMake、MSBuild、Make、Autotools 等),通过 portfile.cmake 中的脚本适配:

  • 对 CMake 库:调用 cmake 并传入 triplet 对应的工具链;
  • 对 Make 库:调用 make 并设置 CC/CXX 编译器路径;
  • 对 Visual Studio 项目:调用 msbuild 并指定平台(如 x64)和配置(Debug/Release)。

7.4.安装布局:按 “triplet” 隔离文件

编译完成后,vcpkg 将库文件安装到 vcpkg/installed 目录,按 triplet 分类存储,确保不同平台 / 配置的库不冲突。典型目录结构如下:

installed/
├─ x64-windows/           # triplet 为 x64-windows 的库
│  ├─ include/            # 头文件(如 boost/asio.hpp)
│  ├─ lib/                # 动态库(.dll.a 或 .lib)
│  ├─ bin/                # 可执行文件(如工具类库)
│  └─ share/              # 配置文件(如 CMake 模块)
└─ x64-linux-static/      # triplet 为 x64-linux-static 的库
   ├─ include/
   └─ lib/                # 静态库(.a)

这种布局让项目可以根据自身目标平台,精准引用对应 triplet 的库文件。

7.5.项目集成:让构建系统 “找到” 库

第4章节,与项目集成已经讲了,就不这里赘述了。

8.常见问题

1)安装失败:检查网络(需访问 GitHub,设置代理:set HTTP_PROXY=http://127..0.0.1:1080)、依赖工具(如 CMake、编译器)是否安装。

2)库版本冲突:通过vcpkg install <库名>=<版本>指定版本(如vcpkg install boost-asio=1.78.0)。

3)静态 / 动态链接切换:通过triplet区分(如x64-windows-static强制静态链接)。如:安装对应VS组件:vcpkg env --triplet=x64-windows

9.总结

优势总结:

  • 简化流程:一键安装复杂库(如 Boost、OpenCV),无需手动编译。
  • 跨平台统一:一套命令适配多系统,避免 “在 Windows 能编,Linux 编不过” 的问题。
  • 版本可控:支持指定库版本,配合 Manifest 模式可固化项目依赖。

vcpkg 已成为 C++ 开发的主流包管理工具,尤其适合需要跨平台开发或依赖众多第三方库的项目(如 FastDDS、ROS 2 等)。

官方资源矩阵

Logo

魔乐社区(Modelers.cn) 是一个中立、公益的人工智能社区,提供人工智能工具、模型、数据的托管、展示与应用协同服务,为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作,由全产业链共同建设、共同运营、共同享有,推动国产AI生态繁荣发展。

更多推荐