CMake中INTERFACE库头文件路径未传递给SHARED库的问题排查

环境 #

• CMake 3.25.3
• GCC 12.2.0

场景复现 #

• 定义名为foo的INTERFACE头文件库，配置INTERFACE_INCLUDE_DIRECTORIES并完成安装导出；
• 为foo生成并导出CMake配置文件，支持find_package调用；
• 独立代码库中的SHARED库bar通过find_package引入foo，配置自身头文件路径；
• bar通过target_link_libraries(bar INTERFACE foo)声明依赖，但编译bar.cpp时，编译器无法获取foo的头文件路径；
• 临时解决方案：手动获取foo的INTERFACE_INCLUDE_DIRECTORIES并添加到bar的INCLUDE_DIRECTORIES中。

用户问题 #

1. 该临时方案是否必要？
2. 我的头文件库打包是否存在问题？
3. fooConfig.cmake.in是否缺少配置？

问题解答 #

1. 临时方案完全没必要 #

问题核心是target_link_libraries(bar INTERFACE foo)的写法错误。INTERFACE修饰的依赖仅会传递给链接bar的下游目标，不会作用于bar自身的编译阶段——而bar.cpp属于bar自身的源文件编译，根本无法通过这个声明获取foo的头文件路径。

正确写法需根据实际需求调整：

# 仅bar的源文件需要foo头文件，用PRIVATE
target_link_libraries(bar PRIVATE foo)
# 若bar的头文件也引用了foo头文件，用PUBLIC（同时传递依赖给下游）
# target_link_libraries(bar PUBLIC foo)

修正依赖声明后，编译器会自动继承foo的INTERFACE_INCLUDE_DIRECTORIES，无需手动添加。

2. 头文件库打包大概率无问题 #

如果find_package(foo)能成功找到目标，说明打包核心逻辑正确。可通过以下命令验证foo的目标属性：

find_package(foo REQUIRED)
get_target_property(FOO_INCLUDES foo INTERFACE_INCLUDE_DIRECTORIES)
message(STATUS "foo include dirs: ${FOO_INCLUDES}")

若输出路径正确，打包环节无问题，问题出在bar的依赖声明上。

3. fooConfig.cmake.in大概率不缺配置 #

只要配置文件包含导入目标的逻辑，就不存在缺失问题。常见的fooConfig.cmake.in模板如下：

@PACKAGE_INIT@

include("${CMAKE_CURRENT_LIST_DIR}/fooTargets.cmake")
check_required_components(foo)

如果你的配置文件符合上述结构，就无需额外补充配置。

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