CMake多库安装及find_package调用正确实现方案咨询

1. 配置每个子库的安装规则 #

假设你的项目结构是根目录下有src/foo、src/bar等子模块，每个子模块对应一个库。以src/foo/CMakeLists.txt为例：

# 定义库（静态/动态根据需求选）
add_library(foo STATIC foo.cpp foo.h)

# 设置头文件路径，兼容构建期和安装后两种场景
target_include_directories(foo
  PUBLIC
    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>  # 本地构建时的头文件位置
    $<INSTALL_INTERFACE:include>                   # 安装后的头文件根目录
)

# 安装库文件，并标记该库需要被导出到统一目标集合
install(TARGETS foo
  EXPORT MyProjectTargets
  LIBRARY DESTINATION lib  # 动态库安装路径
  ARCHIVE DESTINATION lib  # 静态库安装路径
  RUNTIME DESTINATION bin  # 可执行文件（如果是exe的话）
  INCLUDES DESTINATION include
)

# 安装头文件到指定目录，保持结构清晰
install(FILES foo.h DESTINATION include/foo)

其他子模块（如src/bar）的配置逻辑完全一致，只需替换库名和文件即可。

2. 根目录CMakeLists统一导出目标 #

在项目根目录的CMakeLists.txt末尾，添加以下配置，负责把所有子库的目标信息统一导出：

# 先设置项目基础信息（必须放在文件开头）
project(MyProject VERSION 1.0.0 LANGUAGES CXX)

# ... 其他根目录配置（比如add_subdirectory(src/foo)、add_subdirectory(src/bar)） ...

# 导出所有标记为MyProjectTargets的子库目标到指定文件
install(EXPORT MyProjectTargets
  FILE MyProjectTargets.cmake
  NAMESPACE MyProject::  # 给目标加命名空间，避免和其他库重名
  DESTINATION lib/cmake/MyProject  # 导出文件的安装路径
)

# 生成供find_package识别的Config.cmake文件
include(CMakePackageConfigHelpers)
configure_package_config_file(
  ${CMAKE_CURRENT_SOURCE_DIR}/Config.cmake.in  # 模板文件路径
  ${CMAKE_CURRENT_BINARY_DIR}/MyProjectConfig.cmake
  INSTALL_DESTINATION lib/cmake/MyProject
)

# 生成版本文件（可选，支持find_package时指定版本）
write_basic_package_version_file(
  ${CMAKE_CURRENT_BINARY_DIR}/MyProjectConfigVersion.cmake
  VERSION ${PROJECT_VERSION}
  COMPATIBILITY SameMajorVersion  # 版本兼容规则，比如主版本相同即可
)

# 安装Config.cmake和ConfigVersion.cmake
install(FILES
  ${CMAKE_CURRENT_BINARY_DIR}/MyProjectConfig.cmake
  ${CMAKE_CURRENT_BINARY_DIR}/MyProjectConfigVersion.cmake
  DESTINATION lib/cmake/MyProject
)

3. 编写Config.cmake.in模板 #

在项目根目录创建Config.cmake.in文件，作为生成MyProjectConfig.cmake的模板：

@PACKAGE_INIT@

# 导入之前导出的子库目标文件
include("${CMAKE_CURRENT_LIST_DIR}/MyProjectTargets.cmake")

# 可选：定义全局变量，方便用户快速引用
set_and_check(MyProject_INCLUDE_DIRS "${PACKAGE_PREFIX_DIR}/include")
set(MyProject_LIBRARIES MyProject::foo MyProject::bar)

4. 安装项目并在外部项目中使用 #

安装你的项目 #

mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/your/install  # 指定安装路径，默认是/usr/local
make install

外部项目中调用 #

在另一个项目的CMakeLists.txt中，只需几行代码即可引入：

# 查找你的项目，支持指定版本（如VERSION 1.0.0）
find_package(MyProject REQUIRED)

# 链接所需的子库
add_executable(myapp main.cpp)
target_link_libraries(myapp PRIVATE MyProject::foo MyProject::bar)

关键概念说明 #

• install(EXPORT)：将CMake构建过程中生成的目标元信息（库路径、头文件路径、编译选项等）导出到.cmake文件，避免外部项目手动配置路径。
• Config.cmake：find_package的入口文件，负责导入导出的目标集合，同时可以定义全局变量供用户快速使用。
• 命名空间：给导出的目标加前缀（如MyProject::），是CMake的最佳实践，能有效避免不同库的目标重名冲突。
• BUILD_INTERFACE/INSTALL_INTERFACE：分别指定构建期和安装后的头文件路径，确保目标在本地开发和安装后两种场景下都能正确找到头文件。

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