使用 Modern CMake 构建现代 C++ 项目：target从入门到实践

于 2025-05-15 16:47:53 发布
阅读量428 收藏 8
点赞数 5
文章标签： c++ linux 服务器
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42244181/article/details/147986698
版权

CMake 是 C++ 项目中最主流的构建系统之一，而随着 CMake 3.x ，4.x的发展，Modern CMake（现代 CMake）已成为推荐的最佳实践。

本篇文章将用通俗易懂的方式，带你从头理解并实践 Modern CMake 的核心理念，包括 target_* 系列命令、文件组织、安装与打包、测试下游项目、以及 CMakePresets 的使用。

一、Modern CMake 的核心思想

传统 CMake 中常用的 include_directories()、add_definitions()、file(GLOB ...) 等方式，容易带来依赖混乱。

Modern CMake 提倡：一切都通过 target 管理。

核心原则是：

  • 每个库/程序用一个 add_library() 或 add_executable() 创建 target
  • 使用 target_sources()、target_include_directories()、target_link_libraries() 配置 target 的行为
  • 避免全局变量，改用 target 作用域

二、目录结构设计

一个清晰的目录结构是 Modern CMake 的第一步：

foo_project/
├── CMakeLists.txt
├── include/
│   └── foo/
│       └── foo.h
├── src/
│   └── foo.cpp
├── test_app/
│   ├── main.cpp
│   └── CMakeLists.txt
├── CMakePresets.json
└── fooConfig.cmake.in
  • include/foo/foo.h：公共头文件
  • src/foo.cpp：实现文件
  • test_app/：测试程序

三、使用 target_sources 管理源码

Modern CMake 中推荐使用 target_sources() 明确地将头文件和源文件加入库：

add_library(foo)  # 创建目标 foo

target_sources(foo
  PUBLIC
    FILE_SET foo_headers TYPE HEADERS         # 定义一个文件集用于安装头文件
    BASE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/include
    FILES ${CMAKE_CURRENT_SOURCE_DIR}/include/foo/foo.h
  PRIVATE
    ${CMAKE_CURRENT_SOURCE_DIR}/src/foo.cpp   # 私有源文件不被安装
)

这不仅清晰地标明了头文件和源文件的作用域，还能与 install() 一起自动安装。

四、安装与导出库

使用 install() 命令，可以将构建好的库、头文件和 CMake 配置文件安装到系统或本地目录中。

install(TARGETS foo
  EXPORT fooTargets                           # 导出 target 定义供下游使用
  FILE_SET foo_headers DESTINATION include    # 安装头文件到 include/
  LIBRARY DESTINATION lib                     # 安装 .so 动态库
  ARCHIVE DESTINATION lib                     # 安装 .a 静态库
)

install(EXPORT fooTargets                     # 安装导出文件
  FILE fooTargets.cmake
  NAMESPACE foo::                             # 添加命名空间，使用 foo::foo
  DESTINATION lib/cmake/foo
)

configure_package_config_file(
  fooConfig.cmake.in
  ${CMAKE_CURRENT_BINARY_DIR}/fooConfig.cmake
  INSTALL_DESTINATION lib/cmake/foo
)

install(FILES
  ${CMAKE_CURRENT_BINARY_DIR}/fooConfig.cmake
  DESTINATION lib/cmake/foo
)

这样，其他项目就可以使用 find_package(foo) 来链接你的库了。

五、CMakePresets.json 的使用

CMakePresets.json 是 CMake 3.19+ 引入的新功能，可以统一预设构建参数：

{
  "version": 3,
  "configurePresets": [
    {
      "name": "release",
      "generator": "Unix Makefiles",
      "binaryDir": "${sourceDir}/build",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Release",
        "CMAKE_INSTALL_PREFIX": "${sourceDir}/install"
      }
    }
  ],
  "buildPresets": [
    { "name": "release", "configurePreset": "release" }
  ]
}

