《CMake实践》笔记三：构建静态库(.a) 与 动态库(.so) 及 如何使用外部共享库和头文件

《CMake实践》笔记一：PROJECT/MESSAGE/ADD_EXECUTABLE

《CMake实践》笔记二：INSTALL/CMAKE_INSTALL_PREFIX

《CMake实践》笔记三：构建静态库与动态库 及 如何使用外部共享库和头文件

 

5、静态库与动态库构建

读者云，太能罗唆了，一个Hello World就折腾了两个大节。OK，从本节开始，咱们再也不折腾Hello World了，咱们来折腾Hello World的共享库。

本节的任务：

１、创建一个静态库和动态库，提供HelloFunc函数供其余程序编程使用，HelloFunc向终端输出Hello World字符串。

２、安装头文件与共享库。

 

（一）、准备工做：

在/backup/cmake目录创建t3目录，用于存放本节涉及到的工程

 

（二）、创建共享库

cd /backup/cmake/t3
mkdir lib

在t3目录下创建CMakeLists.txt，内容以下：

PROJECT(HELLOLIB)
ADD_SUBDIRECTORY(lib)

在lib目录下创建两个源文件hello.c与hello.h

hello.c内容以下：

#include "hello.h"
void HelloFunc()
{
    printf("Hello World\n");
}

hello.h内容以下：

#ifndef HELLO_H
#define HELLO_H
#include <stdio.h>
void HelloFunc();
#endif

在lib目录下创建CMakeLists.txt，内容以下：

SET(LIBHELLO_SRC hello.c)
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

 

（三）、编译共享库

仍然采用 out-of-source 编译的方式，按照习惯，咱们创建一个build目录，在build目录中

cmake ..
make

这时，你就能够在lib目录获得一个libhello.so，这就是咱们指望的共享库。

若是你要指定libhello.so生成的位置，能够经过在主工程文件CMakeLists.txt中修改ADD_SUBDIRECTORY(lib)指令来指定一个编译输出位置或者在lib/CMakeLists.txt中添加SET(LIBRARY_OUTPUT_PATH <路径>)来指定一个新的位置。这二者的区别咱们上一节已经提到了，因此，这里再也不赘述，下面，咱们解释一下一个新的指令ADD_LIBRARY：

ADD_LIBRARY(libname [SHARED|STATIC|MODULE][EXCLUDE_FROM_ALL]source1 source2 ... sourceN)

你不须要写全libhello.so，只须要填写hello便可，cmake系统会自动为你生成libhello.X。类型有三种:

• SHARED，动态库(扩展名为.so)
• STATIC，静态库(扩展名为.a)
• MODULE，在使用dyld的系统有效，若是不支持dyld，则被看成SHARED对待。
• EXCLUDE_FROM_ALL 参数的意思是这个库不会被默认构建，除非有其余的组件依赖或者手工构建。

C/C++ 静态连接库(.a) 与 动态连接库(.so)库

Linux C 静态库(.a) 与 动态库(.so)的详解

 

（四）、添加静态库

一样使用上面的指令，咱们在支持动态库的基础上再为工程添加一个静态库，按照通常的习惯，静态库名字跟动态库名字应该是一致的，只不事后缀是.a罢了。下面咱们用这个指令再来添加静态库：

ADD_LIBRARY(hello STATIC ${LIBHELLO_SRC})

而后再在build目录进行外部编译，咱们会发现，静态库根本没有被构建，仍然只生成了一个动态库。由于hello做为一个target是不能重名的，因此，静态库构建指令无效。

若是咱们把上面的hello修改成hello_static：

ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

就能够构建一个libhello_static.a的静态库了。这种结果显示不是咱们想要的，咱们须要的是名字相同的静态库和动态库，由于target名称是惟一的，因此，咱们确定不能经过ADD_LIBRARY指令来实现了。这时候咱们须要用到另一个指令：

SET_TARGET_PROPERTIES，其基本语法是：
SET_TARGET_PROPERTIES(target1 target2 ...PROPERTIES prop1 value1prop2 value2 ...)

这条指令能够用来设置输出的名称，对于动态库，还能够用来指定动态库版本和API版本。在本例中，咱们须要做的是向lib/CMakeLists.txt中添加一条：

SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")

这样，咱们就能够同时获得libhello.so/libhello.a两个库了。与他对应的指令是：

GET_TARGET_PROPERTY(VAR target property)

具体用法以下例，咱们向lib/CMakeListst.txt中添加：

