在Visual Studio中如何使用CMake来创建C++项目-C++-PHP中文网

在Visual Studio中使用CMake开发C++项目，核心是通过CMakeLists.txt实现跨平台构建，同时利用VS强大IDE功能；主要路径包括打开现有CMake项目或使用模板创建新项目，VS会自动识别并配置，提供目标视图、智能感知、调试支持，并通过CMakeSettings.json管理多平台配置，显著提升开发效率与项目可维护性。

在visual studio中如何使用cmake来创建c++项目

在Visual Studio中使用CMake创建C++项目，核心思想是让VS直接识别并管理你的

CMakeLists.txt

登录后复制

文件，从而利用CMake的跨平台构建能力，同时享受Visual Studio强大的IDE功能，无论是打开一个现有CMake项目还是从零开始，过程都相当直接和流畅。

我个人觉得，当你踏入现代C++开发，尤其是在需要跨平台或者管理复杂依赖时，CMake几乎是绕不开的。它不像老旧的

vcxproj

登录后复制

文件那样平台绑定，而是提供了一种更抽象、更灵活的方式来描述你的项目结构。

解决方案

在Visual Studio中利用CMake来构建C++项目，主要有两种路径，但殊途同归，都是为了让VS理解并执行你的

CMakeLists.txt

登录后复制

。

立即学习“C++免费学习笔记（深入）”；

1. 打开一个现有的CMake项目

这大概是我最常用的场景了。你可能从GitHub上克隆了一个项目，或者同事发来一个CMake驱动的工程。

步骤一：选择“打开文件夹” 启动Visual Studio，选择“文件”>“打开”>“文件夹...”。然后导航到你的CMake项目根目录，也就是包含
```
CMakeLists.txt
```
登录后复制
文件的那个文件夹。
步骤二：Visual Studio的自动识别与配置 Visual Studio会非常智能地识别出这是一个CMake项目，并自动开始配置。你会看到输出窗口里CMake在运行，生成缓存文件（
```
CMakeCache.txt
```
登录后复制
）和构建系统文件（比如Ninja或Visual Studio自身的解决方案文件）。这个过程可能需要一些时间，取决于你的项目大小和依赖复杂程度。
步骤三：探索项目结构 配置完成后，你会发现“解决方案资源管理器”窗口变成了“CMake目标视图”。这里会清晰地展示你的CMake目标（可执行文件、库等），你可以像操作传统VS项目一样，选择启动项、构建特定目标。有时，我也会切换回“文件夹视图”，这样能更直观地看到文件系统结构，这在处理一些非代码文件或者想快速定位某个源文件时特别方便。
步骤四：构建与调试 选择一个CMake目标作为启动项（通常是你的主程序），然后直接点击“本地Windows调试器”按钮或者按F5。VS会先构建选定的目标，然后启动调试器。断点、变量查看等功能都和传统VS项目无异，体验非常棒。

2. 从零开始创建一个新的CMake项目

如果你想开始一个新的项目，并且打算一开始就用CMake来管理，Visual Studio也提供了模板。

步骤一：新建项目 选择“文件”>“新建”>“项目...”。
步骤二：选择CMake模板 在项目模板搜索框中输入“CMake”，你会看到“CMake项目”或“CMake项目（控制台应用程序）”等选项。我通常会选择“CMake项目（控制台应用程序）”，因为它会为你生成一个基本的
```
CMakeLists.txt
```
登录后复制
和一个
```
main.cpp
```
登录后复制
，省去了手动创建的麻烦。
步骤三：理解初始
```
CMakeLists.txt
```
登录后复制
新创建的项目会包含一个简单的
```
CMakeLists.txt
```
登录后复制
，通常是这样的：
```
cmake_minimum_required (VERSION 3.8)
project (MyNewCMakeProject VERSION 1.0)

add_executable (MyNewCMakeProject "MyNewCMakeProject.cpp")
```
登录后复制
- ```
cmake_minimum_required
```
  登录后复制
  : 指定CMake的最低版本要求。
- ```
project
```
  登录后复制
  : 定义项目名称和版本。
