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）

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

add_custom_command(       TARGET <target_name>               # 必选：关联的目标（如add_executable生成的目标）       PRE_BUILD | PRE_LINK | POST_BUILD  # 必选：命令执行时机（编译前/链接前/构建后）       COMMAND <command> [<args>...]     # 执行的命令（可多条）       [WORKING_DIRECTORY <dir>]          # 工作目录       [COMMENT "<message>"]              # 提示信息       [VERBATIM]                         # 禁用参数转义   )

2.2 核心参数解析

参数	说明
OUTPUT	必选（场景 1），指定命令生成的文件，CMake 通过检查这些文件是否存在决定是否执行命令
COMMAND	必选，支持多条命令（按顺序执行），可使用 CMake 变量（如 ${CMAKE_CURRENT_BINARY_DIR}）
DEPENDS	显式依赖，支持文件路径或目标名称（如add_executable生成的目标），依赖变化时触发重跑
MAIN_DEPENDENCY	主依赖，优先级高于DEPENDS，仅当该文件变化时才强制重新生成输出文件
IMPLICIT_DEPENDS	隐式依赖（如通过语法分析推导的依赖），需指定语言类型（如CXX、C）
VERBATIM	关键参数！确保命令中的特殊符号（如$、#）不被 CMake 解析，避免语法错误

三、实战案例：从基础到进阶

3.1 案例 1：生成编译期配置文件

需求：根据 CMake 选项生成 config.h，包含版本号和编译参数。

# CMakeLists.txt  
cmake_minimum_required(VERSION 3.16)  
project(add_custom_command02 VERSION 1.0.0)  # 定义配置模板  
configure_file(  ${CMAKE_CURRENT_SOURCE_DIR}/config.h.in  ${CMAKE_CURRENT_BINARY_DIR}/config.h  
)  # 使用 add_custom_command 生成动态内容  
add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/build_info.txtCOMMAND ${CMAKE_COMMAND} -E echo %PATH% >> ${CMAKE_CURRENT_BINARY_DIR}/env.txtCOMMAND ${CMAKE_COMMAND} -E echo "Build Time: %DATE% %TIME%" >> ${CMAKE_CURRENT_BINARY_DIR}/build_info.txtCOMMAND ${CMAKE_COMMAND} -E echo "Version: ${PROJECT_VERSION}" >> ${CMAKE_CURRENT_BINARY_DIR}/build_info.txtCOMMENT "Generating build information"VERBATIM
)# 添加自定义目标，确保配置文件在编译前生成  
add_custom_target(  generate_config ALL  DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/config.h ${CMAKE_CURRENT_BINARY_DIR}/build_info.txt  
)  # 关联到可执行文件，确保依赖正确  
add_executable(add_custom_command01 src/main.cpp)  
target_include_directories(add_custom_command01 PRIVATE ${CMAKE_CURRENT_BINARY_DIR})  

// 以下是 main.cpp 代码示例
#include <iostream>
#include "config.h"int main()
{std::cout << "Project Version: " << PROJECT_VERSION << std::endl;std::cout << "Build Time: " << __DATE__ << " " << __TIME__ << std::endl;return 0;
}

// 以下是 config.h.in 示例内容，可根据实际需求定义更多宏或变量
#ifndef CONFIG_H_IN
#define CONFIG_H_IN#define PROJECT_VERSION "@PROJECT_VERSION@"#endif

编译工程完毕后执行命令生成的文件

关键点：

• 通过 configure_file 处理模板文件，结合 add_custom_command 生成动态内容
• add_custom_target 定义独立构建目标，ALL 关键字使其在默认构建时触发

3.2 案例 2：构建后自动部署

• 需求：将可执行文件和依赖库复制到指定部署目录，并生成版本清单。

cmake_minimum_required(VERSION 3.16)  
project(DeploymentDemo)  # 添加头文件路径（当前源目录）  
include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src)  # 生成可执行文件  
add_executable(DeploymentDemo  src/main.cpp  src/utils.cpp  
)  # 构建后部署命令（兼容Windows/Linux）  
add_custom_command(  TARGET DeploymentDemo  POST_BUILD  # 创建部署目录（跨平台路径）  COMMAND ${CMAKE_COMMAND} -E make_directory "${CMAKE_CURRENT_BINARY_DIR}/deploy"  # 复制可执行文件（使用生成器表达式获取路径）  COMMAND ${CMAKE_COMMAND} -E copy "$<TARGET_FILE:DeploymentDemo>" "${CMAKE_CURRENT_BINARY_DIR}/deploy"  # 复制动态库（Windows示例，Linux可忽略或使用cp命令）  COMMAND ${CMAKE_COMMAND} -E copy_if_different "$<TARGET_FILE:DeploymentDemo>" "${CMAKE_CURRENT_BINARY_DIR}/deploy"  # 生成版本清单  COMMAND ${CMAKE_COMMAND} -E echo "Version: ${PROJECT_VERSION}" > "${CMAKE_CURRENT_BINARY_DIR}/deploy/VERSION.txt"VERBATIM  
)  

 main.cpp代码

