如何用CMake处理含子库与指定包含目录的项目结构？

我来帮你梳理下如何用CMake实现你的需求，完全不需要移动现有目录结构，还能完美保留模块化和头文件引用方式，同时避免暴露私有文件。

核心思路 #

CMake的目标属性系统是关键——通过为每个子库目标设置PUBLIC/PRIVATE/INTERFACE属性，我们可以精确控制哪些头文件路径对外暴露，哪些只在内部使用。同时，利用CMake的install命令和构建时的包含路径配置，既能满足开发时的引用需求，也能保证安装后的库可以被外部程序正确引用。

具体实现步骤 #

1. 根目录CMakeLists.txt基础配置 #

先在项目根目录创建CMakeLists.txt，设置项目基本信息，并添加子目录：

cmake_minimum_required(VERSION 3.16)
project(MyProject LANGUAGES CXX)

# 设置编译选项（按需调整）
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_POSITION_INDEPENDENT_CODE ON) # 生成共享库时需要开启

# 添加子目录，每个子目录会生成独立静态库
add_subdirectory(subdir)
add_subdirectory(subdir2)

# 生成包含所有子库的整体静态/共享库
add_library(MyProject_all STATIC) # 要共享库就替换为SHARED
target_link_libraries(MyProject_all
    PRIVATE
        subdir_lib
        subdir2_lib
)

# 安装整体库（可选，供外部程序链接）
install(TARGETS MyProject_all
    ARCHIVE DESTINATION lib
    LIBRARY DESTINATION lib
)

2. 处理subdir目录（含嵌套subdir/subdir） #

在subdir目录下创建CMakeLists.txt，区分私有文件（仅子库内部使用）和公共文件（对外暴露的头文件）：

# 先处理嵌套的subdir/subdir（公开头文件目录）
add_subdirectory(subdir)

# 创建subdir的静态库
add_library(subdir_lib STATIC
    # 这里放subdir层级的.cxx文件（私有实现）
    SomeFile.cxx
    AnotherFile.cxx
)

# 设置subdir_lib的包含路径：
# - PRIVATE：仅当前库编译时使用，不对外暴露
# - PUBLIC：当前库编译和依赖它的目标都能使用
target_include_directories(subdir_lib
    PRIVATE
        ${CMAKE_CURRENT_SOURCE_DIR} # 让subdir内部能#include "foo.h"（私有头）
    PUBLIC
        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/subdir> # 构建时的公开头路径
        $<INSTALL_INTERFACE:include/subdir> # 安装后的公开头路径
)

# 链接嵌套的subdir_subdir_lib（如果有依赖）
target_link_libraries(subdir_lib
    PRIVATE
        subdir_subdir_lib
)

# 安装subdir_lib（可选，供测试子库依赖用）
install(TARGETS subdir_lib
    ARCHIVE DESTINATION lib
)

# 安装公开头文件：把subdir/subdir下的头文件安装到include/subdir
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/subdir/
    DESTINATION include/subdir
    FILES_MATCHING PATTERN "*.h"
)

然后在subdir/subdir目录下创建CMakeLists.txt，处理这个公开子目录的内容：

# 创建subdir_subdir的静态库（如果有实现文件的话，没有则可以跳过库创建）
add_library(subdir_subdir_lib STATIC
    # 这里放subdir/subdir下的.cxx文件（如果有的话）
    PublicImpl.cxx
)

# 设置该库的包含路径，确保内部能引用自己的头文件
target_include_directories(subdir_subdir_lib
    PRIVATE
        ${CMAKE_CURRENT_SOURCE_DIR}
)

# 安装该子库（可选）
install(TARGETS subdir_subdir_lib
    ARCHIVE DESTINATION lib
)

3. 处理subdir2目录（类似subdir的逻辑） #

在subdir2目录下创建CMakeLists.txt：

# 创建subdir2的静态库
add_library(subdir2_lib STATIC
    # subdir2层级的.cxx文件
    Subdir2File.cxx
)

# 设置包含路径：私有头在当前目录，公开头在subdir2的子目录
target_include_directories(subdir2_lib
    PRIVATE
        ${CMAKE_CURRENT_SOURCE_DIR} # 内部#include "foo.h"（私有头）
    PUBLIC
        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/subdir2> # 构建时公开头路径
        $<INSTALL_INTERFACE:include/subdir2> # 安装后公开头路径
)

# 安装subdir2_lib和公开头文件
install(TARGETS subdir2_lib
    ARCHIVE DESTINATION lib
)

install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/subdir2/
    DESTINATION include/subdir2
    FILES_MATCHING PATTERN "*.h"
)

关键细节说明 #

1. 避免暴露私有文件：

   • 我们只把subdir/subdir和subdir2/subdir2设置为PUBLIC包含路径，而subdir和subdir2本身的目录设置为PRIVATE，这样外部程序无法通过#include <subdir/bar.h>引用私有头文件，更不可能引用.cxx文件（这些文件不在公开包含路径内）。
   • 通过install命令的FILES_MATCHING PATTERN "*.h"，只安装公开的头文件，私有文件不会被安装到系统目录。

2. 头文件引用方式：

   • 开发构建时，外部测试程序或整体库通过target_link_libraries依赖子库后，自动获得PUBLIC包含路径，直接用#include <subdir/foo.h>就能引用公开头文件。
   • 安装后，外部程序只需在CMake中用find_package(MyProject)，或者手动添加-I/path/to/install/include，就能用同样的方式引用头文件。

3. 子库依赖测试：
   每个子目录生成独立的静态库（subdir_lib、subdir2_lib等），你可以单独编写测试程序链接这些子库，验证它们之间的依赖关系。

是否需要移动目录？ #

完全不需要！通过CMake的target_include_directories和install命令的路径映射，我们可以在保留现有目录结构的前提下，实现你想要的头文件引用方式和模块化构建。

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