异常教程

CMake 基础（超详细）

更新时间:

💡一则或许对你有用的小广告

欢迎加入小哈的星球 ，你将获得：专属的项目实战 / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论

  • 新项目:《从零手撸：仿小红书（微服务架构）》 正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...，点击查看项目介绍 ;
  • 《从零手撸：前后端分离博客项目（全栈开发）》 2 期已完结，演示链接： http://116.62.199.48/ ;

截止目前， 星球 内专栏累计输出 82w+ 字，讲解图 3441+ 张，还在持续爆肝中.. 后续还会上新更多项目，目标是将 Java 领域典型的项目都整一波，如秒杀系统, 在线商城, IM 即时通讯，权限管理，Spring Cloud Alibaba 微服务等等，已有 2900+ 小伙伴加入学习 ，欢迎点击围观

在软件开发过程中，构建系统是连接代码与可执行文件的桥梁。对于 C/C++ 项目而言，手动编写 Makefile 或依赖复杂的编译命令容易导致效率低下和维护困难。CMake 基础知识的学习，能够帮助开发者高效管理项目构建流程，尤其在跨平台开发中发挥关键作用。本文将从零开始讲解 CMake 的核心概念、配置方法及实际应用场景，通过形象的比喻和代码示例，让读者快速掌握这一工具的精髓。

一、什么是 CMake？

CMake（Cross-Platform Makefile Generator）是一个开源的跨平台构建系统生成器。它通过将项目配置信息抽象为文本文件（如 CMakeLists.txt），自动生成适用于不同编译器和操作系统的构建文件（如 Makefile、Visual Studio 项目文件等）。

形象比喻：
可以将 CMake 想象为一个“交通指挥系统”。开发者在 CMakeLists.txt 中定义项目的“交通规则”（如代码路径、依赖库、编译选项等），CMake 则根据这些规则生成适合当前环境的“道路规划”（如 Makefile 或项目文件），最终让代码顺利“行驶”到可执行文件的终点。

二、安装与环境准备

1. 安装 CMake

在主流操作系统中安装 CMake 的方法如下：

  • Linux：通过包管理器安装（如 sudo apt install cmake）；
  • Windows：下载官方安装包（cmake.org ）；
  • macOS：使用 Homebrew（brew install cmake）。

2. 验证安装

安装完成后，在终端输入以下命令验证版本号：

cmake --version

若显示版本信息，则表明安装成功。

三、CMake 核心概念与工作流程

1. CMake 工作流程

CMake 的典型工作流程分为以下步骤：

  1. 编写 CMakeLists.txt：在项目根目录定义构建规则；
  2. 生成构建系统：通过 cmake 命令生成 Makefile 或其他编译文件；
  3. 编译与链接：使用 make 或 IDE 进行编译。

流程图示：

项目代码 → CMakeLists.txt → CMake → Makefile → 编译器 → 可执行文件

2. CMakeLists.txt 的基本结构

一个简单的 CMakeLists.txt 包含以下核心指令：

cmake_minimum_required(VERSION 3.10)  
project(MyProject)  
add_executable(my_program main.cpp)
  • cmake_minimum_required：指定所需的最低 CMake 版本；
  • project：定义项目名称；
  • add_executable：声明可执行文件及其源文件。

四、CMake 基础指令详解

1. 常用指令与功能

指令功能描述
add_executable创建可执行文件
add_library创建静态或共享库
target_link_libraries指定目标文件的依赖库
include_directories添加头文件搜索路径
set定义变量

示例：

set(SOURCE_FILES main.cpp utils.cpp)  

add_executable(my_program ${SOURCE_FILES})  

include_directories(include)

2. 构建类型配置

通过 CMAKE_BUILD_TYPE 变量可指定编译模式：

cmake -DCMAKE_BUILD_TYPE=Debug ..  # 调试模式  
cmake -DCMAKE_BUILD_TYPE=Release ..  # 发布模式

在 CMakeLists.txt 中也可通过 set 指令设置默认值：

set(CMAKE_BUILD_TYPE Debug)

五、构建多文件项目

1. 分层项目结构

假设项目结构如下：

MyProject/  
├── CMakeLists.txt  
├── include/  
│   └── utils.h  
├── src/  
│   ├── main.cpp  
│   └── utils.cpp  
└── tests/  
    └── test.cpp

2. 配置 CMakeLists.txt

cmake_minimum_required(VERSION 3.10)  
project(MyProject)  

include_directories(include)  

add_executable(my_program  
    src/main.cpp  
    src/utils.cpp  
)  

add_executable(test_program  
    tests/test.cpp  
    src/utils.cpp  # 共享代码  
)  

target_link_libraries(my_program some_library)

3. 构建流程

mkdir build && cd build  
cmake ..  
make

执行后生成 my_program 和 test_program 可执行文件。

六、CMake 的高级特性

1. 条件判断与变量控制

通过 if 指令实现条件编译：

if(CMAKE_SYSTEM_NAME STREQUAL "Windows")  
    add_definitions(-DWINDOWS_PLATFORM)  
else()  
    add_definitions(-DUNIX_PLATFORM)  
endif()

2. 外部依赖管理

使用 find_package 搜索系统库：

find_package(OpenGL REQUIRED)  
target_link_libraries(my_program ${OPENGL_LIBRARIES})

3. 自定义函数与宏

封装常用逻辑以提高复用性：

function(add_my_library NAME)  
    add_library(${NAME} ${ARGN})  
    target_include_directories(${NAME} PUBLIC include)  
endfunction()  

add_my_library(math_utils math.cpp)

七、实际案例：构建一个跨平台工具

1. 项目需求

开发一个支持 Windows/Linux 的命令行工具，功能为计算文件 MD5 值。

2. CMakeLists.txt 设计

cmake_minimum_required(VERSION 3.10)  
project(FileHash)  

set(SOURCE_FILES  
    src/main.cpp  
    src/md5.cpp  
)  

add_executable(filehash ${SOURCE_FILES})  

if(CMAKE_SYSTEM_NAME STREQUAL "Windows")  
    target_link_libraries(filehash crypt32)  # Windows 加密库  
else()  
    target_link_libraries(filehash m)        # Linux 数学库  
endif()  

set_target_properties(filehash PROPERTIES  
    CXX_STANDARD 17  
    CXX_STANDARD_REQUIRED YES  
)

3. 构建与运行

mkdir build && cd build  
cmake .. -DCMAKE_BUILD_TYPE=Release  
make  

./filehash --input test.txt

八、常见问题与解决方案

1. 错误：找不到头文件

原因：未正确设置 include_directories。
解决：在 CMakeLists.txt 中添加头文件路径：

include_directories(${PROJECT_SOURCE_DIR}/include)

2. 警告：未指定编译标准

原因：未设置 C++ 标准版本。
解决：在项目配置中指定标准：

set(CMAKE_CXX_STANDARD 17)  
set(CMAKE_CXX_STANDARD_REQUIRED ON)

结论

通过本文的讲解，读者应已掌握 CMake 基础 的核心概念与实践方法。CMake 不仅简化了多平台项目的构建流程，还通过灵活的配置能力适应复杂工程需求。无论是小型工具开发还是大型框架搭建，合理使用 CMake 都能显著提升开发效率。建议读者通过实际项目进一步练习，例如尝试将现有代码迁移到 CMake 管理，或探索 find_package、add_subdirectory 等高级功能。掌握 CMake，将为跨平台开发之路奠定坚实基础。

最新发布

查看更多文章