#include <iostream>  
#include "utils.h"  int main() {  std::cout << "Main program running." << std::endl;  printDeploymentInfo();  // 调用部署信息函数  return 0;  
}  

// 假设这里有一个简单的辅助函数声明在 utils.h 中，实现于 utils.cpp，用于打印一些部署信息
// utils.h
#ifndef UTILS_H
#define UTILS_Hvoid printDeploymentInfo();#endif

// utils.cpp
#include <iostream>
#include "utils.h"void printDeploymentInfo()
{std::cout << "Deployment completed successfully." << std::endl;
}

编译工程完毕后执行命令生成的文件

关键点：

• POST_BUILD 时机确保在目标构建完成后执行
• $<TARGET_FILE:target> 生成器表达式动态获取目标文件路径
• copy_if_different 避免重复复制，提升构建效率

高级技巧与最佳实践

4.1 动态生成命令参数

利用 CMake 的变量和生成器表达式，使命令参数动态化：

# 根据系统架构选择不同的处理脚本  
add_custom_command(  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/arch_info.txt  COMMAND ${CMAKE_COMMAND} -E echo "Architecture: $<IF:$<BOOL:$<CMAKE_SIZEOF_VOID_P:8>>,x86_64,i386>" >> ${ARCH_INFO_FILE}  VERBATIM  
)  

4.2 处理复杂依赖链

通过 IMPLICIT_DEPENDS 声明隐式依赖（如语法分析生成的依赖）：

add_custom_command(  OUTPUT parser.cpp parser.h  COMMAND bison -d ${CMAKE_CURRENT_SOURCE_DIR}/parser.yy -o ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp  IMPLICIT_DEPENDS CXX ${CMAKE_CURRENT_BINARY_DIR}/parser.h  # 声明C++头文件依赖  VERBATIM  
)  

4.3 避免循环依赖

确保 add_custom_command 的输出文件不被其依赖的目标直接或间接依赖，例如：

# 错误示例：输出文件作为目标源文件，同时目标依赖自身  
add_custom_command(OUTPUT a.txt COMMAND echo "a" > a.txt)  
add_executable(bad_target a.txt)  # 循环依赖风险！  

正确做法：通过 add_custom_target 显式管理依赖关系。

五、常见问题与解决方案

5.1 输出文件路径错误

现象：命令执行后文件未生成到预期目录。解决：

• 使用绝对路径（如 ${CMAKE_CURRENT_BINARY_DIR}/output.txt）
• 通过 WORKING_DIRECTORY 指定命令执行目录

5.2 依赖检测不生效

现象：依赖文件变化后，命令未重新执行。解决：

• 确保 DEPENDS 正确列出所有相关文件
• 对非文件依赖（如环境变量），可添加虚拟依赖文件

5.3 多命令执行顺序混乱

现象：多条 COMMAND 未按顺序执行。解决：

• CMake 保证 COMMAND 按声明顺序执行，无需额外处理

5.4 VERBATIM 的必要性

场景：命令中包含 $、$#$ 等符号时，必须添加 VERBATIM，否则 CMake 会尝试解析为变量或注释，导致错误。

六、总结与推荐用法

使用场景	推荐语法	核心参数
文件生成	OUTPUT + COMMAND + DEPENDS	VERBATIM, MAIN_DEPENDENCY
构建阶段钩子	TARGET + PRE/POST_BUILD	WORKING_DIRECTORY, 生成器表达式
复杂依赖管理	IMPLICIT_DEPENDS	语言类型（如CXX）
动态参数生成	生成器表达式（如$<TARGET_FILE>）	VERBATIM

add_custom_command 的灵活性使其成为 CMake 进阶的必备工具，但过度使用可能导致构建逻辑复杂化。建议：

1. 优先使用 CMake 内置命令（如configure_file、add_library），仅在必要时引入自定义命令
2. 为自定义命令添加清晰的 COMMENT，如上面案例中详细说明每个命令的意图，方便调试
3. 通过add_custom_target 集中管理独立的构建步骤

通过合理运用 add_custom_command，开发者可以将 CMake 构建系统与项目的特殊需求深度整合，实现从代码生成到部署的全流程自动化。

如果有具体项目场景或疑难问题，欢迎在评论区交流！