草莓熊Lotso个人主页❄️个人专栏:《C知识分享》 《Linux 入门到实践零基础也能懂》✨生活是默默的坚持毅力是永久的享受 博主简介文章目录前言一. CMake核心认知到底解决了什么问题1.1 传统C/C构建的两大核心痛点1.2 CMake的核心功能1.3 CMake的核心优势1.4 主流IDE的CMake支持二. 环境搭建一分钟搞定CMake开发环境2.1 CMake安装Ubuntu环境2.2 VS Code CMake核心插件安装三. 快速上手你的第一个CMake Hello World工程3.1 工程目录结构3.2 编写业务源码main.cpp3.3 核心配置CMakeLists.txt逐行深度解析3.4 完整构建执行流程四. CMake核心命令行工具工程构建全流程指令详解4.1 构建系统生成cmake -S/-B 核心参数4.2 编译链接cmake --build 统一构建命令4.3 集成测试ctest 自动化测试框架4.4 本地安装cmake --install 产物部署4.5 打包分发cpack 安装包生成4.6 脚本模式cmake -P 非构建自动化任务4.7 外部命令调用cmake -E 跨平台命令行工具4.8 帮助命令cmake --help 官方文档快速查询五. 工业级完整示例全功能CMake工程结尾前言做C/C开发的同学一定都被工程构建问题折磨过Linux下要手写复杂的Makefile依赖关系、增量编译、跨目录管理稍有不慎就出问题中大型项目手写维护几乎是噩梦 Windows下要对着Visual Studio的工程属性一顿配置换个版本、换个机器就可能编译失败想做跨平台开发要同时维护Linux的Makefile、Windows的vcxproj、Mac的Xcode工程光是配置同步就能耗掉大半开发时间。而CMake的出现彻底解决了这些痛点。作为C/C领域事实上的工程构建标准它只需要你编写一份通用的CMakeLists.txt配置文件就能自动生成对应平台的构建配置真正实现「一处配置到处构建」。本文就带你从0到1彻底吃透CMake的核心用法与全流程操作。一. CMake核心认知到底解决了什么问题1.1 传统C/C构建的两大核心痛点在没有CMake的时代C/C工程构建始终绕不开两个无解的难题跨平台适配成本极高不同平台有完全不同的构建系统Linux依赖Makefile、Windows依赖Visual Studio的工程配置每新增一个平台就要手写一套适配配置维护成本指数级上升。手写构建配置门槛高Makefile语法晦涩复杂中大型项目的依赖管理、链接规则、增量编译逻辑手写难度极大极易出现隐藏bug且新人上手成本极高。1.2 CMake的核心功能CMake最核心的能力就是自动生成各个平台构建系统对应的配置文件。我们可以用一个通俗的类比理解传统构建 纯手工雕刻月饼每个模具平台都要单独手工制作耗时耗力还容易出错CMake 自动模具生成器你只需要给出月饼的设计图纸CMakeLists\.txt它自动给你生成对应平台的模具Makefile/vcxproj等再调用对应工具完成「月饼生产」编译链接。1.3 CMake的核心优势对比传统构建方式CMake的优势可以用下表清晰体现核心能力传统构建方式CMake构建方式改进效果跨平台构建人工编辑各平台配置文件自动生成对应平台构建配置一处配置到处构建学习与开发成本Makefile语法复杂上手难度高语法简单表达能力强大大幅降低学习成本提升研发效率包与依赖管理手动查找、配置依赖库自动查找与管理依赖规范统一彻底解决依赖配置混乱问题IDE支持度不同IDE配置规则完全不同主流IDE全量原生支持一处配置多IDE无缝使用1.4 主流IDE的CMake支持目前几乎所有主流C/C开发IDE都对CMake提供了原生级支持无需额外复杂配置即可直接使用IDE厂商跨平台支持CMake核心支持特点Visual StudioMicrosoftWindows最强Windows C开发能力IntelliSense原生集成Visual Studio CodeMicrosoftWindows/Linux/Mac轻量级丰富插件生态远程开发适配极佳CLionJetBrainsWindows/Linux/Mac智能代码分析重构能力跨平台开发首选CursorAnysphereWindows/Linux/MacAI原生编程Claude/GPT-4集成智能代码生成所有主流IDE均支持CMake语法高亮、代码补全、配置文件自动解析与一键构建这也是CMake能成为行业标准的重要原因。二. 环境搭建一分钟搞定CMake开发环境本文所有操作均基于Ubuntu 24.04 VS Code Remote SSH环境也是工业级Linux C开发的主流环境Windows/Mac环境操作逻辑基本一致。2.1 CMake安装Ubuntu环境CMake的安装极其简单Ubuntu系统可直接通过apt包管理器安装# 1. 安装CMakesudoaptinstallcmake# 2. 验证安装查看版本cmake--version安装成功后会输出如下信息本文要求CMake最低版本为3.18Ubuntu 24.04默认apt安装的3.28版本完全满足要求cmake version 3.28.3 CMake suite maintained and supported by Kitware (kitware.com/cmake).不同Linux发行版的预装CMake版本参考如下系统版本越新默认CMake版本越高Linux发行版系统版本预装CMake版本Ubuntu LTS22.043.22Ubuntu LTS24.043.28Debian12 (Bookworm)3.22Fedora393.28Arch Linux滚动更新最新稳定版2.2 VS Code CMake核心插件安装VS Code需要安装4个核心CMake插件即可获得完整的开发支持安装步骤打开VS Code按下Ctrl\Shift\X打开扩展面板搜索并安装以下4个插件CMake基础语法高亮与核心支持CMake Tools微软官方提供的CMake扩展提供一键构建、调试等能力CMake Language Support更完善的语法补全与高亮CMake IntelliSence智能代码分析与错误实时检查安装完成后插件会提供两大核心能力对CMakeLists\.txt提供语法高亮、代码补全减少手动输入错误智能语法分析与错误检查实时提示配置文件中的语法问题与潜在bug。三. 快速上手你的第一个CMake Hello World工程我们用一个最简单的Hello World程序带你走完CMake工程的完整构建流程理解CMakeLists\.txt的核心编写规则。3.1 工程目录结构首先创建最简工程目录结构如下hello_world/ ├── CMakeLists.txt # CMake核心配置文件必须叫这个名字 └── main.cpp # 程序源代码3.2 编写业务源码main.cpp先编写最简单的C Hello World程序代码如下// main.cpp#includeiostreamintmain(){std::couthello world!std::endl;return0;}3.3 核心配置CMakeLists.txt逐行深度解析这是CMake工程的核心我们先写最基础的3行配置就能完成整个工程的构建每一行都有不可替代的作用# 1. 设置CMake最低版本要求 cmake_minimum_required(VERSION 3.18) # 2. 设置项目名称 project(helloWorld) # 3. 添加构建目标可执行文件 add_executable(main main.cpp)下面我们逐行拆解每一行代码的作用与底层逻辑第1行cmake_minimum_required(VERSION 3.18)这一行必须放在CMakeLists.txt的最顶部核心作用是强制检查当前环境的CMake版本是否满足项目要求。CMake是持续迭代的工具不同版本会引入新的语法、命令、模块如果项目用了高版本特性而用户本地版本过低会出现无法解析、行为异常等模糊错误。这个命令会在配置阶段就执行检查如果本地版本低于3.18直接终止并明确报错避免后续出现未知问题如果版本满足要求才会继续执行后续配置流程。第2行project(helloWorld)这一行用于定义项目名称是CMake工程的必备配置执行后会自动生成一系列内置变量比如PROJECT_NAME值为helloWorld、PROJECT_SOURCE_DIR项目源码根目录、PROJECT_BINARY_DIR项目构建目录等供后续配置使用。工业级开发中还可以扩展这个命令指定项目版本、支持的语言等project(helloWorld VERSION 1.0.0 LANGUAGES C CXX )第3行add_executable(main main.cpp)这是构建的核心命令这里要先理解CMake中最核心的概念目标Target。在CMake中「目标」代表一个需要被生成的实体最常见的就是可执行文件、静态库/动态库它是现代CMake的核心操作对象。这一行代码的含义告诉CMake我们要生成一个名为main的可执行文件目标这个可执行文件由main.cpp源码编译链接而来等价于直接执行g命令g main.cpp -o main但CMake会自动处理依赖、增量编译、跨平台适配等所有问题。3.4 完整构建执行流程配置文件写好后我们就可以执行构建了这里强烈推荐使用「源外构建」也是工业级开发的标准规范。源内构建 vs 源外构建源内构建直接在源码根目录执行cmake .所有生成的中间文件、构建产物都和源码混在一起会污染源码树清理极其麻烦仅用于临时测试不推荐使用。源外构建创建一个独立的build目录所有构建相关的文件都放在这个目录里和源码完全隔离保持源码树纯净清理时直接删除build目录即可是官方推荐的标准方式。完整构建步骤# 1. 进入项目根目录cdhello_world# 2. 创建构建目录并进入实现源外构建mkdirbuildcdbuild# 3. 配置阶段执行cmake解析CMakeLists.txt生成Makefile构建文件# ../ 指向源码根目录CMakeLists.txt所在目录cmake../# 4. 构建阶段执行编译链接生成可执行文件make# 跨平台通用写法无需关心底层是make还是msbuildcmake --build .# 5. 运行生成的可执行文件./main执行cmake ../后CMake会完成编译器检测、环境校验、依赖解析最终生成Makefile输出如下关键日志-- The C compiler identification is GNU13.3.0 -- The CXX compiler identification is GNU13.3.0 -- Detecting C compiler ABI info -done-- Detecting CXX compiler ABI info -done-- Configuringdone(0.4s)-- Generatingdone(0.0s)-- Build files have been written to: /home/bit/workspace/hello_world/build执行make后会完成源码的编译链接输出如下日志代表构建成功[50%]Building CXX object CMakeFiles/main.dir/main.cpp.o[100%]Linking CXX executable main[100%]Built target main最后执行./main即可看到程序输出hello world!四. CMake核心命令行工具工程构建全流程指令详解一个完整的CMake工程生命周期包含配置、构建、测试、安装、打包分发五大核心环节CMake提供了完整的命令行工具链覆盖全流程下面我们逐个拆解核心命令的用法与实战。先看CMake工程完整的构建流程图理解每个环节的作用编写工程代码 → 配置阶段cmake → 生成阶段生成构建配置文件 → 编译链接cmake --build/make → 自动化测试ctest → 本地安装cmake --install/make install → 打包分发cpack前置代码准备4.1 构建系统生成cmake -S/-B 核心参数cmake命令最核心的作用就是解析CMakeLists.txt生成对应平台的构建系统文件比如Linux的Makefile。官方推荐的标准语法格式如下也是最通用、最不易出错的写法cmake[options]-S源码根目录-B构建目录核心参数详解参数核心作用-S显式指定源文件根目录必须包含顶级CMakeLists.txt文件对应「源文件树」-B显式指定构建目录所有生成的中间文件、构建产物都放在这里对应「构建树」目录不存在会自动创建比如我们的hello_world工程无需手动创建build目录一条命令即可完成配置# 在项目根目录执行自动创建build目录完成配置 cmake -S . -B build这个命令完全等价于之前的mkdir build amp;amp; cd build amp;amp; cmake ../但更简洁、更规范跨平台兼容性更好。配置完成后构建目录下会生成CMakeCache.txt文件这是CMake的缓存文件存储了编译器路径、配置选项、用户自定义变量等所有环境信息后续重新执行cmake时会复用缓存中的内容提升配置效率。4.2 编译链接cmake --build 统一构建命令配置完成后就可以执行编译链接了CMake提供了跨平台通用的构建命令无需关心底层是Linux的make、Windows的msbuild还是Mac的xcodebuildcmake--build构建目录[选项]实战用法# 构建build目录下的工程默认全量构建cmake--buildbuild# 等价于进入build目录执行 makecdbuildmake这个命令的核心优势是跨平台统一在Windows下无需切换到msbuild命令在Mac下无需用xcodebuild一套命令全平台通用非常适合CI/CD自动化流水线。额外常用选项--target lt;目标名gt;只构建指定的目标而非全量构建--config Release/Debug指定构建类型Release发布版/Debug调试版-j lt;线程数gt;指定多线程编译提升编译速度比如cmake --build build -j8。4.3 集成测试ctest 自动化测试框架CMake提供了原生的集成测试框架CTest用于自动化执行单元测试、功能测试无需引入第三方框架即可实现测试用例的统一管理与执行。步骤1编写测试代码与CMake配置我们新增一个test.cpp测试文件用assert断言验证逻辑正确性// test.cpp#includeiostream#includecassertintmain(){// 测试用例验证123assert(123);std::couttest passed!std::endl;return0;}修改CMakeLists.txt集成CTest测试能力或者就直接看我最开始提供好的因为我例子里面用的也都是那个# 1. 最低版本要求 cmake_minimum_required(VERSION 3.18) # 2. 项目名称 project(helloWorld) # 3. 生成业务可执行文件 add_executable(main main.cpp) # 4. 生成测试用的可执行文件 add_executable(testAdd test.cpp) # 5. 开启CTest测试功能 include(CTest) # 6. 添加测试用例 add_test( NAME Case_Add # 测试用例名称唯一标识 COMMAND testAdd # 测试执行的命令即我们的测试程序 )步骤2执行测试命令重新配置构建后就可以用ctest命令执行测试了# 进入构建目录cdbuild# 1. 执行所有测试用例ctest# 2. 等价写法make会自动调用ctestmaketest测试执行成功的输出如下Test project /home/bit/workspace/hello_world/build Start1: Case_Add1/1 Test#1: Case_Add .................... Passed 0.00 sec100% tests passed,0tests failed out of1Total Testtime(real)0.00sec测试原理CTest通过测试程序的退出码判断结果程序正常退出退出码0则测试通过异常退出退出码非0比如断言失败则测试失败。如果我们修改测试代码让断言失败ctest会明确提示失败并生成详细的错误日志日志路径为Testing/Temporary/LastTest.log可直接查看失败原因。4.4 本地安装cmake --install 产物部署测试通过后我们可以通过install功能将编译好的二进制、库文件、头文件安装到系统的标准路径实现全机器范围内的共享使用其他程序无需指定路径即可直接调用。步骤1CMakeLists.txt添加安装配置# 1. 最低版本要求 cmake_minimum_required(VERSION 3.18) # 2. 项目名称 project(helloWorld) # 3. 生成可执行文件 add_executable(main main.cpp) # 4. 引入GNUInstallDirs模块定义了各平台标准安装路径 include(GNUInstallDirs) # 5. 配置安装规则安装main可执行目标 install(TARGETS main)GNUInstallDirs是CMake内置模块严格定义了各系统的标准安装目录Linux下默认前缀为/usr/local可执行文件默认安装到${CMAKE_INSTALL_PREFIX\}bin即/usr/local/bin库文件默认安装到${CMAKE_INSTALL_PREFIX}/lib头文件默认安装到${CMAKE_INSTALL_PREFIX}/include。步骤2执行安装命令# 进入构建目录cdbuild# 1. 执行安装需要sudo权限写入系统目录sudocmake--install.# 2. 等价写法sudomakeinstall安装成功后输出如下日志[100%]Built target main Install the project... -- Install configuration:-- Installing: /usr/local/bin/main此时可执行文件已经被安装到系统标准路径在任意目录下直接输入main即可运行程序无需指定路径shell会自动找到对应的二进制文件。底层原理安装操作本质是执行CMake生成的cmake_install.cmake脚本完成文件的拷贝、权限设置、路径配置等操作我们也可以直接通过脚本模式执行这个脚本sudocmake-Pcmake_install.cmake4.5 打包分发cpack 安装包生成除了本地安装CMake还提供了cpack工具用于将编译好的二进制、库文件打包成压缩包或安装包实现跨机器分发与共享。步骤1CMakeLists.txt添加打包配置# 1. 最低版本要求 cmake_minimum_required(VERSION 3.18) # 2. 项目名称 project(helloWorld) # 3. 生成可执行文件 add_executable(main main.cpp) # 4. 安装配置 include(GNUInstallDirs) install(TARGETS main) # 5. 开启CPack打包功能 include(CPack) # 可选配置包名称、版本、生成格式 set(CPACK_PACKAGE_NAME helloWorld) set(CPACK_PACKAGE_VERSION 1.0.0) set(CPACK_GENERATOR TGZ;STGZ) # 生成tar.gz压缩包和自解压脚本注意cpack默认会收集install指令指定的目标文件所以必须先配置install规则才能正常打包。步骤2执行打包命令# 进入构建目录cdbuild# 执行打包需要sudo权限读取安装清单sudocpack打包成功后会在构建目录下生成对应的安装包文件helloWorld-1.0.0-Linux.tar.gztar.gz格式压缩包helloWorld-1.0.0-Linux.sh自解压安装脚本解压压缩包后会得到完整的目录结构包含bin/main可执行文件拷贝到其他机器即可直接运行实现一键分发。cpack执行原理设置临时安装目录执行安装流程收集临时目录中的所有安装文件按照指定的格式执行打包拷贝到构建目录。4.6 脚本模式cmake -P 非构建自动化任务CMake提供了脚本模式语法如下cmake-Pcmake脚本文件脚本模式的核心特点不会执行配置和生成流程不会生成任何构建产物只会执行脚本中的CMake命令非常适合处理跨平台的自动化任务比如文件处理、环境检查、部署打包等。最典型的应用就是前面提到的安装脚本CMake生成的cmake_install.cmake就是一个标准的CMake脚本通过\-P参数执行cmake-Pcmake_install.cmake我们也可以自己写一个简单的脚本比如test\.cmake# test.cmake message(Hello CMake Script Mode!) # 执行文件拷贝 file(COPY main.cpp DESTINATION /tmp/) message(File copy completed!)执行脚本cmake-Ptest.cmake脚本模式无需CMakeLists.txt无需配置构建流程直接执行CMake命令是实现跨平台自动化的利器。4.7 外部命令调用cmake -E 跨平台命令行工具CMake提供了-E参数封装了大量跨平台的通用命令解决了Windows和Linux shell命令不兼容的问题比如Linux的cp和Windows的copyLinux的rm和Windows的del用cmake -E可以一套命令全平台通用。常用实战命令# 1. 文件拷贝cmake-Ecopy main.cpp /tmp/main.cpp# 2. 删除文件/目录cmake-Erm-rfbuild/# 3. 创建目录cmake-Emake_directory build/# 4. 打印内容cmake-EechoHello CMake# 5. 解压压缩包cmake-Etarxvf helloWorld-1.0.0-Linux.tar.gz在CMake自动生成的Makefile中大量使用了cmake -E命令保证了构建脚本的跨平台兼容性。4.8 帮助命令cmake --help 官方文档快速查询CMake提供了完善的帮助命令是学习CMake、查询语法的最佳方式无需翻阅网页直接在终端即可查询官方权威文档。常用帮助命令# 1. 查看cmake完整帮助手册cmake--help# 2. 查看指定命令的详细用法比如add_executablecmake --help-command add_executable# 3. 查看指定模块的详细用法比如GNUInstallDirscmake --help-module GNUInstallDirs# 4. 查看指定变量的详细说明cmake --help-variable CMAKE_INSTALL_PREFIX五. 工业级完整示例全功能CMake工程最后我们把前面所有知识点整合起来给出一个工业级标准的完整CMakeLists\.txt包含了可执行文件生成、测试、安装、打包全流程可直接复制到你的项目中使用工程目录结构cmake_full_demo/ ├── CMakeLists.txt ├── main.cpp └── test.cpp1. main.cpp业务源码#includeiostreamintmain(){std::coutHello CMake Full Demo!std::endl;return0;}2. test.cpp测试源码#includeiostream#includecassert// 模拟业务函数intadd(inta,intb){returnab;}intmain(){assert(add(1,2)3);assert(add(100,200)300);std::coutAll test cases passed!std::endl;return0;}3. CMakeLists.txt全功能配置逐行注释# 基础配置 # 强制最低CMake版本 cmake_minimum_required(VERSION 3.18) # 项目配置名称、版本、支持语言 project(CMakeFullDemo VERSION 1.0.0 DESCRIPTION CMake全功能工程示例 LANGUAGES C CXX ) # 构建目标 # 生成业务可执行文件 add_executable(demo main.cpp) # 生成测试可执行文件 add_executable(demo_test test.cpp) # 测试配置 # 集成CTest测试框架 include(CTest) # 添加测试用例 add_test( NAME Demo_Test_All COMMAND demo_test ) # 安装配置 # 引入标准安装路径模块 include(GNUInstallDirs) # 配置可执行文件安装规则 install(TARGETS demo RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} ) # 打包配置 # 集成CPack打包工具 include(CPack) # 包基础信息配置 set(CPACK_PACKAGE_NAME CMakeFullDemo) set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION}) set(CPACK_PACKAGE_DESCRIPTION_SUMMARY CMake全功能工程示例) set(CPACK_GENERATOR TGZ;STGZ) # 生成tar.gz和自解压包4. 一键执行全流程命令# 1. 配置工程cmake-S.-Bbuild# 2. 编译构建cmake--buildbuild-j8# 3. 执行自动化测试cdbuildctest# 4. 安装到系统sudocmake--installbuild# 5. 打包分发sudocpack-GTGZ--configbuild/CPackConfig.cmake结尾 我是草莓熊 Lotso若这篇技术干货帮你打通了学习中的卡点 【关注】跟我一起深耕技术领域从基础到进阶见证每一次成长 ❤️ 【点赞】让优质内容被更多人看见让知识传递更有力量 ⭐ 【收藏】把核心知识点、实战技巧存好需要时直接查、随时用 【评论】分享你的经验或疑问比如曾踩过的技术坑一起交流避坑 ️ 【投票】用你的选择助力社区内容方向告诉大家哪个技术点最该重点拆解 技术之路难免有困惑但同行的人会让前进更有方向愿我们都能在自己专注的领域里一步步靠近心中的技术目标结语本文从C/C工程构建的痛点出发完整讲解了CMake的核心原理、环境搭建、Hello World入门再到配置、构建、测试、安装、打包的全流程命令行工具所有内容均来自工业级项目的实战规范。CMake的核心价值在于它把开发者从繁琐的平台适配、手写构建配置中解放出来让我们能专注于代码本身。本文覆盖了CMake入门的所有核心知识点掌握这些内容你已经可以应对90%以上的中小型C/C工程构建需求。后续想要深入学习还可以继续探索CMake的静态库/动态库管理、第三方依赖引入、find_package包管理、大型项目的多目录架构设计等内容CMake作为C/C开发的必备技能值得每一位开发者深入掌握。✨把这些内容吃透超牛的放松下吧✨ʕ˘ᴥ˘ʔづきらど