c++ 现代cmake实践 c++如何编写干净且可维护的cmakelists.txt

大枫酱_8892

大枫酱_8892

2026-03-21

735人浏览

原创

推荐选3.20:c++17默认支持、find_package(config)更可靠、target_link_libraries传递接口属性无需interface、兼容msvc /permissive-与c++20 modules、fetchcontent支持exclude_from_all。

c++ 现代cmake实践 c++如何编写干净且可维护的cmakelists.txt

cmake_minimum_required 版本选 3.14 还是 3.20?

选 3.14 是底线,但实际推荐直接写 3.20。C++17 默认支持、find_package(... CONFIG REQUIRED) 行为更可靠、target_link_libraries() 传递接口属性不再需要手动加 INTERFACE —— 这些不是“锦上添花”,而是避免后期改一堆 target 属性的省心前提。

常见错误:用 3.10 写了 add_library(mylib INTERFACE),结果在链接时发现 target_include_directories(mylib INTERFACE ...) 的路径没透传给下游,最后靠全局 include_directories() 补救,污染整个作用域。

  • 项目含 std::filesystem 或需 find_package(Threads REQUIRED) → 至少 3.14
  • 用 FetchContent_Declare() 拉第三方(如 fmt、doctest)→ 3.14+ 可用,但 3.20+ 支持 EXCLUDE_FROM_ALL 避免意外构建
  • 团队有 Windows + MSVC 用户 → 3.20 开始对 /permissive- 和 C++20 modules 的 generator expression 支持更稳

add_executable() / add_library() 后立刻 set_property()?

不建议。现代 CMake 的惯用法是「声明即配置」:把源文件、语言标准、可见性、依赖全塞进 add_executable() 或 add_library() 调用里,而不是事后用 set_property() 补。

典型翻车场景:add_library(foo STATIC foo.cpp) 之后再 target_compile_features(foo PRIVATE cxx_std_17),结果单元测试 target 里 include foo 时因编译特征不一致触发 ODR violation;而写成 add_library(foo STATIC foo.cpp) target_compile_features(foo PRIVATE cxx_std_17) 就能被 CMake 自动推导依赖链。

  • 用 PRIVATE 控制头文件可见范围:只有实现用到的头,就别放 PUBLIC
  • target_compile_options() 中慎用 -Wall -Wextra 全局开关,不同编译器含义不同;改用 target_compile_options(foo PRIVATE $:-Wall>)
  • 想让库默认启用 RTTI 或异常?直接 target_compile_features(foo PRIVATE cxx_rtti cxx_exceptions),比 set(CMAKE_CXX_FLAGS ...) 安全

find_package() 找不到 fmt / spdlog 怎么办?

不是路径问题,大概率是没告诉 CMake 去哪找——尤其当你用 FetchContent 或 vcpkg 管理依赖时。

C++14
C++14

C++14 对 C++11 的修正与增强版本,适合旧系统维护和较老工具链兼容。

下载

现象:find_package(fmt REQUIRED) 报错 Could not find fmtConfig.cmake,但 ls build/_deps/fmt-src/ 下明明有 fmt-config.cmake。

  • 确保在 find_package() 前调用 list(APPEND CMAKE_PREFIX_PATH "${CMAKE_BINARY_DIR}/_deps/fmt-src")
  • 用 vcpkg 时,必须在 configure 阶段传 -DCMAKE_TOOLCHAIN_FILE=/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake,否则 CMAKE_FIND_ROOT_PATH 不生效
  • 自己写的库要被别人 find_package() 到?在 install 步骤里加 install(EXPORT mylibTargets FILE MyLibConfig.cmake ...),别只装头文件和 so

configure_file() 替换版本号总出错?

因为 @VAR@ 是 CMake 变量替换语法,不是 shell 或预处理器;如果 VERSION 没提前 set(),它就真替换成空字符串,连 warning 都不报。

最常漏的一步:在 configure_file(version.h.in version.h) 前,忘了 project(MyProj VERSION 1.2.3) 或显式 set(PROJECT_VERSION "1.2.3")。结果生成的 version.h 里 #define MYPROJ_VERSION "@PROJECT_VERSION@",编译直接炸。

  • 推荐统一用 project() 声明版本,后续所有 @PROJECT_VERSION@、@PROJECT_VERSION_MAJOR@ 都自动可用
  • 想区分构建类型(dev / release)?用 configure_file(config.h.in config.h @ONLY),然后在 .in 文件里写 #cmakedefine MYPROJ_DEV_MODE,配合 option(MYPROJ_DEV_MODE "Enable dev features" OFF)
  • 不要在 configure_file() 里试图执行命令或逻辑判断,那是 string(CONFIGURE ...) 的事,且极少需要

真正的难点不在语法,而在「谁该负责提供变量」——是顶层 CMakeLists.txt 统一设,还是每个子目录自己 set() 再 parent_scope 传?后者容易失控,前者又难适配多配置构建。多数项目卡在这儿,不是不会写,是没约定清楚 scope 边界。

C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!

相关文章

c++速学教程(入门到精通)
c++速学教程(入门到精通)

c++怎么学习?c++怎么入门?c++在哪学?c++怎么学才快?不用担心,这里为大家提供了c++速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c++

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.02

5939

3

typedef和define区别
typedef和define区别

typedef和define区别在类型检查、作用范围、可读性、错误处理和内存占用等。本专题为大家提供typedef和define相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.26

313

5

define的用法
define的用法

define用法:1、定义常量;2、定义函数宏:3、定义条件编译;4、定义多行宏。更多关于define的用法的内容,大家可以阅读本专题下的文章。

2023.10.11

619

5

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

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

2023.08.03

1678

5

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

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

2023.09.04

2524

5

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

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

2023.10.24

5964

49

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2023.11.24

5369

6

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

2024.03.22

7074

16

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2024.04.29

10034

11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习