CMake如何避免重复解压归档文件

这是个非常常见的CMake场景——没人想每次构建都重复执行解压操作，既浪费时间又没必要对吧？虽然${CMAKE_COMMAND} -E tar xkf本身没有“仅当未解压时执行”的选项，但我们可以利用CMake的依赖检查和条件判断来实现这个需求，下面是几个实用的方案：

方案1：配置阶段检查标记文件（适合一次性解压） #

如果希望在CMake配置阶段就完成解压，并且后续不再重复执行，可以通过检查一个自定义的标记文件来控制：

# 定义你的ZIP文件路径和解压后的目标目录
set(YOUR_ZIP_PATH "${CMAKE_CURRENT_SOURCE_DIR}/your_archive.zip")
set(EXTRACT_DIR "${CMAKE_CURRENT_BINARY_DIR}/extracted_content")
# 定义一个标记文件，用来标识是否已经解压过
set(EXTRACT_MARKER "${EXTRACT_DIR}/.extracted_success")

# 检查标记文件是否存在，不存在则执行解压
if(NOT EXISTS ${EXTRACT_MARKER})
    # 执行解压命令
    execute_process(
        COMMAND ${CMAKE_COMMAND} -E tar xkf ${YOUR_ZIP_PATH}
        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
        RESULT_VARIABLE EXTRACT_STATUS
    )

    # 验证解压是否成功，成功则创建标记文件
    if(EXTRACT_STATUS EQUAL 0)
        file(TOUCH ${EXTRACT_MARKER})
    else()
        message(FATAL_ERROR "Failed to extract ZIP file: ${YOUR_ZIP_PATH}")
    endif()
endif()

这个方法的核心是用file(TOUCH)创建一个空的标记文件，后续CMake配置时只要这个文件存在，就不会再执行解压逻辑。

方案2：用自定义命令+目标（集成到构建流程，支持自动更新） #

如果你希望解压操作集成到构建流程中，并且当ZIP文件更新时自动重新解压，推荐用add_custom_command和add_custom_target组合，利用CMake的依赖追踪机制：

set(YOUR_ZIP_PATH "${CMAKE_CURRENT_SOURCE_DIR}/your_archive.zip")
set(EXTRACT_DIR "${CMAKE_CURRENT_BINARY_DIR}/extracted_content")
# 选择解压后的一个关键文件作为输出标记（比目录更可靠）
set(EXTRACTED_KEY_FILE "${EXTRACT_DIR}/important_file.txt")

# 定义自定义命令：当ZIP文件变化或关键文件不存在时执行解压
add_custom_command(
    OUTPUT ${EXTRACTED_KEY_FILE}
    COMMAND ${CMAKE_COMMAND} -E tar xkf ${YOUR_ZIP_PATH}
    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
    MAIN_DEPENDENCY ${YOUR_ZIP_PATH}
    COMMENT "Extracting ${YOUR_ZIP_PATH}..."
)

# 创建自定义目标，让构建流程依赖这个解压操作
add_custom_target(extract_zip ALL DEPENDS ${EXTRACTED_KEY_FILE})

这里的关键是用OUTPUT指定解压后的一个具体文件，而不是目录——CMake对文件的存在性检查更精确。当ZIP文件被修改（时间戳变化），或者这个关键文件不存在时，CMake会自动重新执行解压命令。

方案3：用CMake 3.18+的file(ARCHIVE_EXTRACT)简化操作 #

如果你的CMake版本在3.18及以上，可以用更简洁的file(ARCHIVE_EXTRACT)命令配合条件判断，效果和方案1类似：

set(YOUR_ZIP_PATH "${CMAKE_CURRENT_SOURCE_DIR}/your_archive.zip")
set(EXTRACT_DIR "${CMAKE_CURRENT_BINARY_DIR}/extracted_content")
set(EXTRACTED_KEY_FILE "${EXTRACT_DIR}/important_file.txt")

if(NOT EXISTS ${EXTRACTED_KEY_FILE})
    file(ARCHIVE_EXTRACT
        INPUT ${YOUR_ZIP_PATH}
        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}
        # 可选：如果不需要保留原文件权限，可以加NO_PERMISSIONS
        # NO_PERMISSIONS
    )
endif()

这个命令本质上是封装了tar解压逻辑，用法更直观，适合简单场景。

总结 #

• 如果只需要在配置阶段一次性解压，选方案1；
• 如果需要和构建流程深度集成，支持ZIP更新后自动重新解压，优先选方案2；
• 版本允许的话，方案3是最简洁的选择。

内容的提问来源于stack exchange，提问作者Abruzzo Forte e Gentile