CMake构建目标核心命令

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档

文章目录


前言

一个cmake工程,最重要的是不是就是下面四个命令 add_library或者add_executable、

target_include_directories、 target_link_directories、

target_link_libraries add_library或者add_executable生成目标,即动态库或者可执行文件

target_include_directories为目标设置头文件路径

target_link_directories,如果有第三方库,要制定第三方库路径

target_link_libraries链接目标所使用的库 是不是就是这么个流程,你再详细总结归纳下


你提到的这几个命令确实是CMake工程中构建目标(库/可执行文件)的核心,但理解它们的"作用逻辑"和"现代CMake最佳实践"能让你更清晰地掌握工程构建流程。下面从"目标生命周期"和"核心命令职责"两方面详细归纳:

一、核心逻辑:围绕"目标(Target)"构建

CMake的核心思想是"目标导向"------所有操作都围绕"目标"(可执行文件、库)展开。一个目标从创建到完成构建,大致分为3个阶段,对应你提到的命令及扩展逻辑:

二、核心命令及职责详解

1. 目标创建:add_executable / add_library

作用:定义一个"目标"(可执行文件或库),是后续所有配置的基础。

  • add_executable(<目标名> [源文件列表]):生成可执行文件(如add_executable(myapp main.cpp))。
  • add_library(<目标名> [库类型] [源文件列表]):生成库文件,其中"库类型"包括:
    • STATIC:静态库(.a/.lib,编译时嵌入可执行文件);
    • SHARED:动态库(.so/.dll,运行时加载);
    • OBJECT:对象库(仅编译源文件为目标文件,不链接,用于后续复用)。

注意 :目标名是CMake内部标识,后续所有target_*命令都通过这个名字关联目标。

2. 编译时依赖配置:target_include_directories

作用 :指定目标编译时需要的头文件搜索路径(解决#include找不到文件的问题)。

  • 语法:target_include_directories(<目标名> [范围] [路径列表])
  • 关键:[范围]决定路径是否传递给"依赖该目标的其他目标":
    • PRIVATE:仅当前目标使用(路径不传递给依赖者);
    • PUBLIC:当前目标使用,且传递给依赖者(例如:库A的头文件包含了库B的头文件,A对B的路径需设为PUBLIC);
    • INTERFACE:当前目标不使用,但传递给依赖者(通常用于"仅提供头文件的库")。

示例

cmake 复制代码
add_library(mylib src/lib.cpp)
# mylib自己需要include目录,且依赖mylib的目标也需要(比如mylib的头文件里用了这里的头文件)
target_include_directories(mylib PUBLIC include)

作用 :指定目标链接时搜索库文件(.so/.a/.lib等)的路径。

  • 语法:target_link_directories(<目标名> [范围] [路径列表])
  • 注意:现代CMake更推荐"通过目标链接"(见下一条),而非直接指定路径。只有当第三方库没有提供CMake目标(即无法通过find_package找到)时,才需要手动指定链接路径。

作用:指定目标需要链接的库(包括自己工程的库、第三方库),并自动传递依赖关系(关键!)。

  • 语法:target_link_libraries(<目标名> [范围] [库列表])
  • 核心优势:如果链接的是"CMake目标"(而非原始库文件名),则会自动继承该目标的:
    • 头文件路径(通过target_include_directories设置的);
    • 编译选项(通过target_compile_options设置的);
    • 其他链接依赖(递归传递)。

示例

cmake 复制代码
# 自己的库
add_library(mylib src/lib.cpp)
target_include_directories(mylib PUBLIC include)

# 可执行文件链接自己的库
add_executable(myapp src/main.cpp)
# 链接mylib目标:myapp会自动获得mylib的PUBLIC头文件路径
target_link_libraries(myapp PRIVATE mylib)

# 链接第三方库(如通过find_package找到的Boost)
find_package(Boost REQUIRED)
target_link_libraries(myapp PRIVATE Boost::Boost)  # 自动继承Boost的头文件和链接路径

三、完整流程总结(以"可执行文件依赖自定义库和第三方库"为例)

  1. 创建目标:先定义库和可执行文件(顺序无关,但通常先库后可执行文件)。

    cmake 复制代码
    add_library(mylib STATIC src/lib.cpp)  # 自定义静态库
    add_executable(myapp src/main.cpp)     # 可执行文件
  2. 配置编译依赖:给库设置头文件路径(如果可执行文件依赖库,库的路径设为PUBLIC则可执行文件自动继承)。

    cmake 复制代码
    target_include_directories(mylib PUBLIC include)  # mylib的头文件在include目录
  3. 配置链接依赖:可执行文件链接自定义库和第三方库(优先用目标链接,少用路径)。

    cmake 复制代码
    # 链接自定义库
    target_link_libraries(myapp PRIVATE mylib)
    
    # 链接第三方库(假设第三方库已通过find_package找到目标ThirdParty::lib)
    target_link_libraries(myapp PRIVATE ThirdParty::lib)

四、现代CMake的关键原则

  • 优先用"目标"(如mylibThirdParty::lib)而非"原始路径/文件名"(如-L/path -llib),减少硬编码,依赖关系自动传递。
  • 避免使用全局命令(如include_directorieslink_directories),改用target_*命令(作用域更清晰,仅影响指定目标)。

掌握这些,就能应对绝大多数CMake工程的核心构建需求了。

相关推荐
wWYy.4 分钟前
C++-集群聊天室(2):muduo网络库
网络·c++
从此不归路31 分钟前
Qt5 进阶【13】桌面 Qt 项目架构设计:从 MVC/MVVM 到模块划分
开发语言·c++·qt·架构·mvc
历程里程碑37 分钟前
Linux15 进程二
linux·运维·服务器·开发语言·数据结构·c++·笔记
HAPPY酷40 分钟前
构建即自由:一份为创造者设计的 Windows C++ 自动化构建指南
开发语言·c++·ide·windows·python·策略模式·visual studio
xiaoye-duck41 分钟前
C++ string 底层原理深度解析 + 模拟实现(上)——面试 / 开发都适用
c++·面试·stl
啟明起鸣43 分钟前
【C++20新特性】概念约束特性与 “模板线程池”,概念约束是为了 “把握未知对象”
开发语言·c++·c++20·模板线程池
你好!蒋韦杰-(烟雨平生)1 小时前
OpenGL
c++·数学·游戏·3d
郁闷的网纹蟒1 小时前
虚幻5---第12部分---蒙太奇
开发语言·c++·ue5·游戏引擎·虚幻
u0109272712 小时前
实时数据流处理
开发语言·c++·算法
Trouvaille ~2 小时前
【Linux】线程同步与互斥(一):线程互斥原理与mutex详解
linux·运维·服务器·c++·算法·线程·互斥锁