CMake中引用Boost库

CMake中引用Boost库

概述

在Linux开发时常常使用Boost库，若项目使用CMake进行组织管理和编译，需要掌握在CMake中实现Boost库的引用的基本语法。本片博客结合自己在实际使用过程中的经验进行总结，以期回顾和进行阶段总结。

CMakeLists.txt编写

find_package

通过调用find_package可以找到头文件和所需要的库文件或者是一个CMake打包配置文件。

find_package(Boost
  [version] [EXACT]      # 可选项，最小版本或者确切所需版本
  [REQUIRED]             # 可选项，如果找不到所需库，报错
  [COMPONENTS <libs>...] # 所需的库名称，比如说. "date_time" 代表 "libboost_date_time"
  )     

示例

find_package(Boost 1.62.0 REQUIRED
             COMPONENTS system filesystem thread)

运行完后可以得到很多变量，下面列了一些主要的。

Boost_FOUND            - 如果找到了所需的库就设为true
Boost_INCLUDE_DIRS     - Boost头文件搜索路径
Boost_LIBRARY_DIRS     - Boost库的链接路径
Boost_LIBRARIES        - Boost库名，用于链接到目标程序
Boost_VERSION          - 从boost/version.hpp文件获取的版本号
Boost_LIB_VERSION      - 某个库的版本

搜索路径设置

若Boost库是自定义安装路径，可以在搜索package之前，通过设置一些变量来帮助boost库的查找。

BOOST_ROOT             - 首选的Boost安装路径
BOOST_INCLUDEDIR       - 首选的头文件搜索路径 e.g. <prefix>/include
BOOST_LIBRARYDIR       - 首选的库文件搜索路径 e.g. <prefix>/lib
Boost_NO_SYSTEM_PATHS  - 默认是OFF. 如果开启了，则不会搜索用户指定路径之外的路径

用例

假如目标程序foo需要链接Boost库regex和system，编写如下的CMakeLists文件

# CMakeLists.txt
project(tutorial-0)
cmake_minimum_required(VERSION 3.7)
set(CMAKE_CXX_STANDARD 14)

set(BOOST_ROOT /usr/local/install/boost_1_62_0) // 设置boost库搜索路径
set(Boost_NO_SYSTEM_PATHS ON) // 只搜索上语句设置的搜索路径

find_package(Boost COMPONENTS regex system REQUIRED)

if(Boost_FOUND)
    include_directories(${Boost_INCLUDE_DIRS})
    
    MESSAGE( STATUS "Boost_INCLUDE_DIRS = ${Boost_INCLUDE_DIRS}.")
    MESSAGE( STATUS "Boost_LIBRARIES = ${Boost_LIBRARIES}.")
    MESSAGE( STATUS "Boost_LIB_VERSION = ${Boost_LIB_VERSION}.")

    add_executable(foo foo.cpp)
    target_link_libraries (foo ${Boost_LIBRARIES})
endif()

• 通过设置BOOST_ROOT来设置首选的搜索路径
• 通过MESSAGE函数把查找的结果都打印了出来

-- Boost_INCLUDE_DIRS = /usr/local/install/boost_1_62_0/include.
-- Boost_LIBRARIES = /usr/local/install/boost_1_62_0/lib/libboost_regex.so;/usr/local/install/boost_1_62_0/lib/libboost_system.so.
-- Boost_LIB_VERSION = 1_62.

Boost动态库链接

若项目包含多个子模块，且子模块只用到顶层模块find_package找到的部分库，则可以使用下述语句实现只链接子模块所需要的Boost动态库

 target_link_libraries(foo Boost::regex) // 只使用regex

Boost头文件库链接

在Boost库中有部分库只用头文件实现，并没有相应的动态库，若使用这部分库可以通过以下语句实现：

target_link_libraries(foo Boost::boost)
or
target_include_directories(${Boost_INCLUDE_DIRS})