C++如何通过CMake管理多个子模块项目

夏萱小哥_3301

夏萱小哥_3301

2026-07-09

145人浏览

原创

cmake子模块必须显式调用add_subdirectory()才能被识别,因其默认不递归扫描;推荐扁平结构(如core/、utils/、app/各含独立cmakelists.txt),根目录按依赖顺序调用add_subdirectory,并通过target_link_libraries和target_include_directories确保目标可见性与头文件导出。

c++如何通过cmake管理多个子模块项目

子模块目录结构怎么组织才不会被CMake忽略

CMake默认不递归扫描子目录,add_subdirectory() 必须显式调用,否则子模块的 CMakeLists.txt 根本不会被读取。常见错误是把子模块放在 src/ 下却只在根目录写 add_subdirectory(src),结果子模块里还有 libA/libB/ 两级,而没再加一层 add_subdirectory(libA)

推荐结构:每个子模块自带独立 CMakeLists.txt,且路径层级尽量扁平:

project-root/
├── CMakeLists.txt          # 根:包含所有 add_subdirectory()
├── core/
│   ├── CMakeLists.txt      # 定义 core 库
│   └── core.cpp
├── utils/
│   ├── CMakeLists.txt      # 定义 utils 库
│   └── string_util.cpp
└── app/
    ├── CMakeLists.txt      # 定义可执行文件,链接 core + utils
    └── main.cpp
  • CMakeLists.txt 中按依赖顺序写 add_subdirectory(core)add_subdirectory(utils)add_subdirectory(app)
  • 子模块 CMakeLists.txt 不要用 project()(除非它本身要单独构建),只用 add_library()add_executable()
  • 避免在子模块里写 cmake_minimum_required() —— 由根统一控制版本兼容性

如何让子模块之间正确链接且不报 undefined reference

链接失败通常不是路径问题,而是目标可见性没处理好。CMake中库只有被 target_link_libraries() 显式引用,且该库已通过 add_library() 注册并导出接口,才能被其他子模块使用。

关键点:

  • 子模块库必须用 add_library(core STATIC)(或 SHARED)定义,不能只写 add_library(core)(CMake 3.19+ 默认为 STATIC,但低版本会报错)
  • 在提供头文件的子模块里,用 target_include_directories(core PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)PUBLIC 表示“我用 + 我的使用者也用”
  • 在依赖方(如 app)中,写 target_link_libraries(myapp PRIVATE core utils),注意大小写必须和 add_library() 中的名字完全一致
  • 如果子模块用了第三方库(如 fmt),不要在子模块里用 find_package(fmt) 后直接 target_link_libraries(core PRIVATE fmt::fmt) —— 应由根 CMakeLists.txt 统一 find_package() 并通过 INTERFACE 传递

外部子模块(Git submodule)怎么集成进CMake构建流程

直接把 git submodule add https://... thirdparty/json 拉下来的代码,CMake不认识它,除非你主动纳入构建。最稳妥的方式是把它当作普通子目录管理,而非用 FetchContent 动态下载(后者适合无本地缓存要求的CI场景)。

C++
C++

"空空如也"

下载

实操建议:

  • 在根 CMakeLists.txt 中添加 add_subdirectory(thirdparty/json),前提是该子模块自带 CMakeLists.txt 且支持作为子项目构建(如 nlohmann/json 的 json.hpp 是 header-only,其 CMakeLists.txt 提供 json::json target)
  • 若子模块没有 CMakeLists.txt(比如纯 .h/.c 的小工具),就别强求用 add_subdirectory;改用 file(GLOB ...) 收集源码,再 add_library(thirdparty_xxx INTERFACE) + target_sources(...) + target_include_directories(...) 手动封装
  • 避免在子模块目录里运行 cmake .. —— 这会生成自己的 build 目录,干扰主项目的 out-of-source 构建,CMake 只认你从根目录出发的 cmake -S . -B build

为什么修改子模块CMakeLists.txt后编译不触发重新配置

CMake 缓存的是构建树状态,不是源码变更。当你改了某个子模块的 CMakeLists.txt,CMake 不会自动重新运行 configure 阶段,除非你手动触发或满足特定条件。

