CMake 保姆级教程

原创 已于 2025-03-16 20:36:43 修改 · 2.2k 阅读 · 21 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#c++

于 2025-03-16 12:12:00 首次发布

CMake 是一个跨平台的构建工具，用于生成适合不同平台和编译器的构建系统文件（如 Makefile 或 Visual Studio 项目文件）。
在 Windows 下使用 CMake 构建项目时，CMake 会根据 CMakeLists.txt 文件生成适合 Windows 的构建系统文件（如 Visual Studio 项目文件）。以下是 Windows 下使用 CMake 的基本规则和步骤：

https://subingwen.cn/cmake/CMake-primer/#1-CMake%E6%A6%82%E8%BF%B0

1. CMakeLists.txt 文件的基本结构

CMakeLists.txt 是 CMake 的配置文件，用于定义项目的构建规则。以下是一个简单的示例：

# 指定 CMake 的最低版本要求（不是必须的，这个version需要比本地使用的低就行）
cmake_minimum_required(VERSION 3.10)

# 定义项目名称和使用的编程语言(不写默认情况支持所有语言)  project(<PROJECT-NAME> [<language-name>...]) 
project(MyProject CXX)

# 添加可执行文件目标 add_executable(可执行程序名 所有源文件名称.cpp)
add_executable(MyProgram main.cpp utils.cpp)

# 添加编译选项
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -O2")

# 添加库文件（如果需要）
target_link_libraries(MyProgram some_library)

# 注释单行行(# )    注释多行CMake 使用 #[[ ]] 形式进行块注释
#[[ 这是一个 CMakeLists.txt 文件。
这是一个 CMakeLists.txt 文件
这是一个 CMakeLists.txt 文件]]
set使用

定义变量

# 假设有很多.cpp文件，这些.cpp文件名需要被反复使用，每次都直接将它们的名字写出来很麻烦，此时可以定义一个变量，将文件名对应的字符串存储起来
# SET 指令的语法是：VAR：变量名   VALUE：变量值
set (var value)
set(SRC_LIST add.c  div.c   main.c  mult.c  sub.c)

# 取值 ${变量名}
add_executable(app  ${SRC_LIST})   # 生成可执行程序

指定使用的C++标准

# 在编写C++程序的时候，可能会用到C++11、C++14、C++17、C++20等新特性，那么就需要在编译的时候在编译命令中制定出要使用哪
#增加-std=c++11
set(CMAKE_CXX_STANDARD 11)
#增加-std=c++14
set(CMAKE_CXX_STANDARD 14)
#增加-std=c++17
set(CMAKE_CXX_STANDARD 17)

指定输出的路径

# 定义一个变量用于存储一个绝对路径
set(HOME /home/robin/Linux/Sort)   
# 拼接好的路径值设置给CMAKE_RUNTIME_OUTPUT_DIRECTORY 宏，设置可执行程序输出目录
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${HOME}/bin)

# 设置库文件的输出目录
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "D:/learn/C++/test/code/lib")

# 设置静态库文件的输出目录
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "D:/learn/C++/test/code/lib")


# 定义可执行文件
add_executable(MyProgram main.cpp)
# 为特定目标设置输出目录
set_target_properties(MyProgram PROPERTIES
    RUNTIME_OUTPUT_DIRECTORY "D:/learn/C++/test/code/bin"
)
搜索文件

如果一个项目里边的源文件很多，在编写CMakeLists.txt文件的时候不可能将项目目录的各个文件一一罗列出来，这样太麻烦也不现实。所以，在CMake中为我们提供了搜索文件的命令，可以使用file命令。

# GLOB: 将指定目录下搜索到的满足条件的所有文件名生成一个列表，并将其存储到变量中。
# GLOB_RECURSE：递归搜索指定目录，将搜索到的满足条件的文件名生成一个列表，并将其存储到变量中

