0

0

初学者如何编写一个简单的CMakeLists.txt文件来编译C++项目

P粉602998670

P粉602998670

发布时间:2025-08-31 08:41:01

|

474人浏览过

|

来源于php中文网

原创

答案:编写CMakeLists.txt需明确项目名称、源文件及生成目标。基础配置包含cmake_minimum_required指定CMake版本,project定义项目名,add_executable生成可执行文件。例如编译main.cpp为my_app,只需三行命令。对于外部库,使用find_package查找依赖,target_include_directories添加头文件路径,target_link_libraries链接库文件。项目结构复杂时,通过add_subdirectory管理子目录模块,实现源文件分离。指定C++标准可用set(CMAKE_CXX_STANDARD)并设置标准强制启用,结合target_compile_options使用生成器表达式按构建类型添加编译选项,实现灵活控制。

初学者如何编写一个简单的cmakelists.txt文件来编译c++项目

编写一个简单的CMakeLists.txt文件来编译C++项目,对初学者而言,核心在于明确项目名称、指定源文件,并最终生成可执行程序。最基础的配置通常只需三到五行代码,它就像是给编译器和构建系统写的一份“说明书”,告诉它们你的代码在哪里,叫什么名字,最终要变成什么样子。理解这一点,上手CMake就没那么神秘了。

解决方案

我记得我刚开始接触CMake的时候,面对那些复杂的配置选项也感到头大。但其实,对于一个简单的C++项目,比如一个经典的“Hello World”,CMakeLists.txt可以非常简洁。我们从一个最基础的例子开始:

假设你有一个

main.cpp
文件,内容是:

立即学习C++免费学习笔记(深入)”;

#include 

int main() {
    std::cout << "Hello, CMake!" << std::endl;
    return 0;
}

那么,对应的

CMakeLists.txt
可以这样写:

# 声明所需的CMake最低版本,这是一个好习惯
cmake_minimum_required(VERSION 3.10)

# 定义项目名称,这会影响生成的VS解决方案名或者其他构建系统的名称
project(MyHelloWorld CXX)

# 添加一个可执行目标,参数是目标名称和源文件
add_executable(my_app main.cpp)

就这几行,是不是比想象中简单?

cmake_minimum_required(VERSION 3.10)
:这行是告诉CMake,你的配置需要至少3.10版本的CMake才能正确解析。它避免了在旧版CMake上出现不兼容的问题。
project(MyHelloWorld CXX)
:这里我们给项目起了个名字叫
MyHelloWorld
,并且声明这是一个C++项目(
CXX
)。CMake会用这个名字来生成构建文件。
add_executable(my_app main.cpp)
:这是最关键的一行。它告诉CMake,我们要从
main.cpp
这个源文件编译出一个名为
my_app
的可执行程序。

要编译这个项目,你通常会在项目根目录下创建一个

build
目录,然后进入
build
目录执行:

mkdir build
cd build
cmake ..
make # 或者在Windows上用Visual Studio打开生成的解决方案文件

cmake ..
会根据
CMakeLists.txt
生成特定于你操作系统的构建文件(比如Makefile或Visual Studio项目文件)。
make
(或
ninja
等)就是执行编译过程,最终你会在
build
目录下找到
my_app
可执行文件。

初学者很容易犯的错误就是忘记在

build
目录里运行
cmake ..
,或者路径不对。记住,
..
表示上一级目录,也就是
CMakeLists.txt
所在的目录。

CMake中如何添加外部库和头文件路径?

当你的C++项目开始变得复杂,需要依赖一些外部库,比如Boost、OpenCV或者你自己的某个工具库时,仅仅

add_executable
就不够了。这时,我们需要告诉CMake去哪里找这些库的头文件和二进制文件。这通常涉及
find_package
target_include_directories
target_link_libraries
这三个命令。

假设我们有一个自定义的静态库

mylib
,它提供了
mylib.h
libmylib.a
(或
.lib
),并且它们在项目根目录下的
lib
include
子目录里。

首先,在

CMakeLists.txt
中,你需要告诉CMake头文件在哪里:

# ... (之前的 cmake_minimum_required 和 project) ...

# 告诉CMake去哪里找头文件
target_include_directories(my_app PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)

