17、文件路径处理：sourceDir、binaryDir、installDir 的配置技巧

说实话，路径问题是我在 CMake 项目里踩坑最多的地方之一。你想想看，一个项目少则几十个文件，多则上千个源文件，如果路径配置得乱七八糟，那基本就是给自己挖坑。今天我就把 sourceDir、binaryDir、installDir 这三个核心路径的配置技巧掰开揉碎了讲清楚。

17.1 三个路径的定位

先搞清楚它们各自是干什么的：

• sourceDir：源码所在目录，也就是你写代码的地方
• binaryDir：构建产物目录，编译出来的 .o、.a、可执行文件都放这里
• installDir：安装目录，最终交付给用户的头文件、库文件、可执行文件放这里

我个人习惯把这三个目录分开管理，绝不混在一起。为什么呢？因为我在一个老项目里见过有人把构建产物直接输出到源码目录，结果 git status 一看全是乱七八糟的文件，那叫一个头疼。

17.2 sourceDir 的配置技巧

sourceDir 通常就是项目根目录，但有时候我们会把 CMakeLists.txt 放在子目录里。这时候就需要显式指定 sourceDir。

举个例子，假设你的项目结构是这样的：

my_project/
├── src/
│   └── main.cpp
├── include/
│   └── mylib.h
└── cmake/
    └── CMakeLists.txt

这时候在 Presets 里配置 sourceDir 就要指向 cmake 目录的父级：

{
  "version": 6,
  "configurePresets": [
    {
      "name": "default",
      "sourceDir": "${sourceDir}/..",
      "binaryDir": "${sourceDir}/../build"
    }
  ]
}

嗯，这里要注意 ${sourceDir} 这个变量。在 Presets 里，${sourceDir} 默认指向 Presets 文件所在的目录。如果你把 Presets 文件放在项目根目录，那 ${sourceDir} 就是根目录本身。

17.3 binaryDir 的配置技巧

binaryDir 是我最常调整的地方。不同的构建类型、不同的编译器、不同的平台，我都希望有独立的构建目录。

我曾经在一个跨平台项目里，因为没区分 Debug 和 Release 的构建目录，结果调试了半天发现链接的是 Release 的库，那叫一个郁闷。

我的推荐做法是：

{
  "configurePresets": [
    {
      "name": "debug",
      "binaryDir": "${sourceDir}/build/${presetName}",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Debug"
      }
    },
    {
      "name": "release",
      "binaryDir": "${sourceDir}/build/${presetName}",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Release"
      }
    }
  ]
}

这样构建目录就会是：

• build/debug/ — Debug 版本
• build/release/ — Release 版本

一目了然，对吧？

17.4 installDir 的配置技巧

installDir 决定了最终用户拿到的是什么。这里有个常见的误区：很多人把 installDir 和 binaryDir 搞混。

binaryDir 是给开发者用的，里面包含中间文件、测试数据等。installDir 是给用户用的，只包含最终产物。

我建议在 Presets 里这样配置：

{
  "configurePresets": [
    {
      "name": "release",
      "binaryDir": "${sourceDir}/build/release",
      "cacheVariables": {
        "CMAKE_INSTALL_PREFIX": "${sourceDir}/install/release"
      }
    }
  ]
}

这样安装后的目录结构可能是：

install/release/
├── bin/
│   └── myapp
├── lib/
│   └── libmylib.a
└── include/
    └── mylib.h

17.5 路径变量的使用规范

在 CMakeLists.txt 里，我强烈建议使用以下变量来引用路径：

变量名	含义	使用场景
CMAKE_SOURCE_DIR	顶层源码目录	引用项目根目录下的文件
CMAKE_BINARY_DIR	顶层构建目录	输出构建产物
CMAKE_INSTALL_PREFIX	安装前缀目录	指定安装路径
PROJECT_SOURCE_DIR	当前项目的源码目录	多项目场景下区分不同项目
PROJECT_BINARY_DIR	当前项目的构建目录	多项目场景下区分不同项目

17.6 相对路径与绝对路径的选择

在 Presets 里，路径可以是相对路径，也可以是绝对路径。我个人更推荐使用相对路径，因为这样 Presets 文件可以跨机器共享。

但有个例外：如果你需要引用系统级的路径（比如 /usr/local），那就只能用绝对路径了。

举个例子：

{
  "configurePresets": [
    {
      "name": "ci-linux",
      "binaryDir": "${sourceDir}/build/ci-linux",
      "cacheVariables": {
        "CMAKE_INSTALL_PREFIX": "/opt/myapp"
      }
    }
  ]
}

这里 binaryDir 用了相对路径，而 CMAKE_INSTALL_PREFIX 用了绝对路径。为什么呢？因为安装路径通常是固定的系统路径，而构建目录应该跟随项目位置变化。

17.7 知识体系图

下面这张图展示了三个路径之间的关系：

17.8 实战建议

最后，我总结几条实战经验：

1. 永远不要硬编码路径。用变量代替，这样 Presets 才能跨机器复用。
2. 区分构建类型。Debug 和 Release 的构建目录一定要分开，不然你会后悔的。
3. installDir 要简洁。只放最终用户需要的东西，别把中间文件塞进去。
4. 多用 ${presetName}。这个变量能帮你自动生成有意义的目录名。
5. 测试路径是否正确。配置完后，跑一次 cmake --preset 看看输出路径对不对。

好了，关于文件路径处理就聊到这里。这些技巧都是我在实际项目中一点点积累出来的，希望能帮你少走弯路。

---

公众号:蓝海资料掘金营，微信deep3321