CMake add_subdirectory引入WebKit子模块失败，寻求子项目封装方案

一、紧急修复WebKit的CMAKE_SOURCE_DIR依赖问题 #

WebKit中硬编码使用CMAKE_SOURCE_DIR是不符合CMake最佳实践的——这个变量指向父项目的根目录，而非子项目自身的源码目录。你可以通过以下两种方式快速解决：

1. 修改WebKit源码：直接遍历WebKit的所有CMakeLists.txt，把CMAKE_SOURCE_DIR替换为CMAKE_CURRENT_SOURCE_DIR（指向当前CMakeLists所在目录）或PROJECT_SOURCE_DIR（指向WebKit自身项目的根目录，需确保WebKit用project()声明了自身项目）。这是最彻底的方案，从根源避免路径冲突。
2. 用隔离构建规避：如果暂时不想修改源码，跳过add_subdirectory，改用ExternalProject_Add将WebKit作为独立项目构建。

二、长期封装方案：隔离子项目构建环境 #

对于大型复杂子项目，最好的方式是完全隔离其CMake环境，避免父项目变量污染。推荐两种方案：

1. 使用ExternalProject_Add完全隔离 #

这个方法会让子项目在独立的构建目录中编译，所有CMake变量（包括CMAKE_SOURCE_DIR）都指向子项目自身的路径，完全不受父项目影响。示例代码：

include(ExternalProject)

# 配置WebKit独立构建
ExternalProject_Add(
    WebKit
    SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/third_party/webkit  # 你的git submodule路径
    BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/webkit-build        # 独立的构建目录
    CMAKE_ARGS 
        -DCMAKE_INSTALL_PREFIX=${CMAKE_CURRENT_BINARY_DIR}/webkit-install  # 安装到父项目的二进制目录下
        -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}  # 同步父项目的构建类型
        # 添加WebKit需要的其他CMake参数，比如-DENABLE_WEBGL=ON等
    BUILD_COMMAND ${CMAKE_MAKE_PROGRAM}
    INSTALL_COMMAND ${CMAKE_MAKE_PROGRAM} install
)

# 父项目引入WebKit的安装产物
include_directories(${CMAKE_CURRENT_BINARY_DIR}/webkit-install/include)
link_directories(${CMAKE_CURRENT_BINARY_DIR}/webkit-install/lib)

# 确保父项目目标依赖WebKit构建完成
add_dependencies(your-main-target WebKit)

优点：完全隔离，子项目的CMake逻辑不受父项目干扰；可以灵活控制子项目的构建参数和安装位置。
缺点：子项目的构建过程在父项目配置阶段不会执行，需要手动触发构建（或通过add_dependencies关联）。

2. 使用FetchContent集成（适合Git子模块场景） #

如果你习惯用Git子模块管理源码，也可以用FetchContent来集成，它支持本地路径，同样能隔离构建环境：

include(FetchContent)

FetchContent_Declare(
    WebKit
    SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/third_party/webkit
    BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/webkit-build
)

FetchContent_MakeAvailable(WebKit)

# 之后可以直接链接WebKit的目标（如果WebKit导出了目标）
target_link_libraries(your-main-target PRIVATE WebKit::WebKit)

优点：比ExternalProject_Add更简洁，且能直接使用子项目导出的CMake目标（如果WebKit支持的话）。
缺点：要求子项目的CMakeLists.txt正确导出目标，否则还是需要手动处理头文件和库路径。

三、通用封装最佳实践 #

为了避免类似问题再次发生，建议遵循以下规则：

• 强制子项目使用局部路径变量：所有子项目的CMake代码中，必须用CMAKE_CURRENT_SOURCE_DIR（当前目录）、PROJECT_SOURCE_DIR（自身项目根目录）代替全局的CMAKE_SOURCE_DIR。
• 封装子项目构建逻辑：把每个子项目的构建配置（比如ExternalProject_Add的参数、头文件路径、库链接）放到单独的CMake模块中（如cmake/FindWebKit.cmake），父项目只需通过include(FindWebKit)引入，降低耦合。
• 优先使用CMake目标导出：如果子项目支持，要求其用install(EXPORT)导出CMake目标，父项目通过find_package直接引入目标，无需手动处理路径。

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