C++ 怎么在 CMake 中编写高级的自定义命令(add_custom_command)与目标生成器

胖杰大大_8361

胖杰大大_8361

2026-10-22

378人浏览

原创

关键看生成文件用途:编译前需的(如头文件)用output+add_dependencies;构建后操作(如打包)用post_build(仅限add_custom_target)。byproducts适用于无确定输出的场景,如linter或动态路径生成。

c++ 怎么在 cmake 中编写高级的自定义命令(add_custom_command)与目标生成器

add_custom_command 的两种执行时机怎么选

关键看你要生成的文件是编译前需要的(比如头文件、协议缓冲区代码),还是构建后要做的(比如打包、压缩、校验)。add_custom_command 本质只有两类触发方式:OUTPUT 和 PRE_BUILD/POST_BUILD,但后者仅对 add_custom_target 有效,不能直接挂到库或可执行目标上。

常见错误是把生成 proto.h 的命令写成 COMMAND + POST_BUILD —— 这会导致编译器在第一次编译时找不到头文件而失败。正确做法是用 OUTPUT 声明产出,并让 CMake 知道这个输出是某个源文件的依赖:

add_custom_command(
  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/generated.pb.h
  COMMAND protoc --cpp_out=${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/msg.proto
  DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/msg.proto
  COMMENT "Generating protobuf headers"
)

然后必须显式告诉目标它依赖这个输出:

add_executable(myapp main.cpp)
add_dependencies(myapp ${CMAKE_CURRENT_BINARY_DIR}/generated.pb.h)
target_sources(myapp PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/generated.pb.h)

为什么 add_custom_target 配合 BYPRODUCTS 更适合“伪生成”场景

当命令不产生真实文件(比如运行 linter、触发 CI 通知),或产出文件路径动态不可知(如 git describe 写入版本字符串到临时变量),就不能靠 OUTPUT 触发重执行。BYPRODUCTS 是更安全的替代:它声明“这个命令可能生成这些文件”,但不强制要求它们存在;CMake 会把它当作构建图中的一个节点,支持 add_dependencies,且不会因缺失 byproduct 报错。

典型用法:

  • BYPRODUCTS 必须配合 OUTPUT 或 COMMAND 使用,单独写无效
  • 若命令实际没生成对应文件,CMake 不报错,但下次构建仍会执行(除非加 VERBATIM + 手动缓存)
  • 不要把 BYPRODUCTS 当作“忽略输出检查”的捷径——它解决的是“产出不确定”问题,不是“不想管输出”
add_custom_target(update_version
  COMMAND ${CMAKE_COMMAND} -E echo "$$(${GIT_EXECUTABLE} describe --tags)" > ${CMAKE_CURRENT_BINARY_DIR}/VERSION
  BYPRODUCTS ${CMAKE_CURRENT_BINARY_DIR}/VERSION
  COMMENT "Updating VERSION file"
)

COMMAND 中的路径和变量为什么总出错

CMake 在 add_custom_command 里展开变量是“惰性的”:所有 ${...} 在配置阶段(cmake ..)就被替换成绝对路径,而 $<...></...> 是生成器表达式,延迟到构建阶段(make/ninja)才求值。混用就会崩溃。

Command Guardian
Command Guardian

用于在执行删除、覆盖、移动、部署、重写 Git 历史、修改权限等命令前的安全检查。

下载

常见陷阱:

  • 在 COMMAND 里写 ${CMAKE_SOURCE_DIR}/script.py → 没问题,但若脚本本身要读相对路径参数,就失效
  • 想传当前构建配置(Debug/Release)给命令?必须用 $<config></config>,写成 ${CMAKE_BUILD_TYPE} 会变成空或错误值
  • Windows 上用 cmd.exe /c 调命令时,%CD% 不可靠,应统一用 $<xxx></xxx> 或 $<current_source_dir></current_source_dir>

正确示例(跨平台获取当前源目录并传给 Python 脚本):

add_custom_command(
  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/config.json
  COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/gen_config.py
    $<current_source_dir>
    $<config>
  DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/gen_config.py
)</config></current_source_dir>

自定义目标生成器(generator expression)的边界在哪

生成器表达式($<...></...>)不是万能的。它只能用于 CMake 已知上下文:比如 target_compile_definitions、source_group、add_custom_command(COMMAND)。但它不能出现在 if()、set() 或 shell 命令内部(除非该命令本身由 CMake 解析,如 COMMAND ${CMAKE_COMMAND} -E ...)。

容易被忽略的限制:

  • $<mylib></mylib> 只在 target-aware 上下文有效,不能塞进 add_custom_command(OUTPUT ...) 的文件名里
  • $<...></...><semicolon></semicolon>
  • <...></...>

<mylib></mylib>

C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!

相关专题

更多
c++和c语言的区别有哪些
c++和c语言的区别有哪些

c++和c语言的区别:1、面向对象编程(OOP)支持不同;2、新增特性不同;3、标准库不同;4、编译方式不同;5、命名空间不同等等。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.14

2248

9

c++和python学习顺序推荐
c++和python学习顺序推荐

一般建议先学习C++,再学习Python,因为这样可以逐步从较为底层的编程语言向更高级的语言过渡。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

1019

6

python和c++学习性价比分析
python和c++学习性价比分析

Python易于学习,广泛应用于Web开发、数据科学和人工智能等领域,但性能较低。C语言性能高,适用于对性能要求较高的场景,如游戏开发和系统编程,但学习曲线陡峭,错误处理复杂。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

447

5

c语言和c++一样吗
c语言和c++一样吗

c语言和c++是两种不同的编程语言,虽然有相似之处,但存在显著差异。c语言专注于过程式编程和系统级开发,以简洁、高效著称。c++作为c语言的超集,引入了面向对象编程,增强了代码组织和管理能力,但学习曲线也更陡峭。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

327

5

c语言和c++先学哪个好
c语言和c++先学哪个好

初学者选择学习c语言还是c++语言,需要根据个人学习目标、背景以及编程兴趣和预期应用方向来决定。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

426

5

c语言和c++的区别和联系
c语言和c++的区别和联系

c语言和c++是计算机科学领域应用广泛的编程语言。虽然它们有着相似的基础,但它们在语言类型、语法功能和内存管理方面存在着显著差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

580

5

c++软件中文更改教程
c++软件中文更改教程

对于 ide,可通过打开设置,找到语言设置,选择中文,并保存更改。对于非 ide 应用程序,可查找设置或选项,选择语言设置,更改为中文,并保存更改。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.21

1409

9

python和java和c++学习性价比分析
python和java和c++学习性价比分析

Python以其易学性、丰富的库和活跃的社区而著称,适合数据科学、人工智能和Web开发。Java以其跨平台性、企业级应用开发和Android应用开发而闻名。C++以其底层控制能力、高效性能和游戏开发而著称。选择哪种语言取决于个人兴趣、职业方向和特定需求。想了解更多python和java和c++的相关内容,可以阅读本专题下面的文章。

2024.03.22

1217

7

c++和c语言学习顺序推荐
c++和c语言学习顺序推荐

对于初学者,建议先学习C语言,掌握编程基础后再转入C++,便于理解面向对象编程概念。有编程经验者可直接学习C++,快速接触高级编程技术。想了解更多c++和c语言的相关内容,可以阅读本专题下面的文章。

2024.03.25

1325

9

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习