file(GLOB/GLOB_RECURSE 变量名 要搜索的文件路径和文件类型) 
file(GLOB SRC ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)   # CMAKE_CURRENT_SOURCE_DIR 这个存储路径就是cmakefile.txt所在的路径
# file(GLOB MAIN_SRC ${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp)
# file(GLOB MAIN_HEAD ${CMAKE_CURRENT_SOURCE_DIR}/include/*.h)
指定头文件

如果头文件所在目录发生改变，不需要把引用该头文件所有的.cpp都进行修改，只需要需要对应的cmake文件

include_directories(headpath)
include_directories(${PROJECT_SOURCE_DIR}/include)
通过CMake 制作库文件（动态库/静态库）

制作静态库

add_library(库名称 STATIC 源文件1 [源文件2] ...)

制作动态库

add_library(库名称 SHARED 源文件1 [源文件2] ...) 
# 设置动态库生成路径
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)

# 设置动态库/静态库生成路径
set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)
链接库

链接静态库

link_libraries(<static lib> [<static lib>...])
  • 参数1：指定出要链接的静态库的名字
    可以是全名 libxxx.a 也可以是掐头（lib）去尾（.a）之后的名字 xxx

链接动态库

2. Windows 下的 CMake 使用步骤

(1) 安装 CMake
  • 从 CMake 官网 下载并安装 CMake。
  • 确保将 CMake 添加到系统环境变量中，以便在命令行中使用。
(2) 创建构建目录

在项目根目录下（CMakeLists.txt文件所在路径），创建一个构建目录（例如 build），用于存放生成的构建文件：

mkdir build
cd build
(3) 生成构建系统文件（执行cmake进行编译）

使用 CMake 生成适合 Windows 的构建系统文件。以下是几种常见的方式：

  • 生成 Visual Studio 项目文件：

    cmake -G "Visual Studio 17 2022" ..

    这里的 "Visual Studio 17 2022" 是生成器的名称，可以根据你的 Visual Studio 版本调整。

  • 指定平台（x64 或 x86）：
    如果需要指定目标平台（如 64 位或 32 位），可以使用 -A 参数：

    cmake -G "Visual Studio 17 2022" -A x64 ..
(4) 构建项目

生成构建系统文件后，可以使用以下命令构建项目：

  • 使用 Visual Studio 构建：
    打开生成的 .sln 文件，使用 Visual Studio 进行构建。

  • 使用 CMake 命令行构建：

    cmake --build . --config Release

    这里的 --config Release 指定构建类型为 Release，也可以改为 Debug。

3. CMakeLists.txt 的常用规则

(1) 添加源文件
# 手动指定源文件
add_executable(MyProgram main.cpp utils.cpp)

# 自动查找所有 .cpp 文件
file(GLOB SOURCES "src/*.cpp")
add_executable(MyProgram ${SOURCES})
(2) 添加头文件目录
# 添加头文件目录
include_directories(include)

# 或者使用 target_include_directories（推荐）
target_include_directories(MyProgram PUBLIC include)
(3) 链接库文件
# 链接静态库或动态库
target_link_libraries(MyProgram some_library)

# 查找并链接系统库（如 OpenGL）
find_package(OpenGL REQUIRED)
target_link_libraries(MyProgram OpenGL::GL)
(4) 设置编译选项
# 设置全局编译选项
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -O2")

# 设置目标特定的编译选项
target_compile_options(MyProgram PRIVATE -Wall -O2)
(5) 设置输出目录
# 设置可执行文件的输出目录
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)

# 设置库文件的输出目录
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
(6) 添加子目录

如果项目包含多个子项目，可以使用 add_subdirectory：

add_subdirectory(subproject)

4. Windows 下的注意事项

(1) 路径分隔符

在 Windows 下，路径分隔符是反斜杠 \，但在 CMake 中建议使用正斜杠 /，因为 CMake 会自动处理路径。

(2) 生成器选择

Windows 下常用的生成器包括：

  • Visual Studio 17 2022：生成 Visual Studio 项目文件。
  • MinGW Makefiles：生成适用于 MinGW 的 Makefile。
