cmake：add_library生成静态库和动态库

素颜马尾好姑娘i 2022-12-30 13:52 379阅读 0赞

>  *  此文为：[轻松入门cmake系列教程][cmake]
>  *  下一篇：我们将说明如何链接库

有时我们只需要编译出动态库，静态库，然后等着让其它程序去使用。让我们看下这种情况该如何使用cmake

# add\_library #

## 普通库 ##

add_library(<name> [STATIC | SHARED | MODULE]
                [EXCLUDE_FROM_ALL]
                [source1] [source2] [...])

*  `<name>`
    
     *  表示库文件的名字，该库文件会根据命令里列出的源文件来创建。
     *  < name>对应于逻辑目标名称，并且在项目中必须是全局唯一的。
     *  构建的库的实际文件名是基于本机平台的约定（如lib< name>.a或< name>.lib）构建的。
 *  `[STATIC | SHARED | MODULE]` 指定要创建的库的类型
    
     *  SHARED：
        
         *  动态库。动态库是动态链接并在运行时加载的
         *  如果库不导出任何符号，则不能将其声明为SHARED库
     *  STATIC：静态库。静态库是在链接其他目标时使用的目标文件存档
     *  MODULE：
        
         *  模块库是没有链接到其他目标的插件，但可以在运行时使用类似dlopen的功能动态加载
         *  在使用 dyld 的系统有效,如果不支持 dyld,则被当作 SHARED 对待。
 *  `EXCLUDE_FROM_ALL`：这个库不会被默认构建，除非有其他的组件依赖或者手工构建。
 *  `[source1] [source2] [...]`：指定生成库的源文件

## 对象库 ##

add_library(<name> OBJECT [<source>...])

创建一个对象库。对象库编译源文件，但不归档或者将它们的目标文件链接到库中。相反，add\_library()或者add\_executable()创建的其他目标可以使用$< TARGET\_OBJECT:objlib>形式的表达式作为源引用对象  
，其中objlib是对象库名称。例如：

add_library(... $<TARGET_OBJECTS:objlib> ...)
    add_executable(... $<TARGET_OBJECTS:objlib> ...)

将包括objlib的目标文件在一个库和一个可执行文件，连同那些从自己的源编译。对象库可能只包含编译源、头文件和其他不会影响普通库链接的文件(例如.txt)。它们可能包含生成此类源的自定义命令，但不包含PRE\_BUILD、PRE\_LINK或POST\_BUILD命令。一些原生构建系统(如Xcode)可能不喜欢只有对象文件的目标，所以考虑添加至少一个真正的源文件到任何引用$的目标。

3.12新版功能:可以用target\_link\_libraries()链接到对象库。

# 实践 #

## 编写代码 ##

项目结构如下：  
![在这里插入图片描述][20200630134714151.png]

/*
    ** testFunc.c
    */
    
    #include <stdio.h>
    #include "testFunc.h"
    
    void func(int data)
    {
        
    	printf("data is %d\n", data);
    }

/*
    ** testFunc.h
    */
    
    #ifndef _TEST_FUNC_H_
    #define _TEST_FUNC_H_
    
    void func(int data);
    
    #endif

最外层的CMakeLists.txt内容如下：

cmake_minimum_required (VERSION 2.8)
    
    project (demo)
    
    #向当前工程添加存放源文件的子目录
    add_subdirectory (lib_testFunc)

lib\_testFunc目录下的CMakeLists.txt如下：

aux_source_directory (. SRC_LIST)
    
    # 使用${
        SRC_LIST}为原材料生成一个叫做testFunc_shared 的动态库
    add_library (testFunc_shared SHARED ${
        SRC_LIST})
    # 使用${
        SRC_LIST}为原材料生成一个叫做testFunc_static 的静态库
    add_library (testFunc_static STATIC ${
        SRC_LIST})
    
    # 将testFunc_shared 重新命名为 libtestFunc.so
    set_target_properties (testFunc_shared PROPERTIES OUTPUT_NAME "testFunc")
    # 将testFunc_static  重新命名为 libtestFunc.a
    set_target_properties (testFunc_static PROPERTIES OUTPUT_NAME "testFunc")
    
    # 设置 库文件的默认输出路径
    set (LIBRARY_OUTPUT_PATH ${
        PROJECT_SOURCE_DIR}/lib)

命令：

*  `add_library`: 生成动态库或静态库(第1个参数指定库的名字；第2个参数决定是动态还是静态，如果没有就默认静态；第3个参数指定生成库的源文件)
 *  `set_target_properties`: 设置输出的名称，还有其它功能，如设置库的版本号等等

预定义变量：

*  `LIBRARY_OUTPUT_PATH`: 库文件的默认输出路径，这里设置为工程目录下的lib目录

## 编译 ##

现在，让我们进入build目录下运行cmake …，成功后再运行make：

![在这里插入图片描述][20200630135216503.png]

cd到lib目录下进行查看，发现已经成功生成了动态库和静态库，  
![在这里插入图片描述][20200630135230929.png]

ps：可以看出前面使用set\_target\_properties重新定义了库的输出名字，如果不用set\_target\_properties也可以，那么库的名字就是add\_library里定义的名字，只是我们连续2次使用add\_library指定库名字时，这个名字不能相同，而set\_target\_properties可以把名字设置为相同，只是最终生成的库文件后缀不同，这样相对来说会好看点。

# 总结 #

命令总结：

<table> 
 <thead> 
  <tr> 
   <th>命令</th> 
   <th>说明</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>add_library</code></td> 
   <td>生成动态库或静态库</td> 
   <td><code>add_library (testFunc_shared SHARED ${SRC_LIST})</code></td> 
  </tr> 
  <tr> 
   <td>set_target_properties</td> 
   <td>设置输出的名称</td> 
   <td><code>set_target_properties (testFunc_shared PROPERTIES OUTPUT_NAME "testFunc")</code></td> 
  </tr> 
 </tbody> 
</table>

预定义变量总结：

<table> 
 <thead> 
  <tr> 
   <th>预定义变量</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>LIBRARY_OUTPUT_PATH</code></td> 
   <td>库文件的默认输出路径</td> 
  </tr> 
 </tbody> 
</table>

[cmake]: https://blog.csdn.net/zhizhengguan/article/details/107034372
[20200630134714151.png]: /images/20221120/b6c3834166ec44a1a25305e60c845ee3.png
[20200630135216503.png]: https://img-blog.csdnimg.cn/20200630135216503.png
[20200630135230929.png]: https://img-blog.csdnimg.cn/20200630135230929.png