C++如何编写一个CMakeLists.txt文件?(多目录项目)

13次阅读

多目录c++项目需分层编写CMakeLists.txt:根目录定义项目、标准及add_subDirectory引入src/tests等子目录;src目录用add_library/add_executable构建目标并设头文件路径;tests目录启用enable_testing、添加测试可执行文件并注册add_test;include目录无需CMakeLists.txt,头文件路径通过target_include_directories暴露。

C++如何编写一个CMakeLists.txt文件?(多目录项目)

多目录C++项目的CMakeLists.txt需要分层编写:根目录一个主文件负责项目配置和子目录管理,每个子目录(如srcincludetests)配一个独立的CMakeLists.txt负责局部构建逻辑。

根目录CMakeLists.txt:定义项目与包含子目录

这是整个项目的入口,必须放在最外层。核心是声明项目名、C++标准、最低CMake版本,并用add_subdirectory()引入各模块:

  • cmake_minimum_required(VERSION 3.10)明确最低CMake版本(推荐3.10或更高)
  • project(Myapp VERSION 1.0 LANGUAGES CXX)声明项目名、版本和语言
  • set(CMAKE_CXX_STANDARD 17)统一设置C++标准(可选,也可在target上单独设)
  • add_subdirectory(src)add_subdirectory(tests)逐个引入子目录
  • 若含第三方依赖,可在根目录用find_package()FetchContent提前准备

src/CMakeLists.txt:组织源码与生成可执行/库

该目录通常存放.cpp.h文件。这里用add_library()add_executable()定义构建目标:

  • file(GLOB_RECURSE SOURCES "*.cpp")可收集所有cpp(但更推荐显式列出,便于维护)
  • add_library(mylib Static ${SOURCES})创建静态库;用SHARED可建动态库
  • target_include_directories(mylib public ${CMAKE_CURRENT_SOURCE_DIR}/../include)导出头文件路径
  • 若生成可执行文件:add_executable(myapp main.cpp),再用target_link_libraries(myapp private mylib)链接库

tests/CMakeLists.txt:单独管理测试代码

测试目录建议独立构建,避免污染主逻辑。常用做法是引入google Test或使用CMake内置CTest:

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

  • 启用测试支持:enable_testing()(写在根目录或test目录均可,推荐根目录)
  • 添加测试可执行文件:add_executable(test_main test_main.cpp)
  • 链接测试库和主库:target_link_libraries(test_main PRIVATE mylib gtest_main)
  • 注册为CTest测试:add_test(NAME run_tests COMMAND test_main)
  • 若用FetchContent内嵌gtest,需在根目录或本目录中提前声明并include(FetchContent)

include/ 和其他目录:无需CMakeLists.txt(除非需生成安装规则)

include/目录本身不编译,一般不放CMakeLists.txt。头文件路径通过target_include_directories()暴露给对应target即可。如果要做install(如make install),可在根目录或src/中加:

  • install(TARGETS mylib EXPORT mylibTargets)导出库
  • install(DIRECTORY ../include/myapp/ DESTINATION include/myapp)安装头文件
  • install(EXPORT mylibTargets DESTINATION lib/cmake/myapp)生成配置文件供下游使用

不复杂但容易忽略:每个add_subdirectory()调用都会进入对应目录执行其CMakeLists.txt,变量作用域默认隔离(除非用PARENT_SCOPE显式传递),所以不要假设子目录能自动读到根目录的变量。

text=ZqhQzanResources