- ```
add_executable
```
  登录后复制
  : 创建一个可执行目标，指定源文件。如果你要创建库，会用
```
add_library
```
  登录后复制
  。
步骤四：添加源文件与依赖 你可以像往常一样在解决方案资源管理器中添加新的
```
.cpp
```
登录后复制
或
```
.h
```
登录后复制
文件。添加后，记得更新
```
CMakeLists.txt
```
登录后复制
，把新文件加入到相应的
```
add_executable
```
登录后复制
或
```
add_library
```
登录后复制
命令中。对于外部库依赖，你会用到
```
find_package
```
登录后复制
、
```
target_link_libraries
```
登录后复制
、
```
target_include_directories
```
登录后复制
等CMake命令。
步骤五：构建与运行 和打开现有项目一样，选择目标，然后构建和调试。

为什么在Visual Studio中使用CMake对C++项目开发至关重要？

说实话，刚开始接触CMake时，我曾觉得它不过是给构建系统又加了一层抽象，有点多余。但随着项目复杂度的增加，尤其是需要兼顾Windows、Linux甚至macOS平台时，我才真正体会到CMake的“香”。它不仅仅是方便，更是现代C++开发的一种必然趋势。

首先，跨平台兼容性是其核心优势。我们写C++代码，很多时候是为了高性能，而高性能的应用往往需要部署在各种环境中。传统的

.vcxproj

登录后复制

文件是Visual Studio特有的，在Linux下根本无法识别。CMake则不然，它生成的是平台无关的构建脚本（比如Unix Makefiles、Ninja或Visual Studio解决方案），这意味着你可以在一个

CMakeLists.txt

登录后复制

文件里描述你的项目，然后在Windows上用VS构建，在Linux上用GCC/Clang构建，甚至在macOS上用Xcode构建。这极大地减少了多平台维护的工作量。我曾经手头一个项目，需要在Windows上用MSVC编译，同时在嵌入式Linux板上用交叉编译工具链编译，CMake在这里简直是救星，一套配置搞定所有。

其次，简化复杂项目管理。大型C++项目往往包含多个子项目、库、测试用例，还有各种第三方依赖。手动管理这些依赖关系、编译选项、头文件路径简直是噩梦。CMake提供了一套声明式语言来描述这些关系，比如

target_link_libraries

登录后复制

可以清晰地表达目标之间的依赖，

target_include_directories

登录后复制

则统一管理头文件路径。这使得项目结构更清晰，也更容易维护。当团队成员增加，或者项目迭代时，这种清晰度带来的效率提升是巨大的。

在Android

本文档主要讲述的是在Android-Studio中导入Vitamio框架；介绍了如何将Vitamio框架以Module的形式添加到自己的项目中使用,这个方法也适合导入其他模块实现步骤。希望本文档会给有需要的朋友带来帮助；感兴趣的朋友可以过来看看

查看详情

再者，与Visual Studio的无缝集成。虽然CMake是独立于IDE的构建系统，但Visual Studio对其支持得非常好。从我前面提到的自动识别、CMake目标视图，到强大的IntelliSense、调试器支持，一切都感觉像是原生支持。你不需要离开VS环境去手动运行CMake命令，一切都在IDE内部完成。这种集成度让开发者能够专注于代码本身，而不是纠结于构建工具的细节。我记得有一次，我甚至在VS里直接远程调试一个运行在WSL（Windows Subsystem for Linux）中的CMake项目，那种体验真是太棒了，感觉就像在本地调试一样。

最后，它也推动了现代C++生态的标准化。现在很多流行的C++库（如Boost、OpenCV、Eigen）都使用CMake作为其构建系统。这意味着如果你也使用CMake，就能更容易地集成这些库，而无需为每个库单独编写构建脚本。这形成了一个良性循环，使得整个C++社区的协作和共享变得更加高效。

如何配置和调试基于CMake的C++项目以优化开发效率？

配置和调试是开发过程中最耗时的部分之一。在CMake和Visual Studio的结合下，我们可以通过一些技巧来显著提升效率，避免不必要的“摩擦”。

首先，

