CMake中如何通过ExternalProject_Add使用现有Git子模块

完全可以，ExternalProject_Add 原生支持指向本地已提前拉取完成的Git子模块目录，无需走默认的远程URL下载流程。

具体配置方法 #

核心是通过SOURCE_DIR参数直接指定本地子模块的源码路径，同时关闭默认的下载、更新步骤，避免重复拉取或覆盖本地已有代码：

• 不要配置URL、URL_HASH、GIT_REPOSITORY等远程拉取相关参数
• 用SOURCE_DIR传入本地子模块的绝对路径
• 将DOWNLOAD_COMMAND、UPDATE_COMMAND设为空字符串，禁用默认的下载、更新逻辑
• 其余构建、安装相关参数和你原本的配置保持一致即可

配置示例 #

假设你提前拉取的Git子模块存放在项目根目录的third_party/my_external_lib路径下，配置写法如下：

# 可选：提前检查子模块是否已经拉取完成，避免路径不存在导致构建报错
if(NOT EXISTS "${CMAKE_SOURCE_DIR}/third_party/my_external_lib/CMakeLists.txt")
    message(FATAL_ERROR "外部依赖子模块未初始化，请先执行 `git submodule init && git submodule update` 拉取依赖代码")
endif()

ExternalProject_Add(
    my_external_lib
    # 指向本地已拉取完成的子模块源码目录
    SOURCE_DIR ${CMAKE_SOURCE_DIR}/third_party/my_external_lib
    # 禁用默认下载、更新步骤
    DOWNLOAD_COMMAND ""
    UPDATE_COMMAND ""
    # 按需配置构建参数
    CMAKE_ARGS 
        -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR}/third_party_install
        -DBUILD_TESTING=OFF
    # 其余原有配置项保持不变
)

注意事项 #

• 必须在执行CMake配置前完成子模块的初始化和拉取，否则SOURCE_DIR指向的路径为空会直接构建失败，前面加的检查逻辑可以提前给出明确的报错提示，减少无意义的排查成本
• 如果确实需要同步子模块的最新代码，不要用ExternalProject_Add默认的更新逻辑，直接手动执行git submodule update --remote即可，避免出现版本意外变更的问题
• 不要同时配置远程拉取参数和本地SOURCE_DIR，否则会出现逻辑冲突，可能导致本地代码被远程下载的内容覆盖

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