(3) 动态链接库

在 Windows 下，动态链接库（DLL）的使用需要注意：

  • 确保 DLL 文件在运行时可以被找到（可以将其放在可执行文件目录中）。
  • 使用 target_link_libraries 链接库时，CMake 会自动处理导入库（.lib 文件）。
(4) 调试与发布配置

CMake 支持多配置生成器（如 Visual Studio），可以通过 --config 参数指定构建类型：

cmake --build . --config Debug   # 调试模式
cmake --build . --config Release # 发布模式

5. 示例：完整的 CMakeLists.txt

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

cmake_minimum_required(VERSION 3.10)
project(MyProject CXX)

# 添加头文件目录
include_directories(include)

# 添加源文件
file(GLOB SOURCES "src/*.cpp")

# 生成可执行文件
add_executable(MyProgram ${SOURCES})

# 链接库文件
target_link_libraries(MyProgram some_library)

# 设置编译选项
target_compile_options(MyProgram PRIVATE -Wall -O2)

# 设置输出目录
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)

6. 总结

  • 在 Windows 下使用 CMake 时，可以通过 -G 参数指定生成器（如 Visual Studio）。
  • CMakeLists.txt 文件定义了项目的构建规则，包括源文件、头文件、库文件和编译选项。
  • 使用 cmake --build 可以方便地构建项目。

通过合理配置 CMakeLists.txt，可以在 Windows 下高效地管理和构建项目。

