如何在CMake中正确向子目录传递配置选项？

一、规范使用set(CACHE)，避免缓存变量混乱 #

你之前觉得set(CACHE)需要父项目同步用缓存变量是误解——子项目可以单独用set(CACHE)定义选项的默认值、类型和描述，父项目直接用普通变量赋值就能覆盖这些默认值，不需要父项目也写set(CACHE)。

子项目代码示例：

# 子项目中定义带默认值的配置选项
set(SUB_PROJ_STRING_OPTION "default_string" CACHE STRING "子项目字符串配置选项描述")
set(SUB_PROJ_BOOL_OPTION OFF CACHE BOOL "子项目布尔配置选项描述")

父项目传递自定义值：

# 在add_subdirectory之前直接设置普通变量
set(SUB_PROJ_STRING_OPTION "custom_string")
set(SUB_PROJ_BOOL_OPTION ON)
add_subdirectory(sub_project_dir)

CMake的变量查找优先级是普通变量 > 缓存变量，所以父项目的普通变量会直接覆盖子项目的缓存默认值，既保留了子项目选项的类型校验和描述，又不需要父项目处理缓存逻辑。

二、封装宏简化默认值设置，替代大量if语句 #

如果觉得直接写if(NOT DEFINED)太繁琐，可以自己封装一个宏，统一处理STRING/BOOL类型的选项定义，自动设置默认值：

# 自定义宏：自动处理选项默认值、类型和缓存
macro(define_config_option VAR TYPE DEFAULT DESC)
  if(NOT DEFINED ${VAR})
    set(${VAR} ${DEFAULT})
  endif()
  # FORCE确保父项目设置的普通变量能同步到缓存（可选，根据需求）
  set(${VAR} ${${VAR}} CACHE ${TYPE} ${DESC} FORCE)
endmacro()

# 子项目中使用宏定义选项
define_config_option(MY_STRING_OPTION STRING "default_val" "字符串选项说明")
define_config_option(MY_BOOL_OPTION BOOL OFF "布尔选项说明")

这样父项目还是直接用set()传递值，子项目不用写重复的if判断，代码更简洁。

三、大型项目的通用实践 #

1. 集中管理配置入口
   父项目通常会写一个专门的Options.cmake文件，集中定义所有子项目的可配置选项，然后在add_subdirectory前统一加载这个文件，或者通过CMAKE_PROJECT_INCLUDE变量让子项目自动继承配置。比如：

   # 父项目中设置，子项目初始化时会自动包含该文件
   set(CMAKE_PROJECT_SubProjectName_INCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/SubProjectOptions.cmake)
   add_subdirectory(sub_project_dir)
   

2. 区分公共/私有选项
   子项目的私有配置（不需要父项目干预）用普通set()定义；需要父项目传递的公共选项用set(CACHE)或上述宏定义，并且在子项目的README或文档中明确列出这些选项的名称、类型、默认值，方便父项目按需配置。

3. 混合使用option()和set(CACHE)
   对于BOOL类型选项，继续用option()保持语义清晰；STRING类型用set(CACHE)定义，两者配合使用，既满足类型需求，又保持代码可读性。比如：

   # 子项目中混合定义
   option(SUB_PROJ_DEBUG_MODE "启用调试模式" OFF)
   set(SUB_PROJ_LOG_LEVEL "INFO" CACHE STRING "日志级别，可选DEBUG/INFO/WARN/ERROR")
   

你并没有遗漏核心方法，只是需要通过规范用法和简单封装来规避现有手段的缺陷，上述方案也是大型CMake项目（比如Qt、LLVM等）常用的配置传递方式。

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