如何为Modern CMake的头文件包含路径构建合理结构？

这是Modern CMake实践里很常见的问题，核心是要给库的头文件加上命名空间目录，既能解决头文件归属模糊的痛点，又能严格控制可访问的包含范围。下面是具体的解决方案：

1. 调整目录结构（推荐方案） #

首先把core库的源文件和头文件放到一个与库同名的子目录里，项目结构更新为：

root/
- CMakeLists.txt
- core/
  - CMakeLists.txt
  - core/          # 新增的命名空间目录
    - core.h
    - core.cpp
- bin/
  - x2_cli.cpp
  - CMakeLists.txt
- other_dirs/
  - ...

2. 修改core目录的CMakeLists.txt #

更新core/CMakeLists.txt，调整源文件路径并保持target_include_directories的设置：

add_library(core core/core.cpp core/core.h)
# 将core目录（而非core/core目录）设为PUBLIC包含路径
target_include_directories(core PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})

3. 更新头文件包含语句 #

现在在bin/x2_cli.cpp里，你就可以用清晰的命名空间式包含：

#include "core/core.h"

为什么这样有效？ #

• 当bin/x2_cli链接core库时，core目录会被加入到它的包含路径中，所以#include "core/core.h"能正确定位到头文件。
• other_dirs不在任何目标的PUBLIC/INTERFACE包含路径里，尝试#include "other_dirs/bad.h"会直接触发编译错误，完美满足你“禁止访问不该访问的文件夹”的要求。
• 这种结构也符合Modern CMake的最佳实践：每个库的头文件都被包裹在同名目录下，避免不同库的头文件重名冲突，同时保持包含路径的干净整洁。

为什么不直接用target_include_directories(core PUBLIC ..)？ #

你提到的这种做法确实不可取，因为它会把根目录加入到包含路径中：

• 这会污染所有链接core的目标的包含空间，允许它们直接访问other_dirs等无关目录的文件，违反了代码封装的原则。
• 包含路径变得模糊，无法清晰区分哪些目录是被允许访问的，和你想要解决的“头文件归属混乱”问题背道而驰。

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