CMakeSettings.json

登录后复制

是你的配置中心。当你在Visual Studio中打开一个CMake项目时，VS会在

.vs

登录后复制

隐藏文件夹下生成一个

CMakeSettings.json

登录后复制

文件。这个文件是Visual Studio特有的，它允许你定义多个CMake配置，比如Debug x64、Release x86、或者针对WSL的Linux配置。你可以通过它来：

定义不同的构建类型和架构：比如设置
```
cmakeCommandArgs
```
登录后复制
来传递不同的参数给CMake，或者
```
variables
```
登录后复制
来定义CMake变量。
指定工具链文件（toolchain file）：这对于交叉编译非常关键。你可以在这里指定一个
```
.cmake
```
登录后复制
文件，它会告诉CMake使用哪个编译器、哪个SDK等等。
设置环境变量：在构建或运行程序前，可能需要设置一些特定的环境变量，
```
CMakeSettings.json
```
登录后复制
也能做到。我经常会为我的项目创建多个配置，比如一个用于本地开发（Debug x64），一个用于性能测试（Release x64），还有一个用于WSL上的Linux构建。通过VS顶部的下拉菜单轻松切换，这比手动修改CMake变量方便太多了。

其次，调试体验的优化。VS的调试器是其最强大的功能之一。对于CMake项目，它同样表现出色。

选择正确的启动目标：在“CMake目标视图”中，确保你选择了你想要调试的可执行文件作为启动项。
launch.vs.json
登录后复制
用于高级调试配置：有时候，你的程序需要命令行参数，或者需要以特定的工作目录启动。这时，你可以在
```
.vs
```
登录后复制
文件夹下创建或编辑
```
launch.vs.json
```
登录后复制
文件。这个文件允许你定义多个调试配置，每个配置可以指定可执行文件、命令行参数、环境变量、工作目录等。这对于自动化测试或者特定场景的调试非常有用。我曾经用它来为同一个可执行文件设置不同的命令行参数，从而快速测试不同的功能路径。
远程调试：前面提到了WSL调试，这其实是Visual Studio远程调试能力的一部分。通过在
```
CMakeSettings.json
```
登录后复制
中配置远程连接（比如SSH），你可以直接在VS中构建和调试运行在远程Linux机器上的CMake项目。这对于开发嵌入式系统或服务器端应用来说，简直是神器。

当然，处理常见的CMake问题也是提升效率的关键。

缓存问题：CMake会生成一个缓存，有时候这个缓存会变得“脏”或过时。如果遇到奇怪的构建错误，或者CMake似乎没有识别你的最新修改，尝试在VS的“CMake”菜单中选择“删除缓存并重新配置”。这通常能解决大部分配置问题。
CMakeLists.txt
登录后复制
语法错误：CMake的错误信息有时会比较晦涩。学会查看CMake的输出日志，定位错误发生的行数，并理解常见的CMake命令用法是基本功。
依赖管理：确保所有外部依赖都被正确地
```
find_package
```
登录后复制
或
```
FetchContent
```
登录后复制
引入，并且
```
target_link_libraries
```
登录后复制
被正确使用。依赖路径问题是初学者最常遇到的坑。

将现有Visual Studio项目迁移到CMake有哪些最佳实践和常见挑战？

将一个传统的Visual Studio项目（

.vcxproj

登录后复制

）迁移到CMake，就像是给一栋老房子做现代化改造，既有激动人心的成果，也少不了各种意想不到的“坑”。这绝对是一个值得投入的工作，但需要一些策略。

最佳实践：

从小处着手，逐步迁移。 不要试图一次性把所有东西都迁移过来。如果你的项目是一个庞大的解决方案，包含多个子项目，我建议从最底层、最独立的库开始。先为它编写
```
CMakeLists.txt
```
登录后复制
，确保它能独立构建成功，然后逐步向上层依赖迁移。这种增量式的方法能有效控制风险，也更容易定位问题。
深入理解现有项目结构。 在动手之前，花时间梳理
```
.vcxproj
```
登录后复制
文件，弄清楚：
- 所有的源文件和头文件路径。
- 外部库的依赖关系、它们的
```
.lib
```
  登录后复制
  或
