CGold项目教程：理解CMake中的外部构建(Out-of-Source Build)

什么是外部构建

在CMake项目管理中，"外部构建"(Out-of-Source Build)是一种重要的工程实践，指的是将构建过程中生成的二进制文件与源代码文件分开存放。这种构建方式与"内部构建"(In-Source Build)形成对比，后者会将生成的文件与源代码混在一起。

外部构建是CMake推荐的最佳实践，虽然CMake也支持内部构建方式，但后者实际上没有任何优势，反而会带来诸多问题。

外部构建的优势

1. 支持多配置并行构建

外部构建最大的优势之一是允许开发者同时维护多个不同的构建配置而不会产生冲突。例如：

# 创建Debug版本构建
cmake -H. -B_builds/Debug -DCMAKE_BUILD_TYPE=Debug

# 创建Release版本构建
cmake -H. -B_builds/Release -DCMAKE_BUILD_TYPE=Release

同样的方式也适用于其他自定义配置：

# 开启特定功能
cmake -H. -B_builds/feature-on -DFOO_FEATURE=ON

# 关闭特定功能
cmake -H. -B_builds/feature-off -DFOO_FEATURE=OFF

2. 支持不同生成器和平台

外部构建可以轻松管理不同生成器和平台的配置：

# Xcode生成器
cmake -H. -B_builds/xcode -G Xcode

# Makefile生成器
cmake -H. -B_builds/make -G "Unix Makefiles"

# 不同平台构建
cmake -H. -B_builds/osx -G Xcode
cmake -H. -B_builds/ios -G Xcode -DCMAKE_TOOLCHAIN_FILE=/.../ios.cmake

版本控制友好性

外部构建极大简化了版本控制系统的配置。只需将构建目录(如_builds)添加到忽略列表即可：

# .gitignore
_builds

相比之下，内部构建需要在版本控制中忽略大量不同类型的文件：

# 内部构建需要忽略的文件示例
*.sln
*.vcxproj
*.vcxproj.filters
*.xcodeproj
CMakeCache.txt
CMakeFiles
CMakeScripts
Debug/*
Makefile
Win32/*
cmake_install.cmake
foo
foo.build/*
foo.dir/*
foo.exe
x64/*

开发工作流注意事项

对于习惯将项目/解决方案文件纳入版本控制的开发者来说，内部构建可能看起来更熟悉。但实际上，外部构建能够更好地提醒开发者：现在的工作流已经改变，CMake负责管理构建过程，开发者不应该直接在IDE中编辑项目设置。

另一个重要注意事项是，使用外部构建不仅意味着需要在CMake命令中指定构建目录(-B_builds)，还需要确保所有自动生成的文件都放在构建目录中。例如，如果你有一个C++模板文件myproject.h.in用于生成myproject.h，那么应该将myproject.h.in保留在源代码树中，而将生成的myproject.h放在构建目录中。

总结

外部构建是CMake项目管理的推荐做法，它提供了更清晰的项目结构、更好的版本控制管理以及更灵活的多配置支持。虽然初期可能需要适应新的工作流，但从长远来看，这种构建方式能显著提高项目的可维护性和开发效率。