GET_TARGET_PROPERTY(OUTPUT_VALUE hello_static OUTPUT_NAME)
MESSAGE(STATUS  "This is the hello_static OUTPUT_NAME:" ${OUTPUT_VALUE})

若是没有这个属性定义，则返回 NOTFOUND。

让咱们来检查一下最终的构建结果，咱们发现，libhello.a已经构建完成，位于build/lib目录中，可是libhello.so去消失了。这个问题的缘由是：cmake在构建一个新的target时，会尝试清理掉其余使用这个名字的库，由于，在构建libhello.a时，就会清理掉libhello.so.为了回避这个问题，好比再次使用SET_TARGET_PROPERTIES定义

CLEAN_DIRECT_OUTPUT属性。向lib/CMakeLists.txt中添加:

SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)

这时候，咱们再次进行构建，会发现build/lib目录中同时生成了 libhello.so 和 libhello.a

 

（五）、动态库版本号

按照规则，动态库是应该包含一个版本号的，咱们能够看一下系统的动态库，通常状况是

libhello.so.1.2
libhello.so ->libhello.so.1
libhello.so.1->libhello.so.1.2

为了实现动态库版本号，咱们仍然须要使用SET_TARGET_PROPERTIES指令。具体使用方法以下：

SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)

VERSION指代动态库版本，SOVERSION指代API版本。将上述指令加入lib/CMakeLists.txt中，从新构建看看结果。

在build/lib目录会生成：

libhello.so.1.2
libhello.so.1->libhello.so.1.2
libhello.so ->libhello.so.1

 

（六）、安装共享库和头文件

以上面的例子，咱们须要将libhello.a, libhello.so.x以及hello.h安装到系统目录，才能真正让其余人开发使用，在本例中咱们将hello的共享库安装到<prefix>/lib目录，将hello.h安装到<prefix>/include/hello目录。

利用上一节了解到的INSTALL指令，咱们向lib/CMakeLists.txt中添加以下指令：

INSTALL(TARGETS hello hello_static
LIBRARY DESTINATION lib
ARCHIVE DESTINATION lib)
INSTALL(FILES hello.h DESTINATION include/hello)

注意，静态库要使用ARCHIVE关键字经过:

cmake -DCMAKE_INSTALL_PREFIX=/usr ..
make
make install

咱们就能够将头文件和共享库安装到系统目录/usr/lib和/usr/include/hello中了。

 

（七）、小结

本小节，咱们谈到了：

如何经过 ADD_LIBRARY 指令构建动态库和静态库。

如何经过 SET_TARGET_PROPERTIES 同时构建同名的动态库和静态库。

如何经过 SET_TARGET_PROPERTIES 控制动态库版本

最终使用上一节谈到的 INSTALL 指令来安装头文件和动态、静态库。

在下一节，咱们须要编写另外一个高级一点的Hello World来演示怎么使用咱们已经构建的构建的共享库libhello和外部头文件。

 

---

 

如下是我跟着作的截图，确实很方便：(这里有点失误，设置了个CC的环境变量，因此这里找的是arm-linux-gcc去了。。本意是用gcc编译的)

 

---

 

6、如何使用外部共享库和头文件

抱歉，本节仍然继续折腾Hello World。

上一节咱们已经完成了libhello动态库的构建以及安装，本节咱们的任务很简单：

编写一个程序使用咱们上一节构建的共享库。

一、准备工做:

请在/backup/cmake目录创建t4目录，本节全部资源将存储在t4目录。

 

二、重复之前的步骤，创建src目录，编写源文件main.c，内容以下：

#include <hello.h>
int main()
{
    HelloFunc();
    return 0;
}

编写工程主文件CMakeLists.txt

PROJECT(NEWHELLO)
ADD_SUBDIRECTORY(src)

编写src/CMakeLists.txt

ADD_EXECUTABLE(main main.c)

上述工做已经严格按照咱们前面季节提到的内容完成了。

 

３、外部构建

按照习惯，仍然创建build目录，使用cmake ..方式构建。

过程：

cmake ..
make

构建失败，若是须要查看细节，可使用第一节提到的方法

make VERBOSE=1

来构建

错误输出为是：

/backup/cmake/t4/src/main.c:1:19: error: hello.h: 没有那个文件或目录

 

４、引入头文件搜索路径

hello.h位于/usr/include/hello目录中，并无位于系统标准的头文件路径，(有人会说了，白痴啊，你就不会include <hello/hello.h>，同志，要这么干，我这一节就没什么可写了，只能选择一个glib或者libX11来写了，这些代码写出来不少同志是看不懂的)

