【cmake学习】cmake 引入第三方库（头文件目录、库目录、库文件）

在Windows环境下，程序的编写需要用到头文件，程序的编译需要库文件 lib 文件，程序的运行需要 dll 文件，因此 cmake 引入第三方库其实就是将include目录、lib目录引入工程。引入第三方库的方式分为两种：

• 手动引入：通过 include_directories 或 link_directories 手动引入相关头文件和库文件路径
• 批量引入：先使用 find_package 找到 .cmake 或 .pc 文件，找到后相关的头文件和库文件路径会分别保存在指定变量中，如 XXX_LIBRARIES，此时再通过 include_directories 或 link_directories一键引入所有的库和头文件路径

---

目录

一、手动引入

1、include_directories（引入头文件目录）

2、link_directories（引入库目录）

3、link_libraries (引入库文件)

4、target_link_libraries（引入库文件到子工程）

5、target_include_directories（引入头文件目录到子工程）

二、批量引入

1、find_package（查找 .cmake ）

2、pkg_check_modules（查找 .pc ）

---

一、手动引入

手动引入需要自己获取到所有头文件路径以及库文件路径，然后再调用函数接口引入。

1、include_directories（引入头文件目录）

include_directories表示引入头文件搜索路径，当工程要用到某个头文件的时候，就会去该路径下搜索。一般都是在顶层的CmakeList文件中添加搜索路径。

include_directories(完整路径)

# 绝对路径引入
include_directories("D:\\ProgramFiles\\Qt\\qt5_7_lib_shared_64\\include")

# 普通变量引入(可以理解为把D:\\ProgramFiles\\Qt\\qt5_7_lib_shared_64放入一个集合INCLUDE_PATH)
# ${变量名} 可以获取集合内容，允许拼接
set (INCLUDE_PATH D:\\ProgramFiles\\Qt\\qt5_7_lib_shared_64)
include_directories(${INCLUDE_PATH}/include)       

# 环境变量引入
# 假设环境变量是INCLUDE_PATH = D:\\ProgramFiles\\Qt\\qt5_7_lib_shared_64
# #ENV{环境变量名} 可以获取环境变量的内容，允许拼接
include_directories($ENV{INCLUDE_PATH}/include)

一个cmake总工程可以包含多个子工程，总工程引入的头文件，并不代表子工程就可以用，就好比幼儿园老师（总工程）买来一箱苹果，小朋友（子工程）根据需求拿苹果。

2、link_directories（引入库目录）

link_libraries 表示添加第三方 lib 库文件的搜索路径。若工程在编译的时候会需要用到某个第三方库的 lib 文件，此时就可以使用 link_libraries 来添加搜索路径。

link_libraries(完整路径)

# 绝对引入
link_libraries("D:\ProgramFiles\Qt\qt5_7_lib_shared_64\lib")

# 预定义变量引入
# PROJECT_SOURCE_DIR 是cmake的预定义变量，表示顶层CmakeList文件所在路径
link_libraries(${PROJECT_SOURCE_DIR}/ExtLib/ffmpeg/win64/lib)

# 环境变量引入
# 环境变量 QT_LIB = D:\\ProgramFiles\\Qt\\qt5_7_lib_shared_64
link_libraries($ENV{QT_LIB}/lib)

3、link_libraries (引入库文件)

link_libraries 表示将具体的库文件引入到当前工程中，所填入的路径必须是全路径。

# 全路径引入
LINK_LIBRARIES("/opt/MATLAB/R2012a/bin/glnxa64/libeng.so")

4、target_link_libraries（引入库文件到子工程）

target_link_libraries 表示添加第三方 lib 库文件到目标子工程，上面 link_directories 是引入库目录到当前工程，link_libraries 是引入库文件到当前工程，具体是哪个工程并没有指明。就好比，货车把满载的货物运到幼儿园里，但是没分配。

target_link_libraries 起的作用就是分发工作，分发xx库给指定工程，注意xx库必须是当前工程中有的或者 搜索路径里有的。

