【C++基础】CMake 简介

最新推荐文章于 2025-06-17 14:04:59 发布

Blαck

最新推荐文章于 2025-06-17 14:04:59 发布

阅读量1.3k

点赞数 34

CC 4.0 BY-SA版权

分类专栏： C++ 文章标签： c++ 开发语言

本文链接：https://blog.csdn.net/Bl_a_ck/article/details/146353240

C++ 专栏收录该内容

14 篇文章

订阅专栏

CMake 简介

CMake 是一个跨平台的自动化构建系统生成工具，用于管理软件构建过程。它不直接构建项目，而是生成标准的构建文件（如 Makefile、Visual Studio 项目文件、Ninja 构建文件等），然后由这些构建文件来完成实际的编译和链接工作。CMake 的主要目标是简化跨平台项目的构建过程。

CMake 的特点

跨平台：CMake 支持多种操作系统（如 Linux、Windows、macOS）和编译器（如 GCC、Clang、MSVC）。
灵活性：CMake 可以生成多种构建系统的配置文件，如 Makefile、Ninja、Visual Studio 项目文件等。
模块化：CMake 提供了丰富的模块和函数，方便开发者管理复杂的项目结构。
依赖管理：CMake 可以方便地管理项目的外部依赖。

CMake 的基本结构

1. 基本配置

指定 CMake 的最低版本要求。
定义项目名称和版本。

# 指定 CMake 的最低版本
cmake_minimum_required(VERSION 3.10)

# 定义项目名称和版本
project(MyProject VERSION 1.0)

cmake_minimum_required：指定项目所需的最低 CMake 版本。
project：定义项目名称和版本号，CMake 会自动生成一些变量（如 PROJECT_NAME 和 PROJECT_VERSION）。

2. 设置编译选项

定义编译器选项、标准和其他全局设置。

# 设置 C++ 标准
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# 设置编译选项
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -O2")

set(CMAKE_CXX_STANDARD 17)：指定使用 C++17 标准。
set(CMAKE_CXX_FLAGS)：设置编译器选项，如警告级别和优化选项。

3. 添加可执行文件或库

定义项目的目标（如可执行文件或库）。

# 添加可执行文件
add_executable(myprogram main.cpp utils.cpp)

# 添加静态库
add_library(mylib STATIC mylib.cpp)

# 添加动态库
add_library(mylib SHARED mylib.cpp)

add_executable 是一个 CMake 命令，用于从指定的源文件定义一个可执行目标。以下是其语法的简要说明：
```
add_executable(<name> [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL]
               source1 source2 ... sourceN)
```
- <name>：可执行目标的名称。
- [WIN32]：可选。指定可执行文件是一个 Windows 应用程序（即使用 WinMain 而不是 main）。
- [MACOSX_BUNDLE]：可选。指定可执行文件是一个 macOS 包。
- [EXCLUDE_FROM_ALL]：可选。从默认构建中排除该目标。
- source1 source2 ... sourceN：要编译成可执行文件的源文件列表。
例子：从源文件 src/main.cpp 创建一个名为 HttpServer 的可执行文件。
```
add_executable(HttpServer src/main.cpp)
```
add_library 是 CMake 中用于定义库目标（Library Target）的核心命令。它用于将源代码文件编译为静态库（.a 或 .lib）或动态库（.so 或 .dll）。add_library 的配置项非常灵活，支持多种库类型和构建选项。
```
add_library(<name> [STATIC | SHARED | MODULE] [EXCLUDE_FROM_ALL] source1 [source2 ...])
```
- <name>：库的名称，必须是唯一的。
- [STATIC | SHARED | MODULE]：指定库的类型（静态库、动态库或模块库）。
- [EXCLUDE_FROM_ALL]：如果指定，则该库不会在默认构建目标中构建。
- source1 [source2 ...]：库的源文件列表。

4. 添加头文件目录

指定头文件的搜索路径。

# 添加头文件目录
include_directories(${PROJECT_SOURCE_DIR}/include)

include_directories：添加头文件的搜索路径。

5. 链接库

将目标与库文件链接。

# 链接库
target_link_libraries(myprogram mylib)

target_link_libraries：将目标与指定的库链接。

6. 添加子目录

如果项目包含多个子目录，可以使用 add_subdirectory 添加子目录。

# 添加子目录
add_subdirectory(src)

add_subdirectory：添加子目录，CMake 会查找子目录中的 CMakeLists.txt 并执行。

7. 查找外部库

使用 find_package 查找并链接外部库。

# 查找 OpenCV 库
find_package(OpenCV REQUIRED)

# 链接 OpenCV 库
target_link_libraries(myprogram ${OpenCV_LIBS})

find_package：查找外部库，并设置相关变量（如 OpenCV_LIBS）。
target_link_libraries：将目标与外部库链接。

