0

0

CMake Presets如何统一c++团队的构建配置? (JSON配置入门)

冰火之心

冰火之心

发布时间:2026-01-14 15:08:02

|

284人浏览过

|

来源于php中文网

原创

必须用 CMakePresets.json 统一团队构建配置,因其支持继承、条件分支、多平台适配,且被主流 IDE 原生识别;需置于项目根目录,preset 名全局唯一,布尔值写 true/false,避免缓存污染与变量误用。

cmake presets如何统一c++团队的构建配置? (json配置入门)

CMakePresets.json 统一 C++ 团队构建配置,不是“能不能”,而是“必须做”——否则每人本地 cmake -S . -B build -G "Ninja" -DCMAKE_BUILD_TYPE=RelWithDebInfo 打一遍,参数不一致、路径不一致、工具链漏配,CI 和本地构建就不是同一套逻辑。

为什么不用命令行参数而用 Presets?

命令行参数难复用、难版本控制、难共享。团队里有人加了 -DENABLE_TESTS=ON,有人忘了加 -DCMAKE_TOOLCHAIN_FILE,有人在 Windows 用 Visual Studio 生成器,CI 却跑 Ninja —— 这些差异全靠口头同步,迟早出问题。

Presets 把构建意图固化为 JSON,支持继承、条件分支、多平台适配,且被 VS Code、CLion、VS 2022 原生识别,IDE 直接读取并提供下拉选择。

关键点:

立即学习C++免费学习笔记(深入)”;

  • CMakePresets.json 必须放在项目根目录(和 CMakeLists.txt 同级)
  • 所有 preset 名称(name)全局唯一,推荐按用途+平台命名,如 build-ninja-linux-debug
  • 不要手动写 cacheVariables 里的布尔值为 "ON" 字符串——CMake 会当字符串处理,应写 truefalse(JSON 布尔)

一个可落地的跨平台基础 preset 示例

以下是一个最小但实用的 CMakePresets.json,覆盖 Linux/macOS/Windows 主流场景,不含冗余字段,开箱即用:

来福FM
来福FM

来福 - 你的私人AI电台

下载
{
  "version": 6,
  "configurePresets": [
    {
      "name": "base",
      "displayName": "Base configuration",
      "description": "Shared settings for all builds",
      "binaryDir": "${sourceDir}/build/${presetName}",
      "cacheVariables": {
        "CMAKE_CXX_STANDARD": "20",
        "CMAKE_CXX_STANDARD_REQUIRED": true,
        "CMAKE_EXPORT_COMPILE_COMMANDS": true
      }
    },
    {
      "name": "build-ninja-debug",
      "displayName": "Debug (Ninja)",
      "inherits": ["base"],
      "generator": "Ninja",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Debug"
      },
      "condition": {
        "type": "equals",
        "lhs": "${hostSystemName}",
        "rhs": "Linux"
      }
    },
    {
      "name": "build-ninja-debug-win",
      "displayName": "Debug (Ninja, Windows)",
      "inherits": ["base"],
      "generator": "Ninja",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Debug"
      },
      "condition": {
        "type": "equals",
        "lhs": "${hostSystemName}",
        "rhs": "Windows"
      }
    }
  ]
}

说明:

  • version: 6 是当前(CMake 3.25+)推荐版本,兼容性好;用 version: 4 会缺失 condition 支持
  • inherits 不是“继承类”,而是“复用字段”,子 preset 可覆盖父 preset 的任意字段(如 cacheVariables 中同名键会被替换)
  • ${hostSystemName} 是内置变量,值为 Linux/Windows/Darwin,比手写 if(WIN32) 更可靠
  • Windows 下若需 MSVC 工具链,把 generator 换成 "Visual Studio 17 2022",并加 "architecture": "x64" 字段

常见错误与绕过方式

实际落地时,90% 的问题出在变量展开或路径拼接上:

  • "binaryDir": "${sourceDir}/build" → 错误:没带 ${presetName},多个 preset 共用同一 build 目录,缓存污染
  • "cacheVariables": { "BUILD_SHARED_LIBS": "ON" } → 错误:“ON” 是字符串,CMake 不识别为布尔真,应写 true
  • "condition": { "type": "equals", "lhs": "${hostSystemName}", "rhs": "win32" } → 错误:win32 小写,实际值是 Windows(首字母大写)
  • VS Code 不识别 preset?检查是否安装了官方 “CMake Tools” 插件,并确认工作区打开的是项目根目录(不是子文件夹)
  • 执行 cmake --list-presets 报错 “No presets found”?确认文件名是 CMakePresets.json(不是 cmake-presets.jsonCMakePresets.yml

团队协作的关键细节

统一配置不等于“一刀切”。真正难的是让 preset 既稳定又可扩展:

  • 把敏感配置(如私有 toolchain 路径、密钥开关)抽到 user-presets.json(Git 忽略),用 include 引入,避免提交硬编码路径
  • CI 脚本中显式指定 preset: cmake --preset build-ninja-release-linux,禁止再用裸 cmake -B
  • 新增 preset 前,先在 PR 描述里贴出 cmake --preset xxx --dry-run 输出,确认生成命令符合预期
  • Windows 开发者若用 WSL,注意 ${hostSystemName} 返回的是 Linux,不是 Windows —— 这是正确行为,别强行 hack

最常被忽略的一点:Preset 不是“写完就扔”,它得随 CMakeLists.txt 的 project() 版本升级而同步更新。比如从 cmake_minimum_required(VERSION 3.20) 升到 3.25,就要检查 preset version 是否匹配,否则旧 CMake 会静默忽略整个文件。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

411

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

532

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

309

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

736

2023.08.22

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

254

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

206

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1463

2023.10.24

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 7.1万人学习

Git 教程
Git 教程

共21课时 | 2.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号