百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分析 > 正文

“5 分钟 CMake 使用指南,解决我的 C++ 打包问题!”

liebian365 2025-03-13 17:06 5 浏览 0 评论

在软件开发的世界里,构建系统扮演着至关重要的角色,它不仅决定了项目的构建效率,还直接影响到团队协作的流畅度。对于许多 C++ 开发者而言,CMake 因其强大的功能和广泛的兼容性成为了构建自动化流程的首选工具。

原文链接:
https://journal.hexmos.com/cmake-survial-guide/

声明:未经允许,禁止转载。

者 | Shrijith Venkatramana
翻译 | 郑丽媛
出品 | CSDN(ID:CSDNnews)

最近我一直在用 C++ 处理一些编程挑战,其中管理 C++ 项目的一个重要方面就是依赖管理。

如今,我们在很多编程生态系统中享受着即时包管理器的便利:

● 在 Node.js/JavaScript 中使用 npm

● 在 Rust 中使用 cargo

● 在 Python 中使用 pip

而在 C++ 中,尽管有像 Conan 这样的包管理器,但处理实际项目时,你通常会发现 CMake 是绕不开的选择。因此如果你想在 C++ 生态系统中工作,学习如何使用 CMake 就不是可选项,而是必修课。


CMake 到底是什么,为什么要学它?

CMake 是一个跨平台的构建系统生成器。跨平台这一点非常重要,因为 CMake 能够在一定程度上抽象出不同平台之间的差异。

例如在类 Unix 系统上,CMake 会生成 makefile 文件,然后用这些文件来构建项目。而在 Windows 系统中,CMake 会生成 Visual Studio 项目文件,随后用于构建项目。

需要注意的是,不同平台通常都有各自的编译和调试工具链:Unix 使用 gcc,macOS 使用clang 等等。

在 C++ 生态系统中,另一个重要方面是能同时处理可执行文件和库。

可执行文件可基于以下不同因素:

● 目标 CPU 架构

● 目标操作系统

● 其他因素

对于库来说,链接方式也有不同的选择(链接是指在代码中使用另一个代码库的功能,而无需了解其具体实现):

● 静态链接

● 动态链接

我曾在一些内部原型项目中,需要调用底层操作系统 API 来执行某些任务,唯一可行的高效方法就是基于一些 C++ 库来进行构建。


CMake 是如何工作的:三个阶段

1. 配置阶段

CMake 会读取所有的 CMakeLists.txt 文件,并创建一个中间结构来确定后续步骤(如列出源文件、收集要链接的库等)。

2. 生成阶段

基于配置阶段的中间输出,CMake 会生成特定平台的构建文件(如在 Unix 系统上生成 makefiles 等)。

3. 构建阶段

使用特定平台的工具(如 make 或 ninja)来构建可执行文件或库文件。


一个简单的 CMake 项目示例(Hello World!)

假设你有一个用于计算数字平方根的 C++ 源文件。

tutorial.cxx

