cmake基础示例:如何编译【跨平台】的动态库和应用程序
示例代码
首先看一下测试代码的全貌:
![](https://pic1.zhimg.com/80/v2-6ab1f28ff212960e9817b1b76b92165c_720w.jpg)
- mylib:只有一个源文件,编译输出一个动态库;
- myapp:也只有一个源文件,链接 mylib 动态库,编译输出一个可执行程序;
mylib
在mylib
目录中,一共有3
个文件:mylib.h, mylib.c 以及 CMakeLists.txt,内容分别如下:
// mylib/mylib.h w文件
#ifndef _MY_LIB_
#define _MY_LIB_
#ifdef MY_LINUX
#define MYLIB_API extern
#else
#ifdef MYLIB_EXPORT
#define MYLIB_API __declspec(dllexport)
#else
#define MYLIB_API __declspec(dllimport)
#endif
#endif
MYLIB_API int my_add(int num1, int num2);
MYLIB_API int my_sub(int num1, int num2);
#endif // _MY_LIB_
以上这个代码,主要是用在Windows
系统的动态导出库,在 Linux 系统中,不是必要的。
补充:在 windows 系统中,编译动态库时会生成 xxx.dll 和 xxx.lib。xxx.dll 中是真正的库文件指令,xxx.lib 中仅仅是符号表。
具体来说:在 Windows
系统中,当编译动态库的时候,打开(定义)宏 MYLIB_EXPORT
,下面这个宏生效:
#define MYLIB_API __declspec(dllexport)
这样的话,两个函数 my_add
和 my_sub
的符号才可能被导出到 mylib.lib 文件中。
当这个动态库被应用程序(myapp
)使用的时候,myapp.c
在 include mylib.h
的时,关闭宏 MYLIB_EXPORT
,此时下面这个宏就生效:
#define MYLIB_API __declspec(dllimport)
为了简化宏定义的复杂度,这里就不考虑静态库了。
看完了头文件,再来看看源文件mylib.c
:
// mylib/mylib.c 文件
#include "mylib.h"
int my_add(int num1, int num2)
{
return (num1 + num2);
}
int my_sub(int num1, int num2)
{
return (num1 - num2);
}
最后再来看一下mylib/CMakeLists.txt
文件:
// mylib/CMakeLists.txt 文件
CMAKE_MINIMUM_REQUIRED(VERSION 3.5)
PROJECT(mylib VERSION 1.0.0)
# 自定义宏,代码中可以使用
ADD_DEFINITIONS(-DMYLIB_EXPORT)
# 头文件
INCLUDE_DIRECTORIES(./)
# 源文件
FILE(GLOB MYLIB_SRCS "*.c")
# 编译目标
ADD_LIBRARY(${PROJECT_NAME} SHARED ${MYLIB_SRCS})
关于cmake
的语法就不多说了,这里只用到了其中很少的一部分。
注意其中的一点:ADD_DEFINITIONS(-DMYLIB_EXPORT)
,因为这个CMakeLists.txt
是用来编译动态库的,因此在Windows
平台下,每一个导出符号的前面需要加上 __declspec(dllexport)
,因此需要打开宏定义:MYLIB_EXPORT。
myapp
应用程序的代码就更简单了,只有两个文件:myapp.c 和 CMakeLists.txt,内容如下:
// myapp/myapp.c 文件
#include <stdio.h>
#include <stdlib.h>
#include "mylib.h"
int main(int argc, char *argv[])
{
int ret1, ret2;
int a = 5;
int b = 2;
ret1 = my_add(a, b);
ret2 = my_sub(a, b);
printf("ret1 = %d \n", ret1);
printf("ret2 = %d \n", ret2);
getchar();
return 0;
}
HelloWorld
级别的代码,不需要多解释!CMakeLists.txt
内容如下:
// myapp/CMakeLists.txt 文件
CMAKE_MINIMUM_REQUIRED(VERSION 3.5)
PROJECT(myapp VERSION 1.0.0)
# 头文件路径
INCLUDE_DIRECTORIES(./include)
# 库文件路径
LINK_DIRECTORIES(./lib)
# 源文件
FILE(GLOB MYAPP_SRCS "*.c")
# 编译目标
ADD_EXECUTABLE(${PROJECT_NAME} ${MYAPP_SRCS})
# 依赖的动态库
TARGET_LINK_LIBRARIES(${PROJECT_NAME} mylib)
最后一行 TARGET_LINK_LIBRARIES(${PROJECT_NAME} mylib)
说明要链接mylib
这个动态库。
那么到哪个目录下去查找相应的头文件和库文件呢?
通过这两行来指定查找目录:
# 头文件路径
INCLUDE_DIRECTORIES(./include)
# 库文件路径
LINK_DIRECTORIES(./lib)
这个两个目录暂时还不存在,待会编译的时候我们再手动创建。
可以让 mylib 在编译时的输出文件,自动拷贝到指定的目录。但是为了不把问题复杂化,某些操作步骤通过手动操作来完成,这样也能更清楚的理解其中的链接过程。
最后就剩下最外层的CMakeLists.txt
文件了:
CMAKE_MINIMUM_REQUIRED(VERSION 3.5)
PROJECT(cmake_demo VERSION 1.0.0)
SET(CMAKE_C_STANDARD 99)
# 自定义宏,代码中可以使用
if (CMAKE_HOST_UNIX)
ADD_DEFINITIONS(-DMY_LINUX)
else ()
ADD_DEFINITIONS(-DMY_WINDOWS)
endif()
ADD_SUBDIRECTORY(mylib)
ADD_SUBDIRECTORY(myapp)
它所做的主要工作就是:根据不同的平台,定义相应的宏,并且添加了mylib
和myapp
这两个子文件夹。
【点击链接免费学习c/c++ linux服务器开发相关技术】
需要C/C++ Linux服务器架构师学习资料加qun812855908获取(资料包括C/C++,Linux,golang技术,Nginx,ZeroMQ,MySQL,Redis,fastdfs,MongoDB,ZK,流媒体,CDN,P2P,K8S,Docker,TCP/IP,协程,DPDK,ffmpeg等),免费分享
![](https://pic1.zhimg.com/80/v2-230324b7f95d48140009e6897d60349c_720w.webp)
Linux 下构建过程
cmake 配置
为了不污染源文件目录,在最外层目录下新建build
目录,然后执行cmake
指令:
$ cd ~/tmp/cmake_demo/
$ mkdir build
$ cd build/
$ ls
$ cmake ..
此时,在build
目录下,产生如下文件:
CMakeCache.txt CMakeFiles cmake_install.cmake Makefile myapp mylib
make 编译
我们可以分别进入mylib
和myapp
目录,执行make
指令来单独编译,也可以直接在build
目录下编译所有的目标。
现在就直接在build
目录下编译所有目标:
$ cd ~/tmp/cmake_demo/build
$ make
Scanning dependencies of target mylib
[ 25%] Building C object mylib/CMakeFiles/mylib.dir/mylib.c.o
[ 50%] Linking C shared library libmylib.so
[ 50%] Built target mylib
Scanning dependencies of target myapp
[ 75%] Building C object myapp/CMakeFiles/myapp.dir/myapp.c.o
~/tmp/cmake_demo/myapp/myapp.c:4:19: fatal error: mylib.h: 没有那个文件或目录
#include "mylib.h"
^
compilation terminated.
myapp/CMakeFiles/myapp.dir/build.make:62: recipe for target 'myapp/CMakeFiles/myapp.dir/myapp.c.o' failed
make[2]: *** [myapp/CMakeFiles/myapp.dir/myapp.c.o] Error 1
CMakeFiles/Makefile2:140: recipe for target 'myapp/CMakeFiles/myapp.dir/all' failed
make[1]: *** [myapp/CMakeFiles/myapp.dir/all] Error 2
Makefile:83: recipe for target 'all' failed
make: *** [all] Error 2
从提示信息中看出:已经编译生成了 ./mylib/libmylib.so 文件,但是在编译可执行程序 myapp 时遇到了错误:找不到 mylib.h 文件!
在刚才介绍myapp/CMakeLists.txt
文件时说到:应用程序查找头文件的目录是 myapp/include, 查找库文件的目录是 myapp/lib。
但是这2
个目录以及相应的头文件、库文件都不存在!
因此我们需要手动创建,并且把头文件mylib.h
和库文件libmylib.so
拷贝进去,操作过程如下:
$ cd ~/tmp/cmake_demo/myapp/
$ mkdir include lib
$ cp ~/tmp/cmake_demo/mylib/mylib.h ./include/
$ cp ~/tmp/cmake_demo/build/mylib/libmylib.so ./lib/
注意:刚才编译生成的库文件libmylib.so
是在build
目录下。
准备好头文件和库文件之后,再次编译一下:
$ cd ~/tmp/cmake_demo/build/
$ make
[ 50%] Built target mylib
[ 75%] Building C object myapp/CMakeFiles/myapp.dir/myapp.c.o
[100%] Linking C executable myapp
[100%] Built target myapp
此时,就在 build/myapp 目录下生成可执行文件myapp
了。
测试、执行
$ cd ~/tmp/cmake_demo/build/myapp
$ ./myapp
ret1 = 7
ret2 = 3
完美!
由于我们是在build
目录下编译的,编译过程中所有的输出和中间文件,都放在build
目录下,一点都没有污染源文件。
Windows 下构建过程
把Linux
系统中的build
文件夹删除,然后把测试代码压缩,复制到Windows
系统中继续测试。
在Windows
下编译,一般就很少使用命令行了,大部分都使用VS
或者VSCode
来编译。
打开 VSCode
,然后打开测试代码文件夹 cmake_demo:
![](https://pic2.zhimg.com/80/v2-e88260e79d767fc3766448001bee54e9_720w.webp)
因为需要使用cmake
工具来构建,所以需要在VSCode
安装 cmake 插件。(如何安装 VSCode 插件就不赘述了)
第一步: cmake 配置
按下键盘 ctrl + shift + p
,在命令窗口中选择 Cmake: Configure
,如果没看到这个选项,就手动输入前面的几个字符,然后就可以智能匹配到:
![](https://pic1.zhimg.com/80/v2-f842f8506492436ca545bba4d246fd78_720w.webp)
在第一次 Configure 的时候,会弹出下面的选项,来选择编译器:
![](https://pic2.zhimg.com/80/v2-4c5d492d3012ff2b87cfa5ab7c792445_720w.webp)
我们这里选择 64 位的 amd64。
配置的结果输出在最下面窗口中的output
标签中,如下所示:
![](https://pic2.zhimg.com/80/v2-2af5dc30a358a0f761b02e953ffae9e5_720w.webp)
这就表明cmake
配置成功,正确的执行了每一个文件夹下的 CMakeLists.txt 文件。
这个时候,来看一下资源管理器中有啥变化:自动生成了 build 目录,其中的文件如下:
![](https://pic1.zhimg.com/80/v2-47be64bcdb1e66a315bb046673cb9178_720w.webp)
看来,流程与Linux
系统中都是一样的,只不过这里是VSCode
主动帮我们做了一些事情。
第二步: 编译
配置之后,下一步就是编译了。
按下 shift + F7,或者单击VSCode
底部的 Build 图标:
![](https://pic1.zhimg.com/80/v2-28b2c656b3db66a784f4053b1aded770_720w.webp)
弹出编译目标列表:
![](https://pic1.zhimg.com/80/v2-0b537572871600e9d2ab855d4d8e913c_720w.webp)
这里选择 ALL_BUILD
,也就是编译所有的目标:mylib 和 myapp,输出如下:
![](https://pic3.zhimg.com/80/v2-143c8e50cb856efb3a8fb292124cb72e_720w.webp)
来看一下编译的输出文件:
![](https://pic2.zhimg.com/80/v2-b614952db04f42b549b4ab371e4f2291_720w.webp)
mylib.dll 就是编译得到的动态链接库,mylib.lib是导入符号。
![](https://pic1.zhimg.com/80/v2-7e822db7485aba216d0a567b51678ffc_720w.webp)
myapp.exe 是编译得到的可执行程序。
第三步: 执行
我们先在命令行窗口中执行一下myapp.exe
:
![](https://pic4.zhimg.com/80/v2-a0ca0ec237542c40d135fa8a2ff2388f_720w.webp)
提示错误:找不到动态链接库!
手动把mylib.dll
拷贝到myuapp.exe
同一个目录下,然后再执行一次 myapp.exe
:
![](https://pic1.zhimg.com/80/v2-c35ec9c0ccd8bcf3da26d86d364740b8_720w.webp)
完美!
但是,既然已经用VSCode
来编译了,那就继续在VSCode
中进行代码调试吧。
按下调试快捷键 F5
,第一次会弹出调试器选择项:
![](https://pic3.zhimg.com/80/v2-c024122cd95d65d0ae6f2bca0999ea56_720w.webp)
选择 LLDB
,然后弹出错误对话框:
![](https://pic3.zhimg.com/80/v2-2330d5b4f75d4742de2839e23c4d923a_720w.webp)
因为我们没有提供相应的配置文件来告诉VSCode
调试哪一个可执行程序。
单击[OK]之后,VSCode
会自动为我们生成 .vscode/launcher.json 文件,内容如下:
![](https://pic4.zhimg.com/80/v2-05a79d43157136129d9096d240acd26f_720w.webp)
把其中的program
项目,改成可执行程序的全路径:
"program": "F:/tmp/cmake_demo/build/myapp/Debug/myapp.exe"
然后再次按下F5
键,这回终于可以正确执行了:
![](https://pic2.zhimg.com/80/v2-8a3cf75cb043b1f8c09cee9c2c6a80f9_720w.webp)
此时,就可以在mylib.c
或者myapp.c
中设置断点,然后进行单步调试程序了:
![](https://pic1.zhimg.com/80/v2-ef6e1a0d19f849604309ea2873d2971c_720w.webp)
![](https://pic3.zhimg.com/80/v2-d01f88599dc7bb40a34f1b0dcf5a39d6_720w.webp)