为了让咱们的工程可以找到hello.h头文件，咱们须要引入一个新的指令

INCLUDE_DIRECTORIES，其完整语法为：

INCLUDE_DIRECTORIES([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)

这条指令能够用来向工程添加多个特定的头文件搜索路径，路径之间用空格分割，若是路径中包含了空格，可使用双引号将它括起来，默认的行为是追加到当前的头文件搜索路径的后面，你能够经过两种方式来进行控制搜索路径添加的方式：

(１)、CMAKE_INCLUDE_DIRECTORIES_BEFORE，经过SET这个cmake变量为on，能够将添加的头文件搜索路径放在已有路径的前面。

(２)、经过AFTER或者BEFORE参数，也能够控制是追加仍是置前。如今咱们在src/CMakeLists.txt中添加一个头文件搜索路径，方式很简单，加入：INCLUDE_DIRECTORIES(/usr/include/hello)

进入build目录，从新进行构建，这是找不到hello.h的错误已经消失，可是出现了一个新的错误：

main.c:(.text+0x12): undefined reference to `HelloFunc'

由于咱们并无link到共享库libhello上。

 

五、为target添加共享库

咱们如今须要完成的任务是将目标文件连接到libhello，这里咱们须要引入两个新的指令

LINK_DIRECTORIES和TARGET_LINK_LIBRARIES
LINK_DIRECTORIES的所有语法是：
LINK_DIRECTORIES(directory1 directory2 ...)

这个指令很是简单，添加非标准的共享库搜索路径，好比，在工程内部同时存在共享库和可执行二进制，在编译时就须要指定一下这些共享库的路径。这个例子中咱们没有用到这个指令。

TARGET_LINK_LIBRARIES的所有语法是:
TARGET_LINK_LIBRARIES(target library1<debug | optimized> library2...)

这个指令能够用来为target添加须要连接的共享库，本例中是一个可执行文件，可是一样能够用于为本身编写的共享库添加共享库连接。为了解决咱们前面遇到的HelloFunc未定义错误，咱们须要做的是向src/CMakeLists.txt中添加以下指令：

TARGET_LINK_LIBRARIES(main hello)

也能够写成

TARGET_LINK_LIBRARIES(main libhello.so)

这里的hello指的是咱们上一节构建的共享库libhello.

进入build目录从新进行构建。

cmake ..
make

这是咱们就获得了一个链接到libhello的可执行程序main，位于build/src目录，运行main的结果是输出：

Hello World

让咱们来检查一下main的连接状况：

ldd src/main
linux-gate.so.1 => (0xb7ee7000)
libhello.so.1 => /usr/lib/libhello.so.1 (0xb7ece000)
libc.so.6 => /lib/libc.so.6 (0xb7d77000)
/lib/ld-linux.so.2 (0xb7ee8000)

能够清楚的看到main确实连接了共享库libhello，并且连接的是动态库libhello.so.1

那如何连接到静态库呢？

方法很简单：

将TARGET_LINK_LIBRRARIES指令修改成:

TARGET_LINK_LIBRARIES(main libhello.a)

从新构建后再来看一下main的连接状况

ldd src/main
linux-gate.so.1 => (0xb7fa8000)
libc.so.6 => /lib/libc.so.6 (0xb7e3a000)
/lib/ld-linux.so.2 (0xb7fa9000)

说明，main确实连接到了静态库libhello.a

 

六、特殊的环境变量 CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH

务必注意，这两个是环境变量而不是cmake变量。使用方法是要在bash中用export或者在csh中使用set命令设置或者CMAKE_INCLUDE_PATH=/home/include cmake ..等方式。

这两个变量主要是用来解决之前autotools工程中--extra-include-dir等参数的支持的。也就是，若是头文件没有存放在常规路径(/usr/include, /usr/local/include等)，则能够经过这些变量就行弥补。咱们以本例中的hello.h为例，它存放在/usr/include/hello目录，因此直接查找确定是找不到的。前面咱们直接使用了绝对路径INCLUDE_DIRECTORIES(/usr/include/hello)告诉工程这个头文件目录。为了将程序更智能一点，咱们可使用CMAKE_INCLUDE_PATH来进行，使用bash的方法以下：

export CMAKE_INCLUDE_PATH=/usr/include/hello而后在头文件中将INCLUDE_DIRECTORIES(/usr/include/hello)替换为：

FIND_PATH(myHeader hello.h)
IF(myHeader)
INCLUDE_DIRECTORIES(${myHeader})
ENDIF(myHeader)

上述的一些指令咱们在后面会介绍。这里简单说明一下，FIND_PATH用来在指定路径中搜索文件名，好比：

FIND_PATH(myHeader NAMES hello.h PATHS /usr/include/usr/include/hello)

这里咱们没有指定路径，可是，cmake仍然能够帮咱们找到hello.h存放的路径，就是由于咱们设置了环境变量CMAKE_INCLUDE_PATH。若是你不使用FIND_PATH，CMAKE_INCLUDE_PATH变量的设置是没有做用的，你不能期望它会直接为编译器命令添加参数-I<CMAKE_INCLUDE_PATH>。以此为例，CMAKE_LIBRARY_PATH能够用在FIND_LIBRARY中。一样，由于这些变量直接为FIND_指令所使用，因此全部使用FIND_指令的cmake模块都会受益。

 

七、小节

本节咱们探讨了:

如何经过INCLUDE_DIRECTORIES指令加入非标准的头文件搜索路径。

如何经过LINK_DIRECTORIES指令加入非标准的库文件搜索路径。

若是经过TARGET_LINK_LIBRARIES为库或可执行二进制加入库连接。

并解释了若是连接到静态库。

到这里为止，您应该基本可使用cmake工做了，可是还有不少高级的话题没有探讨，好比编译条件检查、编译器定义、平台判断、如何跟pkgconfig配合使用等等。

到这里，或许你能够理解前面讲到的“cmake的使用过程其实就是学习cmake语言并编写cmake程序的过程”，既然是“cmake语言”，天然涉及到变量、语法等。

下一节，咱们将抛开程序的话题，看看经常使用的CMAKE变量以及一些基本的控制语法规则。

未完，待续。。。。

 

---

 

这里关于LINK_DIRECTORIES彷佛有个bug。基本上按照上述所写方法，只是我没有将测试用的hello.h和libhello.so安装在系统的usr/lib目录下。因而我就须要用到这个LINK_DIRECTORIES指定个人库文件的目录。main.c的CMakeLists.txt以下：

ADD_EXECUTABLE(main main.c)
FIND_PATH(myHeader hello.h)
IF(myHeader)
INCLUDE_DIRECTORIES(${myHeader})
ENDIF(myHeader)
TARGET_LINK_LIBRARIES(main libhello.so)
LINK_DIRECTORIES(/home/wideking/cmakeDemo/libhello/bulid)

在编译的时候它就是找不到个人libhello.so文件。goole了一下，有人试过将ADD_EXECUTABLE和LINK_DIRECTORIES互换了下位置就好了。我也试了试，提示错误，必须先有main，才能有库的连接，确实也应该这样。因而再在后面增长一行ADD_EXECUTABLE就变成了这样：

ADD_EXECUTABLE(main main.c)
FIND_PATH(myHeader hello.h)
IF(myHeader)
INCLUDE_DIRECTORIES(${myHeader})
ENDIF(myHeader)
TARGET_LINK_LIBRARIES(main libhello.so)
LINK_DIRECTORIES(/home/wideking/cmakeDemo/libhello/bulid)
ADD_EXECUTABLE(main main.c)

虽然有构建的时候有warning，可是这样才能正常的使用。我是在cmake2.6版本中测试的。不知道这个是我没理解对仍是咋的。。。。

那个warning就是不得很少添加了一次ADD_EXECUTABLE出来的

 

---

 

cmake中lib库的路径设置

好比目录结构以下

project/utils

project/bin/lib

project/login/remote/control/src

project/login/remote/control/build

构造control工程

LINK_DIRECTORIES(../../../bin/lib)

这里的相对路径并非相对于源码路径(CMakeLists.txt路径)，而是相对于执行命令的路径（build目录），向上三层目录结构。

 

src目录下是源代码，在build目录下执行make，那么这个相对路径就是相对于build目录。

 

而头文件的路径则是相对于源码的路径(CMakeLists.txt路径)

INCLUDE_DIRECTORIES（../../utils）向上2层目录

 指定头文件搜索路径
    INCLUDE_DIRECTORIES( "../../xxxx" )   // 注意：括号里的相对路径是相对CMakeLists.txt的。

指定库的链接路径
   LINK_DIRECTORIES(" ../../xxxx ")    // 括号里的相对路径是相对执行make动做的目录为基准的。

 

 

《CMake实践》笔记一：PROJECT/MESSAGE/ADD_EXECUTABLE

《CMake实践》笔记二：INSTALL/CMAKE_INSTALL_PREFIX

《CMake实践》笔记三：构建静态库与动态库 及 如何使用外部共享库和头文件