如何兼容旧编译器并将模板头文件迁移到CXX Modules

针对既要保留传统头文件兼容旧编译器，又要在新项目中使用CXX Modules且避免代码重复的需求，以下是几个更优雅的解决方案：

1. 单源文件适配双模式（头文件+模块） #

在原有模板头文件中加入预处理器宏，让它既能作为传统头文件被包含，也能作为模块接口编译，无需复制文件或重命名类：

// TemplateHeader.hpp
#if defined(MODULE_MODE)
export module my.template;
#endif

// 用宏控制export关键字
#if defined(MODULE_MODE)
export
#endif
template<typename T>
class MyTemplate {
public:
    T value;
    MyTemplate(T v) : value(v) {}
    T get() const { return value; }
};

CMake配置时，为模块目标编译该文件时定义MODULE_MODE：

# 检查编译器是否支持CXX Modules
include(CheckCXXCompilerFlag)
check_cxx_compiler_flag("-fmodules-ts" SUPPORTS_MODULES)

if(SUPPORTS_MODULES)
    add_library(my_template MODULE)
    target_sources(my_template
        PUBLIC
            FILE_SET CXX_MODULES FILES "TemplateHeader.hpp"
    )
    target_compile_definitions(my_template PRIVATE MODULE_MODE)
    # 添加编译器模块支持参数，比如GCC的-fmodules-ts
    target_compile_options(my_template PRIVATE -fmodules-ts)
else()
    add_library(my_template INTERFACE)
    target_sources(my_template INTERFACE "TemplateHeader.hpp")
endif()

2. 模块包装遗留头文件 #

不用修改原有头文件，创建一个极简的模块文件导出遗留代码中的类，彻底避免重复：

// 原有遗留头文件 TemplateHeader.hpp
namespace legacy {
template<typename T>
class MyTemplate {
    // 原有实现代码
};
}

// 模块文件 my_template.cxx
export module my.template;
#include "TemplateHeader.hpp"

// 导出遗留命名空间中的模板类
export using legacy::MyTemplate;

传统代码仍通过#include "TemplateHeader.hpp"使用legacy::MyTemplate，新代码则通过import my.template;直接使用MyTemplate，完全共享同一套实现。

3. 利用编译器原生的头转模块功能 #

部分主流编译器支持直接将头文件编译为模块接口，无需手动添加模块声明：

• Clang：使用-xc++-module-header标记将头文件视为模块接口
• MSVC：使用/module:interface参数

CMake中可以针对不同编译器配置：

set(TEMPLATE_HEADER "TemplateHeader.hpp")

if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
    add_library(my_template MODULE)
    target_sources(my_template
        PUBLIC
            FILE_SET CXX_MODULES FILES "${TEMPLATE_HEADER}"
    )
    target_compile_options(my_template PRIVATE -xc++-module-header -fmodules-ts)
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
    add_library(my_template MODULE)
    target_sources(my_template
        PUBLIC
            FILE_SET CXX_MODULES FILES "${TEMPLATE_HEADER}"
    )
    target_compile_options(my_template PRIVATE /module:interface)
else()
    # 旧编译器回退到传统头文件模式
    add_library(my_template INTERFACE)
    target_sources(my_template INTERFACE "${TEMPLATE_HEADER}")
endif()

4. CMake条件化目标管理 #

通过CMake的条件判断，自动为支持模块的编译器生成模块目标，旧编译器则使用传统接口库，让上层代码无需感知差异：

cmake_minimum_required(VERSION 3.28)
project(MyProject)

include(CheckCXXCompilerFlag)
check_cxx_compiler_flag("-fmodules-ts" SUPPORTS_MODULES)

# 统一目标名，上层代码直接链接即可
add_library(my_template INTERFACE)

if(SUPPORTS_MODULES)
    # 创建模块子目标
    add_library(my_template_module MODULE)
    target_sources(my_template_module
        PUBLIC
            FILE_SET CXX_MODULES FILES "my_template.cxx"
    )
    target_compile_options(my_template_module PRIVATE -fmodules-ts)
    # 将模块目标链接到接口库
    target_link_libraries(my_template INTERFACE my_template_module)
else()
    # 旧编译器使用传统头文件
    target_sources(my_template INTERFACE "TemplateHeader.hpp")
endif()

# 示例目标
add_executable(main main.cpp)
target_link_libraries(main PRIVATE my_template)

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