cmake系列-怎么构建不同的C++程序目标文件（可执行程序、动态库、静态库）

我们编写的C++代码不仅仅只是为了生成可执行程序，有的时候可能是为了生成动态库或者静态库，那么如果用cmake来构建的话，应该怎么做呢，怎么指定是生成可执行程序，还是生成动态库或者静态库呢，这篇文章我们用简单的demo聊一下这些内容。

示例使用安装了vs2022的Windows系统，使用vscode编辑器。

生成可执行程序

先看一下demo的结构

结构很简单，只有一个用来生成可执行程序的源文件main.cpp和一个指定构建规则的CMakeLists.txt文件。

其中main.cpp的内容如下

// main.cpp#include <iostream>int main()
{std::cout << "demo" << std::endl;return 0;
}

这个main.cpp就不解释了。

然后看下CMakeLists.txt的内容

cmake_minimum_required(VERSION 3.26)project(demo)add_executable(${PROJECT_NAME} main.cpp)

这几条指令的作用：

• cmake_minimum_required(VERSION 3.26)：指定cmake最低版本，如果构建时使用的cmake低于这个版本就会报错，主要是为了避免出现兼容问题。
• project(demo)：设置项目名称为demo，这条指令还可以设置版本以及程序语言等信息，但是一般不需要，设置项目名称就可以了。
• add_executable(${PROJECT_NAME} main.cpp)：这条指令的作用是指定项目目标为生成可执行程序，同时指定可执行程序的文件名为PROJECT_NAME变量的值（这个文件名是不带后缀名的文件名，具体后缀名会根据所处系统环境自动生成，PROJECT_NAME变量的值是最近的一次使用project()设置的项目名称），以及指定生成可执行程序使用的源文件为main.cpp。

编写好这几个文件之后，我们在demo目录下先执行命令cmake -B build生成构建系统，然后执行命令cmake --build build --config Debug就可以构建出可执行程序了。

生成动态库

同样先看一下demo结构

结构也很简单，包括用来生成动态库的源文件demo.cpp，头文件demo.h和demo_config.h，以及一个指定构建规则的CMakeLists.txt文件。

先看一下C++代码

// demo_config.h#ifndef DEMO_CONFIG_H
#define DEMO_CONFIG_H#ifdef DEMO_EXPORT#define DEMO_API __declspec(dllexport)
#else#define DEMO_API __declspec(dllimport)
#endif#endif

// demo.h#ifndef DEMO_H
#define DEMO_H#include "demo_config.h"class Demo
{
public:Demo() = default;~Demo() noexcept = default;DEMO_API void Func();
};#endif

// demo.cpp#include "demo.h"#include <iostream>void Demo::Func()
{std::cout << "demo" << std::endl;
}

代码很简单就不解释了，重点是要解释CMakeLists.txt文件的内容。

看一下这个CMakeLists.txt文件的内容，这个会比上面生成可执行程序的那个demo稍微复杂一些。

cmake_minimum_required(VERSION 3.26)project(demo)include_directories(include)add_definitions(-DDEMO_EXPORT)aux_source_directory(src srcfiles)message(STATUS "srcfiles:${srcfiles}")add_library(${PROJECT_NAME} SHARED ${srcfiles})

解释一下这几条指令的作用：

• cmake_minimum_required(VERSION 3.26)和project(demo)前面已经说过了。
• include_directories(include)：设置包含目录，即头文件位置
• add_definitions(-DDEMO_EXPORT)：设置预定义宏DEMO_EXPORT，前面的-D是写法规则要求带上的，这个宏在C++代码里用到了，用来指定是否需要导出符号。
• aux_source_directory(src srcfiles)：表示收集src目录下的源文件，并且保存为变量srcfiles
• message(STATUS “srcfiles:${srcfiles}”)：打印变量srcfiles的值，不打印也可以，这里只是为了讲的清楚一些，STATUS表示是状态信息。
• add_library(${PROJECT_NAME} SHARED ${srcfiles})：这条指令的作用是指定生成库文件，并且指定库文件的文件名是变量PROJECT_NAME的值，使用的源文件就是前面aux_source_directory(src srcfiles)指令收集的源文件，即变量srcfiles的值，这俩参数和前面的指令add_executable()中对应的参数是一样的含义，另一个参数SHARED表示要生成的是动态库（共享库）文件。

这几个文件写好了之后，和前面构建可执行程序一样，我们在demo目录下先执行命令cmake -B build生成构建系统（执行这条命令的时候可以看到CMakeLists.txt中那条message指令打印的信息），然后执行命令cmake --build build --config Debug就可以构建出动态库了。

生成静态库

还是先看一下demo结构

这个也很简单，包括用来生成动态库的源文件demo.cpp和头文件demo.h，以及一个指定构建规则的CMakeLists.txt文件。

还是先看一下C++代码，但是很简单所以不解释。

// demo.h#ifndef DEMO_H
#define DEMO_Hclass Demo
{
public:Demo() = default;~Demo() noexcept = default;void Func();
};#endif

// demo.cpp#include "demo.h"#include <iostream>void Demo::Func()
{std::cout << "demo" << std::endl;
}

重点是这个CMakeLists.txt文件的内容，但是这个CMakeLists.txt和前面生成动态库的那个CMakeLists.txt基本上一样，我们来看一下。

cmake_minimum_required(VERSION 3.26)project(demo)include_directories(include)aux_source_directory(src srcfiles)message(STATUS "srcfiles:${srcfiles}")add_library(${PROJECT_NAME} STATIC ${srcfiles})

这个CMakeLists.txt和前面生成动态库的那个CMakeLists.txt的一个区别是不用设置预定义宏了，因为不需要，但是这个区别不是重点，重点是add_library()这条指令的区别，这条指令前面讲了可以使用参数SHARED指定生成动态库，相对应的使用参数STATIC就是表示要指定生成静态库。

同样的，这几个文件写好了之后，我们在demo目录下先执行命令cmake -B build生成构建系统，然后执行命令cmake --build build --config Debug就可以构建出静态库了。