8. 自定义变量和选项

定义自定义变量和选项。

# 定义自定义变量
set(MY_VARIABLE "Hello, World!")

# 定义选项
option(ENABLE_FEATURE "Enable a feature" ON)

set：定义变量。
option：定义选项，可以在命令行中通过 -D 参数覆盖。

9. 条件语句

根据条件执行不同的操作。

if(WIN32)
    message(STATUS "This is Windows")
elseif(UNIX)
    message(STATUS "This is Unix")
endif()

if：根据条件执行不同的操作。

10. 安装规则

定义安装规则，用于将构建结果安装到指定目录。

# 安装可执行文件
install(TARGETS myprogram DESTINATION bin)

# 安装库文件
install(TARGETS mylib DESTINATION lib)

# 安装头文件
install(DIRECTORY include/ DESTINATION include)

install：定义安装规则。

11. 测试

添加测试用例。

# 启用测试
enable_testing()

# 添加测试
add_test(NAME mytest COMMAND myprogram)

enable_testing：启用测试功能。
add_test：添加测试用例。

完整示例

以下是一个完整的 CMakeLists.txt 示例：

# 指定 CMake 的最低版本
cmake_minimum_required(VERSION 3.10)

# 定义项目名称和版本
project(MyProject VERSION 1.0)

# 设置 C++ 标准
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# 设置编译选项
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -O2")

# 添加头文件目录
include_directories(${PROJECT_SOURCE_DIR}/include)

# 添加可执行文件
add_executable(myprogram main.cpp utils.cpp)

# 添加静态库
add_library(mylib STATIC mylib.cpp)

# 链接库
target_link_libraries(myprogram mylib)

# 查找并链接外部库
find_package(OpenCV REQUIRED)
target_link_libraries(myprogram ${OpenCV_LIBS})

# 添加子目录
add_subdirectory(src)

# 定义自定义变量
set(MY_VARIABLE "Hello, World!")

# 定义选项
option(ENABLE_FEATURE "Enable a feature" ON)

# 安装规则
install(TARGETS myprogram DESTINATION bin)
install(TARGETS mylib DESTINATION lib)
install(DIRECTORY include/ DESTINATION include)

# 启用测试
enable_testing()

# 添加测试
add_test(NAME mytest COMMAND myprogram)

CMake 的基本使用

1. 编写 `CMakeLists.txt`

CMake 的核心配置文件是 CMakeLists.txt，它定义了项目的构建规则和依赖关系。以下是一个简单的 CMakeLists.txt 示例：

# 指定 CMake 的最低版本要求
cmake_minimum_required(VERSION 3.10)

# 设置项目名称和版本
project(MyProject VERSION 1.0)

# 添加可执行文件
add_executable(myprogram main.cpp utils.cpp)

# 设置编译选项
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -g")

# 添加子目录（如果有子项目）
# add_subdirectory(subdir)

# 查找并链接外部库
# find_package(SomeLibrary REQUIRED)
# target_link_libraries(myprogram SomeLibrary::SomeLibrary)

2. 生成构建系统

在项目根目录下创建一个构建目录，并运行 cmake 命令生成构建系统文件：

mkdir build
cd build
cmake ..

这会在 build 目录下生成所需的构建文件（如 Makefile）。

3. 构建项目

使用生成的构建文件来编译项目。例如，如果生成的是 Makefile，可以运行以下命令：

make

4. 清理构建

如果需要清理构建生成的文件，可以运行：

make clean

CMake 的高级功能

1. 变量和缓存

CMake 支持定义和使用变量，变量可以存储在缓存中，方便跨多个 CMake 运行会话使用。

set(MY_VARIABLE "Hello, World!")
message(STATUS "MY_VARIABLE is ${MY_VARIABLE}")

2. 条件语句

CMake 支持条件语句，可以根据不同的条件执行不同的操作。

if(WIN32)
    message(STATUS "This is Windows")
elseif(UNIX)
    message(STATUS "This is Unix")
endif()

3. 函数和宏

CMake 支持定义函数和宏，方便代码复用。

function(print_hello)
    message(STATUS "Hello, World!")
endfunction()

print_hello()

4. 查找和使用外部库

CMake 提供了 find_package 命令来查找和使用外部库。

find_package(OpenCV REQUIRED)
target_link_libraries(myprogram ${OpenCV_LIBS})

示例项目结构

假设有一个简单的 C++ 项目，结构如下：

MyProject/
├── CMakeLists.txt
├── main.cpp
├── utils.cpp
└── utils.h

对应的 CMakeLists.txt 文件内容如下：

cmake_minimum_required(VERSION 3.10)
project(MyProject VERSION 1.0)

add_executable(myprogram main.cpp utils.cpp)

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -g")