target_link_libraries(子工程名 库文件1 库文件2 ...)     # 注意子工程名和库文件名之间以空格隔开

add_executable(qt_test ${ALL_SRCS})    # 子工程名是 qt_test 

# 绝对路径引入
target_link_libraries(qt_test 
    D:\\ProgramFiles\\Qt\\qt5_7_lib_shared_64\\lib\\Qt5Core.lib
    D:\\ProgramFiles\\Qt\\qt5_7_lib_shared_64\\lib\\Qt5Gui.lib
)

# 普通变量引入（被打包的lib文件，必须能在搜索路径下找到）
set (LIB_FFMPEG "avcodec.lib" "avdevice.lib" "avfilter.lib")
target_link_libraries(qt_test 
    ${LIB_FFMPEG}
)

# 预定义变量引入
# PROJECT_SOURCE_DIR 是cmake的预定义变量，表示顶层CmakeList文件所在路径
target_link_libraries(qt_test 
    ${PROJECT_SOURCE_DIR}/ExtLib/ffmpeg/win64/lib/avcodec.lib
)

5、target_include_directories（引入头文件目录到子工程）

target_include_directories 达到的效果和 target_link_libraries 是类似的，需要注意的是

• include_directories：将头文件目录引入到当前工程
• target_include_directories：将头文件目录针对性的引入到目标子工程（当前工程一般可以包含多个子工程）

二、批量引入

一键引入只需提供 .cmake 文件或 .pc 文件的完整搜索路径，若 cmake 生成器能找到对应的库，便会自动将所有的头文件路径和库文件路径分别装填到对应的变量。

• 头文件路径装填到变量 XXX_INCLUDE_DIRS
• 库文件路径装填到 XXX_LIBRARY_DIRS
• 库文件名装填到变量 XXX_LIBRARIES 或 XXX_LIBS （可能包含了全路径）

注意：这里的 XXX 表示库名，不同库的变量会略微有所不同

1、find_package（查找 .cmake ）

find_package 主要用于查找 .cmake 文件（详细使用可以参考：find_package 的详细使用 ）find_package 需要通过 .cmake 为后缀的文件引入，将 .cmake 包含的库和头文件全部引入工程。不同的库的达到的效果不同。有时需要搭配关键字使用：

• REQUIRED：必须找到该库，找不到就报错
• COMPONENTS：从库中找子库（模块）xx，比如COMPONENTS Widget表示找到子模块Widget

以OpenCV库为例，OpenCV库提供的是 OpenCVConfig.cmake文件，只需引入一次，便可以将OpenCV所有的库文件和头文件引入到当前工程。OpenCVConfig.cmake 也给出了详细的说明。

find_package(OpenCV REQUIRED)

# OpenCV_INCLUDE_DIRS 是预定义变量，代表OpenCV库的头文件路径
include_directories(${OpenCV_INCLUDE_DIRS}) 

# OpenCV_LIBS 是预定义变量，代表OpenCV库的lib库文件
target_link_libraries(MY_TARGET_NAME ${OpenCV_LIBS})

以QT库为例，QT库是一个大型库，内部还包含了许多子库，在引入的时候最好按需引入

# 含义：必须找到Qt5库的子模块Core，找不到就报错
find_package(Qt5 COMPONENTS Core REQUIRED)

# 链接时需要加上前缀Qt::(这里是Qt5的库)
target_link_libraries(qt_test
    Qt5::Core
)

注意：无论是上面的Widget，还是Core，都是去掉了前缀Qt5。实际上，Qt的子库名字都是有前缀 "Qt5" 的！只不过在引入的时候，要去掉。

2、pkg_check_modules（查找 .pc ）

pkg_check_modules 主要通过 .pc 文件引入整个库，该命令会解析指定的 .pc 文件，并将所需的编译和链接信息提取到 CMake 变量中，以便后续使用。

pkg_check_modules：pkg_check_modules 使用详解