CMake如何避免指定头文件的精确路径

目录结构 #

Project
  |  
  |-CMakeLists.txt

Library
  |
  |-LibProjectA
  |   |-CMakeLists.txt
  |   |-src
  |      |-SomeHeader0.h
  |-LibProjectB
  |   |-CMakeLists.txt
  |   |-src
  |      |-SomeHeader1.h
  |-LibProjectC
      |-CMakeLists.txt
      |-src
         |-SomeHeader2.h

OpenSourceProject
  |
  |-CMakeLists.txt
  |-src
     |-SomeOpenSourceHeader.h

依赖背景 #

• Project静态链接LibProjectA
• LibProjectA → LibProjectB → LibProjectC 链式依赖
• 三个Library项目均依赖OpenSourceProject，其中LibProjectC需直接引用SomeOpenSourceHeader.h

当前问题 #

每次配置LibProjectC时，必须手动指定SomeOpenSourceHeader.h的精确路径，顶层Project的全局配置无法生效，导致配置冗余且易出错。

核心疑问 #

能否仅通过一次add_subdirectory配置OpenSourceProject，让所有依赖它的库自动识别其头文件，且上层项目无需关心底层开源库的依赖细节？

解决方案 #

完全可以通过CMake的目标接口属性传递实现需求，核心是将OpenSourceProject封装为CMake目标，让所有依赖通过目标关联而非硬编码路径。

1. 配置OpenSourceProject的CMake目标 #

在OpenSourceProject/CMakeLists.txt中，创建接口库（仅头文件场景）或静态库，并设置接口包含目录，确保依赖它的目标能自动继承路径：

cmake_minimum_required(VERSION 3.10)
project(OpenSourceProject)

# 仅头文件场景用INTERFACE库更轻量；有源码则用STATIC
add_library(${PROJECT_NAME} INTERFACE)

# 设置INTERFACE级别的包含目录，让依赖目标自动添加该路径
target_include_directories(${PROJECT_NAME}
    INTERFACE
        ${CMAKE_CURRENT_SOURCE_DIR}/src
)

2. 让Library项目通过目标关联依赖 #

以LibProjectC为例，在Library/LibProjectC/CMakeLists.txt中，添加OpenSourceProject子目录并关联目标：

cmake_minimum_required(VERSION 3.10)
project(LibProjectC)

add_library(${PROJECT_NAME} STATIC src/SomeHeader2.h)

# 添加OpenSourceProject子目录（路径根据实际相对位置调整）
add_subdirectory(${CMAKE_SOURCE_DIR}/../../OpenSourceProject ${CMAKE_BINARY_DIR}/OpenSourceProject)

# 关联OpenSourceProject目标，自动继承其包含目录
target_link_libraries(${PROJECT_NAME} PRIVATE OpenSourceProject)

同理，LibProjectB关联LibProjectC，LibProjectA关联LibProjectB，只需在各自的CMakeLists.txt中用target_link_libraries链接下层目标即可，无需重复配置OpenSourceProject路径。

3. 顶层Project仅需链接直接依赖 #

在Project/CMakeLists.txt中，只需添加LibProjectA子目录并链接，CMake会自动处理所有底层依赖的路径和关联：

cmake_minimum_required(VERSION 3.10)
project(Project)

add_executable(${PROJECT_NAME} main.cpp)

# 添加LibProjectA子目录
add_subdirectory(${CMAKE_SOURCE_DIR}/../Library/LibProjectA ${CMAKE_BINARY_DIR}/LibProjectA)

# 直接链接LibProjectA，底层依赖会自动传递
target_link_libraries(${PROJECT_NAME} PRIVATE LibProjectA)

关键逻辑 #

CMake的目标属性传递机制：当用target_link_libraries关联目标时，目标的INTERFACE/PUBLIC属性（包含目录、编译选项等）会自动向上传递给依赖它的上层目标。上层项目只需关注直接依赖，底层所有依赖细节由CMake自动处理。

注意事项 #

• 确保CMake版本≥3.10，避免属性传递的兼容性问题
• 用CMAKE_SOURCE_DIR等全局变量指定路径，避免硬编码相对路径
• 若OpenSourceProject是第三方库，也可通过find_package导入其CMake目标，效果一致

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