cmake：find_package 添加依赖库

布满荆棘的人生 2022-12-30 13:53 491阅读 0赞

> 此文为：[轻松入门cmake系列教程][cmake]

引入库文件时，我们必须知道**头文件的路径还有库文件的路径**

在cmake某个程序的时候，经常会提示找不到某个所依赖的库，那么这是时候我们就需要检查我们引入依赖库的路径对不对了， Cmake中一个自动寻找函数find\_package()可以帮我们实现这个功能。

# 实践 #

## 例子1：opencv ##

CMakeFileLists.txt

find_package( OpenCV REQUIRED )
    if (OpenCV_FOUND)
    	include_directories( ${
        OpenCV_INCLUDE_DIRS} )
    	target_link_libraries( ${
        PROJECT_NAME} ${
        OpenCV_LIBS} )
    endif (OpenCV_FOUND)

下面需要说明的是，`find_package(OpenCV REQUIRED)`执行成功后，它的头文件路径，库文件路径都会被赋值。

OpenCV_INCLUDE_DIRS 是头文件路径
    OpenCV_LIBS 是库文件地址

有了头文件和库文件，自然而然可以正常引用 OpenCV 了。

我们可以打印输出这两个变量：

message("!!!!!!!!OpenCV_INCLUDE_DIRS:" ${
        OpenCV_INCLUDE_DIRS})
    message("!!!!!!!!OpenCV_LIBRARIES:" ${
        OpenCV_LIBRARIES} )

## 例子2：bzip2 ##

比如，cmake 可以很轻松引入 bzip2

find_package (BZip2)
    if (BZIP2_FOUND)
        include_directories(${
        BZIP_INCLUDE_DIRS})
        target_link_libraries (test ${
        BZIP2_LIBRARIES})
    endif (BZIP2_FOUND)

BZIP2 定义了一系列变量，含义如下

BZIP2_FOUND - system has BZip2
    BZIP2_INCLUDE_DIR - the BZip2 include directory
    BZIP2_LIBRARIES - Link these to use BZip2
    BZIP2_NEED_PREFIX - this is set if the functions are prefixed with BZ2_
    BZIP2_VERSION_STRING

总结：

现在用 XXX 代表要查找的 package 名字  
`find_pacakge(XXX REQUIRED)`会设置一系列变量。

XXX_FOUND 代表库是否查找成功
    XXX_INCLUDE_DIRS 代表头文件的路径
    XXX_LIBRARIES 代表库文件的路径

## 例子2：单独引入某些组件 ##

一个库可能由好多个组件构成，cmake 可以单独引入这些组件

find_package(Qt5 5.1.0 COMPONENTS Widgets Xml Sql)

引入了 Qt5 中的 Widgets Xml Sql 组件。

# 理论 #

## 语法 ##

实际上，通过 find\_package() 可以顺利查找任何符合 cmake package 标准的外部工程。

find\_pacage()方法签名如下：

find_package(<package> [version] [EXACT] [QUIET] [MODULE]
                 [REQUIRED] [[COMPONENTS] [components...]]
                 [OPTIONAL_COMPONENTS components...]
                 [NO_POLICY_SCOPE])

*  `version`和`EXACT`: 都是可选的，version指定的是版本，如果指定就必须检查找到的包的版本是否和version兼容。如果指定EXACT则表示必须完全匹配的版本而不是兼容版本就可以。
 *  `QUIET` 可选字段，表示如果查找失败，不会在屏幕进行输出（但是如果指定了REQUIRED字段，则QUIET无效，仍然会输出查找失败提示语）
 *  `MODULE`可选字段。默认“如果Module模式查找失败则回退到Config模式进行查找”，但是假如设定了MODULE选项，那么就只在Module模式查找，如果Module模式下查找失败并不回落到Config模式查找。
 *  `REQUIRED`可选字段。表示一定要找到包，找不到的话就立即停掉整个cmake。而如果不指定REQUIRED则cmake会继续执行。
 *  `COMPONENTS`:可选字段，表示查找的包中必须要找到的组件(components)，如果有任何一个找不到就算失败，类似于REQUIRED，导致cmake停止执行
 *  `OPTIONAL_COMPONENTS`：可选的模块，找不到也不会让cmake停止执行。

## 原理 ##

首先，cmake本身不提供任何搜索库的便捷方法，所有搜索库并给变量赋值的操作必须由cmake代码完成，比如FindXXX.cmake和XXXConfig.cmake。只不过，库的作者通常会提供这两个文件，以方便使用者调用。  
find\_package采用两种模式搜索库：

*  Module模式：搜索CMAKE\_MODULE\_PATH指定路径下的FindXXX.cmake文件，执行该文件从而找到XXX库。其中，具体查找库并给XXX\_INCLUDE\_DIRS和XXX\_LIBRARIES两个变量赋值的操作由FindXXX.cmake模块完成（先搜索当前项目里面的Module文件夹里面提供的\*FindXXX.cmake，然后再搜索系统路径/usr/local/share/cmake-x.y/Modules/FindXXX.cmake）
 *  Config模式：搜索XXX\_DIR指定路径下的XXXConfig.cmake文件，执行该文件从而找到XXX库。其中具体查找库并给XXX\_INCLUDE\_DIRS和XXX\_LIBRARIES两个变量赋值的操作由XXXConfig.cmake模块完成。
 *  对于可能没有\*\*\*.cmake和\*\*\*Config.cmake的库文件，可以直接找到其头文件和库文件所在文件夹，直接进行路径赋值：

SET(LAPACK_DIR /usr/local/lib/) 
    SET(LAPACK_INCLUDE_DIRS /usr/local/include) 
    SET(LAPACK_LIBRARIES /usr/local/lib)

[cmake]: https://blog.csdn.net/zhizhengguan/article/details/107034372