如何在C++中使用CMake？-C++-PHP中文网

如何在C++中使用CMake？

下次还敢

发布： 2025-04-23 11:54:02

原创

907人浏览过

在c++++项目中使用cmake可以简化构建过程和提升项目管理效率。1.创建目录结构和基本代码文件。2.编辑cmakelists.txt文件，配置项目和依赖。3.使用命令生成构建文件并编译项目。4.添加外部库如gtest进行单元测试。5.注意常见错误如版本不匹配和路径问题，并使用调试技巧解决。

如何在C++中使用CMake？

在C++项目中使用CMake可以大大简化构建过程，提升项目管理的效率。让我们深入探讨一下如何在C++中使用CMake，以及一些实用的经验和注意事项。

引言

使用CMake可以帮助我们跨平台编译C++项目，无论是Windows、Linux还是macOS都能轻松应对。通过这篇文章，你将学会如何创建和配置CMake文件，如何编译项目，以及一些最佳实践和常见问题解决方案。

基础知识回顾

CMake是一种跨平台的构建系统生成工具，它通过一个名为CMakeLists.txt的文件来定义构建过程。CMake会根据这个文件生成适用于不同构建工具（如Make、Ninja、Visual Studio等）的构建文件。

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

在使用CMake之前，你需要了解一些基本的C++编译和链接知识，以及熟悉命令行操作。

核心概念或功能解析

CMake的作用与优势

CMake的主要作用是生成构建文件，使得项目可以在不同平台上统一构建。它的优势在于：

跨平台：可以生成不同平台的构建文件。
模块化：可以很容易地管理大型项目和依赖。
自动化：可以自动检测系统环境和依赖库。

工作原理

CMake的工作原理可以简单描述为：

读取CMakeLists.txt文件。
执行文件中的命令，生成中间文件CMakeCache.txt。
根据系统环境和用户配置，生成具体的构建文件（如Makefile、Visual Studio项目文件等）。
使用生成的构建文件进行编译和链接。

使用示例

基本用法

让我们从一个简单的例子开始，创建一个基本的C++项目并使用CMake进行构建。

首先，创建一个目录结构：

my_project/
├── CMakeLists.txt
├── src/
│   └── main.cpp
└── include/
    └── mylib.h

登录后复制

在src/main.cpp中添加以下代码：

#include <iostream>
#include "mylib.h"
<p>int main() {
std::cout << "Hello, CMake!" << std::endl;
printHello();
return 0;
}</p>

登录后复制

在include/mylib.h中添加以下代码：

#ifndef MYLIB_H
#define MYLIB_H
<p>void printHello();</p><h1>endif // MYLIB_H</h1>

登录后复制

然后，在src/目录下创建mylib.cpp：

#include <iostream>
#include "mylib.h"
<p>void printHello() {
std::cout << "Hello from mylib!" << std::endl;
}</p>

登录后复制

现在，编辑CMakeLists.txt文件：

cmake_minimum_required(VERSION 3.10)
project(MyProject)
<p>set(CMAKE_CXX_STANDARD 11)</p><p>include_directories(include)</p>
                    <div class="aritcle_card">
                        <a class="aritcle_card_img" href="/xiazai/code/8889">
                            <img src="https://img.php.cn/upload/webcode/000/000/004/175711680870388.jpg" alt="易森网络企业版">
                        </a>
                        <div class="aritcle_card_info">
                            <a href="/xiazai/code/8889">易森网络企业版</a>
                            <p>如果您是新用户，请直接将本程序的所有文件上传在任一文件夹下，Rewrite 目录下放置了伪静态规则和筛选器，可将规则添加进IIS，即可正常使用，不用进行任何设置；(可修改图片等)默认的管理员用户名、密码和验证码都是：yeesen系统默认关闭，请上传后登陆后台点击&ldquo;核心管理&rdquo;里操作如下:进入&ldquo;配置管理&rdquo;中的&ld</p>
                            <div class="">
                                <img src="/static/images/card_xiazai.png" alt="易森网络企业版">
                                <span>0</span>
                            </div>
                        </div>
                        <a href="/xiazai/code/8889" class="aritcle_card_btn">
                            <span>查看详情</span>
                            <img src="/static/images/cardxiayige-3.png" alt="易森网络企业版">
                        </a>
                    </div>
                <p>add_executable(MyProject src/main.cpp src/mylib.cpp)</p>

