CMake学习笔记：find_package

已于 2024-10-04 22:41:07 修改
阅读量521 收藏 10
点赞数 8
分类专栏： Linux环境c++开发 文章标签： 学习 笔记 macos
于 2024-10-04 21:51:46 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/flybirddizi/article/details/142694369
版权

一、用途

        find_package它主要用于查找并加载外部库或框架，自动在CMake的模块路径中搜索相应的FindXXX.cmake或者XXXconfig.cmake或者xxx-config.cmake文件，并根据该文件提供的信息设置库文件路径、头文件路径以及链接选项等‌。

        我们在mac系统下，以Poco库为例子学习find_package的使用。mac安装Poco库的方法在我的文章中。

二、使用find_package的简单例子

        CMakeLists.txt的一段代码，其中查找Poco库中的Foundation和Util两个库

cmake_minimum_required(VERSION 3.30)

project(findPackageDemo)

add_executable(findPackDemo main.cpp)

find_package(
    Poco
    COMPONENTS Foundation Util
    REQUIRED
)

        我们通过下面这段代码，查看找到的库的头文件搜索路径信息和动态库路径信息。

foreach(m ${Poco_LIBRARIES})
    message(STATUS "Poco: ${m}")
    #获取头文件的搜索路径
    get_target_property(
        m_poco_include_dir ${m} INTERFACE_INCLUDE_DIRECTORIES
    )
    message(STATUS " m_poco_include_dir: ${m_poco_include_dir}")
    #获取动态库的路径
    get_target_property(
        m_poco_location ${m} INTERFACE_LOCATION
    )
    message(STATUS " m_poco_location: ${m_poco_location}")
endforeach()

        运行结果如下

[cmake] -- Poco: Poco::Foundation
[cmake] --  m_poco_include_dir: /usr/local/include;/usr/local/include
[cmake] --  m_poco_location: /usr/local/lib/libPocoFoundation.103.dylib
[cmake] -- Poco: Poco::Util
[cmake] --  m_poco_include_dir: /usr/local/include;/usr/local/include
[cmake] --  m_poco_location: /usr/local/lib/libPocoUtil.103.dylib

       find_package在查找和解析Poco库信息的时候，分为两种模式：Module模式和Config模式。Module模式下解析 Findxxx.cmake 文件，Config模式下解析xxxConfig.cmake 文件或者 xxx-config.cmake文件。

三、Module模式

        3.1 find_package参数 

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

        3.2 文件搜索过程

   Module 模式下，在CMAKE_MODULE_PATH 和 CMake 安装路径下（CMAKE_ROOT）的 Modules 目录中查找名为 Find<PackageName>.cmake 的配置文件。

        测试代码如下

message(STATUS "----------------Module模式---------------")
#查找到名为 Find<PackageName>.cmake 的配置文件
#只需要查找两个路径 CMAKE_MODULE_PATH CMAKE_ROOT
message(STATUS ${CMAKE_ROOT})
message(STATUS ${CMAKE_MODULE_PATH})
find_package(GTest REQUIRED) #Cmake提供的现成开发库

         运行结果如下

[cmake] -- ----------------Module模式---------------
[cmake] -- /Applications/CMake.app/Contents/share/cmake-3.30
[cmake] --

四、Config模式

         4.1 用法 

        Config 模式的参数更多更复杂，但实际使用只需要掌握基本的参数用法即可

         4.2 文件搜索过程

        Config 模式搜索文件路径顺序如下：

message(STATUS "----------------Config模式---------------")
#搜索路径有4类
#<PackageName>_DIR
#CMAKE_PREFIX_PATH CMAKE_FRAMEWORK_PATH CMAKE_APPBUNDLE_PATH
#PATH 环境变量路径
#CMAKE_SYSTEM_PREFIX_PATH 系统变量

#<PackageName>_DIR 需要指定到<PackageName>config.cmake文件所在目录
#CMAKE_PREFIX_PATH 只需要指定查找的根目录即可
#找到根目录后，会匹配根目录下的路径，用于找到<PackageName>config.cmake

五、FindXXX.cmake简单例子

任务背景：封装一个自己的MYPOCO动态库，MYPOCO库中依赖第三方Poco库的部分内容。创建一个MYProject项目，依赖MYPOCO库。以此练习find*.cmake文件的编写和find_package的使用。macOS的第三方Poco库的编译安装参考MacOS编译和安装Poco库的方法。

5.1 MYProject项目源代码

1. 首先写一个要被依赖第三方项目MYPOCO，生成动态库libMyPoco.dylib。我们将MYPOCO的头文件和动态库放在如下的公共路径下。MyPOCO项目代码

Common

|_ include

        |_ mypocoApi.h

|_ lib

        |_ libMyPoco.dylib

|_cmake

        |_ FindMyPoco.cmake

2. 编写自己的项目MYProject，使用第三方库libMyPoco.dylib功能。

MYProject项目目录结构

MYPROJECT

|_ CMakeLists.txt

|_ main.cpp

MYProject项目CMakeLists.txt

cmake_minimum_required(VERSION 3.30)

project(MyProject)

#获取当前项目路径的上一级路径
set(_IMPORT_PREFIX ${CMAKE_CURRENT_SOURCE_DIR})
get_filename_component(_IMPORT_PREFIX ${_IMPORT_PREFIX} PATH)
#手动把cmake的搜索路径赋值,用于找到Mypoco对应的cmake文件
set(CMAKE_MODULE_PATH "${_IMPORT_PREFIX}/Common/cmake")

find_package(MyPoco REQUIRED)

#添加可执行程序
add_executable(MyProject main.cpp)

#添加第三方库MyPoco的链接
target_link_libraries(
    MyProject
    PUBLIC MyPoco
)

MYProject项目main.cpp

#include <iostream>
#include "mypocoApi.h"

using namespace std;

int main()
{
    cout<<"This is myProject"<<endl;
    MYTHREELIB::mypoco mp(888);
    mp.mypocoFormat();
    return 1;
}

5.2 FindMyPoco.cmake

编写FindMyPoco.cmake文件，用于其他项目找到MyPoco库的路径

FindMyPoco.cmake文件

get_filename_component(MyPoco_root ${CMAKE_CURRENT_SOURCE_DIR} PATH)
set(MyPoco_root ${MyPoco_root}/Common)

#寻找动态路的搜索路径
find_library(
    MyPoco_LIB
    NAMES libMyPoco.dylib
    PATHS ${MyPoco_root}/lib
    NO_DEFAULT_PATH #不使用其他默认搜索路径
)
#寻找头文件搜索路径
find_path(
    MyPoco_INCLUDE_DIR
    NAMES mypocoApi.h 
    PATHS ${MyPoco_root}/include
)

find_package(
    Poco
    COMPONENTS Foundation
    REQUIRED
)

set(MyPoco_INCLUDE_DIRS ${MyPoco_INCLUDE_DIR} /usr/local/include)
set(MyPoco_LIBS ${MyPoco_LIB})
#防止目标被重复制作 
if(NOT TARGET MyPoco)
    add_library(MyPoco SHARED IMPORTED)
    set_target_properties(MyPoco PROPERTIES
    IMPORTED_LOCATION ${MyPoco_LIB}
    INTERFACE_INCLUDE_DIRECTORIES "${MyPoco_INCLUDE_DIRS}")
    target_link_libraries(MyPoco INTERFACE Poco::Foundation)
endif()

5.3 MYPOCO项目源代码

MYPoco项目目录结构

MYPOCO

|_ CMakeLists.txt

|_ main.cpp

|_ mypocoApi.h

|_ mypocoApi.cpp

MYPOCO项目CMakeLists.txt

cmake_minimum_required(VERSION 3.30)

project(MyPoco)

#打印出来看一下
message(STATUS "${m_poco_include_dir}")
#生成MyPoco的动态库libMyPoco.dylib
add_library(MyPoco SHARED main.cpp mypocoApi.cpp)
#add_executable(MyPoco main.cpp mypocoApi.cpp)
#查找依赖的第三方库PocoFoundation
find_package(
    Poco
    COMPONENTS Foundation
    REQUIRED
)
#获取目标的头文件搜索路径
get_target_property(
    m_poco_include_dir
    Poco::Foundation
    INTERFACE_INCLUDE_DIRECTORIES
    )
#链接第三方库PocoFoundation
target_link_libraries(
    MyPoco
    PUBLIC Poco::Foundation;Poco::Foundation
)
#包含第三方库PocoFoundation的头文件搜索路径
target_include_directories(
    MyPoco
    INTERFACE m_poco_include_dir
    BUILD_INTERFACE m_poco_include_dir
)

MYPOCO项目main.cpp

#include <iostream>
#include "mypocoApi.h"

using namespace std;

int main()
{
    MYTHREELIB::mypoco c_poco(666);
    c_poco.mypocoFormat();
    return 1;
}

MYPOCO项目mypocoApi.h

#include <iostream>
#include "Poco/Foundation.h"
#include "Poco/Format.h"
using namespace std;

namespace MYTHREELIB{
class mypoco
{
public:
    mypoco(int num):m_myformat(num){}
    int m_myformat;
    void mypocoFormat();
};
}

MYPOCO项目mypocoApi.cpp

#include "mypocoApi.h"

