CMakeLists怎么避免重复配置?

老芳君_2973

老芳君_2973

2026-08-08

872人浏览

原创

cmake最佳实践包括:1. 用include_guard(global)防止重复包含;2. 用interface库绑定编译选项替代全局cmake_cxx_flags;3. 用configure_file生成配置头文件;4. 用add_subdirectory组织多目标项目。

cmakelists怎么避免重复配置?

include_guard 防止多次 include 同一个 CMake 模块

重复 include 一个 .cmake 文件(比如 CompileOptions.cmake)会导致变量重定义、函数重复声明,甚至 target_compile_options 被叠加两次——轻则警告,重则编译失败。

include_guard 是 CMake 3.10+ 的标准解法,它像 C++ 的 #pragma once 一样,在文件被第二次包含时直接跳过后续内容:

include_guard(GLOBAL)

常见误用点:

  • include_guard 放在文件末尾或函数体内 —— 它必须是文件里第一个有效命令
  • function() 内部调用 include_guard —— 不合法,CMake 会报错
  • DIRECTORY 却期望跨子目录去重 —— 它只对当前目录及子目录生效,父目录仍可再 include

target_compile_options + INTERFACE 库替代全局 set(CMAKE_CXX_FLAGS)

全局设置 CMAKE_CXX_FLAGS 看似省事,实则破坏模块边界:所有 target 都被迫继承同一套选项,无法为测试目标关掉 -Werror,也无法为嵌入式模块单独加 -mcpu=armv7

正确做法是把编译选项“绑定到目标”,再通过 INTERFACE 库复用:

add_library(common_options INTERFACE)
target_compile_options(common_options INTERFACE -Wall -Wextra)
target_compile_features(common_options INTERFACE cxx_std_17)
<h1>其他 target 只需链接它</h1><p>add_executable(my_app main.cpp)
target_link_libraries(my_app PRIVATE common_options)</p>

好处:

  • 选项只影响显式链接的 target,不污染构建树其他部分
  • 不同平台可为同一 INTERFACE 库设置不同属性:target_compile_options(common_options INTERFACE $:-std=c++17>)
  • Clion 和 VS 等 IDE 能正确解析并高亮这些选项

configure_file 把硬编码路径/宏转成生成式配置

手动在多个 CMakeLists.txt 里写 include_directories(${CMAKE_SOURCE_DIR}/include)add_definitions(-DVERSION=\"1.2.3\"),本质是复制粘贴,版本一改全得手动搜替换。

C++
C++

"空空如也"

下载

换成模板文件 + configure_file

  • 新建 config.h.in
    #define APP_VERSION "@PROJECT_VERSION@"
  • 在根 CMakeLists.txt 中:
    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/config.h.in ${CMAKE_CURRENT_BINARY_DIR}/config.h)
  • 再用 target_include_directories(my_target PRIVATE $>) 让源码能 #include "config.h"

