如何通过CMake仅拉取Git仓库中的单个文件？

如果你只需要Git仓库中的单个Utils.cmake文件，无需拉取整个仓库，可以用以下两种实用方法：

方法一：Git稀疏检出（Sparse Checkout） #

利用Git的稀疏检出功能，让FetchContent仅拉取指定路径的文件，步骤如下：

include(FetchContent)
FetchContent_Declare(
  CMakeScripts
  GIT_REPOSITORY <Git仓库地址>
  GIT_TAG        <对应版本哈希>
  # 启用稀疏检出配置
  GIT_CONFIG     core.sparseCheckout=true
)

FetchContent_GetProperties(CMakeScripts)
if(NOT CMakeScripts_POPULATED)
  # 初始化仓库（仅拉取元数据，未完整检出文件）
  FetchContent_Populate(CMakeScripts)
  
  # 写入需要检出的文件路径
  file(WRITE ${CMakeScripts_SOURCE_DIR}/.git/info/sparse-checkout
    "cmake/Utils.cmake"
  )
  
  # 应用稀疏检出，仅拉取指定文件
  execute_process(
    COMMAND git checkout ${CMakeScripts_GIT_TAG}
    WORKING_DIRECTORY ${CMakeScripts_SOURCE_DIR}
    RESULT_VARIABLE checkout_result
  )
  
  if(NOT checkout_result EQUAL 0)
    message(FATAL_ERROR "稀疏检出失败：${checkout_result}")
  endif()
endif()

# 引入目标文件
include(${CMakeScripts_SOURCE_DIR}/cmake/Utils.cmake)

该方法保留了Git版本管理能力，后续更新版本仅需修改GIT_TAG，无需调整文件路径。

方法二：直接下载单个文件 #

如果仓库支持直接访问单个文件（如GitHub、GitLab等平台），可通过CMake的file(DOWNLOAD)命令直接下载目标文件，无需拉取仓库：

# 构造目标文件的直接下载链接（以GitHub为例）
set(UTILS_CMAKE_URL "https://raw.githubusercontent.com/<用户名>/<仓库名>/<版本哈希>/cmake/Utils.cmake")
# 指定本地保存路径
set(UTILS_CMAKE_PATH "${CMAKE_BINARY_DIR}/external/Utils.cmake")

# 下载文件（可选添加哈希验证确保文件完整性）
file(DOWNLOAD
  ${UTILS_CMAKE_URL}
  ${UTILS_CMAKE_PATH}
  # EXPECTED_HASH SHA256=<文件的SHA256哈希值>
  STATUS download_status
)

# 检查下载状态
list(GET download_status 0 status_code)
list(GET download_status 1 error_msg)
if(NOT status_code EQUAL 0)
  message(FATAL_ERROR "下载Utils.cmake失败：${error_msg}")
endif()

# 引入下载的文件
include(${UTILS_CMAKE_PATH})

该方法更轻量，无需处理Git仓库配置，但需手动构造文件下载链接，当文件路径或仓库地址变更时需同步更新链接。

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