使用 CMake 构建项目:从设置到生成可执行文件
目录
使用 CMake 构建项目:从设置到生成可执行文件
一、项目准备
(一)项目结构
(二)CMakeLists.txt 文件
二、创建构建目录
三、运行 CMake 生成构建文件
常见生成器及英文全称
常见文件后缀及英文全称
四、构建项目
五、查找可执行文件
在软件开发过程中,构建项目是将源代码转换为可执行程序的关键步骤。CMake 作为一款强大的跨平台构建工具,能够帮助开发者轻松管理不同平台下的项目构建过程。本文将详细记录使用 CMake 构建项目并生成可执行文件的过程,同时介绍相关英文全称及文件后缀含义。
一、项目准备
(一)项目结构
首先确保项目目录结构合理。以一个简单的 C++ 项目为例,目录中通常包含源文件(如 main.cpp )和一个至关重要的 CMakeLists.txt 文件。
(二)CMakeLists.txt 文件
CMakeLists.txt 用于定义项目的构建规则,其英文全称为 “CMake List Text” 。以下是一个简单示例:
cmake_minimum_required(VERSION 3.0) # 指定所需的最低CMake版本,cmake_minimum_required 即指定CMake最低版本要求
project(testCmake) # 设置项目名称,project 用于设定项目名
add_executable(testCmake main.cpp) # 指定生成的可执行文件名称以及对应的源文件,add_executable 用于添加可执行文件构建规则
其中:
cmake_minimum_required:此指令用于指定构建项目所需的最低 CMake 版本。project:该指令设置项目的名称,后续生成的可执行文件等可能会与该名称相关。add_executable:此指令表示需要构建一个可执行文件,第一个参数为生成的可执行文件名称,第二个参数为对应的源文件。
二、创建构建目录
在项目根目录下创建一个专门用于存放构建产物的目录,常见命名如 build 。这一步可以通过命令行执行 mkdir build (mkdir 是 “make directory” 的缩写,意为创建目录),也可以在文件资源管理器中直接创建。
三、运行 CMake 生成构建文件
打开命令行工具,进入到构建目录(如 cd build ,cd 是 “change directory” 的缩写,意为切换目录)。然后运行 cmake 命令:
默认生成器:如果使用默认生成器(例如在 Windows 上使用 MinGW Makefiles 生成器),运行 cmake.. 。这里的 .. 表示上一级目录(即项目根目录),CMake 会读取项目根目录下的 CMakeLists.txt 文件,并生成相应的构建文件。指定生成器:若想指定特定生成器,比如生成适用于 Visual Studio 2022 的项目文件,运行 cmake -G "Visual Studio 17 2022".. 。其中 -G 是 “generator” 的缩写,用于指定生成器类型。
常见生成器及英文全称
Visual Studio 17 2022:Generates Visual Studio 2022 project files. 用于生成 Visual Studio 2022 项目文件。Visual Studio 16 2019:Generates Visual Studio 2019 project files. 生成 Visual Studio 2019 项目文件。MinGW Makefiles:Generates a make file for use with mingw32 - make. 生成适用于 mingw32 - make 的 makefile 文件。Unix Makefiles:Generates standard UNIX makefiles. 生成标准 UNIX makefiles。
常见文件后缀及英文全称
.cpp:C - Plus - Plus source file ,C++ 源文件。.txt:Text file ,文本文件,如 CMakeLists.txt 、CMakeCache.txt 等。.sln:Solution file in Visual Studio ,Visual Studio 解决方案文件,用于组织项目中的多个项目。.vcxproj:Visual C++ Project file in Visual Studio ,Visual Studio 中的 Visual C++ 项目文件。.make:Makefile - related file ,与 Makefile 相关的文件,不过在 CMake 中常见的是 Makefile ,它是用于构建项目的脚本文件。
四、构建项目
根据生成的构建文件,使用相应的构建工具进行项目构建:
Makefile 构建:如果生成的是 Makefile (如使用 MinGW Makefiles 生成器),在命令行中执行 mingw32 - make (在 Linux 或 macOS 上使用 Unix Makefiles 生成器时,执行 make )。make 工具会根据 Makefile 中的规则编译源文件并链接生成可执行文件。Visual Studio 项目构建:在构建目录中找到生成的 .sln 文件,用 Visual Studio 打开它,然后在 Visual Studio 中选择相应的配置(如 Debug 或 Release),点击编译按钮(或使用快捷键)进行编译。
五、查找可执行文件
构建成功后,可执行文件通常会生成在构建目录中。例如,在上述示例中,testCmake.exe 就在 build 目录下。可以在命令行中通过运行该可执行文件(如 testCmake.exe )来测试程序是否正常运行。
通过以上步骤,我们就完成了使用 CMake 构建项目并生成可执行文件的全过程。了解相关英文全称和文件后缀含义,有助于更深入地理解和使用 CMake 这一工具。