```
.dll
```
  登录后复制
  文件在哪里，以及对应的头文件路径。
- 项目特有的预处理器定义（
```
#define
```
  登录后复制
  ）。
- 自定义的编译选项（比如
```
/std:c++17
```
  登录后复制
  ，
```
/W4
```
  登录后复制
  ）。
- 是否有自定义的构建事件（Build Events），比如执行脚本、拷贝文件等。这些信息是编写正确
```
CMakeLists.txt
```
  登录后复制
  的基础。
模块化你的
CMakeLists.txt
登录后复制
。对于大型项目，不要把所有东西都塞到一个巨大的
```
CMakeLists.txt
```
登录后复制
里。使用
```
add_subdirectory()
```
登录后复制
来管理子目录中的子项目，每个子项目有自己的
```
CMakeLists.txt
```
登录后复制
。这不仅让文件更易读，也方便复用和维护。我个人习惯把第三方库的查找逻辑放在一个单独的
```
cmake/Find*.cmake
```
登录后复制
文件中，或者使用
```
FetchContent
```
登录后复制
来管理。
充分利用CMake的现代特性。 比如，使用
```
target_link_libraries
```
登录后复制
的
```
PUBLIC
```
登录后复制
/
```
PRIVATE
```
登录后复制
/
```
INTERFACE
```
登录后复制
关键字来精确控制依赖的传递性。使用
```
target_include_directories
```
登录后复制
和
```
target_compile_definitions
```
登录后复制
来管理头文件路径和宏定义，而不是全局设置。这些现代特性让你的CMake脚本更健壮，也更符合C++模块化的思想。
持续测试。 每次迁移一个组件，都要确保它能正确构建，并且功能没有受损。单元测试在这里显得尤为重要。

常见挑战：

Visual Studio特有的项目设置。
```
.vcxproj
```
登录后复制
文件里经常会塞入一些Visual Studio特有的设置，比如预编译头文件（PCH）的生成方式、资源文件（
```
.rc
```
登录后复制
）的处理、自定义构建规则等。这些在CMake中可能没有直接的对应，需要你找到CMake的等效命令（如
```
target_precompile_headers
```
登录后复制
、
```
add_custom_command
```
登录后复制
、
```
add_custom_target
```
登录后复制
）来重新实现。这往往是最耗时也最容易出错的部分。
复杂的构建事件和自定义工具。 如果你的
```
.vcxproj
```
登录后复制
文件里有大量的
```
PreBuildEvent
```
登录后复制
、
```
PostBuildEvent
```
登录后复制
或者自定义的构建工具（比如protobuf的生成器），你需要仔细研究如何用CMake的
```
add_custom_command
```
登录后复制
或
```
add_custom_target
```
登录后复制
来复现这些逻辑。这通常需要对CMake的脚本语言有较深的理解。
外部依赖的查找和链接。 传统的VS项目可能直接通过项目属性页指定了各种库的路径。在CMake中，你需要使用
```
find_package()
```
登录后复制
来查找系统或用户安装的库，或者使用
```
FetchContent
```
登录后复制
来在构建时下载并集成第三方库。如果库没有提供CMake模块，你可能需要自己编写
```
Find*.cmake
```
登录后复制
文件。这要求你对不同操作系统下库的安装路径、命名约定有所了解。
条件编译和平台特定代码。 很多老项目会有大量的
```
#ifdef _WIN32
```
登录后复制
或
```
#ifdef __linux__
```
登录后复制
来处理平台差异。在迁移到CMake时，你需要确保这些条件编译逻辑能够被CMake正确地识别和处理，或者考虑在CMake层级通过
```
if(WIN32)
```
登录后复制
等语句来控制源文件的添加或编译选项。
调试迁移问题。 如果迁移后构建失败，或者行为异常，你需要学会查看CMake的详细输出日志。在VS中，你可以在“工具”>“选项”>“CMake”中调整日志详细程度。这些日志会告诉你CMake在配置和生成过程中做了什么，哪里出了问题。