Visual Studio | 预编译头文件

前言：

在使用Visual Studio（VS）进行C/C++项目开发时，编译时间往往成为影响开发效率的关键因素之一。为了优化编译过程，VS引入了预编译头文件（Precompiled Header，PCH）这一技术。本文将详细介绍VS中预编译头文件的作用及其工作原理。

一、预编译头文件

1、作用

预编译头文件的主要作用是加速编译过程。在大型项目中，头文件通常包含大量的标准库引用、常用库的头文件以及项目特定的宏定义和函数声明等。这些头文件在每次编译时都需要被重新解析和编译，这无疑增加了编译时间。

预编译头文件技术允许开发者将这些常用的头文件预先编译成一个二进制文件（通常以.pch为后缀）。在后续的编译过程中，编译器可以直接加载这个预编译的头文件，而无需再次解析和编译原始的头文件内容。这样一来，就大大减少了编译时间，提高了开发效率。

2、工作原理

预编译头文件的工作原理相对简单，但背后涉及多个步骤。以下是预编译头文件生成和使用的详细过程：

1. 生成预编译头文件：

   • 开发者首先需要在项目中指定一个或多个需要预编译的头文件。
   • VS会创建一个特殊的源文件（通常是stdafx.cpp），并在其中包含一个特殊的指令（如#include "stdafx.h"），用于引入需要预编译的头文件。
   • 编译stdafx.cpp时，VS会将指定的头文件编译成一个二进制文件（即预编译头文件），并以项目名命名（如projectname.pch）。

2. 使用预编译头文件：

   • 在项目的其他源文件中，开发者需要在文件的最开始位置包含stdafx.h头文件（即#include "stdafx.h"）。
   • 编译器在编译这些源文件时，会识别到stdafx.h的包含指令，并跳过对其中引用的头文件的解析和编译过程，直接使用预编译头文件中的内容。

3. 编译优化：

   • 由于预编译头文件包含了常用的头文件内容，编译器在编译源文件时可以直接加载这些内容，从而避免了重复解析和编译头文件的时间开销。
   • 此外，预编译头文件还可以减少编译器的内存占用，因为编译器无需在每次编译时都加载和解析大量的头文件内容。

3、应用示例

下面结合一个具体的示例，看看如何使用预编译头

3.1，创建空白项目并添加源文件和头文件

• stdafx.h 内容

  // stdafx.h - 预编译头文件
  #pragma once
  
  // 在这里添加项目中常用的、不经常更改的头文件
  #include <iostream>
  #include <string>
  #include <vector>
  #include <memory>
  #include <windows.h>  // 如果是Windows程序
  
  // 项目通用的宏定义和常量
  #define APP_VERSION "1.0.0"
  const int MAX_BUFFER_SIZE = 1024;
  

• stdafx.cpp 内容

  // stdafx.cpp - 预编译头源文件
  #include "stdafx.h"
  // 注意: 这个文件通常只需要包含stdafx.h
  

3.2、项目属性配置

• 配置预编译头

  1. 右键项目，选择"属性"
  2. 确保配置为"所有配置"(All Configurations)和"所有平台"(All Platforms)

• 设置预编译头

  1. 进入"配置属性" > “C/C++” > “预编译头”
  2. 设置：
     • 预编译头：使用(/Yu)
     • 预编译头文件：stdafx.h
     • 预编译头输出文件：$(IntDir)$(TargetName).pch

• 为stdafx.cpp单独设置

  1. 右键stdafx.cpp文件，选择"属性"
  2. 进入"配置属性" > “C/C++” > “预编译头”
  3. 设置：
     • 预编译头：创建(/Yc)
     • 预编译头文件：stdafx.h
     • 预编译头输出文件：$(IntDir)$(TargetName).pch

• 使用预处理头

  // main.cpp - 必须首先包含预编译头
  #include "stdafx.h"
  
  int main()
  {
      std::cout << "Hello World!\n";
  }
  

3.3、编译和验证

点击"生成解决方案"(Build Solution)观察输出窗口，首次编译时会看到：

1> stdafx.cpp
1> 正在生成代码...
1> 已编译完成 stdafx.cpp

这表示预编译头正在被创建，后续编译时会重用预编译头，加快编译速度

4、注意事项

• 预编译头内容有重大更改：可以清理解决方案(Build > Clean Solution) 或者删除项目目录下的"Debug"或"Release"文件夹

• 包含顺序：所有源文件必须首先包含预编译头

  // 正确
  #include "stdafx.h"
  #include "other_header.h"
  
  // 错误 - 预编译头不是第一个包含
  #include "other_header.h"
  #include "stdafx.h"
  

• 内容选择：只在预编译头中包含稳定的、不常修改的头文件。

• 大型项目：对于非常大的项目，可以考虑按模块使用多个预编译头。

• 跨平台注意：预编译头是编译器特定功能，不同编译器实现不同。

VS的预编译头文件技术通过预先编译常用的头文件内容，并在后续的编译过程中直接使用这些预编译的内容，从而显著减少了编译时间并提高了开发效率。然而，在使用预编译头文件时，开发者也需要注意其适用性、更新和维护以及兼容性等问题。