Cmake中“目标层级“的概念（target_include_directories和include_directories的区别）

最新推荐文章于 2025-03-16 18:01:40 发布

原创最新推荐文章于 2025-03-16 18:01:40 发布

· 1.3k 阅读

23 ·

版权

文章标签：

#cmake #c++

Cmake 专栏收录该内容

10 篇文章

订阅专栏

CMake 中，“目标层级”（Target-Level）是一个核心概念，涉及到项目中构建的具体实体，如可执行文件、库等。理解目标层级对于有效地使用现代 CMake 功能、管理依赖关系以及配置构建过程至关重要。以下将详细解释什么是目标层级、其重要性以及如何在 CMake 中应用相关命令。

什么是“目标”？

**目标（Target）**是 CMake 中的一个基本构建单元，代表了最终要生成的文件或构建过程中的中间产物。主要包括：

可执行文件（Executable）：通过 add_executable() 定义。
静态库（Static Library）：通过 add_library() 定义，类型为 STATIC。
动态库（Shared Library）：通过 add_library() 定义，类型为 SHARED。
模块库（Module Library）：通过 add_library() 定义，类型为 MODULE。

示例

# 定义一个静态库目标
add_library(MyStaticLib STATIC src/mylib.cpp)

# 定义一个动态库目标
add_library(MySharedLib SHARED src/mylib.cpp)

# 定义一个可执行文件目标
add_executable(MyApp src/main.cpp)

在上述示例中，MyStaticLib、MySharedLib 和 MyApp 都是不同的目标。

目标层级的重要性

使用目标层级的主要优点包括：

封装性：每个目标的属性（如编译选项、链接库等）都是独立管理的，避免了全局设置带来的副作用。
依赖管理：CMake 可以自动处理目标之间的依赖关系，确保正确的构建顺序。
可维护性：通过将配置与特定目标绑定，项目的配置更加清晰和模块化，易于维护和扩展。
现代化功能：现代 CMake 强调面向目标的配置，支持更高级的功能，如接口库（Interface Libraries）和生成位置自适应的构建规则。

全局命令 vs. 目标层级命令

在之前的回答中提到的 link_directories() 和 link_libraries() 是全局命令，它们影响整个 CMake 项目中后续定义的所有目标。而 target_link_directories() 和 target_link_libraries() 是目标层级命令，它们只影响特定的目标。

全局命令

link_directories()：为所有目标指定链接库的搜索路径。
link_libraries()：为所有目标指定要链接的库。

缺点：

可能导致意外的库链接，难以追踪问题。
全局设置可能影响到不需要这些库的目标，导致不必要的依赖。

目标层级命令

target_link_directories()：为特定目标指定链接库的搜索路径。
target_link_libraries()：为特定目标指定要链接的库。

优点：

只影响指定的目标，避免全局副作用。
更加明确和可维护，易于理解每个目标的依赖关系。

详细解释目标层级

1. 定义目标

在 CMake 中，每个目标通过诸如 add_executable() 或 add_library() 等命令定义。这些目标可以是最终的可执行文件、静态库、动态库，甚至是一些中间的构建单元。

# 定义一个静态库目标
add_library(MyLib STATIC src/mylib.cpp)

# 定义一个可执行文件目标
add_executable(MyApp src/main.cpp)

2. 为目标设置属性

一旦定义了目标，就可以为其设置各种属性，如包含目录、编译选项、链接库等。这些属性通过目标层级的命令进行设置。

示例：为特定目标添加包含目录和链接库

# 为 MyLib 添加包含目录
target_include_directories(MyLib PUBLIC include/)

# 为 MyApp 链接 MyLib
target_link_libraries(MyApp PRIVATE MyLib)

在这个示例中：

MyLib 添加了一个包含目录 include/，并且通过 PUBLIC 关键字，这个包含目录对链接到 MyLib 的其他目标也可见。
MyApp 链接了 MyLib，并且通过 PRIVATE 关键字，表示 MyApp 使用 MyLib，但这个依赖不会传递给依赖 MyApp 的其他目标。

3. 目标之间的依赖关系

目标层级命令允许你清晰地定义目标之间的依赖关系，CMake 会自动处理这些依赖，确保正确的构建顺序。

示例：定义依赖关系

# 定义库目标
add_library(Utils STATIC src/utils.cpp)

# 定义可执行文件并链接库
add_executable(MyApp src/main.cpp)
target_link_libraries(MyApp PRIVATE Utils)

在这个例子中，MyApp 依赖于 Utils。CMake 会确保在构建 MyApp 之前先构建 Utils。

4. 可见性关键字

在目标层级命令中，可以使用 PRIVATE、PUBLIC 和 INTERFACE 关键字来控制属性的可见性和传递性。