使用方式非常简单：

cmake --preset=release                # 配置构建目录
cmake --build --preset=release       # 构建项目
cmake --install build                # 安装到 install/ 目录

实际终端输出如下所示：

$ cmake --preset=release
-- The CXX compiler identification is GNU 10.2.1
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /.../foo_project/build

$ cmake --build --preset=release
[ 50%] Building CXX object CMakeFiles/foo.dir/src/foo.cpp.o
[100%] Linking CXX static library libfoo.a
[100%] Built target foo

$ cmake --install build
-- Install configuration: "Release"
-- Installing: /.../foo_project/install/lib/libfoo.a
-- Installing: /.../foo_project/install/include/foo/foo.h
-- Installing: /.../foo_project/install/lib/cmake/foo/fooTargets.cmake
-- Installing: /.../foo_project/install/lib/cmake/foo/fooTargets-release.cmake
-- Installing: /.../foo_project/install/lib/cmake/foo/fooConfig.cmake

六、测试下游项目

在项目根目录下我们还设置了一个 test_app/ 目录，用于模拟一个使用 foo 库的下游项目。

// test_app/main.cpp
#include <foo/foo.h>

int main() {
    foo::say_hello();
    return 0;
}

# test_app/CMakeLists.txt
cmake_minimum_required(VERSION 3.21)
project(test_app)

find_package(foo REQUIRED PATHS ../install/lib/cmake/foo)  # 查找安装后的包

add_executable(test_app main.cpp)
target_link_libraries(test_app PRIVATE foo::foo)  # 链接目标

构建和运行：

$ cmake -B build -DCMAKE_PREFIX_PATH=../install
-- The CXX compiler identification is GNU 10.2.1
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /.../test_app/build

$ cmake --build build
[ 50%] Building CXX object CMakeFiles/test_app.dir/main.cpp.o
[100%] Linking CXX executable test_app
[100%] Built target test_app

$ ./build/test_app
Hello from foo!

说明 foo 库已经成功安装并被下游项目引用。

七、安装生成的配置文件说明

安装完成后你会得到：

install/lib/cmake/foo/
├── fooConfig.cmake
├── fooTargets.cmake
└── fooTargets-release.cmake

这些文件让其他项目通过 find_package(foo REQUIRED PATHS ./install/lib/cmake/foo) 使用 foo::foo 目标，无需写死路径。

它们的作用分别是：

文件作用
fooConfig.cmake包配置入口文件，供 find_package() 加载
fooTargets.cmake定义导出的目标及其依赖
fooTargets-release.cmake定义 release 模式下库文件路径

八、总结

功能Modern CMake 命令说明
添加源码add_library() + target_sources()创建目标并声明源文件和头文件
设置包含路径target_include_directories()设置头文件查找路径
链接库target_link_libraries()连接依赖库
安装头文件install(FILE_SET ...)安装头文件并保持目录结构
导出配置install(EXPORT ...)安装 target 定义供 find_package() 使用
包配置文件configure_package_config_file()生成并安装 Config.cmake 供下游使用
使用 preset 构建cmake --preset=...快速构建统一配置
测试下游项目find_package() + target_link验证库是否被成功引用

通过 Modern CMake，构建脚本更可维护、更易复用、更标准化。

下一步，你可以尝试将自己的项目改造成 Modern CMake 风格，或基于本文的结构构建可复用的 C++ SDK。

📌 如需完整示例项目打包文件、测试程序或跨平台支持配置，欢迎留言交流！

