多应用CMake项目中静态库引用应用专属头文件的问题

项目结构 #

CMakeExample
├── Apps
│   ├── App1
│   │   ├── AppSpecificHeader.h
│   │   ├── CMakeLists.txt
│   │   └── main.c
│   ├── App2
│   │   ├── AppSpecificHeader.h
│   │   ├── CMakeLists.txt
│   │   └── main.c
│   └── CMakeLists.txt
├── CMakeLists.txt
└── Libs
    ├── CMakeLists.txt
    ├── Lib1
    │   ├── CMakeLists.txt
    │   ├── Lib1.c
    │   └── Lib1.h
    └── Lib2
        ├── CMakeLists.txt
        ├── Lib2.c
        └── Lib2.h

问题背景 #

在单个CMake项目中构建多静态库及依赖这些库的应用时，遇到核心问题：Lib1编译时需要引用不同应用的专属头文件（App1用自身的AppSpecificHeader.h，App2同理）；若Lib2依赖Lib1，依赖关系会更复杂。

当前临时方案是将Lib1作为每个应用的一部分编译（通过引入Lib1.cmake），Lib2也随应用编译——即便Lib2不直接依赖应用专属头文件，这属于不良实践。此前尝试的其他方案均有缺陷：

• 创建仅包含应用专属头文件的interface library，但无法在不同应用中创建同名目标；
• 通过指定应用编译标志，导致多次构建、编译时间大幅延长。

补充代码 #

Apps/App1/AppSpecificHeader.h #

#ifndef APP_SPECIFIC_HEADER_H
#define APP_SPECIFIC_HEADER_H

#define CONSTANT_CONFIG_VALUE 5U

#endif

Apps/App2/AppSpecificHeader.h #

#ifndef APP_SPECIFIC_HEADER_H
#define APP_SPECIFIC_HEADER_H

#define CONSTANT_CONFIG_VALUE 6U

#endif

Libs/Lib1/Lib1.c #

#include "Lib1.h"
#include "AppSpecificHeader.h"

void foo()
{
    uint8_t val = CONSTANT_CONFIG_VALUE;
}

解决方案 #

方法1：为每个应用的依赖库创建带后缀的独立目标 #

CMake允许为同一库创建不同命名的目标，通过参数化配置实现每个应用对应独立的Lib1编译实例：

修改Libs/Lib1/CMakeLists.txt：

cmake_minimum_required(VERSION 3.10)
# 接受目标后缀参数，默认空
set(TARGET_SUFFIX "" CACHE STRING "Suffix for library target name")

set(LIB_TARGET_NAME "Lib1${TARGET_SUFFIX}")

add_library(${LIB_TARGET_NAME} STATIC Lib1.c Lib1.h)
# 传入应用专属头文件路径
target_include_directories(${LIB_TARGET_NAME} PRIVATE ${APP_SPECIFIC_INCLUDE_DIR})

在Apps/App1/CMakeLists.txt中配置：

# 指定编译目录避免冲突
add_subdirectory(${CMAKE_SOURCE_DIR}/Libs/Lib1 Lib1_App1_build)
# 设置专属后缀和头文件路径
set(TARGET_SUFFIX "_App1" CACHE INTERNAL "")
set(APP_SPECIFIC_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR} CACHE INTERNAL "")

add_executable(App1 main.c)
target_link_libraries(App1 PRIVATE Lib1_App1)

App2可按相同逻辑配置，Lib2若依赖Lib1，也可为每个应用创建对应后缀的Lib2目标（如Lib2_App1依赖Lib1_App1）。

方法2：使用对象库复用编译产物 #

通过对象库保存Lib1的编译中间产物，在应用端添加专属编译配置：

修改Libs/Lib1/CMakeLists.txt定义对象库：

add_library(Lib1 OBJECT Lib1.c Lib1.h)
# 不在这里添加应用头文件路径，留到应用端配置

在Apps/App1/CMakeLists.txt中配置：

add_executable(App1 main.c $<TARGET_OBJECTS:Lib1>)
# 添加应用专属头文件路径
target_include_directories(App1 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})

# 处理Lib2依赖
add_library(Lib2 OBJECT ${CMAKE_SOURCE_DIR}/Libs/Lib2/Lib2.c ${CMAKE_SOURCE_DIR}/Libs/Lib2/Lib2.h)
target_link_libraries(Lib2 PRIVATE Lib1)
target_include_directories(Lib2 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})

target_sources(App1 PRIVATE $<TARGET_OBJECTS:Lib2>)

此方式下CMake会根据编译选项差异缓存对象文件，比完全复制代码的临时方案更高效。

方法3：重构代码，分离配置与库（推荐） #

从根源消除库对应用头文件的依赖，通过接口注入配置：

修改Libs/Lib1/Lib1.h：

#ifndef LIB1_H
#define LIB1_H

void foo(uint8_t config_val);

#endif

修改Libs/Lib1/Lib1.c：

#include "Lib1.h"

void foo(uint8_t config_val)
{
    uint8_t val = config_val;
}

在App1的main.c中传入配置：

#include "AppSpecificHeader.h"
#include "Lib1.h"

int main()
{
    foo(CONSTANT_CONFIG_VALUE);
    return 0;
}

这种方式彻底解耦库与应用配置，是最干净、可维护性最高的方案。

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