PRIVATE：属性仅对当前目标可见。
PUBLIC：属性对当前目标及依赖它的其他目标可见。
INTERFACE：属性仅对依赖该目标的其他目标可见，不影响当前目标。

示例：使用可见性关键字

# 定义库目标
add_library(CoreLib STATIC src/core.cpp)

# 定义公共包含目录
target_include_directories(CoreLib PUBLIC include/core)

# 定义另一个库，依赖于 CoreLib
add_library(FeatureLib STATIC src/feature.cpp)
target_link_libraries(FeatureLib PRIVATE CoreLib)

# 定义可执行文件，依赖于 FeatureLib
add_executable(MyApp src/main.cpp)
target_link_libraries(MyApp PRIVATE FeatureLib)

在这个例子中：

CoreLib 的包含目录 include/core 是 PUBLIC，因此任何链接 CoreLib 的目标（如 FeatureLib）也会继承这个包含目录。
FeatureLib 通过 PRIVATE 链接 CoreLib，意味着 MyApp 不会自动继承 CoreLib 的属性，除非显式指定。

为什么使用目标层级而不是全局命令？

模块化和可维护性：目标层级的配置使得每个目标的依赖关系和属性独立，便于维护和理解。
避免全局副作用：全局命令可能导致不可预期的行为，特别是在大型项目中，目标层级命令则提供了更高的隔离性。
自动依赖管理：CMake 能够根据目标之间的依赖关系自动处理构建顺序和链接顺序，减少手动配置的复杂性。
现代 CMake 最佳实践：现代 CMake 强调面向目标的配置方法，这种方法更灵活、强大且易于扩展。

进一步的示例

假设你有一个项目，包含一个核心库、一个功能库以及一个可执行文件。核心库依赖于一个外部库 mylib，功能库依赖于核心库，而可执行文件依赖于功能库。

CMakeLists.txt 示例

cmake_minimum_required(VERSION 3.13)
project(MyProject)

# 定义核心库
add_library(CoreLib STATIC src/core.cpp)

# 指定 CoreLib 的包含目录
target_include_directories(CoreLib PUBLIC include/core)

# 指定 CoreLib 的链接目录（假设 mylib 位于 /usr/local/lib）
target_link_directories(CoreLib PRIVATE /usr/local/lib)

# 链接 CoreLib 所需的外部库 mylib
target_link_libraries(CoreLib PRIVATE mylib)

# 定义功能库
add_library(FeatureLib STATIC src/feature.cpp)

# 链接 FeatureLib 依赖的 CoreLib
target_link_libraries(FeatureLib PUBLIC CoreLib)

# 定义可执行文件
add_executable(MyApp src/main.cpp)

# 链接 MyApp 依赖的 FeatureLib
target_link_libraries(MyApp PRIVATE FeatureLib)

解释

CoreLib：
- 包含目录 include/core 对任何链接 CoreLib 的目标可见（PUBLIC）。
- 链接目录 /usr/local/lib 仅对 CoreLib 本身有效（PRIVATE）。
- 链接外部库 mylib 仅对 CoreLib 本身有效（PRIVATE）。
FeatureLib：
- 通过 PUBLIC 关键字链接 CoreLib，这意味着任何链接 FeatureLib 的目标（如 MyApp）也会自动链接 CoreLib 并继承其 PUBLIC 属性（如包含目录）。
MyApp：
- 通过 PRIVATE 关键字链接 FeatureLib，这意味着 MyApp 使用 FeatureLib，但不会将 FeatureLib 的依赖传递给其他目标（如果有的话）。

构建流程

构建顺序：CMake 自动识别 MyApp 依赖于 FeatureLib，而 FeatureLib 又依赖于 CoreLib，因此会按顺序构建 CoreLib → FeatureLib → MyApp。
链接设置：MyApp 会链接到 FeatureLib，而由于 FeatureLib 公共链接了 CoreLib，MyApp 也会自动链接到 CoreLib 的 PUBLIC 属性，如包含目录。

总结

目标层级在 CMake 中指的是围绕具体构建目标（如可执行文件、库）进行的配置和管理。与全局命令相比，目标层级命令提供了更高的封装性、可维护性和灵活性。通过将依赖关系和属性与特定目标绑定，CMake 能够更有效地管理复杂项目的构建过程。

关键点

目标（Target）：项目中构建的具体实体，如可执行文件、静态库、动态库等。
目标层级命令：仅影响特定目标的命令，如 target_link_libraries() 和 target_link_directories()。
可见性关键字：PRIVATE、PUBLIC、INTERFACE，用于控制属性的传播范围。
现代 CMake 最佳实践：优先使用目标层级命令，避免全局命令，以实现更模块化和可维护的构建配置。