# 告诉CMake去哪里找库文件,并链接到你的可执行文件
target_link_libraries(my_app ${CMAKE_CURRENT_SOURCE_DIR}/lib/mylib.a)

这里的

target_include_directories(my_app PUBLIC ...)
表示
my_app
这个目标需要从指定路径下寻找头文件。
PUBLIC
关键字意味着这个头文件路径不仅对
my_app
本身可见,如果其他目标依赖
my_app
,它们也能看到这个路径。
CMAKE_CURRENT_SOURCE_DIR
是一个内置变量,代表当前
CMakeLists.txt
文件所在的目录。

对于更复杂的、系统级的库,比如Boost或者OpenCV,CMake通常有内置的

find_package
模块。比如,如果你想使用Boost的
system
组件:

find_package(Boost COMPONENTS system REQUIRED)
if (Boost_FOUND)
    message(STATUS "Found Boost: ${Boost_LIBRARIES}")
    target_include_directories(my_app PUBLIC ${Boost_INCLUDE_DIRS})
    target_link_libraries(my_app PUBLIC ${Boost_LIBRARIES})
else()
    message(FATAL_ERROR "Boost system component not found!")
endif()

find_package(Boost COMPONENTS system REQUIRED)
会尝试在你的系统上找到Boost库,并确保
system
组件可用。如果找到,它会设置
Boost_INCLUDE_DIRS
Boost_LIBRARIES
等变量,我们就可以直接用这些变量来链接。这种方式更优雅,也更跨平台,因为它不需要你硬编码库的路径。

C++项目源文件分散,CMakeLists.txt应该怎么组织?

Sora
Sora

Sora是OpenAI发布的一种文生视频AI大模型,可以根据文本指令创建现实和富有想象力的场景。

下载

随着项目规模的增长,把所有源文件都堆在一个目录里,或者在

add_executable
里列出几十个源文件,显然不是个好主意。项目结构应该清晰,模块化。CMake提供了
add_subdirectory
和一些其他策略来管理分散的源文件。

最推荐的方式是使用

add_subdirectory
来组织你的项目。想象一下,你的项目有
src
目录存放主要代码,
lib
目录存放一个自定义的静态库。

项目结构可能如下:

MyProject/
├── CMakeLists.txt         # 根CMakeLists.txt
├── src/
│   ├── CMakeLists.txt     # src目录的CMakeLists.txt
│   └── main.cpp
└── lib/
    ├── CMakeLists.txt     # lib目录的CMakeLists.txt
    ├── mylib.h
    └── mylib.cpp

MyProject/CMakeLists.txt
中:

cmake_minimum_required(VERSION 3.10)
project(MyComplexProject CXX)

# 添加lib子目录,它会处理mylib的构建
add_subdirectory(lib)

# 添加src子目录,它会处理my_app的构建,并链接mylib
add_subdirectory(src)

MyProject/lib/CMakeLists.txt
中:

# 创建一个静态库目标
add_library(mylib STATIC mylib.cpp mylib.h)

# 确保mylib的头文件对外部可见,以便src目录能找到
target_include_directories(mylib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})

MyProject/src/CMakeLists.txt
中:

# 创建可执行文件
add_executable(my_app main.cpp)

# 链接mylib库
target_link_libraries(my_app PRIVATE mylib)

这样,每个子目录都有自己的

CMakeLists.txt
来定义如何构建该模块,而根目录的
CMakeLists.txt
则负责协调这些子模块。
add_subdirectory
会递归地处理子目录中的
CMakeLists.txt
文件。这种结构非常清晰,易于维护和扩展。

你可能还会看到

aux_source_directory( )
,它会查找指定目录下的所有源文件并将其存储在一个变量中。但我个人不推荐过度使用它,因为它可能导致在添加新文件时CMake不会自动重新配置,除非你手动删除
CMakeCache.txt
。明确列出源文件,或者利用
add_subdirectory
来模块化管理,通常是更好的实践。

如何在CMake中指定C++标准和编译器优化选项?

现代C++开发通常会指定一个特定的C++标准(如C++11, C++17, C++20),并且根据需要设置不同的编译器优化级别。CMake也提供了非常直观的方式来处理这些。

要指定C++标准,你可以在

