合并目录结构下CMake target_include_directories排除私有头文件问询

针对你使用合并目录结构（头、源、测试文件同目录）时，关联库意外访问私有头文件的问题，以下是具体的CMake解决方案：

核心思路 #

通过CMake的target_include_directories关键字（PRIVATE/PUBLIC/INTERFACE）区分对外暴露的路径和仅当前目标可用的路径，同时配合target_sources标记公共头文件，实现私有头的隔离。

具体实现步骤 #

假设你的项目模块结构如下（以modules/foo模块为例）：

modules/foo/
├── foo.h          # 公共头文件
├── foo.cpp        # 源文件
├── foo_internal.h # 私有头文件
└── test_foo.cpp   # 测试文件

1. 模块库的CMake配置 #

在modules/foo/CMakeLists.txt中：

# 创建模块库目标
add_library(libfoo STATIC)

# 标记文件可见性：公共头对外暴露，私有文件仅本库可用
target_sources(libfoo
  PUBLIC
    foo.h
  PRIVATE
    foo.cpp
    foo_internal.h
)

# 设置include路径：
# - PUBLIC：对外暴露项目根路径，让依赖库通过<modules/foo/foo.h>引用公共头
# - PRIVATE：仅本库可用当前目录，用于引用私有头文件
target_include_directories(libfoo
  PUBLIC
    ${PROJECT_SOURCE_DIR}
  PRIVATE
    ${CMAKE_CURRENT_SOURCE_DIR}
)

2. 测试目标的配置 #

测试文件需要访问私有头，单独给测试目标添加私有include路径：

add_executable(test_foo test_foo.cpp)
# 链接模块库
target_link_libraries(test_foo PRIVATE libfoo)
# 给测试目标添加当前目录的include权限，允许访问私有头
target_include_directories(test_foo PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})

3. 依赖模块的配置 #

当其他模块依赖libfoo时，只需链接目标即可，依赖模块只能通过<modules/foo/foo.h>访问公共头，无法看到foo_internal.h：

add_library(libbar STATIC bar.cpp bar.h)
target_link_libraries(libbar PUBLIC libfoo)

关键说明 #

• PUBLIC关键字：将路径暴露给当前目标及其所有依赖目标
• PRIVATE关键字：仅当前目标可用，依赖目标无法获取该路径
• 公共头文件通过项目根路径引用，既符合合并目录结构，又能避免私有头被意外访问

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