cmake：CMAKE_PREFIX_PATH使用技巧与示例

十秒耿直拆包选手

于 2025-05-15 16:36:39 发布

阅读量115

点赞数

分类专栏： C and C++ 大教堂与市集文章标签： c++ cmake

原文链接：https://blog.csdn.net/djfjkj52/article/details/133274999

版权

C and C++ 同时被 2 个专栏收录

115 篇文章

订阅专栏

大教堂与市集

55 篇文章

订阅专栏

一、CMAKE_PREFIX_PATH的基本概念

CMAKE_PREFIX_PATH是CMake中一个重要的环境变量，它用于帮助CMake在配置项目时找到各种依赖项的位置。这个变量尤其在处理那些不在标准位置安装的库时显得非常有用。

CMAKE_PREFIX_PATH指定了一系列的路径，它可以帮助CMake定位库文件，头文件和执行文件等。指示CMake在查找包和项目所需库文件的路径。当使用find_package，find_library、find_file等命令时，CMake会优先在CMAKE_PREFIX_PATH指定的路径中查找，从而缩短构建时间并提高构建成功率。
CMAKE_PREFIX_PATH可设定为绝对路径或相对路径，推荐使用绝对路径。CMAKE_PREFIX_PATH可以设置多个查找路径，路径间使用分号“;”分隔。可以通过set命令来设置CMAKE_PREFIX_PATH变量。
CMAKE_PREFIX_PATH是一个全局变量，其对所有的子文件CMakeLists文件都有效。所以设置CMAKE_PREFIX_PATH的位置通常在项目的根目录下的根文件CMakeLists.txt中。

二、CMAKE_PREFIX_PATH的应用场景

CMAKE_PREFIX_PATH用于查找预编译库。当项目依赖的第三方库已经编译好或直接从包管理器(例如：apt-get、yum等)中获取到，可以设置CMAKE_PREFIX_PATH值，CMake进行查找。
CMAKE_PREFIX_PATH用于不同平台或工具链下的构建。在跨平台开发时，当有多个平台的库文件同时存在源码的同一目录下。可以在CMakeLists.txt文件中根据不同的构建平台或工具链，动态修改CMAKE_PREFIX_PATH的值，确保正确的库文件会被链接到目标可执行文件。
CMAKE_PREFIX_PATH也可以用于指定测试用例中的库文件。当项目需要对各个模块进行单元测试，并且这些模块依赖于不同版本的库文件时，可以通过设置CMAKE_PREFIX_PATH来动态的切换不同版本的库文件，以便在构建测试用例时能够正确链接。

三、设置CMAKE_PREFIX_PATH的方法

在CMakeLists.txt文件中使用set命令设置CMAKE_PREFIX_PATH的值，如下所示：

set(CMAKE_PREFIX_PATH /path/to/libA;/path/to/libB)

通过命令行方式指定CMAKE_PREFIX_PATH的值。在执行cmake命令，使用-D参数设置CMAKE_PREFIX_PATH变量，如下所示：

cmake .. -DCMAKE_PREFIX_PATH=/path/to/libA;/path/to/libB

此外可以将CMAKE_PREFIX_PATH设置为环境变量，这样CMake会自动从环境中读取CMAKE_PREFIX_PATH的值。在Linux系统下，可使用如下命令设置：

export CMAKE_PREFIX_PATH=/path/to/libA:/path/to/libB

在Windows系统下，需要使用如下命令设置：

set CMAKE_PREFIX_PATH=/path/to/libA;/path/to/libB

四、CMAKE_PREFIX_PATH实际应用示例

假设有一个项目依赖于两个库：LibA和LibB。这两个库的头文件和库文件分别存储在"/path/to/libA/include"、“/path/to/libA/lib”、“/path/to/libB/include"和”/path/to/libB/lib"这四个文件夹中。现在需要在CMakeLists.txt文件中设置CMAKE_PREFIX_PATH，以便CMake能够找到这些库。

首先，在项目的根目录下创建一个名为CMakeLists.txt的文件，并编写如下内容：

cmake_minimum_required(VERSION 3.0)
project(example_project)

set(CMAKE_PREFIX_PATH /path/to/libA;/path/to/libB)

find_package(LibA REQUIRED)
find_package(LibB REQUIRED)

add_executable(example_project main.cpp)

target_include_directories(example_project PRIVATE ${LibA_INCLUDE_DIRS} ${LibB_INCLUDE_DIRS})
target_link_libraries(example_project ${LibA_LIBRARIES} ${LibB_LIBRARIES})

上面的CMakeLists.txt文件中，首先使用set命令设置了CMAKE_PREFIX_PATH的值，然后使用find_package命令寻找依赖的两个库。最后，为目标可执行文件example_project添加了库文件路径和库文件。

五、CMAKE_PREFIX_PATH与其他查找路径的关系

除了CMAKE_PREFIX_PATH外，CMake还有其他几个相关的变量，如CMAKE_INCLUDE_PATH、CMAKE_LIBRARY_PATH等。这些变量可以理解为CMAKE_PREFIX_PATH的子集。例如，当设置了CMAKE_INCLUDE_PATH后，CMake会在指定路径下搜索头文件。同样，设置CMAKE_LIBRARY_PATH后，CMake会在指定路径下搜索库文件。
在实际应用中，如果确定项目只需要查找头文件或库文件，可以使用CMAKE_INCLUDE_PATH或CMAKE_LIBRARY_PATH。这样做的好处是提高了查找效率，降低了构建时间。但是，如果项目需要同时查找头文件和库文件，推荐使用CMAKE_PREFIX_PATH。
需要注意的是，设置了CMAKE_PREFIX_PATH时，CMake会优先在CMAKE_PREFIX_PATH指定的路径下查找。如果没有找到，CMake会进一步在默认查找路径、CMAKE_INCLUDE_PATH或CMAKE_LIBRARY_PATH指定的路径下进行查找。因此，在设置CMAKE_PREFIX_PATH时，需要确保其值的正确性，以避免出现查找失败的情况。