CMake入门教程【基础篇】在Windows、Linux上安装CMake
小鱼酱的博客
01-01 2283
CMake如何下载与安装
CMake学习（上）
weixin_48856218的博客
03-18 996
关于项目构建我们所熟知的还有Makefile（通过 make 命令进行项目的构建），大多是IDE软件都集成了make，比如：VS 的 nmake、linux 下的 GNU make、Qt 的 qmake等，如果自己动手写 makefile，会发现，makefile 通常依赖于当前的编译平台，而且编写 makefile 的工作量比较大，解决依赖关系时也容易出错。在编写程序的过程中，可能会用到一些系统提供的动态库或者自己制作出的动态库或者静态库文件，cmake中也为我们提供了相关的加载动态库的命令。
CMake入门指南
weixin_34302561的博客
05-22 6257
CMake是一个比make更高级的编译配置工具，它可以根据不同平台、不同的编译器，生成相应的Makefile或者vcproj项目。通过编写CMakeLists.txt，可以控制生成的Makefile，从而控制编译过程。CMake自动生成的Makefile不仅可以通过make命令构建项目生成目标文件，还支持安装（make install）、测试安装的程序是否能正确执行（make test，或者cte...
弄懂CMake是什么，看完这篇就够了！
最新发布
qq_39599112的博客
09-17 1282
本文介绍了C++项目编译工具链，重点讲解了CMake、Make和g++的关系及使用方法。内容涵盖：1）手动编译单文件与多文件的差异，说明CMake诞生的必要性；2）CMake作为构建系统生成器与Make执行器的协作机制；3）跨平台使用指南（Windows生成VS项目/Linux生成Makefile）；4）多文件项目编译流程（CMakeLists编写→生成构建文件→Make编译）；5）现代机器人开发框架ROS/ROS2的编译特点（catkin_make/colcon工具）。
CMake最详细教程.pdf
03-01
CMake 教程高清文字版，图解CMake原理过程。非常详细。带书签。
window Cmake开发环境搭建
weixin_46935110的博客
06-13 1955
window Cmake开发环境搭建
Windows下CMake使用教程
热门推荐
RyanLN的博客
03-29 1万+
编译一个cpp文件 在终端里输入：g++ 函数名.cpp -o 期望函数名（若为c语言程序则输入） 例如：g++ arfupt.cpp -o app 编译结束后使用命令 .\app.exe去执行
CMake保姆级教程！！！
07-04
C++，cmake，makefile，
CMake保姆级教程2.pdf
02-26
CMake保姆级教程2.pdf
CMake保姆级教程1.pdf
02-26
CMake保姆级教程1.pdf
精选资源
### 【CMake项目构建工具】CMake保姆级教程：跨平台项目自动化构建与管理
04-03
内容概要：本文档详细介绍了CMake的基本概念、使用方法及其在项目构建中的优势。首先解释了CMake作为一种跨平台的项目构建工具，相比传统Makefile的优势在于简化编译构建过程、自动适应不同平台。接着，文档逐步介绍...
CMake保姆级教程【C_C++】：全面解锁跨平台项目构建之谜
CMake基础介绍 CMake是一个跨平台的自动化构建系统，它使用CMakeLists.txt文件作为项目的构建脚本，简化了编译环境的配置过程。本章将介绍CMake的基本概念和它在项目构建中所扮演的角色。 ## 1.1 CMake的起源和...
【CMake保姆级教程】制作动静态链接库、指定动静态库输出路径
m0_62599305的博客
12-22 6957
在软件开发中，我们经常听到动态链接库（Dynamic Link Library，DLL）和静态链接库（Static Link Library，LIB）的术语。它们是一种组织和共享代码的方式，有助于提高代码的可维护性和可重用性。本教程将使用CMake来创建动态链接库和静态链接库，为你提供一份简单易懂的指南，让你轻松理解这两种库的概念和制作过程。动态链接库是一种包含可执行代码和数据的文件，它可以在运行时被加载和执行。这种库的主要优势在于代码的共享，多个程序可以同时使用同一个动态链接库，从而减少内存占用。
Windows系统中 CMake 快速图解入门 ( 解决你的开发环境 )
键盘爱好者
07-30 2975
CMake是一个跨平台的自动化构建系统，它使用配置文件（CMakeLists.txt）来生成标准的构建文件，如Unix的Makefile或Windows的Visual Studio解决方案。 CMake 能够处理项目的组织、编译器选项、库依赖和目标文件的生成。 CMake 并不直接管理依赖，但它可以找到已安装在系统上的库，并根据需要生成适当的链接指令。 CMake 常用于C和C++项目，尤其是那些需要跨平台支持的项目。
CMake保姆级教程
bitjs的博客
07-25 1398
CMake是一个跨平台的项目构建工具，通过编写CMakeLists.txt文件替代复杂的Makefile，简化了构建流程。它支持自动生成适用于不同平台的构建文件，提高了跨平台开发效率。文章介绍了CMake的基本使用，包括环境准备、CMakeLists编写、变量定义、C++标准设置、输出路径指定等。重点讲解了如何制作和使用静态库/动态库，包括库文件生成、路径设置、头文件包含以及链接方式（link_libraries和target_link_libraries）。通过CMake可以高效管理项目构建过程，特别适合
windows下cmake安装和使用教程
hutaotaotao的博客
08-02 9679
windows下cmake安装和使用教程
Cmake使用教程
06-11
<think>首先，用户的问题是：“我想查找CMake的使用教程请问CMake使用教程|CMake入门指南|CMake配置详解”。这是一个查找CMake教程的请求。在系统级指令中，我需要：-所有行内数学表达式使用$...$格式（但在这个上下文中，CMake教程可能不涉及数学，所以可能不需要）。-独立公式使用$$...$$格式，并单独成段（同样，可能不适用）。-LaTeX语法正确。-使用中文回答。-生成相关问题。-回答中引用的段落末尾自然地添加引用标识，例如[^1].用户提供了站内引用：-引用[1]：讨论了CMake_SOURCE_DIR和基本构建步骤。-引用[2]：是关于CMake入门教程，包括Helloworld示例和命令详解。-引用[3]：提到了CMake帮助手册的使用。用户说：“上述引用仅供参考，并不是用户真正的需求，请尽可能多的参考用户上一次的问题和你的回答。”但在这个对话中，这是第一个用户消息，所以没有“上一次的问题”。系统指令提到“参考用户上一次的问题和你的回答”，但这里没有历史。所以，我应该直接回应用户的查询。关键点是：用户想要CMake的使用教程。所以，我需要提供CMake入门指南、配置详解的摘要或指导。响应结构：-基于系统指令，回答应结构清晰，帮助用户逐步解决问题。-使用中文。-在末尾生成相关问题。-如果有引用，末尾添加引用标识；但由于用户说引用仅供参考，我应该主要基于自己的知识提供可靠信息，但可以参考提供的引用。制定响应：1.**介绍CMake**：简述CMake是什么，为什么有用。2.**入门步骤**：提供基本的CMake使用教程，类似于引用[2]中的内容。3.**配置详解**：解释CMakeLists.txt的基本结构、常用命令如project(),add_executable(),等。4.**构建过程**：描述如何创建构建目录、运行cmake、make等。5.**参考提供的引用**：自然地融入引用。例如，在描述命令时，可以提到引用[2]中的例子。生成相关问题：在末尾，创建几个相关问题，比如基于教程的扩展问题。确保LaTeX：CMake教程不涉及数学，所以可能不需要数学表达式。如果出现变量等，可能需要使用$...$，但这里不太可能。最终响应结构：-开头解释CMake。-逐步讲解入门教程（HelloWorld示例）。-详细解释配置（CMakeLists.txt中的命令）。-总结如何编译安装。-添加引用标识，如果使用了参考信息。-§§相关问题§§部分：列出相关问题。问题用中文。相关问题示例：1.CMake如何管理多文件项目？2.CMake的缓存机制是什么？3.如何添加外部库依赖？引用：用户提供了引用标签[^1],[^2],[^3]，所以如果我引用，就用这些。例如：在描述project()命令时，可以引用引用[2]。保持自然。</think> ### CMake 入门教程和配置详解 CMake是一个跨平台的构建工具，广泛用于管理C++等语言的软件编译过程。它能生成标准的构建文件（如Makefile或Visual Studio项目），简化了从源代码到可执行文件的转换。本教程将逐步介绍CMake的基本使用方法，从最简单的Hello World项目开始，扩展到配置详解。内容基于通用知识和最佳实践，同时参考您提供的引用信息[^1][^2][^3]进行补充。 #### 1. **CMake 基础入门：Hello World 项目** 这是最基础的CMake项目，适合学习基本命令和构建流程。 - **步骤1: 创建项目文件** 在您的项目根目录下，创建一个名为`CMakeLists.txt`的文件。这个文件定义了项目的构建规则。以下是一个Hello World示例的完整内容（参考引用[^2]）： ```cmake # 指定最小CMake版本，确保兼容性（建议至少3.10） cmake_minimum_required(VERSION 3.10) # 设置项目名称（如“HelloWorld”） project(HelloWorld) # 创建可执行文件：目标名称为HelloWorld，源码文件为helloworld.cpp add_executable(HelloWorld helloworld.cpp) ``` 同时，创建一个源码文件`helloworld.cpp`： ```cpp #include <iostream> int main() { std::cout << "Hello, CMake World!" << std::endl; return 0; } ``` - **步骤2: 构建项目** 在命令行中，执行以下命令（参考引用[^1][^2]）。这包括： - 创建并进入`build`目录（隔离构建文件，保持源码整洁）。 - 运行`cmake`生成构建文件（如Makefile）。 - 编译并运行。 ```bash # 创建build目录（推荐方式） mkdir build cd build # 使用cmake生成构建文件（.. 表示上一级目录的CMakeLists.txt） cmake .. # 编译项目（在Linux/Unix使用make，Windows会生成VS工程） make # 运行可执行文件 ./HelloWorld ``` 输出应该为：`Hello, CMake World!` **注意**: 在Windows上，`cmake ..`会生成Visual Studio解决方案，可使用`cmake --build .`代替`make`。 这些步骤展示了CMake的最小工作流程，其中`cmake_minimum_required()`指定版本，`project()`定义项目属性，`add_executable()`添加编译目标[^2]。 #### 2. **CMake 配置详解：常用命令和功能** 理解CMakeLists.txt的配置是关键。以下是核心命令的解释和使用场景（参考引用[^2][^3]）。 - **基本命令详解**: - `cmake_minimum_required(VERSION x.y)`: 设置最低CMake版本，避免兼容性问题（如VERSION 3.10）。必须放在文件开头。 - `project(项目名 [VERSION 版本号] [LANGUAGES CXX])`: 定义项目名称，可添加版本和语言（CXX表示C++）。这会设置变量如`PROJECT_NAME`，在后续配置中可用。 - `add_executable(target名 源码文件)`: 创建一个可执行文件目标。例如，`add_executable(MyApp main.cpp)`。如果源码文件有多个，直接列出（如`main.cpp util.cpp`）。 - `add_library(target名 STATIC/SHARED 源码文件)`: 创建静态库或动态库（如`add_library(mylib STATIC lib.cpp)`）。 - **管理多文件项目**（参考引用[^1]）: 当项目包含多个源文件时，使用`file(GLOB ...)`或手动列出文件： ```cmake cmake_minimum_required(VERSION 3.10) project(MultiFileExample) # 方式1: 手动添加所有源码文件 add_executable(App main.cpp file1.cpp file2.cpp) # 方式2: 使用file命令自动搜集 file(GLOB SOURCES "src/*.cpp") add_executable(App ${SOURCES}) ``` **注意**: 使用`file(GLOB)`时需谨慎，因为它可能导致构建不稳定（新增文件时需重新运行cmake）。 - **添加编译器选项和依赖**: - `add_compile_options(...)`: 添加编译器标志（如`add_compile_options(-Wall -O2)`开启警告和优化）。查看帮助手册：`cmake --help-commands add_compile_options`[^3]。 - `find_package(库名 REQUIRED)`: 自动查找系统依赖库（如OpenCV），需配合`target_link_libraries()`。 - `target_link_libraries(target名 库名)`: 链接库到目标（如`target_link_libraries(MyApp mylib)`）。 - **变量和路径设置**: - CMake定义了内置变量，如`CMAKE_SOURCE_DIR`（项目根目录）、`CMAKE_BINARY_DIR`（构建目录）。例如，`CMAKE_SOURCE_DIR`指向定义了顶级CMakeLists.txt的文件夹[^1]。 - 自定义变量：`set(变量名 值)`，如`set(COMPILE_FLAGS "-std=c++11")`。 #### 3. **进阶功能：安装和自定义目标** 在入门后，扩展功能能提升项目管理： - **安装程序**: 在CMakeLists.txt中添加： ```cmake # 安装可执行文件到系统目录（默认/usr/local/bin） install(TARGETS HelloWorld DESTINATION bin) ``` 运行安装：在构建目录执行`make install`（或Windows的`cmake --build . --target install`）[^1]。 - **使用帮助手册**: CMake提供了完整的命令行帮助： - `cmake --help`: 查看基本用法。 - `cmake --help-command <命令>`: 获取命令详情（如`cmake --help-command add_executable`[^3]）。 - `cmake --help-variable <变量名>`: 查看变量解释。 - **跨平台提示**: - 在Windows上，cmake可能生成Visual Studio项目；在macOS，使用Xcode工具链。统一命令行：`cmake -G "Generator Name" ..`（如`-G "Visual Studio 17 2022"`）。 #### 4. **总结和推荐资源** 这个教程覆盖了从入门到配置的核心内容。实际项目中，建议： - 从简单项目开始练习。 - 使用官方文档或在线教程（如CMake官网）深化学习（参考引用[^2][^3]）。 - 在构建时始终使用隔离的`build`目录（最佳实践[^1]）。 如果您有特定项目问题（如添加外部库），请提供更多细节！我会进一步协助。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值