如何在INTERFACE库中使用target_sources命令？多子目录项目场景

先明确你的项目结构（方便对照）：

project
 |
 |----- src 
 |    |----- dir1 <-- 仅含头文件的库
 |    |    |--- dir1.h
 |    |    |--- CMakeLists.txt
 |    |
 |    |----- dir2
 |         |--- dir2.cpp
 |         |--- dir2.h
 |         |--- CMakeLists.txt
 |
 |--- file.h
 |--- CMakeLists.txt
 |
 |----- test 
 |      |----- dir1 
 |      |    |--- test.cpp
 |      |----- dir2 
 |           |--- test_xxx.cpp

针对这种有跨目录依赖、包含纯头文件库的场景，INTERFACE类型的CMake目标是完美适配的——它不需要编译二进制，专门用来传递头文件路径、编译选项这类依赖信息。下面是具体的实现步骤：

1. 配置纯头文件库dir1的CMakeLists.txt #

在src/dir1/CMakeLists.txt里，我们创建INTERFACE目标，并用target_sources声明对外暴露的头文件，同时设置头文件的包含路径：

# src/dir1/CMakeLists.txt
add_library(dir1 INTERFACE)

# 用target_sources + INTERFACE关键字添加头文件
# 这些文件会被所有依赖dir1的目标自动识别
target_sources(dir1 INTERFACE
    ${CMAKE_CURRENT_SOURCE_DIR}/dir1.h
)

# 设置头文件的根目录，INTERFACE关键字确保依赖dir1的目标能自动找到这里
target_include_directories(dir1 INTERFACE
    ${CMAKE_CURRENT_SOURCE_DIR}
)

2. 配置有源码的dir2库 #

dir2如果依赖dir1，直接链接dir1的INTERFACE目标就行，CMake会自动处理头文件路径的传递：

# src/dir2/CMakeLists.txt
add_library(dir2 STATIC) # 根据需求选STATIC/SHARED/OBJECT

# 给dir2添加自己的源码和头文件（用PRIVATE，因为这些不需要对外暴露）
target_sources(dir2 PRIVATE
    dir2.cpp
    dir2.h
)

# 链接dir1的INTERFACE库，这样dir2编译时就能直接#include "dir1.h"
target_link_libraries(dir2 PRIVATE dir1)

3. 上层CMakeLists.txt的整合 #

src目录的CMakeLists.txt #

需要把dir1和dir2的子目录加进来，让上层能找到这些目标：

# src/CMakeLists.txt
add_subdirectory(dir1)
add_subdirectory(dir2)

顶层项目的CMakeLists.txt #

设置项目基础信息，同时包含src和test目录：

# 顶层CMakeLists.txt
cmake_minimum_required(VERSION 3.16) # 建议用3.16+的版本，支持更多INTERFACE特性
project(MyProject)

add_subdirectory(src)
add_subdirectory(test)

4. 测试代码的配置 #

以test/dir1为例，测试代码依赖dir1，直接链接INTERFACE目标即可：

# test/dir1/CMakeLists.txt
add_executable(test_dir1 test.cpp)

# 链接dir1后，test.cpp里就能直接#include "dir1.h"，不用手动加头文件路径
target_link_libraries(test_dir1 PRIVATE dir1)

对于test/dir2的测试，因为dir2已经依赖了dir1，所以只需要链接dir2就足够了：

# test/dir2/CMakeLists.txt
add_executable(test_dir2 test_xxx.cpp)
target_link_libraries(test_dir2 PRIVATE dir2)

几个关键细节要注意 #

• target_sources的INTERFACE关键字：添加的文件会传递给所有依赖该目标的其他目标，确保头文件能被IDE正确索引，同时CMake也能追踪这些文件的变化。
• 头文件路径的传递：通过target_include_directories的INTERFACE关键字，不需要每个依赖的目标手动写include_directories，CMake会自动把路径传递下去，避免重复配置。
• INTERFACE库的优势：纯头文件库用INTERFACE目标，不会生成多余的二进制文件，依赖关系更清晰，尤其适合这种多子目录的项目结构。

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