Redis++项目中使用CMake集成Hiredis的实践指南

问题背景

在构建基于Redis++的项目时，开发者经常需要通过CMake将Hiredis作为依赖项集成进来。当采用非标准安装路径时，可能会遇到CMake无法正确找到Hiredis库的问题，导致构建失败。

典型错误场景

开发者在使用ExternalProject_Add构建Hiredis和Redis++时，即使正确设置了CMAKE_PREFIX_PATH，Redis++仍然报告找不到Hiredis库和头文件。错误信息通常表现为：

• HIREDIS_LIB变量被设置为NOTFOUND
• HIREDIS_HEADER变量被设置为NOTFOUND
• 构建过程中出现相对路径错误

解决方案分析

1. 构建顺序控制

确保Hiredis的构建在Redis++之前完成。在CMake中，可以通过DEPENDS参数明确指定构建依赖关系：

ExternalProject_Add(redis-plus-plus
    DEPENDS hiredis
    ...
)

2. 路径设置优化

除了CMAKE_PREFIX_PATH外，还需要确保以下路径设置正确：

• 头文件搜索路径：通过CMAKE_INCLUDE_PATH指定
• 库文件搜索路径：通过CMAKE_LIBRARY_PATH指定

3. 变量传递机制

ExternalProject_Add创建的构建环境是隔离的，普通变量不会自动传递。需要使用特定的CMake参数传递机制：

ExternalProject_Add(redis-plus-plus
    CMAKE_ARGS
        -DHIREDIS_LIB=${HIREDIS_LIB}
        -DHIREDIS_HEADER=${HIREDIS_HEADER}
    ...
)

完整解决方案示例

# 设置外部依赖安装路径
set(EXTERNAL_INSTALL_LOCATION ${CMAKE_BINARY_DIR}/external)

# 构建Hiredis
ExternalProject_Add(hiredis
    PREFIX ${EXTERNAL_INSTALL_LOCATION}/hiredis
    SOURCE_DIR ${CMAKE_SOURCE_DIR}/vendor/hiredis
    CMAKE_ARGS 
        -DCMAKE_INSTALL_PREFIX=${EXTERNAL_INSTALL_LOCATION}/hiredis
        -DBUILD_SHARED_LIBS=OFF
        -DCMAKE_TOOLCHAIN_FILE=${CMAKE_TOOLCHAIN_FILE}
    BUILD_ALWAYS TRUE
    BUILD_IN_SOURCE FALSE
)

# 设置Hiredis路径变量
set(HIREDIS_HEADER ${EXTERNAL_INSTALL_LOCATION}/hiredis/include)
set(HIREDIS_LIB ${EXTERNAL_INSTALL_LOCATION}/hiredis/lib/libhiredis.a)

# 构建Redis++
ExternalProject_Add(redis-plus-plus
    DEPENDS hiredis
    PREFIX ${EXTERNAL_INSTALL_LOCATION}/redis-plus-plus
    SOURCE_DIR ${CMAKE_SOURCE_DIR}/vendor/redis-plus-plus
    CMAKE_ARGS 
        -DCMAKE_INSTALL_PREFIX=${EXTERNAL_INSTALL_LOCATION}/redis-plus-plus
        -DCMAKE_TOOLCHAIN_FILE=${CMAKE_TOOLCHAIN_FILE}
        -DCMAKE_PREFIX_PATH=${EXTERNAL_INSTALL_LOCATION}/hiredis
        -DHIREDIS_LIB=${HIREDIS_LIB}
        -DHIREDIS_HEADER=${HIREDIS_HEADER}
        -DREDIS_PLUS_PLUS_BUILD_TEST=OFF
    BUILD_ALWAYS TRUE
    BUILD_IN_SOURCE FALSE
)

最佳实践建议

1. 路径验证：在构建前使用message()命令输出关键路径变量，确认路径设置正确
2. 构建顺序：明确指定项目间的依赖关系
3. 变量传递：显式传递所有必要的路径变量
4. 隔离构建：为每个ExternalProject使用独立的PREFIX路径
5. 错误处理：添加适当的错误检查和回退机制

通过以上方法，可以确保Redis++在非标准路径下正确找到并链接Hiredis库，顺利完成构建过程。