关键细节:

  • @VAR@ 语法只认 CMake 变量,且变量必须在 configure_file 执行前已定义(如 project(... VERSION 1.2.3) 自动设 PROJECT_VERSION
  • 生成的 config.hbuild/ 目录下,不是 source/,避免污染源码树
  • 如果要导出给下游项目用,得配合 install(EXPORT ...)find_package

子目录用 add_subdirectory 而非手写 add_executable 列表

当项目有多个可执行目标(如 serverclienttest_runner),把它们全堆在根 CMakeLists.txt 里,很快就会变成维护噩梦。每次增删目标都要改根文件,还容易漏掉 target_link_librariestarget_include_directories

更健壮的结构是每个子目录独立管理自身目标:

  • src/server/CMakeLists.txt
    add_executable(server server.cpp)
    target_link_libraries(server PRIVATE core_lib)
  • src/client/CMakeLists.txt
    add_executable(client client.cpp)
    target_link_libraries(client PRIVATE core_lib)
  • CMakeLists.txt 只做一件事:
    add_subdirectory(src/server)
    add_subdirectory(src/client)

这样做的实际收益:

  • Clion 右上角运行配置下拉菜单自动列出所有 add_executable 目标,无需手动切换
  • 某个子目录临时禁用?注释掉一行 add_subdirectory 就行,不影响其他模块构建
  • 子目录可独立测试:cd build/src/server && make server

最常被忽略的是 add_subdirectory 的路径必须是相对于当前 CMakeLists.txt 的,不能用绝对路径或 ../ 跨级引用 —— CMake 会静默失败,目标根本不会注册进构建系统。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

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

相关专题

更多
C++ 跨平台开发
C++ 跨平台开发

本专题聚焦 C++ 在跨平台应用与工程构建中的实战应用,系统讲解 CMake 构建系统、跨平台编译配置、第三方库集成、调试技巧、静态与动态链接库管理等核心知识。通过实战案例(如跨平台工具开发、Linux与Windows编译兼容性项目),帮助学习者掌握 从环境配置到完整跨平台构建的开发能力。

2025.10.17

5266

15

c++  cmake用法
c++ cmake用法

本专题整合了c++ cmake用法相关教程,阅读专题下面的文章了解更多详细内容。

2025.10.23

1371

14

C++ 编译构建系统与CMake实战
C++ 编译构建系统与CMake实战

本专题聚焦 C++ 项目的编译与构建体系,系统讲解 CMake 的核心语法、项目结构设计、库与依赖管理、跨平台构建、调试与发布配置。通过完整项目示例,帮助开发者掌握 从源码到可执行程序的工程化构建流程,提升 C++ 项目在实际开发中的可维护性与扩展性。

2025.12.13

314

18

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

2026.09.21

0

20

NumPy随机数文件读写与dtype数据类型
NumPy随机数文件读写与dtype数据类型

本专题整理 NumPy 随机数、文件读写与 dtype 数据类型相关教程,覆盖 Generator/random、随机数种子、正态分布采样、npy/npz/CSV/TXT 保存读取、loadtxt/savetxt、memmap、大文件处理、astype 类型转换、结构化 dtype、整数溢出和精度丢失等场景。

2026.09.21

0

24

NumPy矩阵运算与线性代数计算
NumPy矩阵运算与线性代数计算

本专题整理 NumPy 矩阵运算与线性代数计算相关教程,覆盖矩阵乘法、dot 与 @ 运算符、逆矩阵、行列式、特征值与特征向量、SVD、线性方程组、欧氏距离、矩阵分解和大规模矩阵性能优化等内容,帮助读者掌握 np.linalg 与矩阵计算实战。

2026.09.21

0

20

NumPy广播机制数学运算与统计分析
NumPy广播机制数学运算与统计分析

本专题整理 NumPy 广播机制、数组数学运算与统计分析相关教程,覆盖广播规则、维度对齐、矩阵与数组加减除法、向量化计算、均值方差、分位数、中位数、直方图和 unique 频次统计等场景,帮助读者掌握 ndarray 高效计算与统计处理方法。

2026.09.21

0

17

NumPy数组创建索引切片与数据选择
NumPy数组创建索引切片与数据选择

本专题整理 NumPy 数组创建、索引、切片与数据选择相关教程,覆盖 np.array、zeros/ones、多维数组形状、基础切片、花式索引、布尔索引、条件筛选、视图与副本等常用场景,帮助读者系统掌握 ndarray 数据构造与高效提取方法。

2026.09.21

0

12

Aionclaw智能助手介绍
Aionclaw智能助手介绍

本专题汇总了AionClaw(AI龙虾助手)的功能介绍与在线使用入口。AionClaw是杭州趣猿人工智能有限公司推出的桌面级AI智能体,能直接在电脑上读写文件、运行脚本、操作浏览器,自动交付Word、PPT、Excel等成品。

2026.09.20

20

13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CLion CMake 快速入门教程
CLion CMake 快速入门教程

共0课时 | 0人学习

CMake 保姆级教程
CMake 保姆级教程

共0课时 | 0人学习