CMake 目标与属性：使用 INTERFACE、PUBLIC 和 PRIVATE
CMake 是一个强大的构建系统，它通过目标（targets）和属性（properties）来管理项目的构建过程。在 CMake 中，目标可以是库、可执行文件或其他构建单元。理解如何使用 INTERFACE、PUBLIC 和 PRIVATE 关键字来定义目标的属性是构建复杂项目的关键。本文将详细探讨这三个关键字的用法、优缺点以及注意事项。
1. 目标的基本概念
在 CMake 中，目标是构建的基本单位。每个目标可以有不同的属性，这些属性可以影响编译器的行为、链接库、包含目录等。CMake 提供了三种访问控制关键字来定义目标的属性：PRIVATE、PUBLIC 和 INTERFACE。
1.1 PRIVATE
PRIVATE 关键字用于指定某个属性仅对目标本身可见。这意味着该属性不会被链接到依赖于该目标的其他目标。
示例代码
add_library(my_library PRIVATE my_library.cpp)
target_include_directories(my_library PRIVATE include)
在这个示例中，my_library 目标的包含目录 include 仅对 my_library 自身可见，其他链接到 my_library 的目标无法访问这个目录。
优点
- 封装性：使用
PRIVATE可以确保某些实现细节不会暴露给其他目标，增强了模块的封装性。 - 减少依赖：可以减少其他目标的依赖，避免不必要的编译。
缺点
- 可重用性：如果其他目标需要访问这些属性，使用
PRIVATE会导致代码重复或不必要的修改。
注意事项
- 确保在使用
PRIVATE时，确实不需要将属性暴露给其他目标。
1.2 PUBLIC
PUBLIC 关键字用于指定某个属性对目标本身和所有链接到该目标的其他目标可见。这意味着该属性会被传递给所有依赖于该目标的其他目标。
示例代码
add_library(my_library PUBLIC my_library.cpp)
target_include_directories(my_library PUBLIC include)
在这个示例中，my_library 的包含目录 include 对所有链接到 my_library 的目标都是可见的。
优点
- 共享性：使用
PUBLIC可以方便地共享库的接口和依赖，简化了其他目标的配置。 - 易于维护：当多个目标依赖于同一个库时，使用
PUBLIC可以减少重复配置。
缺点
- 依赖性增加：过多使用
PUBLIC可能导致不必要的依赖传播，增加了构建系统的复杂性。
注意事项
- 确保在使用
PUBLIC时，确实需要将属性暴露给其他目标。
1.3 INTERFACE
INTERFACE 关键字用于指定某个属性仅对链接到该目标的其他目标可见，而对目标本身不可见。这通常用于定义接口库（interface library），这些库不包含任何源文件，但提供了头文件和其他属性。
示例代码
add_library(my_interface INTERFACE)
target_include_directories(my_interface INTERFACE include)
在这个示例中，my_interface 是一个接口库，包含目录 include 仅对链接到 my_interface 的目标可见。
优点
- 轻量级：接口库不需要编译源文件，适合用于提供公共接口。
- 清晰的依赖关系：使用
INTERFACE可以清晰地定义目标之间的依赖关系。
缺点
- 功能限制：接口库不能包含源文件，因此功能上受到限制。
注意事项
- 确保在使用
INTERFACE时，确实不需要在目标本身中使用这些属性。
2. 组合使用
在实际项目中，通常会组合使用这三种关键字来定义目标的属性。例如，一个库可能需要一些私有的实现细节，同时也需要向外部提供公共接口。
示例代码
add_library(my_library my_library.cpp)
target_include_directories(my_library PRIVATE private_include)
target_include_directories(my_library PUBLIC public_include)
target_link_libraries(my_library INTERFACE my_interface)
在这个示例中，my_library 目标有一个私有的包含目录 private_include，一个公共的包含目录 public_include，并且链接到一个接口库 my_interface。
3. 总结
在 CMake 中，PRIVATE、PUBLIC 和 INTERFACE 是定义目标属性的关键字。它们各自有不同的作用和适用场景：
- PRIVATE：仅对目标本身可见，增强封装性。
- PUBLIC：对目标和所有依赖目标可见，便于共享。
- INTERFACE：仅对依赖目标可见，适合定义接口库。
在使用这些关键字时，开发者需要根据项目的需求和目标之间的关系来选择合适的关键字，以确保构建系统的清晰性和可维护性。通过合理的组合使用，可以构建出高效、可重用的 CMake 项目。