如何让CMake生成的Makefile检查环境变量是否已设置

可以通过CMake定义自定义检查目标，让所有编译目标都依赖这个目标，这样make执行时会先检查环境变量，未设置则直接报错退出，避免后续编译失败。

具体代码示例 #

假设需要检查的必填环境变量为MY_REQUIRED_VAR，在你的CMakeLists.txt中添加以下逻辑：

# 创建检查环境变量的自定义目标
add_custom_target(
    check_required_env
    COMMAND sh -c "if [ -z \"$${MY_REQUIRED_VAR}\" ]; then echo '错误：必须设置环境变量 MY_REQUIRED_VAR' >&2; exit 1; fi"
    COMMENT "检查必填环境变量..."
)

# 让项目主目标依赖检查目标，确保编译前先执行检查
add_dependencies(${CMAKE_PROJECT_NAME} check_required_env)

说明 #

• add_custom_target创建了一个名为check_required_env的目标，其执行的shell命令会检查环境变量是否为空：如果为空则输出错误信息到标准错误流，然后以非零状态码退出，触发make报错。
• add_dependencies将你的项目主目标（${CMAKE_PROJECT_NAME}）与检查目标绑定，这样执行make时会先运行检查逻辑，只有检查通过才会开始编译。

扩展：检查多个环境变量 #

如果需要检查多个变量，只需修改shell命令即可：

add_custom_target(
    check_required_env
    COMMAND sh -c "
        if [ -z \"$${VAR1}\" ]; then echo '错误：必须设置环境变量 VAR1' >&2; exit 1; fi
        if [ -z \"$${VAR2}\" ]; then echo '错误：必须设置环境变量 VAR2' >&2; exit 1; fi
    "
    COMMENT "检查必填环境变量..."
)
add_dependencies(${CMAKE_PROJECT_NAME} check_required_env)

这样生成的Makefile会在编译前自动执行环境变量检查，未设置时直接报错，无需手动修改Makefile。

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