C++跨目录引用类如何避免路径变动重复修改include语句

核心原则：永远不要在业务源码里写死依赖模块的磁盘路径，把路径配置逻辑和业务代码解耦，就能实现源码零修改。

首选方案：通过构建系统配置头文件搜索路径（零源码修改，工业界标准做法） #

问题根源是把可变的磁盘路径写死在了每个源码文件的#include语句里，只要把路径查找的工作交给编译器/构建系统，源码里就不需要带任何可变路径前缀：

1. 先把B模块所有源码里对A模块头文件的引用改成不带可变路径的形式：

// Two.hpp、Three.hpp等所有B模块文件里，统一这么写
#include <One.hpp>
// 更规范的写法是给A模块加固定命名空间前缀：#include <ModuleA/One.hpp>，前缀固定写模块名，和磁盘路径无关

2. 所有和A模块实际目录相关的配置，全部收敛到构建配置的单处位置，路径变更时只需要改这一处，完全不需要碰B模块的源码：
   • 直接用GCC/Clang命令行编译时，给编译命令加-I<模块A的实际磁盘路径>参数，编译器会自动到指定目录下查找One.hpp
   • 用CMake构建时，在B模块的构建规则里加target_include_directories(B目标名 PRIVATE ${A模块实际路径})，路径变更只需要修改A模块路径的变量赋值即可
   • 用手写Makefile构建时，在全局的INCLUDES变量里追加-I<模块A实际磁盘路径>，后续改路径只动这个变量

这个方案完全满足零修改B模块源码的要求，是所有中大型C++项目处理跨模块依赖的通用方案。

过渡方案：统一代理头文件（无法修改构建配置时，修改次数从N次降到1次） #

如果受限于现有项目规则暂时没法调整构建配置，可以在B模块的固定根目录下新建一个唯一的代理头文件，比如ModuleA_Dep.hpp，这个文件里只写对A模块头文件的引用：

// B模块固定位置的ModuleA_Dep.hpp
#include <当前A模块的实际路径/One.hpp>

之后B模块里所有需要引用A模块类的文件，都统一包含这个本地代理头文件：

// Two.hpp
#include "ModuleA_Dep.hpp"

// Three.hpp
#include "ModuleA_Dep.hpp"

后续如果A模块的目录位置变更，你只需要修改这一个代理头文件里的路径即可，不需要逐个修改所有引用了A类的源码文件。

实践建议 #

• 不要在任何业务源码里写头文件的绝对路径，所有路径相关的配置全部收敛到构建层，避免跨开发环境、跨设备编译时出现路径不匹配问题
• 建议给每个模块的头文件加一层和模块名绑定的固定目录前缀，比如A模块的头文件统一放在ModuleA/目录下，构建系统把ModuleA/的父目录加入搜索路径，源码里统一写#include <ModuleA/One.hpp>，可以避免不同模块出现同名头文件时的冲突问题

内容的提问来源于stack exchange，提问作者fva