库开发者需提供哪些配置以简化用户的库安装流程？

问题背景 #

作为C库开发者，我需要优化CMake配置，让使用者能更便捷地安装、导入我的库。请审阅当前的CMakeLists.txt、config.cmake文件及目录结构，给出具体修改建议，实现流畅的用户使用体验。

现有文件与目录结构 #

顶层CMakeLists.txt #

cmake_minimum_required(VERSION 3.26)
project(mylib C)

set(CMAKE_C_STANDARD 11)

add_library(mylib src/foo.c src/bar.c)
target_compile_features(mylib PRIVATE c_std_11)

target_include_directories(mylib PUBLIC
        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>)

include(GNUInstallDirs)
include(CMakePackageConfigHelpers)

# 配置文件
configure_package_config_file(build/config.cmake
        ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake # cmake-build-debug/
        INSTALL_DESTINATION ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME} NO_SET_AND_CHECK_MACRO) # share/

# 版本文件
write_basic_package_version_file(
        ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake
        VERSION 1.0.0
        COMPATIBILITY SameMajorVersion)

# 安装配置与版本文件
install(FILES
        ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake # cmake-build-debug/
        ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake # cmake_build-debug/
        DESTINATION
        ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME}) # share/

# 创建导出集以支持在其他CMake项目中导入
install(TARGETS ${PROJECT_NAME} EXPORT ${PROJECT_NAME}-targets # 创建导出集
        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} # lib/
        ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} # lib/
        INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} # include/
)
# 安装导出集
install(EXPORT ${PROJECT_NAME}-targets
        NAMESPACE mylib::
        DESTINATION ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME})

# 安装头文件
install(DIRECTORY ${CMAKE_SOURCE_DIR}/include/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}) # include/

config.cmake模板 #

@PACKAGE_INIT@

include(${CMAKE_CURRENT_LIST_DIR}/mylib-targets.cmake)

check_required_components(mylib)

消费者示例代码 #

cmake_minimum_required(VERSION 3.26)
project(consumer C)

set(CMAKE_C_STANDARD 11)

add_executable(consumer main.c)

find_package(mylib CONFIG REQUIRED)
target_link_libraries(consumer PRIVATE mylib::mylib)

目录结构 #

mylib/
|-- CMakeLists.txt (顶层)
|-- src/
|   |-- CMakeLists.txt
|   |-- foo.c
|   |-- bar.c
|-- example/
|   |-- CMakeLists.txt
|   |-- example1.c
|   |-- example2.c

example/CMakeLists.txt #

add_executable(example1 example1.c)
target_link_libraries(example1 PRIVATE mylib)
add_test(NAME TestExample1 COMMAND example1)

add_executable(example2 example2.c)
target_link_libraries(example2 PRIVATE mylib)
add_test(NAME TestExample2 COMMAND example2)

核心修改建议 #

1. 修复CMakeLists.txt的关键问题 #

（1）统一头文件路径逻辑

当前头文件安装到 ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}，但target_include_directories的INSTALL_INTERFACE指向${CMAKE_INSTALL_INCLUDEDIR}，导致用户包含头文件时路径不匹配。修改如下：

# 调整target_include_directories的INSTALL_INTERFACE
target_include_directories(mylib PUBLIC
        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>)

# 安装头文件时保留目录结构（确保include/mylib下的头文件被正确安装）
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/mylib
        DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})

同时必须在目录结构中添加include/mylib目录，存放foo.h、bar.h等头文件，符合标准库的头文件组织规范。

（2）启用src目录的CMakeLists.txt

当前顶层CMakeLists直接编译src下的源文件，但src目录已有自己的CMakeLists，应改为通过add_subdirectory引入，保持模块化：

# 替换原add_library(mylib src/foo.c src/bar.c)
add_subdirectory(src)

然后修改src/CMakeLists.txt：

add_library(mylib foo.c bar.c)
target_compile_features(mylib PRIVATE c_std_11)

# 头文件路径配置移到src的CMakeLists
target_include_directories(mylib PUBLIC
        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/../include>
        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}>)

（3）版本号模块化管理

将硬编码的版本号改为变量，便于后续维护：

# 在project命令后添加版本变量
project(mylib C VERSION 1.0.0)

# 版本文件生成时使用变量
write_basic_package_version_file(
        ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake
        VERSION ${PROJECT_VERSION}
        COMPATIBILITY SameMajorVersion)

（4）修正配置文件模板路径

当前configure_package_config_file的输入路径是build/config.cmake，但目录结构中无此文件。应将模板文件命名为config.cmake.in放在顶层，修改命令：

configure_package_config_file(${CMAKE_CURRENT_SOURCE_DIR}/config.cmake.in
        ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake
        INSTALL_DESTINATION ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME}
        NO_SET_AND_CHECK_MACRO)

（5）添加示例编译开关

给example目录添加编译选项，让用户可以选择是否编译示例：

# 顶层CMakeLists添加
option(BUILD_EXAMPLES "Build example programs" ON)
if(BUILD_EXAMPLES)
    enable_testing() # 启用测试（如果需要运行example中的test）
    add_subdirectory(example)
endif()

2. 优化config.cmake模板 #

增强鲁棒性，添加目标检查，避免导入失败时无明确提示：

@PACKAGE_INIT@

# 检查导出文件是否存在
if(NOT EXISTS "${CMAKE_CURRENT_LIST_DIR}/mylib-targets.cmake")
    message(FATAL_ERROR "mylib targets file not found! Ensure mylib is installed correctly.")
endif()

include("${CMAKE_CURRENT_LIST_DIR}/mylib-targets.cmake")

# 验证核心目标是否存在
if(NOT TARGET mylib::mylib)
    message(FATAL_ERROR "mylib::mylib target not found!")
endif()

check_required_components(mylib)

3. 完善目录结构 #

补充缺失的include目录，最终结构应为：

mylib/
|-- CMakeLists.txt (顶层)
|-- include/
|   |-- mylib/
|       |-- foo.h
|       |-- bar.h
|-- src/
|   |-- CMakeLists.txt
|   |-- foo.c
|   |-- bar.c
|-- example/
|   |-- CMakeLists.txt
|   |-- example1.c
|   |-- example2.c
|-- config.cmake.in

4. 消费者使用体验优化 #

在消费者文档中补充说明：

• 如果库安装在非系统默认路径（如~/local），需要在调用find_package前设置CMAKE_PREFIX_PATH：

  set(CMAKE_PREFIX_PATH "/path/to/mylib/install")
  find_package(mylib CONFIG REQUIRED)
  

• 头文件包含方式：#include <mylib/foo.h>

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