CMake 实践与踩坑记录（三）

Hello World的共享库。

**本篇主要参考文档的第五章（21～25页） **

是时候展现真正的技术了！重点来了：

1. 建立一个静态库和动态库，提供HelloFunc函数供其他程序编程使用，HelloFunc向终端输出Hello World字符串。
2. 安装头文件与共享库。

（一）、准备工作：

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

（二）、建立共享库

cd 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})

**都是最简单的C语言和基本的cmake语法，相信大家一眼就能看懂！ **

（三）、编译共享库

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

cmake ..
make

***经过前面两节的学习，再看这些再做这些，相信都不在话下了吧！（逃 ***

在t3目录下面tree一下，这时，你就可以发现在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)

我们写的是ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})，你不需要写全libhello.so，只需要填写hello即可，cmake系统会自动为你生成libhello.X。类型有以下几种:

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

（四）、添加静态库

同样使用上面的指令，我们在支持动态库的基础上再为工程添加一个静态库，按照一般的习惯，静态库名字跟动态库名字应该是一致的，只不过后缀是.a罢了。下面我们用这个指令再来添加静态库：(在lib目录下的CMakeLists.txt添加

ADD_LIBRARY(hello STATIC ${LIBHELLO_SRC})

正如上文所说，STATIC就是创建静态库的意思了(扩展名为.a)。

接着我们再在build目录进行外部编译(cmake ..)，我们会发现，静态库根本没有被构建，仍然只生成了一个动态库。因为hello作为一个target是不能重名的，所以，静态库构建指令无效。

***这里就奇怪了，明明有了啊！libhello.a就在libhello.so上面，难道是cmake版本的原因？。先不管，按照教程走吧！***
如果我们把上面的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

emmmm，还是之前的结果。

（五）、动态库版本号

按照规则，动态库是应该包含一个版本号的，我们可以看一下系统的动态库，一般情况是

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中了。

（七）、错误排查

试了好多方案，发现是自己的理解能力太差，回头重新写了CMakeLists.txt的内容如下：

SET(LIBHELLO_SRC hello.c)

ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")

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

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

SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)

然后删去build的所有文件，重新cmake ..之后make，可以得到预期的效果：

现在再来做第六节中的事情：向lib/CMakeLists.txt中添加如下指令：

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

将build清理后再重新编译，可以看见依然出现了之前的错误：

google了一下解决办法：安装共享库，有时需要root密码。此时用 sudo make install
所以编译指令应为：

cmake -DCMAKE_INSTALL_PREFIX=/usr ..
make
sudo make install

可以看出现在已经成功了！

在对应的文件夹中可以找到我们自己所要保存的库文件：

（八）、小结

本小节，我们谈到了：
如何通过 ADD_LIBRARY 指令构建动态库和静态库。
如何通过 SET_TARGET_PROPERTIES 同时构建同名的动态库和静态库。
如何通过 SET_TARGET_PROPERTIES 控制动态库版本
最终使用上一节谈到的 INSTALL 指令来安装头文件和动态、静态库。
在下一节，我们需要编写另一个高级一点的Hello World来演示怎么使用我们已经构建的构建的共享库libhello和外部头文件。 在下一节，我们需要编写另一个高级一点的Hello World来演示怎么使用我们已经构建的构建的共享库libhello和外部头文件。

对于自己来说，这一篇主要是进行了库的构建和相应的错误排查，learning by doing，这句话真的是一点不假！