如何为供他人使用的C++库配置CMake文件与项目结构

1. 解决CMake反向子目录报错问题 #

你遇到的错误是因为CMake不允许用add_subdirectory(..)将上级目录作为子目录——子目录必须是当前CMakeLists.txt所在目录的下级。正确的思路是从根目录的CMakeLists.txt统一管理测试构建，而非反过来从test目录引入根目录。

调整后的CMake配置 #

根目录CMakeLists.txt

cmake_minimum_required(VERSION 3.12)
project(mylib VERSION 0.2.0.0 LANGUAGES C CXX)

# 定义库目标
add_library(mylib)
target_sources(mylib PRIVATE src/sourceA.cpp src/sourceB.cpp)
target_include_directories(mylib PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/include")

# 新增测试构建开关，默认关闭
option(MYLIB_BUILD_TESTS "Build tests for mylib" OFF)
if(MYLIB_BUILD_TESTS)
    add_subdirectory(test)
endif()

test/CMakeLists.txt

# 无需重新定义project，复用根目录的项目配置即可
add_executable(mylib_test test.cpp)
target_link_libraries(mylib_test PRIVATE mylib)

当你需要构建测试时，只需在配置CMake时开启开关：

cmake -S . -B build -DMYLIB_BUILD_TESTS=ON
cmake --build build

其他开发者默认构建时不会编译测试代码，完全满足你的需求。

2. 标准化项目结构与最佳实践 #

你当前的项目结构本身就是符合行业通用标准的，核心优化点是用CMake选项控制可选组件（如测试）的构建，这是C++库开发的主流最佳实践：

核心满足的需求 #

• 你开发时：开启MYLIB_BUILD_TESTS开关，就能同时构建库和测试程序，测试可直接链接库目标
• 其他开发者：默认仅构建库本身，不会引入测试相关的冗余配置

补充优化建议 #

• 测试目标命名避免用test这类通用名称，改成mylib_test可防止和其他项目目标冲突
• 可结合CTest框架管理测试：在根CMakeLists.txt中添加enable_testing()，在test目录用add_test(NAME mylib_test COMMAND mylib_test)，方便批量运行测试
• 如果lib目录存放第三方依赖，可在根CMakeLists.txt中用add_subdirectory(lib)引入，或用FetchContent远程拉取依赖

内容的提问来源于stack exchange，提问作者glades