登录后复制

使用以下命令生成构建文件和编译项目：

mkdir build
cd build
cmake ..
cmake --build .

登录后复制

高级用法

在实际项目中，我们可能需要处理更多的复杂情况，比如添加依赖库、使用子模块、生成安装文件等。让我们看一个更复杂的例子，添加一个外部库gtest用于单元测试。

首先，修改CMakeLists.txt文件，添加对gtest的支持：

cmake_minimum_required(VERSION 3.10)
project(MyProject)
<p>set(CMAKE_CXX_STANDARD 11)</p><p>include_directories(include)</p><p>add_executable(MyProject src/main.cpp src/mylib.cpp)</p><h1>添加gtest</h1><p>include(FetchContent)
FetchContent_Declare(
googletest
URL <a href="https://www.php.cn/link/c1b990e1e8ae798b46c46e4cde715bef">https://www.php.cn/link/c1b990e1e8ae798b46c46e4cde715bef</a>
)</p><h1>For Windows: Prevent overriding the parent project's compiler/linker settings</h1><p>set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
FetchContent_MakeAvailable(googletest)</p><p>enable_testing()</p><p>add_executable(
hello_test
src/hello_test.cpp
)
target_link_libraries(
hello_test
gtest_main
)</p><p>include(GoogleTest)
gtest_discover_tests(hello_test)</p>

登录后复制

然后，创建src/hello_test.cpp文件：

#include <gtest/gtest.h>
#include "mylib.h"
<p>TEST(HelloTest, BasicAssertions) {
EXPECT_EQ(1, 1);
EXPECT_TRUE(true);
}</p><p>TEST(MyLibTest, PrintHello) {
testing::internal::CaptureStdout();
printHello();
std::string output = testing::internal::GetCapturedStdout();
EXPECT_EQ(output, "Hello from mylib!\n");
}</p>

登录后复制

使用以下命令生成构建文件和编译项目：

mkdir build
cd build
cmake ..
cmake --build .
ctest

登录后复制

常见错误与调试技巧

在使用CMake的过程中，可能会遇到一些常见的问题：

CMake版本不匹配：确保你的CMake版本符合cmake_minimum_required的要求。
路径问题：确认所有路径设置正确，特别是include_directories和link_directories。
依赖库问题：使用FetchContent或find_package时，确保正确配置和下载依赖库。

调试技巧：

使用cmake --debug-output来查看详细的CMake输出。
使用cmake -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON来查看详细的编译过程。
检查CMakeCache.txt文件，了解CMake的配置信息。

性能优化与最佳实践

在实际应用中，优化CMake文件和构建过程可以显著提升开发效率和项目质量。以下是一些建议：

使用缓存：尽量使用FetchContent来管理外部依赖，这样可以减少重复下载和编译时间。
模块化：将大型项目拆分为多个子模块，每个子模块都有自己的CMakeLists.txt，这样可以提高构建速度和管理效率。
代码可读性：保持CMakeLists.txt文件清晰明了，使用注释和变量来提高可读性。

例如，比较以下两种写法：

# 较差的写法
add_executable(MyProject src/main.cpp src/mylib.cpp)
target_include_directories(MyProject PUBLIC include)
target_link_libraries(MyProject gtest_main)
<h1>较好的写法</h1><p>set(SOURCES src/main.cpp src/mylib.cpp)
set(HEADERS include/mylib.h)
set(LIBRARIES gtest_main)</p><p>add_executable(MyProject ${SOURCES})
target_include_directories(MyProject PUBLIC ${HEADERS})
target_link_libraries(MyProject ${LIBRARIES})</p>

登录后复制

通过这种方式，我们可以更容易地管理和修改项目配置。