CMakeLists.txt
中这样做:

cmake_minimum_required(VERSION 3.10)
project(MyModernCppProject CXX)

# 指定C++标准为C++17
set(CMAKE_CXX_STANDARD 17)
# 确保编译器必须支持C++17,如果不支持则报错
set(CMAKE_CXX_STANDARD_REQUIRED ON)
# 禁用编译器扩展,强制使用标准C++17特性
set(CMAKE_CXX_EXTENSIONS OFF)

add_executable(my_app main.cpp)

通过

set(CMAKE_CXX_STANDARD 17)
,你告诉CMake你的项目需要C++17标准。
CMAKE_CXX_STANDARD_REQUIRED ON
则让CMake在编译器不支持该标准时直接报错,而不是默默地使用一个旧标准。
CMAKE_CXX_EXTENSIONS OFF
则确保编译器不会使用非标准的语言扩展,这有助于提高代码的可移植性。

至于编译器优化选项,这通常与构建类型(Debug, Release, RelWithDebInfo, MinSizeRel)相关。CMake默认会根据构建类型设置一些优化标志。例如,在Release模式下,通常会自动启用

-O3
等优化。但你也可以为特定的目标添加自定义的编译选项:

# ... (之前的配置) ...

add_executable(my_app main.cpp)

# 为my_app目标添加特定的编译选项
# 比如,在Debug模式下添加更多警告,在Release模式下添加特定的优化
target_compile_options(my_app PUBLIC
    $<$:-Wall -Wextra> # Debug模式下启用更多警告
    $<$:-O3 -DNDEBUG> # Release模式下启用O3优化并定义NDEBUG
)

这里使用了CMake的“生成器表达式”(Generator Expressions),它允许你根据构建配置(

CONFIG:Debug
CONFIG:Release
)来有条件地添加编译选项。
PUBLIC
关键字表示这些选项不仅应用于
my_app
本身,如果其他目标依赖
my_app
,它们也会继承这些编译选项。这种方式非常灵活,可以让你针对不同的构建场景精细控制编译行为。

记住,这些设置都是为了让你的项目编译过程更可控、更健壮。一开始可能觉得有点多,但随着实践,你会发现它们都是为了解决实际问题而存在的。

相关专题

更多
堆和栈的区别
堆和栈的区别

堆和栈的区别:1、内存分配方式不同;2、大小不同;3、数据访问方式不同;4、数据的生命周期。本专题为大家提供堆和栈的区别的相关的文章、下载、课程内容,供大家免费下载体验。

392

2023.07.18

堆和栈区别
堆和栈区别

堆(Heap)和栈(Stack)是计算机中两种常见的内存分配机制。它们在内存管理的方式、分配方式以及使用场景上有很大的区别。本文将详细介绍堆和栈的特点、区别以及各自的使用场景。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

572

2023.08.10

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

java用途介绍
java用途介绍

本专题整合了java用途功能相关介绍,阅读专题下面的文章了解更多详细内容。

11

2026.01.19

java输出数组相关教程
java输出数组相关教程

本专题整合了java输出数组相关教程,阅读专题下面的文章了解更多详细内容。

3

2026.01.19

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

2

2026.01.19

xml格式相关教程
xml格式相关教程

本专题整合了xml格式相关教程汇总,阅读专题下面的文章了解更多详细内容。

4

2026.01.19

PHP WebSocket 实时通信开发
PHP WebSocket 实时通信开发

本专题系统讲解 PHP 在实时通信与长连接场景中的应用实践,涵盖 WebSocket 协议原理、服务端连接管理、消息推送机制、心跳检测、断线重连以及与前端的实时交互实现。通过聊天系统、实时通知等案例,帮助开发者掌握 使用 PHP 构建实时通信与推送服务的完整开发流程,适用于即时消息与高互动性应用场景。

13

2026.01.19

微信聊天记录删除恢复导出教程汇总
微信聊天记录删除恢复导出教程汇总

本专题整合了微信聊天记录相关教程大全,阅读专题下面的文章了解更多详细内容。

93

2026.01.18

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 7.5万人学习

Excel 教程
Excel 教程

共162课时 | 12.5万人学习

PHP基础入门课程
PHP基础入门课程

共33课时 | 2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号