自制C++库的CMake基础Config文件编写方案咨询

我完全懂这种感受——本来以为CMake配置文件是小事，但查资料越看越懵。别担心，我会一步步带你写一个适配你库结构的Config文件，让find_package能精准找到你的库。

第一步：确定CMake Config文件的命名与位置 #

首先，CMake对Config文件的命名有严格要求：必须是<你的库名>Config.cmake或者<你的库名>-config.cmake。假设你的库叫MyLib，那文件就得叫MyLibConfig.cmake。

推荐把这个文件放在你的库目录下的cmake子文件夹里，也就是${MY_LIB_PATH}/cmake/MyLibConfig.cmake——这样结构更清晰，也符合CMake的常规约定。

第二步：编写Config文件的核心内容 #

下面是适配你路径结构的完整Config文件代码，我会逐段解释：

# MyLibConfig.cmake

# 1. 设置头文件目录：从当前Config文件所在目录（cmake）回到根目录的include文件夹
set(MY_LIB_INCLUDE_DIR "${CMAKE_CURRENT_LIST_DIR}/../include")

# 2. 自动判断目标架构（x86/x64）
if(CMAKE_SIZEOF_VOID_P EQUAL 8)
    # 64位系统，指针大小为8字节
    set(MY_LIB_ARCH "x64")
else()
    # 32位系统，指针大小为4字节
    set(MY_LIB_ARCH "x86")
endif()

# 3. 自动匹配构建类型（Debug/Release），默认用Release
if(NOT CMAKE_BUILD_TYPE)
    set(MY_LIB_BUILD_TYPE "release")
else()
    # 把CMake的大写构建类型转成小写，匹配你的目录命名
    string(TOLOWER "${CMAKE_BUILD_TYPE}" MY_LIB_BUILD_TYPE)
endif()

# 4. 拼接对应架构和构建类型的库文件目录
set(MY_LIB_LIB_DIR "${CMAKE_CURRENT_LIST_DIR}/../lib/${MY_LIB_ARCH}/${MY_LIB_BUILD_TYPE}")

# 5. 查找具体的库文件（替换成你的实际库名，比如MyLib.lib）
find_library(MY_LIB_LIBRARY
    NAMES MyLib
    PATHS "${MY_LIB_LIB_DIR}"
    NO_DEFAULT_PATH  # 只在指定路径找，避免找到其他同名库
)

# 6. 导入库为CMake目标（推荐用命名空间，更规范）
if(NOT TARGET MyLib::MyLib)
    # 如果是动态库，把STATIC改成SHARED
    add_library(MyLib::MyLib STATIC IMPORTED)
    set_target_properties(MyLib::MyLib PROPERTIES
        # 指定库文件的路径
        IMPORTED_LOCATION "${MY_LIB_LIBRARY}"
        # 告诉链接的项目要包含这个头文件目录
        INTERFACE_INCLUDE_DIRECTORIES "${MY_LIB_INCLUDE_DIR}"
    )
endif()

# 7. 设置find_package需要的返回变量
set(MY_LIB_FOUND TRUE)
set(MY_LIB_INCLUDE_DIRS "${MY_LIB_INCLUDE_DIR}")
set(MY_LIB_LIBRARIES "${MY_LIB_LIBRARY}")

关键细节说明： #

• CMAKE_CURRENT_LIST_DIR：CMake内置变量，代表当前Config文件所在的绝对路径，用它拼接路径比硬编码更灵活。
• 架构判断：通过CMAKE_SIZEOF_VOID_P（指针大小）自动区分32/64位，不用手动指定。
• 构建类型适配：把CMake的大写CMAKE_BUILD_TYPE转成小写，匹配你目录里的debug/release命名。

第三步：让find_package找到你的Config文件 #

有三种常用方法：

方法1：设置环境变量（全局生效） #

把${MY_LIB_PATH}/cmake添加到系统的CMAKE_PREFIX_PATH环境变量里，CMake会自动搜索这个路径下的Config文件。

方法2：在项目CMakeLists.txt里指定路径 #

在调用find_package前，把你的库cmake目录加到CMAKE_PREFIX_PATH：

set(CMAKE_PREFIX_PATH "${MY_LIB_PATH}/cmake" ${CMAKE_PREFIX_PATH})
find_package(MyLib REQUIRED)

方法3：直接指定Config文件路径给find_package #

如果只是临时用，可以直接告诉CMake去哪里找：

find_package(MyLib REQUIRED PATHS "${MY_LIB_PATH}/cmake")

第四步：在你的项目中使用库 #

配置好之后，在目标项目的CMakeLists.txt里就可以这样用：

cmake_minimum_required(VERSION 3.10)
project(MyDemoApp)

# 找到你的库
find_package(MyLib REQUIRED)

# 创建可执行文件
add_executable(MyDemoApp main.cpp)

# 链接库（用命名空间的目标更规范）
target_link_libraries(MyDemoApp PRIVATE MyLib::MyLib)

这样CMake就会自动根据当前项目的架构和构建类型，链接对应的库文件，同时包含头文件目录。

内容的提问来源于stack exchange，提问作者J. Doe