实例分享cmake编译一个简单c++项目(demo)

作为网站作者，我很乐意为大家详细讲解如何使用CMake编译一个简单的C++项目。在本文中，我将为您提供一些步骤，以帮助您了解如何使用CMake生成可执行文件、静态库或共享库。我们将会涉及以下几个方面：

1. 概述
2. 安装CMake
3. 创建C++项目
4. 编写CMakeLists.txt
5. 配置并生成项目
6. 示例说明
7. 总结

1. 概述

CMake是一个跨平台的、开源的构建工具，可以自动生成本地构建环境文件，它使得构建C++项目变得更容易。与其他编译工具相比，CMake具有灵活、可扩展的编码语言，可快速构建大型项目。

在本文中，我们将演示如何使用CMake编译一个简单的C++项目。

2. 安装CMake

在开始之前，您需要先安装CMake。您可以从官网下载最新的稳定版本（https://cmake.org/download/）。

3. 创建C++项目

假设我们有一个简单的项目，其中包含两个源代码文件：main.cpp和math.cpp，再加上一个头文件：math.h。我们的目标是生成一个可执行文件。

项目目录结构如下：

/demo
----/src
--------/main.cpp
--------/math.cpp
--------/math.h
----CMakeLists.txt

4. 编写CMakeLists.txt

接下来，我们需要编写一个名为CMakeLists.txt的文件，告诉CMake如何编译我们的项目。该文件应位于项目的根目录下。

示例内容代码如下：

cmake_minimum_required(VERSION 3.16)
project(demo)

set(CMAKE_CXX_STANDARD 17)

add_executable(demo src/main.cpp src/math.cpp)

该文件包含三个主要组件：

• cmake_minimum_required：指定至少需要的CMake版本。
• project：指定要构建的项目的名称。
• add_executable：指定源代码文件和目标名称。

在上述代码中，我们设置了最低要求为CMake 3.16，并命名了项目为demo。我们将使用C++ 17进行编译，并指定了两个源代码文件：src/main.cpp和src/math.cpp。

对于头文件，由于order of including的原因，我们无须明确指定。当我们建立demo头文件时，可以参照 src/math.h 中的写法，在main.cpp文件中add_executable时，将头文件加入。

另外，如果您有其他需要使用的关联库文件，也可以在此处添加。例如，如果您需要使用OpenGL库，请添加以下代码：

find_package(OpenGL REQUIRED)
target_link_libraries(demo OpenGL::GL)

5. 配置并生成项目

现在，我们已经创建了C++项目和CMakeLists.txt文件，接下来，我们需要使用CMake构建项目，生成可执行文件。

先在终端进入到项目的根目录，然后使用以下命令进行配置：

cmake -S . -B build/

其中，-S .表示源代码的目录为当前目录，而-B build/则表示输出的文件将存放在build目录中。

接下来，使用以下命令生成可执行文件：

cmake --build build/

构建完成后，您可以在build目录下看到程序的可执行文件。

6. 示例说明

我们假设我们需要编写一个数学库，其中包含一个Add函数。然后，我们创建一个C++项目，并将math.cpp文件中的Add函数定义为：

#include "math.h"

int Add(int x, int y)
{
    return x + y;
}

在主函数main.cpp中，我们想调用Add函数。我们在头文件math.h中定义了该函数的原型：

int Add(int x, int y);

我们需要声明一个源文件来调用Add函数：

#include "math.h"

int main()
{
    int result = Add(1, 2);
    return 0;
}

接下来，我们需要更新CMakeLists.txt文件，并将生成共享库。以下是更新后的CMakeLists.txt文件：

cmake_minimum_required(VERSION 3.16)
project(demo)

set(CMAKE_CXX_STANDARD 17)

add_library(math SHARED src/math.cpp)

add_executable(demo src/main.cpp)
target_link_libraries(demo math)

我们使用add_library命令来生成共享库，并使用 target_link_libraries 命令将库与可执行文件链接。我们再次使用以下命令进行配置和构建：

cmake -S . -B build/
cmake --build build/

这次，CMake将生成共享库和可执行文件。如果您想将生成的共享库安装到系统目录，可以使用以下命令：

cmake --install build/

7. 总结

CMake是一个非常好用的跨平台构建工具。使用CMake可以简化C++项目的构建过程，提高开发效率。在本文中，我们对使用CMake编译C++项目进行了详细的介绍，希望对您有所帮助。