cmake构建静态或动态库(三)

2019-10-03 本文已影响0人仙人掌__

前言

前文的的最终目标都是构建一个可执行文件，本文目标是如何构建静态库或者动态库
目标如下：
1、创建一个静态库libmath.a，提供一个函数接口double power(double base, int exponent);供外部调用
2、创建一个动态库libmath.so，提供一个函数接口double power(double base, int exponent);供外部调用
3、同时构建一个静态库libmath.a和一个动态库libmath.so，提供一个函数接口double power(double base, int exponent);供外部调用
4、构建动态库时添加版本号，提供一个函数接口double power(double base, int exponent);供外部调用

代码准备

创建sample6目录，然后创建src文件夹，将sample2中Math.h Math.cpp拷贝到src中，创建构建目录 build，最终目录如下：

./sample6
    |
    +--- CMakeLists.txt
    |
    +--- src/
          +--- CMakeLists.txt
          |
          +--- Math.h
          |
          +--- Math.cpp

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

# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目工程名
project (sample6)
message(STATUS "root This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "root This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 添加子目录
ADD_SUBDIRECTORY(src)

构建静态库

这里构建libmath.a静态库，那么src目录下CMakeLists.txt文件内容为：

message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 定义源文件列表
AUX_SOURCE_DIRECTORY(. SRC_LIST)

# 指定最终生成的可执行文件的路径
SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

# 指定生成目标 目标名字随便写；${SRC_LIST}代表前面定义的源文件列表变量
ADD_LIBRARY(math ${SRC_LIST})

上一篇文章用EXECUTABLE_OUTPUT_PATH指定最终可执行程序的生成路径，这里用LIBRARY_OUTPUT_PATH指定最终静态库或者动态库的生成路径，所以这里最终的libmath.a静态库将在build/lib目录下生成

ADD_EXECUTABLE()用来构建可执行程序，这里用ADD_LIBRARY()来构建静态库或者动态库

ADD_LIBRARY(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL]

libname代表要生成的静态库或者动态库的名字，名字前不用带lib 系统会自动加上。比如要生成libmath库名，写math就好
[SHARED|STATIC|MODULE] 分别表示构建动态库(一般.so结尾,mac os 系统为.dyld)、(.a)静态库、动态库(mac os 系统为.so,如果不支持则当做SHARED看待)；默认参数为STATIC
EXCLUDE_FROM_ALL 意思是这个库不会被默认构建，除非有其他的组件依赖或者手工构建

接下在build目录下执行 cmake .. ;make 成功后将在build/lib目录下生成libmath.a静态库

构建动态库

这里构建libmath.so动态库，只需要将上一步骤中ADD_LIBRARY(math ${SRC_LIST})改成ADD_LIBRARY(math SHARED ${SRC_LIST})即可，那么src目录下CMakeLists.txt文件内容为：

message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 定义源文件列表
AUX_SOURCE_DIRECTORY(. SRC_LIST)

# 指定最终生成的可执行文件的路径
SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

# 指定生成目标 目标名字随便写；${SRC_LIST}代表前面定义的源文件列表变量
ADD_LIBRARY(math MODULE ${SRC_LIST})

tips:
我这里的环境是mac os x,如果用SHARED则生成的是.dyld动态库，换成MODULE才生成的是.so动态库；其它linux/unix系统可以试试

同时构建静态库和动态库

上面两个步骤是分别构建静态库和动态库，如何同时构建libmath.a静态库和libmath.so动态库呢？如果再src的CMakeLists.txt文件的最后添加构建ADD_LIBRARY(math MODULE ${SRC_LIST})和ADD_LIBRARY(math STATIC ${SRC_LIST}) 会怎样？试着执行发现会提示错误：
"ADD_LIBRARY cannot create target "math" because another target with thesame name already exists."

也就是ADD_LIBRARY()或者ADD_EXECUTABLE()指令同一构建目标同时只能出现一次

那如果改成ADD_LIBRARY(math MODULE ${SRC_LIST})和ADD_LIBRARY(static_math STATIC ${SRC_LIST}) 会怎样？试着执行发现最终构建成功，再build/lib目录下同时生成了libstatic_math.a和libmath.so两个文件

如果要同时生成libmath.a和libmath.so两个库，方法为：
使用指令实现 SET_TARGET_PROPERTIES(target1 target2 ... PROPERTIES prop1 value1 prop2 value2 ...)

1、它可以指定构建静态库目标的最终库名
2、它可以指定构建动态库目标的版本号

首先实现指定构建静态库目标的最终库名，所以要实现同时生成libmath.a和libmath.so两个库那最终的CMakeLists.txt文件内容为：

message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 定义源文件列表
AUX_SOURCE_DIRECTORY(. SRC_LIST)

# 指定最终生成的可执行文件的路径
SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

# 指定生成目标 目标名字随便写；${SRC_LIST}代表前面定义的源文件列表变量
ADD_LIBRARY(math MODULE ${SRC_LIST})
# 指定静态库名 
ADD_LIBRARY(math_static STATIC ${SRC_LIST})
# 改变最终生成的静态库的名字
SET_TARGET_PROPERTIES(math_static PROPERTIES OUTPUT_NAME math)
# 获取指定构建目标的指定属性的值；这里获取math_static的属性OUTPUT_NAME值赋值给OUTPUT_VALUE变量
GET_TARGET_PROPERTY(OUTPUT_VALUE math_static OUTPUT_NAME)
MESSAGE(STATUS "This is the math_static OUTPUT_NAME:" ${OUTPUT_VALUE})

SET_TARGET_PROPERTIES(math_static PROPERTIES OUTPUT_NAME math)，会将默认的库名math_static改成math

重新再build目录下执行 cmake ..;make，最终在buil/lib目录下生成libmath.a和libmath.so两个库

GET_TARGET_PROPERTY(VAR target property) 与前面的指令对应

获取指定目标target的属性property值并赋值给VAR变量

构建动态库时添加版本号

为了实现动态库版本号，我们仍然需要使用SET_TARGET_PROPERTIES 指令，具体方法为：
SET_TARGET_PROPERTIES(math PROPERTIES VERSION 1.2 SOVERSION 1)

VERSION 指代动态库版本，SOVERSION 指代API版本。

最终CMakeLists.txt文件内容如下：

message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 定义源文件列表
AUX_SOURCE_DIRECTORY(. SRC_LIST)

# 指定最终生成的可执行文件的路径
SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

# 指定生成目标 目标名字随便写；${SRC_LIST}代表前面定义的源文件列表变量
ADD_LIBRARY(math SHARED ${SRC_LIST})

# 给动态库添加版本号
SET_TARGET_PROPERTIES(math PROPERTIES VERSION 1.2 SOVERSION 1)

重新构建，最终在build/lib中生成三个文件动态文件
libmath.1.2.dylib、libmath.1.dylib、libmath.dylib

可能有人会注意了，这里ADD_LIBRARY()指令怎么会变成 SHARED，由于我这里使用的是MAC OS 系统，如果换成MODULE 会失败,提示
"clang: error: invalid argument '-compatibility_version 1.0.0' only allowed with '-dynamiclib'"

至此，目标全部实现