void MYTHREELIB::mypoco::mypocoFormat()
{
    string res = Poco::format("%d", m_myformat);
    cout<<"This is mypocoFormat res "<<res<<endl;
}

六、XXXConfig.cmake简单例子

XXXConfig.cmake的编写方法todo...

小笛子的专栏
关注
专栏目录
CMAKE学习笔记--find_package
weixin_44194690的博客
12-23 520
main中的CMakeLists.txt通过find_package()函数去找到hello_DIR路径下helloConfig.cmake，从而得到hello_INCLUDE_DIRS，hello_LIBS两个变量值。第四句：fing_package所做的事情就是根据xxx_DIR路径找到xxxConfig.cmake文件，然后执行该文件得到xxx_INCLUDE_DIRS和xxx_LIBS变量，前者存放了所需要的头文件路径，后者指向了所需要用到的库路径。再来看world的CMakeLists.txt。
cmake：find_package 添加依赖库
OceanStar的博客
12-26 5189
此文为：轻松入门cmake系列教程 引入库文件时，我们必须知道头文件的路径还有库文件的路径 在cmake某个程序的时候，经常会提示找不到某个所依赖的库，那么这是时候我们就需要检查我们引入依赖库的路径对不对了， Cmake中一个自动寻找函数find_package()可以帮我们实现这个功能。 实践 例子1：opencv CMakeFileLists.txt find_package( OpenCV REQUIRED ) if (OpenCV_FOUND) include_directories( ${O.
cmake find_package 使用笔记
A_cainiao_A
07-06 483
find_package
CMake学习笔记：搜索第三方库及头文件路径 find_package()命令
weixin_45824067的博客
05-22 3978
在实际开发过程中，经常不可避免的会使用到第三方开源库，这些开源库可能是通过apt-get install 命令自动安装到系统目录，也可能是由我们自己下载库的源码然后通过编译安装到指定目录的。不管哪种方式安装的库文件，如果我们需要在自己的项目中使用这些库，首先面临的第一个问题就是如何找到这些库。也就是说，根据我们的需要找到指定本版的库头文件包含路径、链接库路径等，从而能够满足我们开发项目的编译链接需要。
cmake：find_file、find_library、find_path、find_program
OceanStar的博客
07-01 3534
find_file find_file (<VAR> name1 [path1 path2 ...]) find_file ( <VAR> name | NAMES name1 [name2 ...] [HINTS [path | ENV var]... ] [PATHS [path | ENV var]... ] [PATH_SUFFIXES suffix1 [suffix2 ..
cmake：pkg_check_modules
热门推荐
OceanStar的博客
12-27 2万+
此文为：轻松入门cmake系列教程 理论 是什么？ pkg_check_modules是 CMake 自己的 pkg-config模块的一个用来简化的封装：你不用再检查 CMake 的版本，加载合适的模块，检查是否被加载，等等，参数和传给 find_package 的一样：先是待返回变量的前缀，然后是包名（pkg-config 的）。这样就定义了<prefix>_INCLUDE_DIRS和其他的这类变量，后续的用法就与find_package一致。 工作原理 当安装某些库时（例如从RPM，d.
CMake和Linux编程：find_package的使用
weixin_34259232的博客
07-11 327
1.第一个CMake例子 　　在 t1 目录建立 main.c 和 CMakeLists.txt(注意文件名大小写)：　　main.c 文件内容： //main.c #include <stdio.h> int main() { printf(“Hello World from t1 Main!n”); return 0; } 　Cmake...
CMake学习笔记四：usb_cam的CMakeLists解析
weixin_30532973的博客
04-09 217
最近在学习cmake，在完整看了《cmake实践》一书后，跟着书上例程敲了跑了一遍，也写了几篇相关读书笔记，算是勉强基本入门了。所以找了usb_cam软件包的CMakeLists.txt来进一步学习，在看懂这个例子之后，准备写篇博客记录一下，若有谬误还望指正。 1 usb_cam软件包简介 现在市面上最常见的还是USB摄像头，物美价廉，要想使USB摄像头在ROS下正常工作，我们就需要一...
CMake20-弃用指令1：link_directories【指定第三方库所在路径】【官方不建议使用该命令，取而代之的为find_package()、find_library()】
u013250861的博客
11-20 2536
LINK_DIRECTORIES 命令来指定第三方库所在路径，比如，你的动态库在/home/myproject/libs这个路径下，则通过命令：LINK_DIRECTORIES(/home/myproject/libs)，把该路径添加到第三方库搜索路径中，这样就可以使用相对路径了，使用TARGET_LINK_LIBRARIES的时候，只需要给出动态链接库的名字就行了。官方不建议使用该命令，取而代之的为find_package() find_library()
CMake入门笔记-王逸凡_488011331
08-03
CMake 提供了许多高级功能来处理这些情况，如 `find_package` 查找外部库、`set_property` 设置目标属性、`enable_testing` 开启测试并使用 `add_test` 添加测试用例等。 总的来说，CMake 是一个强大的跨平台构建...
cMake 学习笔记，快速入门
06-11
**cMake 学习笔记，快速入门** cMake 是一种跨平台的构建系统，用于管理软件项目的构建过程。它能够生成各种编译器所需的构建文件，如Visual Studio的解决方案文件或Unix Makefiles，使得开发者无需关心底层构建...
cmake 学习笔记(三) - Mingz技术博客 - 博客频道 - CSDN1
08-04
本篇学习笔记主要探讨了如何使用CMake来寻找和管理第三方库，特别是通过`find_package`命令来自动化这一过程。 `find_package`是CMake的一个关键功能，它允许在构建项目时自动定位并链接所需的外部库。例如，当你...
cmake学习笔记——常用命令，以及finder使用
axiba_gun的博客
02-18 854
1 Cmake是什么 CMake 是一个跨平台的自动化建构系统,它使用一个名为 CMakeLists.txt 的文件来描述构建过程,可以产生标准的构建文件,如 Unix 的 Makefile 或Windows Visual C++ 的 projects/workspaces 。文件 CMakeLists.txt 需要手工编写,也可以通过编写脚本进行半自动的生成。在 linux 平台下使用 CMak...
Go基础学习08-并发安全型类型-通道（chan）深入研究
FLJS_T的博客
09-28 883
在前面学习中了解到对于单值变量，如：int、string；多值变量，如：map存在多协程对资源竞争的并发问题，为了解决并发性通常需要引入sync.Mutex解决。>对于通道的基本声明方式有三种：声明并初始化带缓冲的通道（ch1）；声明并初始化一个不带缓冲的通道（ch2）；仅仅声明一个通道（ch3） >什么是通道：==一个通道相当于一个先进先出（FIFO）的队列。也就是说，通道中的各个元素值都是严格地按照发送的顺序排列的，先被发送通道的元素值一定会先被接收。Select和for循环实现对channel的多次选
10.2学习
最新发布
2401_87363162的博客
10-02 1102
​ Spring AOP就是基于动态代理的，如果要代理的对象，实现了某个接⼝，那么Spring AOP会使⽤JDKProxy，去创建代理对象，⽽对于没有实现接⼝的对象，就⽆法使⽤ JDK Proxy 去进⾏代理了，这时候Spring AOP会使⽤基于asm框架字节流的Cglib动态代理 ，这时候Spring AOP会使⽤ Cglib ⽣成⼀个被代理对象的⼦类来作为代理。每个线程中都有一个自己的ThreadLocalMap类对象，可以将线程自己的对象保持到其中，各管各的，线程可以正确的访问到自己的对象。
6.824 Lab 2C 学习记录
kingsill的博客
09-29 309
最后10s，开始的时候，恢复网络，插入一个数据，等待这个数据被提交，如果超过这10s就报错。2C的test中的unreliable figure8算是给博主的迎头一棒，需要根据raft论文的figure8进行解决，leader。根据前任及博主自己的经验，unreliable figure8的除了上述这一点以外，需要对。博主由于之前的不严谨，给自己留下了很大的改进困难，最后不得不重构代码。进行一定的设计，可以参考课程里老师提出的意见。一下为博主的github仓库，需要的可以参考。有一定的考验，那么就需要对。
Elasticsearch学习笔记(2）
m0_74293254的博客
09-28 1199
创建索引: 使用 PUT 请求来定义索引及其映射。创建文档: 使用 POST 请求将数据添加到索引。读取文档: 使用 GET 请求获取特定文档。更新文档: 使用 POST 加上 _update 操作来修改现有文档。删除文档: 使用 DELETE 请求删除指定文档。删除索引: 使用 DELETE 请求删除整个索引。请求方式：POST请求格式：/{索引库名}/_doc/文档id示例：POST /my_index/_doc/1 { "field": "value" }
【DirectX sdk 学习使用】
qq_41610493的博客
10-01 354
设置包含目录：打开你的项目属性，导航到VC++目录，然后在包含目录中添加DirectX SDK的Include文件夹路径。设置库目录：同样在VC++目录中，在库目录中添加DirectX SDK的Lib文件夹路径。运行安装程序：下载完成后，找到下载的安装程序（通常是一个.exe文件），双击运行。选择安装路径：选择你希望安装DirectX SDK的路径，或者使用默认路径。如果你有任何问题或需要进一步的指导，请随时告诉我。接受许可协议：在安装向导中，阅读并接受许可协议。完成安装：点击“安装”按钮，等待安装完成。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值