CMake向所有子目录传递包含目录及模块链接相关疑问

项目结构 #

project
├── CMakeLists.txt
└── src
    ├── main.c
    ├── CMakeLists.txt
    ├── module1
    │   ├── module1.c
    │   ├── module1.h
    │   └── CMakeLists.txt
    └── module2
        └── module2_1
            ├── module2_1.c
            ├── module2_1.h
            └── CMakeLists.txt

各目录CMakeLists.txt内容 #

根目录CMakeLists.txt #

cmake_minimum_required(VERSION 3.28)
set(PROJECT_NAME example2)
project(${PROJECT_NAME} C)
add_subdirectory(src)

src目录CMakeLists.txt #

add_executable(${PROJECT_NAME} main.c)
add_subdirectory(module1)
add_subdirectory(module2/module2_1)
target_link_libraries(${PROJECT_NAME} PRIVATE module1)

module1目录CMakeLists.txt #

add_library(module1 module1.c)
target_link_libraries(module1 PRIVATE module2_1)

module2_1目录CMakeLists.txt #

add_library(module2_1 module2_1.c)

问题背景 #

采用从项目根目录开始的绝对路径引用头文件（如module1中用#include "module2/module2_1/module2_1.h"），但编译时提示找不到该头文件，同时有两个疑问：

疑问1：在module1中链接module2_1是否正确？module2_1会被多个模块引用，将其设为静态库并让所有消费者链接它是否合理？ #

• 链接方式正确：module1依赖module2_1的实现，通过target_link_libraries(module1 PRIVATE module2_1)明确依赖关系后，CMake会自动处理静态库的链接顺序与符号解析，逻辑没问题。
• 静态库的复用方式合理：静态库本身就是可复用代码的载体，多个模块依赖它时，各自通过target_link_libraries声明依赖即可。CMake生成最终可执行文件时，会自动打包所有用到的静态库目标文件，开启优化后不会出现冗余代码。这种方式能让每个模块的依赖关系清晰，便于维护和移植。

疑问2：src目录的CMakeLists.txt中是否需要添加target_link_libraries(module2/module2_1)？该模块并未在main.c中使用，仅被module1引用。 #

• 不需要。module1已经通过PRIVATE方式链接了module2_1，CMake的依赖链会自动传递：当main链接module1时，CMake会识别到module1的依赖，自动将module2_1的目标文件包含到最终可执行文件中。手动在src层链接属于冗余操作，会让依赖关系变得混乱。

额外修复：头文件找不到的问题 #

编译时找不到头文件，核心是未将项目根目录或src目录添加到编译器的头文件搜索路径，推荐采用目标级别的包含目录设置（更清晰，无全局污染）：
在module2_1的CMakeLists.txt中添加：

add_library(module2_1 module2_1.c)
# 将src目录设为module2_1的公开包含目录，依赖它的模块会自动继承该路径
target_include_directories(module2_1 PUBLIC ${PROJECT_SOURCE_DIR}/src)

这样module1编译时，就能通过#include "module2/module2_1/module2_1.h"找到头文件。

如果偏好全局设置，也可以在根目录CMakeLists.txt中添加：

include_directories(${PROJECT_SOURCE_DIR})

但这种方式不如目标级设置清晰，不推荐。

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