CMake之PUBLIC、PRIVATE、INTERFACE

竹杖芒鞋轻胜马,谁怕?一蓑烟雨任平生~
个人主页： rainInSunny  |  个人专栏： C++那些事儿、 Learn OpenGL In Qt

---

写在前面

  使用CMake必然离不开target_include_directories和target_link_libraries，这两个命令中都可以设置为三种属性：PRIVATE、PUBLIC、INTERFACE。CMake官方文档对于这三种属性的解释过于抽象，本文将从编译行为的角度来理解这三种属性有什么差异。

抽象版解释

• 以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。

头文件和链接库传递

测试代码结构

testCMake
├─ add.cpp
├─ build
├─ CMakeLists.txt
├─ Iadd
│  └─ add.h
├─ Isub
│  └─ sub.h
├─ main.cpp
└─ sub.cpp

  代码目录结构十分简单，add.cpp和add.h组成add模块，Iadd是add模块头文件目录，sub.cpp和sub.h组成sub模块，Isub为sub模块头文件目录。main.cpp最后被编译成sample可执行程序。接下来开始测试～

PUBLIC传递

//Iadd里面的头文件可以传递给链接add的target，头文件传递
target_include_directories(add PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/Iadd)
//Isub的头文件传递给链接sub库的target，头文件传递
target_include_directories(sub PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/Isub)
//sub链接add库，链接sub的库也将链接add，链接库传递（含头文件）
target_link_libraries(sub PUBLIC add)
//sample链接sub
target_link_libraries(sample PUBLIC sub) //无视，因为属于最尾子节点，没有下一级来传播

  使用上面的CMake配置进行测试，得到结果如下。可以看出由于头文件包含属性和链接属性都是PUBLIC，因此sample虽然只链接了sub模块，此时sub链接的add模块会直接传递到sample模块，即sample模块也链接了add模块。

//add模块配置内容
//include
-ID:/workspace/testCmake/Iadd
// link
 -lkernel32 -luser32

//sub模块配置内容
//include 由于add库包含头文件使用的是public，所以sub只要link了add库，就会自动包含add的头文件目录，不需要另外include_directories
-ID:/workspace/testCmake/Isub -ID:/workspace/testCmake/Iadd
// link
 -ladd -lkernel32 -luser32

//sample模块配置内容
//include 同理Isub，另外由于sub是public链接add库，因此add库的头文件可以传递到链接sub的sample
-ID:/workspace/testCmake/Isub -ID:/workspace/testCmake/Iadd
//由于sub是public链接add库，sample也链接了add库
-lsub -ladd -lkernel32 -luser32

PRIVATE传递

//Iadd里面的头文件不可以传递给链接add的target
target_include_directories(add PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/Iadd)
//Isub的头文件不可以传递给链接sub库的target
target_include_directories(sub PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/Isub)
//sub链接add库，链接sub的库不能自动链接add
target_link_libraries(sub PRIVATE add)
//sample链接sub
target_link_libraries(sample PRIVATE sub)

  使用上面的CMake配置进行测试，得到结果如下。由于使用PRIVATE属性，头文件和链接库都不能传递，所以sample包含的头文件目录为空，只链接了sub库。

//add模块配置内容
//include
-ID:/workspace/testCmake/Iadd
//link
-lkernel32 -luser32

//sub模块配置内容
//include 由于add库包含头文件使用的是PRIVATE，所以sub包含没有Iadd
-ID:/workspace/testCmake/Isub 
// link
-ladd -lkernel32 -luser32

//sample模块配置内容
//include 为空，add及sub头文件都无法传递至sample
//link 只链接sub
-lsub -lkernel32 -luser32

INTERFACE传递

//Iadd里面的头文件可以传递给链接add的target，而add模块本身不包含该目录
target_include_directories(add INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/Iadd)
//Isub的头文件可以传递给链接sub库的target，而sub模块本身不包含该目录
target_include_directories(sub INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/Isub)
//sub没有链接add库，链接sub的库自动链接add
target_link_libraries(sub INTERFACE add)
//sample链接sub和add
target_link_libraries(sample PUBLIC sub) //private也可

  使用上面的CMake配置进行测试，得到结果如下。由于头文件和链接库都设置为INTERFACE，所以add和sub模块都只做头文件和链接库的传递，传递到sample中，最终sample中包含add和sub的头文件并同时链接了add和sub。

//add模块配置内容
//include 为空，INTERFACE只给链接者提供接口，而被链接者不依赖该接口，只做include path的传递
//link
-lkernel32 -luser32

//sub模块配置内容
//include 为空，同上
// link 链接也是INTERFACE，不链接，只做链接库的传递
 -lkernel32 -luser32

//sample模块配置内容
//include 由于是PUBLIC连接sub，所以前面INTERFACE传递的头文件和库都会包含在sample中 
-ID:/workspace/testCmake/Isub -ID:/workspace/testCmake/Iadd
// 同上 
-lsub -ladd -lkernel32 -luser32

欢迎留言讨论，创作不易，感谢点赞、关注和收藏～