另寻沧海
关注
Modern CMake 简明教程（1） - 初识 CMake
while(1) { smile(); }
10-08 519
是一个开源、跨平台的构建系统生成器（Build-system Generator）。CMake 是构建系统生成器，而不是构建系统，CMake 支持生成不同构建系统所支持的工程文件，如 Visual Studio，XCode，Makefile 等。本教程作为 CMake 的简明教程，不会事无巨细的讲述 CMake 的每一个语法，而是以实用为目的，介绍 CMake 的基础语法和常用指令。
c++与cmake:完整的C++项目构建注意事项
最新发布
aqwca的博客
09-18 1661
总结使用cmake构建c++项目经验,从创建项目到打包发布总结一下需要注意的事情.
【Modern CMake】基础知识介绍
I'm Zz.
04-20 180
【代码】【Modern CMake】基础知识介绍。
modern cmake 使用总结
zb313982521的博客
11-16 536
自建cmake 父CMAKE 1.add_subdirectory() 添加子CMakeList目录 2.使用 target_link_libraries(projectname PUBLIC 子cmakeprojectName) 子CMAKE 1.projectName() 2.addLibrary(projectName static *.cpp) 3.target_include_directories(projectName public ${cmake_current_sou...
探索现代CMake：moderncmake开源项目解析
gitblog_00013的博客
05-30 461
探索现代CMake：moderncmake开源项目解析 moderncmakeSamples for Learning Modern CMake项目地址:https://gitcode.com/gh_mirrors/mo/moderncmake 在软件开发的世界里，构建系统是项目管理和协作的核心环节。CMake作为一个跨平台的构建工具，因其灵活性和广泛支持而备受开发者喜爱。moderncmake...
最好用的json库，也许是JSON for modern C++ 的最佳实践！解决nlohmann json中文无法解析的问题！
CodeBowl的博客
10-09 4964
GitHub开源项的地址：https://github.com/nlohmann/json json for modern c++是一个德国大牛nlohmann写的，该版本的json有以下特点： 1.直观的语法。 2.整个代码由一个头文件组成json.hpp，没有子项目，没有依赖关系，没有复杂的构建系统，使用起来非常方便。 3.使用c++11标准编写。 4.使用json 像使用STL容器一样。 5.STL和json容器之间可以相互转换。 如何使用？ 只需要带一个文件即可。 #include <js.
CMake集成现代C++库：分享6个最佳实践，提升开发效率
本文详细介绍了CMake在现代C++库开发中的应用，包括基础语法、项目结构规划、依赖管理、高级特性和最佳实践。首先，我们探讨了CMake的基础知识和如何规划项目结构，以及如何设置编译器选项以支持C++标准。接着，我们...
CMake与现代C++整合：构建系统与新标准特性应用实战
本文深入探讨了CMake在现代C++项目开发中的应用，从基础知识和项目构建流程开始，逐步介绍CMake与C++11及以上新标准的整合方法。文中详述了CMake在跨平台项目配置、包管理器整合、自定义命令和生成器创建方面的高级...
modern_cmake
05-14
使用现代cmake（target_ *） 例子： # create library add_library(Box2D file.cpp) target_compile_features(Box2D PUBLIC cxx_std_11) target_include_directories(Box2D PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}) #...
modern-cmake-sample:通过使用目标展示CMake的最佳实践和正确用法的示例库
05-04
现代CMake示例 示例项目显示了虚拟库上正确的现代CMake用法以及使用该库的可执行文件。 我的博客文章的随附代码 制作说明 依存关系 cmake > = 3.13 Boost > = 1.65 rapidjson > = 1.1 建立图书馆 cd libjsonutils cmake -Bbuild cmake --build build 您可以运行测试： cmake --build build -- test 安装库 您可以通过两种方式安装lib。 首先，以一种经典的方式：将其放置在系统中的某个位置，以便可执行文件可以找到它，或者将其构建为两个，但是将其注册到CMake的User Package Registry中，避免安装。 正常安装 sudo cmake --build build -- install 这会将示例库安装在UNIX系统上的/usr/local/下。 或
modern-cpp-cheatsheet:有关现代C ++最佳实践的备忘单（摘自有效的现代C ++）
03-08
有效的现代C ++备忘单 速记 参考：参考 操作：操作 条款 lvalue ：通常是一个表达式，其地址可以使用，例如变量名（ auto x = 10; ） rvalue ：一个表达式，其地址不能在C ++中使用，即在C ++ 11之前，例如，文字类型（ 10 ） lvalue-ref（erence） ：对通常由&表示的左值类型的引用，例如auto& lvalue_ref = x; rvalue-ref（erence） ：对通常由&&表示的右值类型的引用，例如auto&& rvalue_ref = 10; 复制操作：使用拷贝构造函数和拷贝赋值运算符的左值拷贝构造 此举的操作使用移动构造函数和移动赋值操作符布展结构从右值 arguments ：在调用站点传递给函数调用的表达式（可以是lvalues或rvalues ） 参数：由传递给函数的参数初始化的左值名称，例如x in void
modern-cmake.pdf
03-10
Modern CMake. 现代 CMake，入门学习教程，英文版，需要有一定的 CMake 基础，提高学习。
modern cmake的概念剖析
KeLiaoo的博客
12-04 1215
modern cmake的初步认识 这篇文章主要介绍一些相关的概念，具体的语法建议去github上看相关例程。 target是modern cmake的核心 在cmake 3.0之前，cmake处于”全局变量满天飞，成功与否一把梭“的境地。为了改善社区用户的生态，在3.0后，开始逐步像modern cmake过渡，把cmake中的一切都视作target，而cmake需要设置的则是target的属性。这些属性包括target的编译间相关属性、链接间相关属性、以及target间的依赖关系。 引用依赖和实现依赖
Modern CMake 简介
GitChat
08-09 2331
作为拥有 20 年发展历史的 CMake，肩负 Build-system Generate 的重任，被越来越多的开源库接纳，其自身理念也在不断推陈出现。到底 Modern CMake 和 Traditional CMake 有什么区别，这是个值得讨论的话题。...
Modern C++ 学习笔记 —— 智能指针篇
小小笑笑川的博客
07-01 532
Modern C++ 智能指针篇 关键字：智能指针、shared_ptr、unique_ptr 文章目录Modern C++ 智能指针篇RAII自己动手实现智能指针代码列表参考文档 RAII RAII，资源获取即初始化（Resource Acquisition Is Initialization），是一种C++编程中的惯用手法。但是不要被它的名字给误导了，它实际上的作用是将资源的生命周期与一个对象的生命周期相绑定。所谓的资源包括但不限于分配的堆内存、打开的套接字、打开的文件、锁定的互斥体等。 RAII 保证
Modern C++ 学习笔记——易用性改进篇
小小笑笑川的博客
05-22 1049
C++11之后引入了大量语法糖，这简直就是开发人员的福音，本文介绍了其中部分最为关键的语法糖，建议收藏~~~！！！ ModernC++学习笔记是一系列介绍现代C++新特性的文章，结合《effective modern C++》说明了如何更好的使用这些新特性。相互讨论，共同学习，不断成长
【CMake】CMake官方教程
qq_43331089的博客
04-29 1307
【CMake】CMake官方教程 很好的一个官方教程翻译文档。 CMake简介 CMake是一个跨平台的、开源的构建工具。cmake是makefile的上层工具，它们的目的正是为了产生可移植的makefile，并简化自己动手写makefile时的巨大工作量.目前很多开源的项目都可以通过CMake工具来轻松构建工程，例如博客之前分享的openHMD、hidapi、OSVR-Core等等，代码的分享者提供源代码和相应的Cmake配置文件，使用者就可以非常方便的在自己的电脑上构建相应的工程，进行开发和调试。 CM
modern cmake：cmake 3.x版本的一些用法
lgfun的专栏
11-01 267
内容：待细化 简单来说，3.x版本的cmake以target为核心，当用target_link_libraries/target_include_directoires这种命令时，如果指定flag为PUBLIC/INTERFACE， 会设置当前target的一些属性（target类似一个对象，而各种target_include_directoires…命令就相当于成员函数，对当前target产生一...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值