CMake interface library 的 PRIVATE file set 为何仍可访问?
结论
这个示例能够构建成功,符合 CMake 的行为。ggg 的 INTERFACE HEADERS file set 将整个 include 目录加入 consumer 的头文件搜索路径,main 通过 ggg1 间接获得该路径。g.h 和 g1.h 都在这个目录下,因此编译器能找到它们。
PRIVATE 控制 file set 及相关使用要求的传播,不会限制对目录中单个文件的访问。即使 ggg1_headers 保持 PRIVATE,编译器仍能通过其他 target 提供的搜索路径找到 g1.h。
BASE_DIRS 为什么会让 g1.h 可见
对于 TYPE HEADERS 的 file set,BASE_DIRS 也会影响头文件搜索路径:
PRIVATE或PUBLIC的 base directories 会加入 target 的INCLUDE_DIRECTORIES。INTERFACE或PUBLIC的 base directories 会加入 target 的INTERFACE_INCLUDE_DIRECTORIES,供 consumer 使用。
示例中,ggg 的配置是:
target_sources(ggg
INTERFACE
FILE_SET ggg_headers
TYPE HEADERS
BASE_DIRS include
FILES
include/g.h
)
这会将项目的 include 目录作为 ggg 的使用要求向外传播。再通过下面的链接关系,main 就能获得这个头文件搜索路径:
target_link_libraries(ggg1 INTERFACE ggg)
target_link_libraries(main PRIVATE ggg1)
这里 main 链接时使用 PRIVATE,仍会使用依赖的 usage requirements。PRIVATE 控制的是这些依赖是否继续作为 main 的接口向外传播。
编译器按目录搜索头文件。虽然 ggg_headers 的 FILES 只列出了 include/g.h,编译器仍能在同一目录中找到 g1.h。FILES 列表不会成为 #include 的文件白名单。
将 ggg1_headers 改为 PRIVATE 后,这个 file set 不再向 consumer 提供其 base directories,但 ggg 提供的相同路径仍然存在。
如何验证搜索路径
可以重新配置并查看详细构建命令:
cmake -S . -B build
cmake --build build --verbose
如果 main.cpp 已经是最新状态,需要修改后重新构建,才会出现对应的编译命令。
检查命令中的头文件搜索选项,例如 GCC 或 Clang 的 -I,以及 MSVC 的 /I。按题目给出的配置,编译 main.cpp 时应获得项目 include 目录的搜索路径;具体选项格式由编译器决定。
如何避免通过公共搜索路径暴露 g1.h
如果 g1.h 是内部头文件,可以将它移出公开的 base directory,例如:
项目根目录/
├── CMakeLists.txt
├── include/
│ └── ggg/
│ └── g.h
├── internal/
│ └── ggg1/
│ └── g1.h
└── src/
└── main.cpp
对应的完整配置可以写成:
cmake_minimum_required(VERSION 3.30)
project(test20 VERSION 1.0 LANGUAGES CXX)
add_library(ggg INTERFACE)
target_sources(ggg
INTERFACE
FILE_SET ggg_headers
TYPE HEADERS
BASE_DIRS include/ggg
FILES include/ggg/g.h
)
add_library(ggg1 INTERFACE)
target_sources(ggg1
PRIVATE
FILE_SET ggg1_headers
TYPE HEADERS
BASE_DIRS internal/ggg1
FILES internal/ggg1/g1.h
)
target_link_libraries(ggg1 INTERFACE ggg)
add_executable(main src/main.cpp)
target_link_libraries(main PRIVATE ggg1)
在没有其他头文件搜索路径配置的前提下,main 可以继续使用 #include "g.h",但原来的 #include "g1.h" 将无法找到文件。如果 main 不应该使用内部接口,还应删除对应的 include 和 g1() 调用。
如果 g1.h 本来就需要供 main 使用,则应将 ggg1_headers 声明为 INTERFACE,让依赖关系明确表达这一需求。
interface library 的注意事项
interface library 自身不编译源文件,也不生成供链接使用的目标文件。给它添加 PRIVATE HEADERS file set,不会创建编译内部实现的步骤。
对于 header-only library,如果公开头文件需要包含某个辅助头文件,consumer 编译时也必须能找到该文件。可以用 detail 等目录表达内部实现约定,但只要编译器能够访问相应路径,就无法通过 file set visibility 禁止 consumer 直接包含它。
拆分目录可以避免通过公共搜索路径意外暴露内部头文件,但不能用作文件访问控制。
备注:内容仅供参考。
