CMake实战指南一：add_custom_command

CMake 进阶：add_custom_command 用法详解与实战指南

在 CMake 构建系统中，add_custom_command 是一个灵活且强大的工具，允许开发者在构建流程中插入自定义操作。无论是生成中间文件、执行预处理脚本，还是在目标构建前后触发额外逻辑，它都能轻松胜任。本文将从基础语法、核心参数、实战案例到高级技巧，全面解析 add_custom_command 的用法。

一、为什么需要 add_custom_command？

CMake 的核心优势在于跨平台构建，但默认流程难以覆盖所有个性化需求。例如：

• 生成动态配置文件（如根据编译选项生成 config.h）
• 集成外部工具链（如代码生成器、静态分析工具）
• 构建后处理（如复制可执行文件到部署目录、生成版本号）
• 复杂依赖管理（非传统文件依赖的场景）

add_custom_command 正是为解决这类问题而生，它通过在构建流程中注入自定义命令，让 CMake 具备更强的扩展性。

二、基础语法与核心参数

2.1 两大使用场景

场景 1：生成文件（File Generation）

用于定义 “输入文件→输出文件” 的映射关系，CMake 会根据依赖自动触发命令：

add_custom_command(       OUTPUT <output1> [<output2>...]  # 必选：命令生成的目标文件       COMMAND <command1> [<args1>...]   # 必选：执行的命令（可多条）       [MAIN_DEPENDENCY <file>]           # 主依赖文件（变化时强制重新执行）       [DEPENDS <dep1> <dep2>...]        # 附加依赖文件/目标（变化时触发重新执行）       [IMPLICIT_DEPENDS <lang> <file>]   # 隐式依赖（如语法分析生成的依赖）       [WORKING_DIRECTORY <dir>]          # 命令执行的工作目录（默认当前源目录）       [COMMENT "<message>"]              # 执行时显示的提示信息       [VERBATIM]                         # 保留命令原始格式（避免CMake转义）       [USES_TERMINAL]                    # 在终端中执行命令（Windows适用）   )

场景 2：关联构建目标（Target Hook）

用于在目标（可执行文件 / 库）的构建阶段插入钩子：