解决方式很直接:

  • 每次改完任意 CMakeLists.txt(包括子模块的),执行 cmake --build build --clean-first 或删掉 build/CMakeCache.txtcmake -S . -B build
  • 更省事的做法:在根 CMakeLists.txt 开头加 set(CMAKE_SUPPRESS_REGENERATION TRUE) 不起作用 —— 别设这个,它禁用的是内部逻辑,不是用户触发时机
  • 真正起效的是启用 CMAKE_POLICY_DEFAULT_CMP0130(CMake 3.24+),但多数项目还用不上;现阶段最可靠的就是养成“改完 CMakeLists 就重跑 cmake 命令”的习惯
  • IDE(如 CLion)通常监听 CMakeLists.txt 变更并自动 reload,但命令行下不会 —— 这不是 bug,是设计使然

子模块越多,CMakeLists.txt 之间的隐式依赖越难追踪,一个 target_link_libraries() 写错大小写,或者漏掉 PUBLIC / PRIVATE 限定符,编译器报的错往往指向最终链接处,而不是出问题的那行配置 —— 调试时得倒着查依赖链。

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

相关文章

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

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

下载

相关标签:

c++ cmake

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

相关专题

更多
c++和c语言的区别有哪些
c++和c语言的区别有哪些

c++和c语言的区别:1、面向对象编程(OOP)支持不同;2、新增特性不同;3、标准库不同;4、编译方式不同;5、命名空间不同等等。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.14

2068

9

c++和python学习顺序推荐
c++和python学习顺序推荐

一般建议先学习C++,再学习Python,因为这样可以逐步从较为底层的编程语言向更高级的语言过渡。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

939

6

python和c++学习性价比分析
python和c++学习性价比分析

Python易于学习,广泛应用于Web开发、数据科学和人工智能等领域,但性能较低。C语言性能高,适用于对性能要求较高的场景,如游戏开发和系统编程,但学习曲线陡峭,错误处理复杂。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

367

5

c语言和c++一样吗
c语言和c++一样吗

c语言和c++是两种不同的编程语言,虽然有相似之处,但存在显著差异。c语言专注于过程式编程和系统级开发,以简洁、高效著称。c++作为c语言的超集,引入了面向对象编程,增强了代码组织和管理能力,但学习曲线也更陡峭。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

307

5

c语言和c++先学哪个好
c语言和c++先学哪个好

初学者选择学习c语言还是c++语言,需要根据个人学习目标、背景以及编程兴趣和预期应用方向来决定。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

346

5

c语言和c++的区别和联系
c语言和c++的区别和联系

c语言和c++是计算机科学领域应用广泛的编程语言。虽然它们有着相似的基础,但它们在语言类型、语法功能和内存管理方面存在着显著差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

560

5

c++软件中文更改教程
c++软件中文更改教程

对于 ide,可通过打开设置,找到语言设置,选择中文,并保存更改。对于非 ide 应用程序,可查找设置或选项,选择语言设置,更改为中文,并保存更改。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.21

1389

9

python和java和c++学习性价比分析
python和java和c++学习性价比分析

Python以其易学性、丰富的库和活跃的社区而著称,适合数据科学、人工智能和Web开发。Java以其跨平台性、企业级应用开发和Android应用开发而闻名。C++以其底层控制能力、高效性能和游戏开发而著称。选择哪种语言取决于个人兴趣、职业方向和特定需求。想了解更多python和java和c++的相关内容,可以阅读本专题下面的文章。

2024.03.22

1177

7

c++和c语言学习顺序推荐
c++和c语言学习顺序推荐

对于初学者,建议先学习C语言,掌握编程基础后再转入C++,便于理解面向对象编程概念。有编程经验者可直接学习C++,快速接触高级编程技术。想了解更多c++和c语言的相关内容,可以阅读本专题下面的文章。

2024.03.25

1305

9

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Valgrind Quick Start Guide
Valgrind Quick Start Guide

共0课时 | 0人学习

CLion CMake 快速入门教程
CLion CMake 快速入门教程

共0课时 | 0人学习