// A simple program that computes the square root of a number#include #include  // TODO 5: Remove this line#include #include 
// TODO 11: Include TutorialConfig.h
int main(int argc, char* argv[]){ if (argc < 2) { // TODO 12: Create a print statement using Tutorial_VERSION_MAJOR // and Tutorial_VERSION_MINOR std::cout << "Usage: " << argv[0] << " number" << std::endl; return 1; }
// convert input to double // TODO 4: Replace atof(argv[1]) with std::stod(argv[1]) const double inputValue = atof(argv[1]);
// calculate square root const double outputValue = sqrt(inputValue); std::cout << "The square root of " << inputValue << " is " << outputValue << std::endl; return 0;}

CMakeLists.txt

project(Tutorial)add_executable(tutorial tutorial.cxx)

上述两行是生成一个可执行文件所需的最少指令。理论上,我们还应该指定 CMake 的最低版本号,省略 CMake 会默认使用某个版本(暂时跳过这部分)。

严格来说,project 指令并非必需,但我们还是保留它。所以最重要的代码行是:

add_executable(tutorial tutorial.cxx)

这行代码指定了目标二进制文件 tutorial 以及源文件 tutorial.cxx。


如何构建

以下是一组用于构建项目和测试二进制文件的命令,稍后会详细解释:

mkdir buildcd build/cmake ..ls -l # inspect generated build filescmake --build ../tutorial 10 # test the binary

从上面的步骤可以看到,整个构建过程大约涉及 5-6 个步骤。

首先,在 CMake 中,我们应该将构建相关的内容与源代码分开,所以先创建一个构建目录:

mkdir build

然后我们可以在构建目录中进行所有与构建相关的操作:

cd build

从这一步开始,我们将执行多个构建相关的任务。

先是生成配置文件:

cmake ..

在这一步中,CMake 会生成平台特定的配置文件。在我的 Ubuntu 系统中,我看到了生成的makefile,这些文件相当冗长,但目前我不需要担心它们。

接下来,我根据新生成的文件触发构建:

cmake --build .

这一步使用生成的构建文件,生成目标二进制文件 tutorial。

最后,我可以通过以下命令验证二进制文件是否如预期运行:

./tutorial 16

我得到了预期的答案,这说明构建过程运行正常!


在 C++ 项目中注入变量

CMake 通过 Config.h.in 提供了一种机制,允许你在 CMakeLists.txt 中指定变量,这些变量可以在你的 .cpp 文件中使用。

下面是一个示例,我们在 CMakeLists.txt 中定义了项目的版本号,并在程序中使用。

Config.h.in

在这个文件中,来自 CMakeLists.txt 的变量将以 @VAR_NAME@ 的形式出现。

#pragma once
#define PROJECT_VERSION_MAJOR @PROJECT_VERSION_MAJOR@#define PROJECT_VERSION_MINOR @PROJECT_VERSION_MINOR@#define AUTHOR_NAME "@AUTHOR_NAME@"

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)project(Tutorial)
# Define configuration variablesset(PROJECT_VERSION_MAJOR 1)set(PROJECT_VERSION_MINOR 0)set(AUTHOR_NAME "Jith")
# Configure the header fileconfigure_file(Config.h.in Config.h)
# Add the executableadd_executable(tutorial tutorial.cxx)
# Include the directory where the generated header file is locatedtarget_include_directories(tutorial PRIVATE "${CMAKE_BINARY_DIR}")

请注意,我们添加了 cmake_minimum_required 来指定所需的最低 CMake 版本,这是编写 CMakeLists.txt 文件时的一个良好习惯。

然后,我们使用多个 set() 语句来定义所需的变量名。接着,指定配置文件 Config.h.in,通过该文件来使用上述设置的变量。

最后,CMake 会在变量占位被填充后生成头文件,这些动态生成的头文件需要被包含到项目中。

在我们的示例中,Config.h 文件将被放置在 ${CMAKE_BINARY_DIR} 目录中,所以我们只需指定该路径即可。

你可能会对以下这一行的 PRIVATE 标签感到好奇:

target_include_directories(tutorial PRIVATE "${CMAKE_BINARY_DIR}")


理解 CMake 的两个关键概念:可见性修饰符和目标

在 CMake 中,有三个可见性修饰符:PRIVATE、PUBLIC、INTERFACE。

这些修饰符可以在命令中使用,例如:
target_include_directories 和 target_link_libraries 等。

这些修饰符是在目标(Targets)的上下文中指定的。目标是 CMake 中的一种抽象概念,表示某种类型的输出:

● 可执行目标(通过 add_executable)生成二进制文件

● 库目标(通过 add_library)生成库文件

● 自定义目标(通过 add_custom_target)通过脚本等生成任意文件

所有上述的目标都会产生具体的文件或工件作为输出。库目标的一个特殊情况是接口目标(Interface Target)。接口目标的定义如下:

add_library(my_interface_lib INTERFACE)target_include_directories(my_interface_lib INTERFACE include/)

在这里,my_interface_lib 并不会立即生成任何文件。但在后续阶段,一些具体的目标可能会依赖于 my_interface_lib。这意味着,接口目标中指定的 include 目录也会被依赖。因此,INTERFACE 库可以看作是构建依赖关系树的一种便利机制。

理解了目标和依赖的概念之后,我们就回到可见性修饰符的概念。

PRIVATE 可见性

1target_include_directories(tutorial PRIVATE "${CMAKE_BINARY_DIR}")

PRIVATE 表示目标 tutorial 将使用指定的包含目录。但如果在后续阶段其他目标链接到 tutorial,包含目录将不会传递给那些依赖项。

PUBLIC 可见性

1target_include_directories(tutorial PUBLIC "${CMAKE_BINARY_DIR}")

使用 PUBLIC 修饰符意味着目标 tutorial 需要使用该包含目录,并且任何依赖于 tutorial 的其他目标也会继承这个包含目录。

INTERFACE 可见性

1target_include_directories(tutorial INTERFACE "${CMAKE_BINARY_DIR}")

INTERFACE 修饰符表示 tutorial 本身不需要该包含目录,但任何依赖于 tutorial 的其他目标会继承这个包含目录。

简单总结,可见性修饰符的工作原理如下:

● PRIVATE:源文件和依赖关系只传递给当前目标;

● PUBLIC:源文件和依赖关系传递给当前目标及其依赖的目标;

INTERFACE:源文件和依赖关系不传递给当前目标,但会传递给依赖于它的目标。


将项目构建划分为库和目录

随着项目规模不断增长,通常需要模块化来组织项目并管理复杂性。

在 CMake 中,可以用子目录来指定独立的模块及其自定义的构建流程。我们可以拥有一个主 CMake 配置,它能触发多个库(子目录)的构建,最后将所有模块链接在一起。

这是一个经过简化后的示例。我们将创建一个名为 MathFunctions 的模块/库,它将构建为一个静态库(在 Unix 系统上生成 MathFunctions.a),最后再把它链接到我们的主程序中。

首先是源文件部分(代码较为简单):

MathFunctions.h

#pragma once
namespace mathfunctions {double sqrt(double x);}

MathFunctions.cxx

#include "MathFunctions.h"#include "mysqrt.h"
namespace mathfunctions {double sqrt(double x){ return detail::mysqrt(x);}}

mysqrt.h

#pragma once
namespace mathfunctions {namespace detail {double mysqrt(double x);}}

mysqrt.cxx

#include "mysqrt.h"
#include
namespace mathfunctions {namespace detail {// a hack square root calculation using simple operationsdouble mysqrt(double x){ if (x <= 0) { return 0; }
double result = x;
// do ten iterations for (int i = 0; i < 10; ++i) { if (result <= 0) { result = 0.1; } double delta = x - (result * result); result = result + 0.5 * delta / result; std::cout << "Computing sqrt of " << x << " to be " << result << std::endl; } return result;}}}

以上这些代码片段,引入了一个名为 mathfunctions 的命名空间,其中包含了一个自定义的 sqrt 函数实现。这样我们就可以在项目中定义自己的平方根函数,而不会与其他版本的 sqrt 冲突。

接下来,如何将该文件夹构建为 Unix 二进制文件?我们需要为该模块/库创建一个自定义的 CMake 子配置:

MathFunctions/CMakeLists.txt

add_library(MathFunctions MathFunctions.cxx mysqrt.cxx)

通过这条简单的 add_library 指令,我们指定了需要编译的 .cxx 文件来生成库文件。

但这还不够,解决方案的核心在于如何将这个子目录或库链接到我们的主项目中:

tutorial.cxx(使用库/模块版本)

#include "Config.h"#include "MathFunctions.h"#include #include  #include #include 
int main(int argc, char* argv[]){ std::cout << "Project Version: " << PROJECT_VERSION_MAJOR << "." << PROJECT_VERSION_MINOR << std::endl; std::cout << "Author: " << AUTHOR_NAME << std::endl;
if (argc < 2) { std::cout << "Usage: " << argv[0] << " number" << std::endl; return 1; }
const double inputValue = atof(argv[1]);
// use library function const double outputValue = mathfunctions::sqrt(inputValue); std::cout << "The square root of " << inputValue << " is " << outputValue << std::endl; return 0;}

在这个文件中,我们导入了 MathFunctions.h,并使用命名空间 mathfunctions 来调用自定义的 sqrt 函数。我们都知道 MathFunctions.h 位于子目录中,但可以直接引用它,就像它在根目录中似的,这是怎么做到的?答案在于修订后的主 CMake 配置文件中:

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)project(Tutorial)
# Define configuration variablesset(PROJECT_VERSION_MAJOR 1)set(PROJECT_VERSION_MINOR 0)set(AUTHOR_NAME "Jith")
# Configure the header fileconfigure_file(Config.h.in Config.h)
add_subdirectory(MathFunctions)
add_executable(tutorial tutorial.cxx)

target_include_directories(tutorial PUBLIC "${PROJECT_BINARY_DIR}" "${PROJECT_SOURCE_DIR}/MathFunctions")
target_link_libraries(tutorial PUBLIC MathFunctions)

这里有几条新命令:

● add_subdirectory 指定了一个子目录构建,CMake 将负责处理该子目录中的构建任务。


target_include_directories 告诉 CMake MathFunctions 文件夹的路径,这样我们可以在 tutorial.cxx 中直接引用 MathFunctions.h。

● target_link_libraries 将 MathFunctions 库链接到主程序 tutorial 中。

当我在 Linux 上构建这个项目时,我看到 build/MathFunctions 目录下生成了 libMathFunctions.a 文件,这是一个静态链接的库文件,它已经成为主程序的一部分。

现在,我们还可以随意移动生成的 tutorial 可执行文件,它将继续正常运行,因为 libMathFunctions.a 已经被静态链接进主程序中。


下一步是什么?

学习 CMake 的基本工作原理和如何用它完成一些基本任务确实很有意思。

CMake 解决了我现在在 C++ 打包方面遇到的大部分问题。同时,探索 Conan 和 vcpkg 以简化 C++ 中的依赖管理也是一件有趣的事情。未来有机会的话,我应该会进一步了解和尝试这些工具。

相关推荐

看黑客是如何获取你电脑最高权限的,一定要看

在渗透过程中,通过各种方式获取到一枚cmdshell,但是这个shell的权限比较低,无法让我们做我们想要做的一些操作,比如说获取系统密码,获取数据库信息,又或者比如说拿到服务器中的另一个站点的权限,...

是50个常用的Visual Basic代码示例:

以下是50个常用的VisualBasic代码示例:1.声明变量```vb...

电脑系统型号怎么看版本(如何看电脑系统型号)

有时候我们会需要进行查看电脑上安装的windows系统版本及系统版本号,但对于不懂电脑知识的小白来说要怎么查看电脑系统版本信息呢?别着急,有小编在接下来,就将查看电脑系统版本的教程来分享给你们,希望对...

dos命令systeminfo,查看系统启动时间。电脑卡慢,win10怎么了?

最近一段时间,有几个反应电脑卡慢的,都是windows10的系统。询问得知每天电脑有关机,打开任务管理器,内存使用量达到百分之九十多,而程序只打开微信、wps、360浏览器。cmd窗口运行命令syst...

systeminfo命令:全面解析系统信息!

你是否曾想过,仅凭一条简单的命令,就能深入了解计算机的"内心世界"?是不是有点不可思议?那么,让我们一起探寻这个神奇的命令,揭开它背后的奥秘吧!它能提供的信息超乎你的想象,从操作系统到硬件配置,再到驱...

电脑序列号怎么查询?只需两行命令一键查询

当我们的电脑出问题需要保修的时候,需要查询到电脑的型号和序列号才更便于进行下一步的操作,有包装盒的朋友还可以在包装盒上查询,笔记本用户可以在电脑底部标签上查询,没有包装盒和标签破损的用户就无从下手了。...

快速显示系统信息:Systeminfo命令详解

Systeminfo命令是windows系统中显示系统信息的命令,此命令可以显示出计算机的操作系统的详细配置信息,包括操作系统配置、安全信息、产品ID和硬件属性(如RAM、磁盘空间和网卡)。使用...

dos命令systeminfo图文教程,显示操作系统配置信息msinfo32

大家好,我是老盖,首先感谢观看本文,本篇文章做的有视频,视频讲述的比较详细,也可以看我发布的视频。今天我们学习systeminfo命令,该工具显示本地或远程机器(包括服务包级别)的操作系统配置的信息,...

基于uniapp+vue3跨端仿制chatgpt实例uniapp-chatgpt

#夏日生活打卡季#...

原创新作uniapp+vue3+pinia2高仿微信App聊天

前段时间有给大家分享一个flutter3.x桌面端os系统。今天再分享一款最新原创之作uniapp-vue3-wechat聊天实例。uni-vue3-wechat采用...

UniApp开发的设备适配(uniapp服务器配置)

UniApp是一个跨平台开发框架,支持多端应用(如H5、小程序、iOS、Android等)。由于不同设备的屏幕尺寸、分辨率、操作系统等存在差异,设备适配是开发过程中需要重点关注的问题。以下是Uni...

如何用服务器搭建自己的个人网站(自己服务器怎么做网站)

这篇教程主要是告诉大家如何利用TCP和HTTP协议来完成网站的搭建。首先你需要有C/C++语言基础,且有服务器、客户端概念,如果你了解TCP或者HTTP协议的话,那么将会帮助你更快的学会如何搭建个人网...

大话C语言:字符数组(c语言字符数组教学视频)

1字符数组概述C语言中没有字符串这种数据类型,可以通过char的数组来替代。数字0(和字符'\0'等价)结尾的char数组就是一个字符串,字符串是一种特殊的char的数组。...

源码分享:在pdf上加盖电子签章(pdf怎么加电子签章)

在pdf上加盖电子签章,并不是只是加个印章图片,。而是要使用一对密钥中的私钥对文件进行签字。为啥要用私钥呢?很简单,因为公钥是公开的,其他人才可以用公钥为你证明,这个文件是你签的。这就是我们常说的:私...

C语言wcstombs函数详解:宽字符字符串到多字节的「翻译官」

核心定位wcstombs是C语言中用于将宽字符字符串转换为多字节字符串的「翻译官」,它能将宽字符(wchar_t)转换为多字节字符(如UTF-8编码的中文)。就像一位翻译官,它能将一种语言(宽字符...

取消回复欢迎 发表评论: