CMake中的PUBLIC、PRIVATE、INTERFACE

概 述

CMake中经常会使用target_**()相关命令，target_**()命令支持通过PUBLIC，PRIVATE和INTERFACE关键字来控制传播。本文主要介绍下这三个关键字的区别。

解 释

以target_link_libraries(A B)命令为例，从理解的角度解释：

• PRIVATE      依赖项B仅链接到目标A，若有C链接了目标A，C不链接依赖项B
• INTERFACE 依赖项B并不链接到目标A，若有C链接了目标A，C会链接依赖项B
• PUBLIC       依赖项B链接到目标A，若有C链接了目标A，C也会链接依赖项B

从使用的角度解释，若有C链接了目标A：

• 如果依赖项B仅用于目标A的实现，且不在头文件中提供给C使用，使用 PRIVATE
• 如果依赖项B不用于目标A的实现，仅在头文件中作为接口提供给C使用，使用 INTERFACE
• 如果依赖项B不仅用于目标A的实现，而且在头文件提供给C使用，使用 PUBLIC

例 子

举一个简单的例子说明一下

add_library(C c.cpp)
add_library(D d.cpp)

add_library(B b.cpp)
target_link_libraries(B PUBLIC C)
target_link_libraries(B PRIVATE D)

add_executable(A a.cpp)
target_link_libraries(A B)

因为C是B的PUBLIC依赖项，所以其会被传播到A。
因为D是B的PRIVATE依赖项，所以其不会传播到A。

补 充

这里补充下使用target_**()相关命令，有无target的区别。
以target_include_directories()命令为例，include_directories(dir)是一个全局设置，其会将dir添加到当前CMakeLists文件中每个目标的INCLUDE_DIRECTORIES属性中。即当前CMakeLists文件其下所有的子目录都会添加dir目录。
因此，建议使用有target的命令来减少不必要或多余的目录包含和链接。

这里我们也可以换另外一种更容易理解的形式：

当创建动态库时，

• 如果源文件(例如CPP)中包含第三方头文件，但是头文件（例如hpp）中不包含该第三方文件头，采用PRIVATE。
• 如果源文件和头文件中都包含该第三方文件头，采用PUBLIC。
• 如果头文件中包含该第三方文件头，但是源文件(例如CPP)中不包含，采用 INTERFACE。