C++在CMake中怎么开启预编译头文件(target_precompile_headers)

秋敏姑娘_6684

秋敏姑娘_6684

2026-10-26

309人浏览

原创

target_precompile_headers 是 cmake 3.16+ 提供的原生预编译头机制,用于加速编译;但仅适用于稳定、大体积、被广泛包含的头文件,模板或频繁变动的头文件反而降低增量编译效率。

c++在cmake中怎么开启预编译头文件(target_precompile_headers)

target_precompile_headers 是什么,为什么不是所有项目都适合开

target_precompile_headers 是 CMake 3.16+ 引入的原生预编译头(PCH)支持机制,它替代了早期靠 set_property 或手动设置 COMPILE_FLAGS 的方式。但它不是“开了就快”的银弹:C++ 模板、宏定义频繁变动的头文件(比如带 __LINE__ 或依赖构建配置的头)一旦放进 PCH,后续修改会导致整个 PCH 失效并重建,反而拖慢增量编译。只有稳定、体积大、被大量源文件包含的头(如 <vector></vector>、<string></string>、项目级公共 common.hpp)才值得放进。

怎么写 target_precompile_headers 才不报错

常见错误是路径写错或目标未正确关联。必须确保:

  • target_precompile_headers 必须在 add_executable 或 add_library 之后调用,且目标名完全一致
  • 头文件路径是相对于 CMAKE_CURRENT_SOURCE_DIR 的,不能用绝对路径或 ${CMAKE_SOURCE_DIR}/xxx 拼接(CMake 会静默忽略)
  • 只支持单个主头文件(如 stdafx.h 或 pch.hpp),不支持通配符或多个顶层头
  • 该头文件本身必须存在,且内容可被独立编译(不能依赖未定义的宏或前置 #include)

正确示例:

add_library(mylib src/a.cpp src/b.cpp)
target_precompile_headers(mylib PRIVATE "pch.hpp")

如果 pch.hpp 在 include/ 目录下,应写成 "include/pch.hpp",而不是 "${CMAKE_SOURCE_DIR}/include/pch.hpp"。

C++14
C++14

C++14 对 C++11 的修正与增强版本,适合旧系统维护和较老工具链兼容。

下载

PRIVATE / PUBLIC / INTERFACE 对预编译行为的影响

这个参数决定 PCH 是否“传染”给依赖者,但实际影响比普通属性更隐蔽:

  • PRIVATE:仅本 target 的源文件使用 PCH,最常用也最安全
  • PUBLIC:本 target 及所有链接它的 target 都会启用该 PCH —— 但若链接方源码里没包含对应头(比如你用了 PUBLIC "pch.hpp",但对方 .cpp 里没 #include "pch.hpp"),MSVC 会报 C1010: unexpected end of file while looking for precompiled header;Clang/GCC 则可能跳过 PCH 或报错
  • INTERFACE:仅对链接者生效,本 target 自身不启用 —— 几乎无实用场景,容易引发混乱

结论:99% 场景用 PRIVATE,除非你明确控制上下游代码结构且强制要求统一 PCH。

Windows(MSVC)和 Linux(Clang/GCC)的行为差异

MSVC 默认严格校验 PCH 包含顺序:第一个非注释行必须是 #include "pch.hpp"(或你指定的头),否则直接失败;而 Clang/GCC 更宽松,即使没显式包含也能尝试复用,但效果不稳定。因此:

  • 跨平台项目中,不要假设 PCH 一定能自动注入 —— 必须在每个 .cpp 文件顶部手动加 #include "pch.hpp"(放在所有其他 #include 之前)
  • MSVC 下开启 /Zi(调试信息)时,PCH 调试体验较差;建议开发阶段关掉 PCH,发布构建再启用
  • Clang 的 -include 机制与 CMake 的 target_precompile_headers 并不完全等价,某些旧版 Clang(compile_commands.json 中是否出现 -Xclang -include-pch 类参数

预编译头真正起效的前提,是头文件内容足够“钝”——不随编译单元变化,也不依赖局部宏。一不小心把它变成构建系统的隐形瓶颈,比不用还麻烦。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
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

1039

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

600

5

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

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

2024.03.21

1429

9

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

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

2024.03.22

1237

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人学习