基于SDL2的CMake库引用时出现SDL.h找不到的编译问题

一、解决SDL.h找不到的问题 #

这个错误的核心原因是：SquareEngine单独编译时，自身CMake配置正确处理了SDL2的包含路径，但这些路径没有传递给父项目（Demo）。下面是具体修复步骤：

1. 修正SquareEngine的CMakeLists.txt，确保依赖传递
   编译SquareEngine时，不要用PRIVATE来设置SDL2的包含路径和链接库，改用PUBLIC或INTERFACE，这样CMake会自动把这些依赖信息传递给引用它的父项目。示例配置：

   # 找到SDL2（根据你的环境选择合适的find方式）
   find_package(SDL2 REQUIRED)
   
   # 定义你的库目标
   add_library(SquareEngine src/your_source.cpp)
   
   # 设置包含路径，用PUBLIC暴露给父项目
   target_include_directories(SquareEngine
     PUBLIC
       ${SDL2_INCLUDE_DIRS}
       ${CMAKE_CURRENT_SOURCE_DIR}/include  # 你的库自身头文件路径
   )
   
   # 链接SDL2，同样用PUBLIC传递链接依赖
   target_link_libraries(SquareEngine
     PUBLIC
       ${SDL2_LIBRARIES}
   )
   

   如果你的SDL2版本支持现代CMake目标（如SDL2::SDL2），更推荐用下面的写法，自动处理包含路径和链接：

   find_package(SDL2 REQUIRED CONFIG)
   target_link_libraries(SquareEngine PUBLIC SDL2::SDL2)
   

2. 确保Demo项目正确链接SquareEngine
   在Demo的CMakeLists.txt中，通过target_link_libraries链接SquareEngine即可，不需要再手动添加SDL2的依赖：

   add_executable(Demo demo_main.cpp)
   # 链接SquareEngine，CMake会自动导入它的所有PUBLIC依赖
   target_link_libraries(Demo PRIVATE SquareEngine)
   

3. 验证SDL2的查找配置
   如果你的环境中CMake找不到SDL2，可能需要指定SDL2_DIR变量，比如在编译Demo时通过命令行传递：

   cmake -S . -B build -DSDL2_DIR=/path/to/SDL2/cmake/config
   

二、改用静态SDL是否更好？ #

静态SDL和动态SDL各有优劣，取决于你的需求：

静态SDL的优势 #

• 分发更方便：不需要用户额外安装SDL2运行库，编译后的Demo程序可以直接运行，适合展示或分发成品。
• 避免版本冲突：不会出现用户系统中SDL2版本与开发版本不兼容的问题。

静态SDL的劣势 #

• 程序体积更大：SDL2的代码会被打包进可执行文件，导致文件尺寸增加。
• 内存占用更高：如果多个进程都使用静态SDL，会重复加载相同的代码到内存中。
• 额外配置需求：部分平台（如Windows）静态链接SDL2时，需要在代码中定义SDL_STATIC宏，否则会出现链接错误。

总结 #

如果你的Demo是用于展示SquareEngine、需要快速分发，静态SDL是更优选择；如果是开发阶段调试、追求程序轻量化，动态链接更合适。两种方式下，CMake的依赖传递逻辑（用PUBLIC暴露依赖）都是一致的。

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