cmake引用静态或动态库(四)

前言

上一篇文章讲解了如何构建静态库或者动态库，本文目标为：
1、引入外部静态库
2、引入外部动态库

准备工作

创建sample7,在里面创建3rdlilb，将上一篇文章构建的Math.h头文件、以及将lib文件夹下内容全部拷贝进来，创建src源码目录，将sample2的main.cpp拷贝进来，最终目录如下：

./sample7
    |
    +--- CMakeLists.txt
    |
    +--- build/
    +--- src/
            +--- CMakeLists.txt
            +--- main.cpp
    +--- lib/
          +--- libMath.a
          +--- libmath.1.2.dylib
          +--- libmath.1.dylib
          +--- libmath.dylib
          +--- Math.h

这里要再main.cpp中应用外部math库，其内容为：

#include 
#include 
#include "Math.h"

int main(int argc, char *argv[])
{
    if (argc < 3){
        printf("Usage: %s base exponent \n", argv[0]);
        return 1;
    }
    double base = atof(argv[1]);
    int exponent = atoi(argv[2]);
    double result = power(base, exponent);
    printf("%g ^ %d is %g\n", base, exponent, result);
    return 0;
}

工程根目录下CMakeLists.txt内容为：

# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)

if(POLICY CMP0042)
  cmake_policy(SET CMP0042 NEW)  # CMake 3.0+ (2.8.12): MacOS "@rpath" in target's install name
endif()

# 项目工程名
project (sample7)
message(STATUS "root This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "root This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 添加子目录
ADD_SUBDIRECTORY(src)

1、引入外部静态库

src目录下的CMakeLists.txt文件内容为：

# 打印信息
message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 定义工程根目录; CMAKE_SOURCE_DIR为内建变量，表示工程根目录的CMakeLists.txt文件路径
SET(ROOT_DIR ${CMAKE_SOURCE_DIR})

# 指定头文件搜索路径
INCLUDE_DIRECTORIES(${ROOT_DIR}/3rdlib)

# 指定引用的外部库的搜索路径
LINK_DIRECTORIES(${ROOT_DIR}/3rdlib)

# 指定可执行文件存放目录
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)

# 构建可执行程序
ADD_EXECUTABLE(sample7 main.cpp)
TARGET_LINK_LIBRARIES(sample7 libmath.a)

• INCLUDE_DIRECTORIES(${ROOT_DIR}/3rdlib)
  用于指定头文件的搜索路径，因为Math.h与main.cpp不在同一目录，所以如果不配置这个搜索路径，肯定会报错
• LINK_DIRECTORIES(${ROOT_DIR}/3rdlib)
  指定静态库或者动态库的搜索路径
• TARGET_LINK_LIBRARIES(sample7 libmath.a)
  指定要连接的静态库，必须要有，第二个参数也可以换成math，那么将自动去搜索libmath.a或者libmath.so或者libmath.dyld动态库

还有另外一种写法，如下：

# 打印信息
message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 定义工程根目录; CMAKE_SOURCE_DIR为内建变量，表示工程根目录的CMakeLists.txt文件路径
SET(ROOT_DIR ${CMAKE_SOURCE_DIR})

# 指定头文件搜索路径
INCLUDE_DIRECTORIES(${ROOT_DIR}/3rdlib)

# 以导入外部库的方式(不会重新编译)重新构建一个静态库libMath
add_library(libMath STATIC IMPORTED)
# 设置要导入的外部静态库的路径
set_target_properties(libMath PROPERTIES IMPORTED_LOCATION ${ROOT_DIR}/3rdlib/libmath.a)

# 指定可执行文件存放目录
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)

# 构建可执行程序
ADD_EXECUTABLE(sample7 main.cpp)
# 注意这里连接的库名为新构建的库名libMath而外部库libmath
TARGET_LINK_LIBRARIES(sample7 libMath)

这里解释下，这里是先根据外部静态库重新构建一个libMath静态库，然后可执行程序连接到该库

• add_library(libMath STATIC IMPORTED)
  以导入外部库的方式重新构建一个静态库libMath,不会重新编译
• set_target_properties(libMath PROPERTIES IMPORTED_LOCATION ${ROOT_DIR}/3rdlib/libmath.a)

设置要导入的外部静态库的路径

tips:
建议用方式一导入外部库

2、引入外部动态库

修改src下CMakeLists.txt文件内容：

# 打印信息
message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 定义工程根目录; CMAKE_SOURCE_DIR为内建变量，表示工程根目录的CMakeLists.txt文件路径
SET(ROOT_DIR ${CMAKE_SOURCE_DIR})

# 指定头文件搜索路径
INCLUDE_DIRECTORIES(${ROOT_DIR}/3rdlib)

# 指定引用的外部库的搜索路径
LINK_DIRECTORIES(${ROOT_DIR}/3rdlib)

# 指定可执行文件存放目录
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)

# 构建可执行程序
ADD_EXECUTABLE(sample7 main.cpp)
TARGET_LINK_LIBRARIES(sample7 libmath.dylib)

tips:
因为sample7 在构建的时候引入了动态库，所以当./sample7 在执行的时候将去指定的目录加载这个动态库(这个路径非编译时指定的动态库路径，发现会报错"dyld: Library not loaded: @rpath/libmath.1.dylib") ，如果将他们拷贝到/usr/local/lib/目录下，发现就不报错了。对于mac 系统，它默认按照如下顺序搜索动态库:

1.编译目标代码时指定的动态库搜索路径(通过 -Wl,-rpath参数指定的)
2.环境变量LD_LIBRARY_PATH指定的动态库搜索路径；
3.配置文件/etc/ld.so.conf中指定的动态库搜索路径；
4.默认的动态库搜索路径/usr/lib
5.默认的动态库搜索路径/usr/local/lib

其它系统可能有些区别，但大体都差不多

引入静态库和动态库的区别

1、引入静态库时，静态库在连接阶段会被连接到最终目标中(比如可执行执行程序中)，缺点就是同一份静态库如果被不同的程序引用，那么内存中会存在这个静态库函数的多份拷贝
2、引入动态库时，连接阶段不会被拷贝最终目标中，程序运行时将按照指定的规则(上一步提到的规则，并非编译时的动态库路径)去搜索这个动态库，搜索到了之后才加载到内存中。所以多个程序就算引用了同一个动态库，内存中也只是存在一份动态库函数的拷贝

CMake 环境变量关键字

1、CMAKE_INCLUDE_PATH
2、CMAKE_LIBRARY_PATH
这两个变量在cmake语法中显示调用并没有效果，它的作用给CMake的FIND__XXX()系列函数提供查找路径，比如如下代码

# 在环境变量CMAKE_LIBRARY_PATH指定的目录中查找libmath.dylib
# 的路径，并赋值给mypath变量
message(STATUS "ddd This is SOURCE dir " ${CMAKE_INCLUDE_PATH})
FIND_PATH(myHeader hello.h)
FIND_LIBRARY(mypath libmath.dylib)
message(STATUS "ee This is SOURCE dir " ${myHeader})
message(STATUS "ttt This is SOURCE dir " ${mypath})

将libmath.dyld,Math.h分别拷贝到/usr/local/lib，/usr/local/include目录中，执行

export PATH=$PATH:/usr/local/lib:/usr/local/include
cmake ..

发现${myHeader}和${mypath}都是有值的